Get a sales invoice by ID

Get a sales invoice by ID

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

Path parameters

consentId*string (uuid)

The consent for which you wish to get an invoice.

salesInvoiceId*string

The id of the invoice you wish to retrieve.

Header parameters

Response

200401403404501

Returns Invoices related to specific consent.

Body

application/json

idnullable string

referencenullable string

buyerReferencenullable string

bookedInvoiceIndicatornullable boolean

cancelledInvoiceIndicatornullable boolean

issueDatenullable string

issueTimenullable string

dueDatenullable string

creditInvoiceCreditInvoiceDto (object)

financialDimensionsnullable array of FinancialDimensionDto (object)

notesnullable array of NoteDto (object)

orderReferenceOrderReferenceDto (object)

documentCurrencyCodeDocumentCurrencyCodeDto (object)

accountingSupplierPartySupplierPartyDto (object)

accountingCustomerPartyCustomerPartyDto (object)

invoicePeriodPeriodDto (object)

deliveryDeliveryDto (object)

deliveryTermsDeliveryTermsDto (object)

paymentTermsPaymentTermsDto (object)

paymentMeansnullable array of PaymentMeansDto (object)

allowanceChargesnullable array of AllowanceChargeDto (object)

taxTotalsnullable array of TaxTotalDto (object)

withholdingTaxTotalsnullable array of WithholdingTaxTotalDto (object)

totalBalanceAmountAmountTypeDto (object)

additionalDocumentReferencesnullable array of AdditionalDocumentReferenceDto (object)

legalMonetaryTotalLegalMonetaryTotalDto (object)

invoiceLinesnullable array of InvoiceLineDto (object)

isSentnullable boolean

isSoldnullable boolean

Request

JavaScriptCurlPython

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

Response

200401403404

{
  "id": "text",
  "reference": "text",
  "buyerReference": "text",
  "bookedInvoiceIndicator": false,
  "cancelledInvoiceIndicator": false,
  "issueDate": "text",
  "issueTime": "text",
  "dueDate": "text",
  "creditInvoice": {
    "creditInvoiceIndicator": false,
    "reference": "text"
  },
  "financialDimensions": [
    {
      "id": "text",
      "financialDimensionId": "text",
      "type": "text"
    }
  ],
  "notes": [
    {
      "text": "text",
      "languageId": "text"
    }
  ],
  "orderReference": {
    "buyerOrderId": "text",
    "sellerOrderId": "text"
  },
  "documentCurrencyCode": {
    "currency": "text",
    "currencyRate": 0
  },
  "accountingSupplierParty": {
    "customerAssignedAccountId": {
      "id": "text",
      "schemeId": "text"
    },
    "party": {
      "partyIdentification": [
        {
          "id": "text",
          "schemeId": "text"
        }
      ],
      "partyName": {
        "name": "text",
        "languageId": "text"
      },
      "postalAddress": {
        "buildingNumber": "text",
        "streetName": "text",
        "additionalStreetName": "text",
        "cityName": "text",
        "postalZone": "text",
        "country": {
          "identificationCode": "text",
          "name": "text"
        }
      },
      "partyLegalEntity": {
        "registrationName": "text",
        "companyId": {
          "id": "text",
          "schemeId": "text"
        }
      },
      "contact": {
        "name": "text",
        "telephone": "text",
        "email": "text"
      }
    }
  },
  "accountingCustomerParty": {
    "supplierAssignedAccountId": {
      "id": "text",
      "schemeId": "text"
    },
    "party": {
      "partyIdentification": [
        {
          "id": "text",
          "schemeId": "text"
        }
      ],
      "partyName": {
        "name": "text",
        "languageId": "text"
      },
      "postalAddress": {
        "buildingNumber": "text",
        "streetName": "text",
        "additionalStreetName": "text",
        "cityName": "text",
        "postalZone": "text",
        "country": {
          "identificationCode": "text",
          "name": "text"
        }
      },
      "partyLegalEntity": {
        "registrationName": "text",
        "companyId": {
          "id": "text",
          "schemeId": "text"
        }
      },
      "contact": {
        "name": "text",
        "telephone": "text",
        "email": "text"
      }
    }
  },
  "invoicePeriod": {
    "startDate": "text",
    "endDate": "text"
  },
  "delivery": {
    "deliveryParty": {
      "partyName": {
        "name": "text",
        "languageId": "text"
      }
    },
    "carrierParty": {
      "partyName": {
        "name": "text",
        "languageId": "text"
      }
    },
    "actualDeliveryDate": "text",
    "deliveryAddress": {
      "buildingNumber": "text",
      "streetName": "text",
      "additionalStreetName": "text",
      "cityName": "text",
      "postalZone": "text",
      "country": {
        "identificationCode": "text",
        "name": "text"
      }
    }
  },
  "deliveryTerms": {
    "deliveryTermsId": {
      "id": "text",
      "schemeId": "text"
    },
    "specialTerms": {
      "text": "text",
      "languageId": "text"
    }
  },
  "paymentTerms": {
    "paymentTermsId": {
      "id": "text",
      "schemeId": "text"
    },
    "notes": [
      {
        "text": "text",
        "languageId": "text"
      }
    ]
  },
  "paymentMeans": [
    {
      "paymentChannelCode": "text",
      "paymentDueDate": "text",
      "paymentIds": [
        {
          "id": "text",
          "schemeId": "text"
        }
      ]
    }
  ],
  "allowanceCharges": [
    {
      "allowanceChargeId": {
        "id": "text",
        "schemeId": "text"
      },
      "chargeIndicator": false,
      "allowanceChargeReason": "text",
      "allowanceChargeAmount": {
        "amount": 0,
        "currencyId": "text"
      },
      "taxTotal": {
        "taxAmount": {
          "amount": 0,
          "currencyId": "text"
        },
        "taxIncludedIndicator": false
      },
      "taxCategory": {
        "percent": 0,
        "taxScheme": {
          "taxSchemeId": {
            "id": "text",
            "schemeId": "text"
          }
        }
      },
      "allowanceChargeBaseAmount": {
        "amount": 0,
        "currencyId": "text"
      },
      "multiplierFactorNumeric": 0
    }
  ],
  "taxTotals": [
    {
      "taxAmount": {
        "amount": 0,
        "currencyId": "text"
      },
      "taxIncludedIndicator": false
    }
  ],
  "withholdingTaxTotals": [
    {
      "taxAmount": {
        "amount": 0,
        "currencyId": "text"
      },
      "taxSubtotals": [
        {
          "taxableAmount": {
            "amount": 0,
            "currencyId": "text"
          },
          "taxAmount": {
            "amount": 0,
            "currencyId": "text"
          },
          "taxCategory": {
            "id": "text",
            "percent": 0,
            "taxScheme": {
              "id": "text"
            }
          }
        }
      ]
    }
  ],
  "totalBalanceAmount": {
    "amount": 0,
    "currencyId": "text"
  },
  "additionalDocumentReferences": [
    {
      "id": "text",
      "reference": "text"
    }
  ],
  "legalMonetaryTotal": {
    "taxInclusiveAmount": {
      "amount": 0,
      "currencyId": "text"
    },
    "prepaidAmount": {
      "amount": 0,
      "currencyId": "text"
    },
    "payableRoundingAmount": {
      "amount": 0,
      "currencyId": "text"
    },
    "payableAmount": {
      "amount": 0,
      "currencyId": "text"
    }
  },
  "invoiceLines": [
    {
      "id": "text",
      "invoicedQuantity": {
        "quantity": 0,
        "unitCode": "text"
      },
      "lineExtensionAmount": {
        "amount": 0,
        "currencyId": "text"
      },
      "item": {
        "name": "text",
        "description": "text",
        "sellersItemIdentification": {
          "id": "text",
          "extendedId": "text",
          "barCodeSymbologyId": "text"
        },
        "classifiedTaxCategories": [
          {
            "percent": 0,
            "taxScheme": {
              "taxSchemeId": {
                "id": "text",
                "schemeId": "text"
              }
            }
          }
        ]
      },
      "price": {
        "priceAmount": {
          "amount": 0,
          "currencyId": "text"
        },
        "priceTypeCode": {
          "code": "text",
          "listId": "text"
        },
        "allowanceCharges": [
          {
            "allowanceChargeId": {
              "id": "text",
              "schemeId": "text"
            },
            "chargeIndicator": false,
            "allowanceChargeReason": "text",
            "allowanceChargeAmount": {
              "amount": 0,
              "currencyId": "text"
            },
            "taxTotal": {
              "taxAmount": {
                "amount": 0,
                "currencyId": "text"
              },
              "taxIncludedIndicator": false
            },
            "taxCategory": {
              "percent": 0,
              "taxScheme": {
                "taxSchemeId": {
                  "id": "text",
                  "schemeId": "text"
                }
              }
            },
            "allowanceChargeBaseAmount": {
              "amount": 0,
              "currencyId": "text"
            },
            "multiplierFactorNumeric": 0
          }
        ]
      },
      "delivery": {
        "actualDeliveryDate": "text"
      },
      "financialDimensions": [
        {
          "id": "text",
          "financialDimensionId": "text",
          "type": "text"
        }
      ],
      "allowanceCharges": [
        {
          "allowanceChargeId": {
            "id": "text",
            "schemeId": "text"
          },
          "chargeIndicator": false,
          "allowanceChargeReason": "text",
          "allowanceChargeAmount": {
            "amount": 0,
            "currencyId": "text"
          },
          "taxTotal": {
            "taxAmount": {
              "amount": 0,
              "currencyId": "text"
            },
            "taxIncludedIndicator": false
          },
          "taxCategory": {
            "percent": 0,
            "taxScheme": {
              "taxSchemeId": {
                "id": "text",
                "schemeId": "text"
              }
            }
          },
          "allowanceChargeBaseAmount": {
            "amount": 0,
            "currencyId": "text"
          },
          "multiplierFactorNumeric": 0
        }
      ],
      "subInvoiceLines": [
        {
          "invoicedQuantity": {
            "quantity": 0,
            "unitCode": "text"
          },
          "item": {
            "name": "text",
            "description": "text",
            "sellersItemIdentification": {
              "id": "text",
              "extendedId": "text",
              "barCodeSymbologyId": "text"
            },
            "classifiedTaxCategories": [
              {
                "percent": 0,
                "taxScheme": {
                  "taxSchemeId": {
                    "id": "text",
                    "schemeId": "text"
                  }
                }
              }
            ]
          }
        }
      ]
    }
  ],
  "isSent": false,
  "isSold": false
}

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
buyerReference	reference for the buyer (usually buyer's purchase invoice number)	PO001
creditInvoice.creditInvoiceIndicator	marker if the invoice is credit invoice / credit note	true/false
creditInvoice.reference	identifier (invoice number) of the credited invoice, if it is a credit invoice	INV001
financialDimensions	financial dimension to assign financial granularity to the financial reports (usually cost center, projects, etc.)
financialDimensions.type	type of financial dimensions: - costCode -> cost center - costBearer -> cost bearer - project -> project	CC001
orderReference	reference of the order number that is invoiced from: - buyerOrderId -> order number of the buyer (generated by customer's system) - sellerOrderId -> order number of the seller (generated by own system)	SO001
accountingCustomerParty.supplierAssignedAccountId.id	customer code assigned by system	CUST001
accountingCustomerParty.party.partyIdentification.id	legal identifier for the customer (GLN - "schemeId": "GLN" or VAT number - "schemeId": "SE:VAT")	SE559079010001
accountingCustomerParty.partyLegalEntity.companyId.id	registered customer's organisation number	559079-0100
accountingSupplierParty	same as accountingCustomerParty above, only for supplier side (used only in supplier invoice)
allowanceCharges	additional costs or discounts related to the invoice, ex: freight costs or discount
allowanceCharges.chargeIndicator	denote if it is a cost (+) or a discount (-) to the invoice amount	true/false
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
isSent	denote if the invoice is sent	true/false
isSold	denote if the invoice is sold to the factoring company (for lending purposes)	true/false
...schemeId	standard used for codification	SE:ORG (organisation number format in Sweden)

NOTE: some information like GLN, organisation number, VAT number or contact (phone & email) need another API call (customer) in some systems. Use include parameter to display customer entity (/salesinvoices/:id?include=customer).

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