List Sales Invoices

List sales invoices

GEThttps://apione.zwapgrid.com/accounting/api/v1/consents/{consentId}/salesinvoices

Path parameters

consentId*string (uuid)

The consent for which you wish to list invoices.

Query parameters

Header parameters

Response

200401403501

Returns Invoices related to specific consent.

Body

application/json

metaPagedResultMetadataDto (object)

datanullable array of SalesInvoiceSummaryDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://apione.zwapgrid.com/accounting/api/v1/consents/{consentId}/salesinvoices', {
    method: 'GET',
    headers: {
      "x-correlation-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200401403

{
  "meta": {},
  "data": [
    {
      "id": "text",
      "reference": "text",
      "dueDate": "text",
      "issueDate": "text",
      "createdDateTime": "text",
      "modifiedDateTime": "text",
      "isSent": false,
      "accountingCustomerParty": {
        "supplierAssignedAccountId": {
          "id": "text",
          "schemeId": "text"
        },
        "party": {
          "partyIdentification": [
            {
              "id": "text",
              "schemeId": "text"
            }
          ],
          "partyName": {
            "name": "text",
            "languageId": "text"
          }
        }
      },
      "notes": [
        {
          "text": "text",
          "languageId": "text"
        }
      ],
      "totalBalanceAmount": {
        "amount": 0,
        "currencyId": "text"
      },
      "legalMonetaryTotal": {
        "taxInclusiveAmount": {
          "amount": 0,
          "currencyId": "text"
        },
        "prepaidAmount": {
          "amount": 0,
          "currencyId": "text"
        },
        "payableRoundingAmount": {
          "amount": 0,
          "currencyId": "text"
        },
        "payableAmount": {
          "amount": 0,
          "currencyId": "text"
        }
      }
    }
  ]
}

Field Description

Field	Description	Example
id	unique system generated id by the system	5050d6f7-d16a-4376-b00d-a20390c77bde
reference	an identifier (invoice number) for the document, assigned by the sender.	INV001
accountingCustomerParty.supplierAssignedAccountId.id	customer code assigned by system	CUST001
accountingCustomerParty.party.partyIdentification.id	legal identifier for the customer (legal organisation number)	559079-0100
totalBalanceAmount	remaining balance of an invoice (will be different than taxInclusiveAmount if the invoice is half paid and will be 0 if fully paid)	800.00
taxInclusiveAmount	total amount of the invoice (tax included). this amount will never change no matter if the invoice is paid or not	1,000.00
prepaidAmount	advanced payment deducted to the invoice (if the accounting systems supports it)	100.00
payableRoundingAmount	the rounded nominal if there is decimal rounding involved (ex: 499.95 -> 500 the amount for payableRoundingAmount will be 0.05)	0.05
payableAmount	remaining amount to be paid, should be the same as totalBalanceAmount	800.00
...schemeId	standard used for codification	SE:ORG (organisation number format in Sweden)

Knowing if an invoice paid or not can be tricky since not all systems provide a clear cut status which denotes payment. The easiest will be to locate these 2 fields: 1. totalBalanceAmount (if totalBalanceAmount is 0 then it is FULLY PAID) 2. taxInclusiveAmount (if totalBalanceAmount < taxInclusiveAmount and taxInclusiveAmount not 0, then it is HALF PAID) 3. IF taxInclusiveAmount = totalBalanceAmount then there is no one single payment yet (NOT PAID)

To list the payments made for that invoice you can use GET /salesinvoices/:id/payments or GET /salesinvoices/payments to list all payments

Filtering

Status

Notes: all invoices returned are booked

SYSTEM	ISSOLD	PAID	UNPAID	OVERDUE	CANCELLED	UNSENT
Fortnox	NA	v	v	v	v	NA
Visma eAccounting	NA	v	v	v	NA	NA
Bjorn Lunden	NA	v	v	v	v	NA
Procountor	v	v	NA	NA	NA	v
Visma Netvisor	NA	v	v	v	v	v
Billy	NA	v	v	NA	NA	NA
Visma Dinero	NA	v	NA	v	NA	NA
Visma e-conomic	NA	v	v	v	NA	NA
Tripletex	NA	NA	NA	NA	NA	NA
Xero	NA	v	v	v	NA	v

isSent field

currently only supported by these systems: fortnox, billy, procountor, netvisor

Note

System by system filtering depends on the capability of the corresponding system, API.1 will return following message should the corresponding system does not have the capability:

$"Filtering by status {status} is not supported by {system}");