> For the complete documentation index, see [llms.txt](https://docs.zwapgrid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zwapgrid.com/api-guide/accounting-api-guide/supplier-invoices.md).
# Supplier Invoices
Create and retrieve supplier (purchase) invoices for a given consent.
## List supplier invoices
> Retrieves a paginated list of supplier invoices for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \
Fortnox | ✅ Supported |\
> \| \
Bjorn Lunden | ✅ Supported |\
> \| \
Spiris | ✅ Supported |\
> \| \
Tripletex | 📞 Not supported / contact us |\
> \| \
Visma e-conomic | ✅ Supported |\
> \| \
Billy | ✅ Supported |\
> \| \
Visma Dinero | 📞 Not supported / contact us |\
> \| \
Procountor | ✅ Supported |\
> \| \
Visma Netvisor | ✅ Supported |\
> \| \
Microsoft Business Central | ✅ Supported |\
> \| \
Exact Online | 📞 Not supported / contact us |\
> \| \
QuickBooks | 📞 Not supported / contact us |\
> \| \
Xero | ✅ Supported |\
> \| \
Bokio | ✅ Supported |\
> \| \
Kleer | ✅ Supported |\
> \| \
DATEV | 📞 Not supported / contact us |
```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices","description":"Create and retrieve supplier (purchase) invoices for a given consent."}],"servers":[{"url":"https://apione.zwapgrid.com/accounting"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Use the API key to access all API endpoints.","name":"x-api-key","in":"header"}},"schemas":{"SupplierInvoiceSummaryDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a summary view of a supplier invoice.","$ref":"#/components/schemas/SupplierInvoiceSummaryDto"},"description":"Collection of items in the current page."}},"additionalProperties":false,"description":"Represents a paginated result containing metadata and a collection of items."},"PagedResultMetadataDto":{"type":"object","properties":{"totalResources":{"type":["null","integer"],"description":"Total number of resources across all pages.","format":"int32"},"totalPages":{"type":["null","integer"],"description":"Total number of pages available.","format":"int32"},"currentPage":{"type":"integer","description":"The current page number.","format":"int32"}},"additionalProperties":false,"description":"Represents pagination metadata for a paged result set."},"SupplierInvoiceSummaryDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier generated by the accounting system."},"reference":{"type":["null","string"],"description":"External reference or number assigned to the invoice."},"dueDate":{"type":["null","string"],"description":"Date when the invoice payment is due. Format: yyyy-MM-dd."},"issueDate":{"type":["null","string"],"description":"Date when the invoice was issued. Format: yyyy-MM-dd."},"createdDateTime":{"type":["null","string"],"description":"Date and time when the invoice was created."},"modifiedDateTime":{"type":["null","string"],"description":"Date and time when the invoice was last modified."},"accountingSupplierParty":{"description":"Supplier party on the invoice (null if not available).","$ref":"#/components/schemas/SupplierPartySummaryDto"},"notes":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of notes attached to the invoice (null if not available)."},"totalBalanceAmount":{"description":"Remaining balance amount on the invoice (null if not available).","$ref":"#/components/schemas/AmountTypeDto"},"legalMonetaryTotal":{"description":"Legal monetary totals for the invoice (null if not available).","$ref":"#/components/schemas/LegalMonetaryTotalDto"},"paymentStatus":{"description":"Payment status of the invoice (null if not available).","$ref":"#/components/schemas/PaymentStatusDto"}},"additionalProperties":false,"description":"Represents a summary view of a supplier invoice."},"SupplierPartySummaryDto":{"type":"object","properties":{"customerAssignedAccountId":{"description":"Account identifier assigned to the supplier by the customer.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Summarized party details for the supplier.","$ref":"#/components/schemas/PartySummaryDto"}},"additionalProperties":false,"description":"Represents a summarized supplier party view for invoice listings."},"IdentifierDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Legal identifier."},"schemeId":{"type":["null","string"],"description":"Legal identifier scheme (e.g. SE:ORGNR)."}},"additionalProperties":false,"description":"Represents a legal identifier with an associated scheme."},"PartySummaryDto":{"type":"object","properties":{"partyName":{"description":"Name of the party.","$ref":"#/components/schemas/PartyNameDto"}},"additionalProperties":false,"description":"Represents a summarized view of a party."},"PartyNameDto":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Name of the party."},"languageId":{"type":["null","string"],"description":"ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."}},"additionalProperties":false,"description":"Represents the name of a party with an optional language identifier."},"NoteDto":{"type":"object","properties":{"text":{"type":["null","string"],"description":"Content of the note."},"languageId":{"type":["null","string"],"description":"ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."}},"additionalProperties":false,"description":"Represents a textual note with an optional language identifier."},"AmountTypeDto":{"type":"object","properties":{"amount":{"type":"number","description":"The balance amount.","format":"double"},"currencyId":{"type":["null","string"],"description":"The currency code (e.g. SEK)."}},"additionalProperties":false,"description":"Represents a monetary amount with an associated currency."},"LegalMonetaryTotalDto":{"type":"object","properties":{"taxInclusiveAmount":{"description":"Total amount of the invoice (tax included). This amount does not change regardless of payment status.","$ref":"#/components/schemas/AmountTypeDto"},"prepaidAmount":{"description":"Advance payment deducted from the invoice (if the accounting system supports it).","$ref":"#/components/schemas/AmountTypeDto"},"payableRoundingAmount":{"description":"Rounding amount applied to the payable total (e.g. 499.95 rounded to 500 yields 0.05).","$ref":"#/components/schemas/AmountTypeDto"},"payableAmount":{"description":"Remaining amount to be paid, should equal the total balance amount.","$ref":"#/components/schemas/AmountTypeDto"},"lineExtensionAmount":{"description":"Sum of all invoice line extension amounts before tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxExclusiveAmount":{"description":"Total amount of the invoice excluding tax.","$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents the legal monetary totals of an invoice."},"PaymentStatusDto":{"type":"object","properties":{"status":{"enum":["UNPAID","PARTLY_PAID","FULLY_PAID"],"type":["null","string"],"description":"Current payment status."},"settlementDate":{"type":["null","string"],"description":"Date when the payment was settled."}},"additionalProperties":false,"description":"Represents the payment status of an invoice."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"ProviderRateLimitInformation":{"type":"object","properties":{"responseHeaders":{"type":["null","object"],"additionalProperties":{"type":"string"}}},"additionalProperties":false}}},"paths":{"/api/v1/consents/{consentId}/supplierinvoices":{"get":{"tags":["Supplier Invoices"],"summary":"List supplier invoices","description":"Retrieves a paginated list of supplier invoices for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| ![\"Fortnox\"](\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\")
Fortnox | ✅ Supported |\n| ![\"Bjorn](\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\")
Bjorn Lunden | ✅ Supported |\n| ![\"Spiris\"](\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\")
Spiris | ✅ Supported |\n| ![\"Tripletex\"](\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\")
Tripletex | 📞 Not supported / contact us |\n| ![\"Visma](\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\")
Visma e-conomic | ✅ Supported |\n| ![\"Billy\"](\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\")
Billy | ✅ Supported |\n| ![\"Visma](\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\")
Visma Dinero | 📞 Not supported / contact us |\n| ![\"Procountor\"](\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\")
Procountor | ✅ Supported |\n| ![\"Visma](\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\")
Visma Netvisor | ✅ Supported |\n| ![\"Microsoft](\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\")
Microsoft Business Central | ✅ Supported |\n| ![\"Exact](\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\")
Exact Online | 📞 Not supported / contact us |\n| ![\"QuickBooks\"](\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\")
QuickBooks | 📞 Not supported / contact us |\n| ![\"Xero\"](\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\")
Xero | ✅ Supported |\n| ![\"Bokio\"](\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\")
Bokio | ✅ Supported |\n| ![\"Kleer\"](\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\")
Kleer | ✅ Supported |\n| ![\"DATEV\"](\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\")
DATEV | 📞 Not supported / contact us |","operationId":"ListSupplierInvoices","parameters":[{"name":"consentId","in":"path","description":"Identifier of the consent representing the connection to the accounting system.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Count","in":"query","description":"Number of records to return per page. Range: 1-100.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}},{"name":"CurrentPage","in":"query","description":"Page number to return. Must be 1 or greater.","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"FromInvoiceDate","in":"query","description":"Start invoice issue date filter. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).","schema":{"type":"string","format":"date-time"}},{"name":"ToInvoiceDate","in":"query","description":"End invoice issue date filter. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).","schema":{"type":"string","format":"date-time"}},{"name":"ModifiedDateTime","in":"query","description":"Return invoices modified on or after this date and time. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).","schema":{"type":"string","format":"date-time"}},{"name":"OrderBy","in":"query","description":"Sort order for the results.","schema":{"enum":["DateDescending","DateAscending"],"type":"string"}},{"name":"Status","in":"query","description":"The status to filter invoices by.\n \nStatus filtering support per system is shown below.\n \nLegend:\n- ✅ = Supported\n- ⛔ = Not supported\n \n| System | IsSold | Paid | Unpaid | Overdue | Cancelled | Unsent | PendingPayment |\n|-|-|-|-|-|-|-|-|\n| Fortnox | ⛔ | ✅ | ✅ | ✅ | ✅ | ⛔ | ✅ |\n| Bjorn Lunden | ⛔ | ⛔ | ✅ | ✅ | ⛔ | ⛔ | ⛔ |\n| Spiris | ⛔ | ✅ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Tripletex | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Visma e-conomic | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Billy | ⛔ | ✅ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Visma Dinero | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Procountor | ⛔ | ✅ | ⛔ | ⛔ | ✅ | ✅ | ⛔ |\n| Visma Netvisor | ⛔ | ✅ | ✅ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Microsoft Business Central | ⛔ | ✅ | ✅ | ⛔ | ✅ | ⛔ | ⛔ |\n| Bokio | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Kleer | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Xero | ⛔ | ✅ | ✅ | ✅ | ✅ | ⛔ | ⛔ |\n| FileOne | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |","schema":{"enum":["IsSold","Paid","Unpaid","Overdue","Cancelled","Unsent","PendingPayment"],"type":"string"}},{"name":"Include","in":"query","description":"Comma-separated list of optional data to include in the response.\n \nAvailable values:\n1. `paymentStatus` — Include the payment status.","schema":{"type":"string"}},{"name":"x-correlation-id","in":"header","description":"Unique identifier used to correlate and trace this request.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returns a paginated list of supplier invoices for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/SupplierInvoiceSummaryDtoPagedResultDto"}}}},"401":{"description":"Missing or invalid authentication credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorized to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"The request was rate-limited. The response may include Retry-After and ErpError.responseHeaders with retry and quota information from the accounting system.","headers":{"Retry-After":{"description":"Delay in seconds or an HTTP date supplied by the accounting system. Wait until this interval has elapsed before retrying. Optional; availability depends on the integration.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"ErpError":{"$ref":"#/components/schemas/ProviderRateLimitInformation"}}}]}}}},"501":{"description":"This operation is not supported by the connected accounting system.","content":{"application/json":{}}}}}}}}
```
## Create a supplier invoice
> Creates a new supplier invoice in the connected accounting system.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \ Fortnox | ✅ Supported |\
> \| \ Bjorn Lunden | ✅ Supported |\
> \| \ Spiris | ✅ Supported |\
> \| \ Tripletex | 📞 Not supported / contact us |\
> \| \ Visma e-conomic | 📞 Not supported / contact us |\
> \| \ Billy | 📞 Not supported / contact us |\
> \| \ Visma Dinero | 📞 Not supported / contact us |\
> \| \ Procountor | 📞 Not supported / contact us |\
> \| \ Visma Netvisor | 📞 Not supported / contact us |\
> \| \ Microsoft Business Central | ✅ Supported |\
> \| \ Exact Online | 📞 Not supported / contact us |\
> \| \ QuickBooks | 📞 Not supported / contact us |\
> \| \ Xero | 📞 Not supported / contact us |\
> \| \ Bokio | ✅ Supported |\
> \| \ Kleer | 📞 Not supported / contact us |\
> \| \ DATEV | 📞 Not supported / contact us |
```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices","description":"Create and retrieve supplier (purchase) invoices for a given consent."}],"servers":[{"url":"https://apione.zwapgrid.com/accounting"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Use the API key to access all API endpoints.","name":"x-api-key","in":"header"}},"schemas":{"SupplierInvoiceInputDto":{"type":"object","properties":{"reference":{"type":["null","string"],"description":"Invoice number assigned by the sender."},"buyerReference":{"type":["null","string"],"description":"Reference for the buyer (usually the buyer's purchase invoice number)."},"bookedInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is booked."},"cancelledInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is cancelled."},"issueDate":{"type":["null","string"],"description":"Issue date of the invoice."},"issueTime":{"type":["null","string"],"description":"Issue time of the invoice."},"dueDate":{"type":["null","string"],"description":"Due date for payment of the invoice."},"creditInvoice":{"description":"Credit invoice details, if the invoice is a credit note.","$ref":"#/components/schemas/CreditInvoiceInputDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions assigned to the invoice."},"notes":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of notes attached to the invoice."},"orderReference":{"description":"Reference to the originating order.","$ref":"#/components/schemas/OrderReferenceDto"},"documentCurrencyCode":{"description":"Currency and exchange rate of the invoice document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"accountingSupplierParty":{"description":"Supplier party for the invoice.","$ref":"#/components/schemas/SupplierPartyInputDto"},"accountingCustomerParty":{"description":"Customer party for the invoice.","$ref":"#/components/schemas/CustomerPartyInputDto"},"invoicePeriod":{"description":"Billing period covered by the invoice.","$ref":"#/components/schemas/PeriodDto"},"delivery":{"description":"Delivery information for the invoice.","$ref":"#/components/schemas/DeliveryDto"},"deliveryTerms":{"description":"Delivery terms associated with the invoice.","$ref":"#/components/schemas/DeliveryTermsDto"},"paymentTerms":{"description":"Payment terms for the invoice.","$ref":"#/components/schemas/PaymentTermsInputDto"},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents the means of payment for an invoice.","$ref":"#/components/schemas/PaymentMeansInputDto"},"description":"Collection of payment means for the invoice."},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or invoice line.","$ref":"#/components/schemas/AllowanceChargeInputDto"},"description":"Collection of allowances and charges on the invoice."},"taxTotals":{"type":["null","array"],"items":{"description":"Represents the total tax amount for an invoice or line.","$ref":"#/components/schemas/TaxTotalInputDto"},"description":"Collection of tax totals for the invoice."},"withholdingTaxTotals":{"type":["null","array"],"items":{"description":"Represents the total withholding tax amount for an invoice.","$ref":"#/components/schemas/WithholdingTaxTotalInputDto"},"description":"Collection of withholding tax totals for the invoice."},"totalBalanceAmount":{"description":"Remaining balance of the invoice (differs from tax-inclusive amount if partly paid; zero if fully paid).","$ref":"#/components/schemas/AmountTypeDto"},"additionalDocumentReferences":{"type":["null","array"],"items":{"description":"Represents an additional document reference associated with an invoice.","$ref":"#/components/schemas/AdditionalDocumentReferenceDto"},"description":"Collection of additional document references."},"legalMonetaryTotal":{"description":"Legal monetary totals for the invoice.","$ref":"#/components/schemas/LegalMonetaryTotalDto"},"paymentStatus":{"description":"Current payment status of the invoice.","$ref":"#/components/schemas/PaymentStatusDto"},"invoiceLines":{"type":["null","array"],"items":{"description":"Represents a line item on a supplier invoice.","$ref":"#/components/schemas/SupplierInvoiceLineInputDto"},"description":"Collection of supplier invoice lines."},"sellerReference":{"type":["null","string"],"description":"Reference for the seller."}},"additionalProperties":false,"description":"Represents input data for a supplier invoice."},"CreditInvoiceInputDto":{"type":"object","properties":{"creditInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is a credit invoice / credit note."},"reference":{"type":["null","string"],"description":"Invoice number of the credited invoice, if this is a credit invoice."},"creditInvoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a reference to a credited invoice document.","$ref":"#/components/schemas/CreditInvoiceDocumentReferenceDto"},"description":"Collection of references to the credited invoices or credit invoices."}},"additionalProperties":false,"description":"Represents credit invoice details associated with an invoice."},"CreditInvoiceDocumentReferenceDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the document reference."},"reference":{"type":["null","string"],"description":"Reference number of the credited invoice."},"documentType":{"enum":["Invoice","CreditInvoice"],"type":["null","string"],"description":"Type of the referenced document."}},"additionalProperties":false,"description":"Represents a reference to a credited invoice document."},"FinancialDimensionDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the financial dimension."},"reference":{"type":["null","string"],"description":"Reference code for the financial dimension."},"type":{"type":["null","string"],"description":"Type or code of the financial dimension as exposed by the connected accounting system.\n\nKnown values currently emitted by supported connectors include:\n\n- businessGroup\n- campaign\n- costBearer\n- costCode\n- costUnit\n- customerGroup\n- department\n- employee\n- product\n- project\n- purchaser\n- salesPerson\n- salesRegion\n- supplierGroup\n\nSome connectors can also return additional system-specific dimension codes (for example custom Business Central dimension codes)."},"name":{"type":["null","string"],"description":"Display name of the financial dimension."},"description":{"type":["null","string"],"description":"Description of the financial dimension."},"isActive":{"type":["null","boolean"],"description":"Indicates whether the financial dimension is active."}},"additionalProperties":false,"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project)."},"NoteDto":{"type":"object","properties":{"text":{"type":["null","string"],"description":"Content of the note."},"languageId":{"type":["null","string"],"description":"ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."}},"additionalProperties":false,"description":"Represents a textual note with an optional language identifier."},"OrderReferenceDto":{"type":"object","properties":{"buyerOrderId":{"type":["null","string"],"description":"Order number of the buyer (generated by the customer's system)."},"sellerOrderId":{"type":["null","string"],"description":"Order number of the seller (generated by the seller's system)."}},"additionalProperties":false,"description":"Represents a reference to the order from which the invoice originates."},"DocumentCurrencyCodeDto":{"type":"object","properties":{"currency":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Common.DocumentCurrencyCodeDto.CurrencyId instead. Currency code of the document (e.g. SEK, EUR). (Deprecated: Use CurrencyId instead)","deprecated":true},"currencyId":{"type":["null","string"],"description":"Currency code of the document (e.g. SEK, EUR)."},"currencyRate":{"type":["null","number"],"description":"Exchange rate applied to the document currency.","format":"double"}},"additionalProperties":false,"description":"Represents the document currency and its exchange rate."},"SupplierPartyInputDto":{"type":"object","properties":{"customerAssignedAccountId":{"description":"Supplier code assigned by the customer's system.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details of the supplier.","$ref":"#/components/schemas/PartyInputDto"}},"additionalProperties":false,"description":"Represents the supplier party on an invoice."},"IdentifierDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Legal identifier."},"schemeId":{"type":["null","string"],"description":"Legal identifier scheme (e.g. SE:ORGNR)."}},"additionalProperties":false,"description":"Represents a legal identifier with an associated scheme."},"PartyInputDto":{"type":"object","properties":{"partyName":{"description":"Name of the party.","$ref":"#/components/schemas/PartyNameDto"},"postalAddress":{"description":"Postal address of the party.","$ref":"#/components/schemas/AddressDto"},"partyLegalEntity":{"description":"Legal entity information of the party.","$ref":"#/components/schemas/PartyLegalEntityDto"},"contact":{"description":"Contact information for the party.","$ref":"#/components/schemas/ContactDto"},"endpointId":{"description":"Electronic endpoint identifier for the party.","$ref":"#/components/schemas/IdentifierDto"},"partyIdentification":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of identifiers for the party."}},"additionalProperties":false,"description":"Represents a party (business entity) involved in an invoice."},"PartyNameDto":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Name of the party."},"languageId":{"type":["null","string"],"description":"ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."}},"additionalProperties":false,"description":"Represents the name of a party with an optional language identifier."},"AddressDto":{"type":"object","properties":{"buildingNumber":{"type":["null","string"],"description":"Building number of the address."},"streetName":{"type":["null","string"],"description":"Primary street name."},"additionalStreetName":{"type":["null","string"],"description":"Secondary street name or additional address line."},"cityName":{"type":["null","string"],"description":"City or locality name."},"postalZone":{"type":["null","string"],"description":"Postal or ZIP code."},"country":{"description":"Country associated with the address.","$ref":"#/components/schemas/CountryDto"}},"additionalProperties":false,"description":"Represents a postal address."},"CountryDto":{"type":"object","properties":{"identificationCode":{"type":["null","string"],"description":"ISO 3166-1 alpha-2 country code."},"name":{"type":["null","string"],"description":"Country name."}},"additionalProperties":false,"description":"Represents a country with its identification code and name."},"PartyLegalEntityDto":{"type":"object","properties":{"registrationName":{"type":["null","string"],"description":"Registered legal name of the entity."},"companyId":{"description":"Company identifier (e.g. organization number).","$ref":"#/components/schemas/IdentifierDto"}},"additionalProperties":false,"description":"Represents the legal entity information of a party."},"ContactDto":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Contact person name."},"telephone":{"type":["null","string"],"description":"Primary telephone number."},"email":{"type":["null","string"],"description":"Primary email address."},"secondaryEmail":{"type":["null","string"],"description":"Secondary email address."}},"additionalProperties":false,"description":"Represents contact information for a party."},"CustomerPartyInputDto":{"type":"object","properties":{"supplierAssignedAccountId":{"description":"Customer code assigned by the supplier's system.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details of the customer.","$ref":"#/components/schemas/PartyInputDto"}},"additionalProperties":false,"description":"Represents the customer party on an invoice."},"PeriodDto":{"type":"object","properties":{"startDate":{"type":["null","string"],"description":"Start date of the period."},"endDate":{"type":["null","string"],"description":"End date of the period."}},"additionalProperties":false,"description":"Represents a date period defined by a start and end date."},"DeliveryDto":{"type":"object","properties":{"deliveryParty":{"description":"Party receiving the delivery.","$ref":"#/components/schemas/DeliveryPartyDto"},"carrierParty":{"description":"Party responsible for carrying out the delivery.","$ref":"#/components/schemas/DeliveryPartyDto"},"actualDeliveryDate":{"type":["null","string"],"description":"Actual date of delivery."},"trackingId":{"type":["null","string"],"description":"Tracking identifier for the delivery shipment."},"deliveryAddress":{"description":"Address where the delivery is made.","$ref":"#/components/schemas/AddressDto"}},"additionalProperties":false,"description":"Represents delivery information for an invoice."},"DeliveryPartyDto":{"type":"object","properties":{"partyIdentification":{"description":"Identifier of the delivery party.","$ref":"#/components/schemas/IdentifierDto"},"partyName":{"description":"Name of the delivery party.","$ref":"#/components/schemas/PartyNameDto"}},"additionalProperties":false,"description":"Represents a party involved in a delivery."},"DeliveryTermsDto":{"type":"object","properties":{"deliveryTermsId":{"description":"Identifier of the delivery terms (e.g. Incoterms code).","$ref":"#/components/schemas/IdentifierDto"},"specialTerms":{"description":"Special delivery terms described as a note.","$ref":"#/components/schemas/NoteDto"}},"additionalProperties":false,"description":"Represents delivery terms associated with an invoice."},"PaymentTermsInputDto":{"type":"object","properties":{"paymentTermsId":{"description":"Identifier of the payment terms.","$ref":"#/components/schemas/IdentifierDto"},"notes":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of notes describing the payment terms."}},"additionalProperties":false,"description":"Represents payment terms for an invoice."},"PaymentMeansInputDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel (e.g. bank transfer, credit card)."},"paymentDueDate":{"type":["null","string"],"description":"Due date for the payment."},"paymentIds":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of payment identifiers (e.g. bank account numbers)."}},"additionalProperties":false,"description":"Represents the means of payment for an invoice."},"AllowanceChargeInputDto":{"type":"object","properties":{"allowanceChargeId":{"description":"Identifier of the allowance or charge.","$ref":"#/components/schemas/IdentifierDto"},"chargeIndicator":{"type":"boolean","description":"Indicates whether this is a charge (true) or an allowance (false)."},"allowanceChargeReason":{"type":["null","string"],"description":"Reason for the allowance or charge."},"allowanceChargeAmount":{"description":"Monetary amount of the allowance or charge.","$ref":"#/components/schemas/AmountTypeDto"},"taxTotal":{"description":"Tax total associated with the allowance or charge.","$ref":"#/components/schemas/TaxTotalInputDto"},"taxCategory":{"description":"Tax category applied to the allowance or charge.","$ref":"#/components/schemas/TaxCategoryDto"},"allowanceChargeBaseAmount":{"description":"Base monetary amount from which the allowance or charge is calculated.","$ref":"#/components/schemas/AmountTypeDto"},"multiplierFactorNumeric":{"type":["null","number"],"description":"Multiplier factor used to calculate the allowance or charge.","format":"double"}},"additionalProperties":false,"description":"Represents an allowance or charge applied to an invoice or invoice line."},"AmountTypeDto":{"type":"object","properties":{"amount":{"type":"number","description":"The balance amount.","format":"double"},"currencyId":{"type":["null","string"],"description":"The currency code (e.g. SEK)."}},"additionalProperties":false,"description":"Represents a monetary amount with an associated currency."},"TaxTotalInputDto":{"type":"object","properties":{"taxAmount":{"description":"Monetary amount of the total tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxIncludedIndicator":{"type":["null","boolean"],"description":"Indicates whether the tax is included in the line amounts."},"taxSubtotals":{"type":["null","array"],"items":{"description":"Represents a tax subtotal within a tax total.","$ref":"#/components/schemas/TaxSubtotalDto"},"description":"Collection of tax subtotals composing this tax total."}},"additionalProperties":false,"description":"Represents the total tax amount for an invoice or line."},"TaxSubtotalDto":{"type":"object","properties":{"taxableAmount":{"description":"Monetary amount subject to tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxAmount":{"description":"Monetary amount of the tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxCategory":{"description":"Tax category applied to this subtotal.","$ref":"#/components/schemas/TaxSubtotalTaxCategoryDto"}},"additionalProperties":false,"description":"Represents a tax subtotal within a tax total."},"TaxSubtotalTaxCategoryDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the tax category."},"percent":{"type":["null","number"],"description":"Tax rate percentage for this category.","format":"double"},"taxScheme":{"description":"Tax scheme associated with this tax category.","$ref":"#/components/schemas/TaxCategoryTaxSchemeDto"},"taxExemptionReason":{"type":["null","string"],"description":"Reason for tax exemption, if applicable."},"taxExemptionReasonCode":{"type":["null","string"],"description":"Code identifying the tax exemption reason."}},"additionalProperties":false,"description":"Represents the tax category details within a tax subtotal."},"TaxCategoryTaxSchemeDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the tax scheme."}},"additionalProperties":false,"description":"Represents the tax scheme associated with a tax category."},"TaxCategoryDto":{"type":"object","properties":{"percent":{"type":"number","description":"Tax rate percentage for this category.","format":"double"},"taxScheme":{"description":"Tax scheme that this category belongs to.","$ref":"#/components/schemas/TaxSchemeDto"},"id":{"type":["null","string"],"description":"Unique identifier for the tax category."}},"additionalProperties":false,"description":"Represents a tax category with its percentage rate and scheme."},"TaxSchemeDto":{"type":"object","properties":{"taxSchemeId":{"description":"Identifier of the tax scheme.","$ref":"#/components/schemas/IdentifierDto"}},"additionalProperties":false,"description":"Represents a tax scheme."},"WithholdingTaxTotalInputDto":{"type":"object","properties":{"taxAmount":{"description":"Monetary amount of the withholding tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxSubtotals":{"type":["null","array"],"items":{"description":"Represents a tax subtotal within a tax total.","$ref":"#/components/schemas/TaxSubtotalDto"},"description":"Collection of tax subtotals composing this withholding tax total."}},"additionalProperties":false,"description":"Represents the total withholding tax amount for an invoice."},"AdditionalDocumentReferenceDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the document reference."},"reference":{"type":["null","string"],"description":"Reference value of the additional document."}},"additionalProperties":false,"description":"Represents an additional document reference associated with an invoice."},"LegalMonetaryTotalDto":{"type":"object","properties":{"taxInclusiveAmount":{"description":"Total amount of the invoice (tax included). This amount does not change regardless of payment status.","$ref":"#/components/schemas/AmountTypeDto"},"prepaidAmount":{"description":"Advance payment deducted from the invoice (if the accounting system supports it).","$ref":"#/components/schemas/AmountTypeDto"},"payableRoundingAmount":{"description":"Rounding amount applied to the payable total (e.g. 499.95 rounded to 500 yields 0.05).","$ref":"#/components/schemas/AmountTypeDto"},"payableAmount":{"description":"Remaining amount to be paid, should equal the total balance amount.","$ref":"#/components/schemas/AmountTypeDto"},"lineExtensionAmount":{"description":"Sum of all invoice line extension amounts before tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxExclusiveAmount":{"description":"Total amount of the invoice excluding tax.","$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents the legal monetary totals of an invoice."},"PaymentStatusDto":{"type":"object","properties":{"status":{"enum":["UNPAID","PARTLY_PAID","FULLY_PAID"],"type":["null","string"],"description":"Current payment status."},"settlementDate":{"type":["null","string"],"description":"Date when the payment was settled."}},"additionalProperties":false,"description":"Represents the payment status of an invoice."},"SupplierInvoiceLineInputDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice line."},"type":{"type":["null","string"],"description":"Type classification of the invoice line."},"account":{"description":"Accounting account associated with this line.","$ref":"#/components/schemas/AccountingAccountInputDto"},"invoicedQuantity":{"description":"Quantity invoiced on this line.","$ref":"#/components/schemas/InvoicedQuantityDto"},"lineExtensionAmount":{"description":"Monetary amount for the line before tax.","$ref":"#/components/schemas/AmountTypeDto"},"item":{"description":"Item details for this invoice line.","$ref":"#/components/schemas/ItemInputDto"},"price":{"description":"Price details for this invoice line.","$ref":"#/components/schemas/PriceInputDto"},"delivery":{"description":"Delivery information for this invoice line.","$ref":"#/components/schemas/InvoiceLineDeliveryDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions for this line."},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or invoice line.","$ref":"#/components/schemas/AllowanceChargeInputDto"},"description":"Collection of allowances and charges on this line."},"subInvoiceLines":{"type":["null","array"],"items":{"description":"Represents a sub-line within an invoice line.","$ref":"#/components/schemas/SubInvoiceLineInputDto"},"description":"Collection of sub-lines within this invoice line."}},"additionalProperties":false,"description":"Represents a line item on a supplier invoice."},"AccountingAccountInputDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the accounting account."},"accountingAccountId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Input.AccountingAccountInputDto.Reference instead. (Deprecated: Use Reference instead.)","deprecated":true},"reference":{"type":["null","string"],"description":"Reference code for the accounting account."},"standardAccountingAccountId":{"type":["null","string"],"description":"Standard accounting account identifier (e.g. BAS account number)."},"name":{"type":["null","string"],"description":"Display name of the accounting account."},"active":{"type":["null","boolean"],"description":"Indicates whether the accounting account is active."},"postable":{"type":["null","boolean"],"description":"Indicates whether entries can be posted to this account."},"description":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Input.AccountingAccountInputDto.Descriptions instead. (Deprecated: Use Descriptions instead.)","deprecated":true,"$ref":"#/components/schemas/DescriptionDto"},"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the accounting account."},"accountingAccountTypeCode":{"description":"Type code classifying the accounting account.","$ref":"#/components/schemas/PriceTypeCodeDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions for the account."}},"additionalProperties":false,"description":"Represents input data for an accounting account."},"DescriptionDto":{"type":"object","properties":{"text":{"type":["null","string"],"description":"Content of the description."},"languageId":{"type":["null","string"],"description":"ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."}},"additionalProperties":false,"description":"Represents a description with an optional language identifier."},"PriceTypeCodeDto":{"type":"object","properties":{"code":{"type":["null","string"],"description":"Price type code value."},"listId":{"type":["null","string"],"description":"Identifier of the code list the code belongs to."}},"additionalProperties":false,"description":"Represents a price type classification code."},"InvoicedQuantityDto":{"type":"object","properties":{"quantity":{"type":["null","number"],"description":"Number of units invoiced.","format":"double"},"unitCode":{"type":["null","string"],"description":"Unit of measure code (e.g. EA, KG)."}},"additionalProperties":false,"description":"Represents an invoiced quantity with its unit of measure."},"ItemInputDto":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Name of the item."},"description":{"type":["null","string"],"description":"Description of the item."},"sellersItemIdentification":{"description":"Seller's identification of the item.","$ref":"#/components/schemas/SellersItemIdentificationDto"},"classifiedTaxCategories":{"type":["null","array"],"items":{"description":"Represents a tax category with its percentage rate and scheme.","$ref":"#/components/schemas/TaxCategoryDto"},"description":"Collection of tax categories classified for the item."}},"additionalProperties":false,"description":"Represents an item on an invoice line."},"SellersItemIdentificationDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the item assigned by the seller."},"extendedId":{"type":["null","string"],"description":"Extended identifier for the item assigned by the seller."}},"additionalProperties":false,"description":"Represents the seller's identification of an item."},"PriceInputDto":{"type":"object","properties":{"priceAmount":{"description":"Monetary amount of the unit price.","$ref":"#/components/schemas/AmountTypeDto"},"priceTypeCode":{"description":"Code classifying the type of price.","$ref":"#/components/schemas/PriceTypeCodeDto"},"baseQuantity":{"description":"Base quantity to which the price applies.","$ref":"#/components/schemas/InvoicedQuantityDto"},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or invoice line.","$ref":"#/components/schemas/AllowanceChargeInputDto"},"description":"Collection of allowances and charges applied to the price."}},"additionalProperties":false,"description":"Represents price details for an invoice line item."},"InvoiceLineDeliveryDto":{"type":"object","properties":{"actualDeliveryDate":{"type":["null","string"],"description":"Actual date of delivery for the invoice line."}},"additionalProperties":false,"description":"Represents delivery information at the invoice line level."},"SubInvoiceLineInputDto":{"type":"object","properties":{"invoicedQuantity":{"description":"Quantity invoiced on this sub-line.","$ref":"#/components/schemas/InvoicedQuantityDto"},"item":{"description":"Item details for this sub-line.","$ref":"#/components/schemas/ItemInputDto"}},"additionalProperties":false,"description":"Represents a sub-line within an invoice line."},"SupplierInvoiceDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier generated by the accounting system."},"reference":{"type":["null","string"],"description":"External reference or number assigned to the invoice."},"buyerReference":{"type":["null","string"],"description":"Reference for the buyer, usually the buyer's purchase order number."},"bookedInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is booked."},"cancelledInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is cancelled."},"issueDate":{"type":["null","string"],"description":"Date when the invoice was issued. Format: yyyy-MM-dd."},"issueTime":{"type":["null","string"],"description":"Time when the invoice was issued (null if not available)."},"dueDate":{"type":["null","string"],"description":"Date when the invoice payment is due. Format: yyyy-MM-dd."},"creditInvoice":{"description":"Credit invoice details, if the invoice is a credit invoice (null if not applicable).","$ref":"#/components/schemas/CreditInvoiceDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions associated with the invoice."},"notes":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of notes attached to the invoice."},"orderReference":{"description":"Order reference linked to the invoice (null if not available).","$ref":"#/components/schemas/OrderReferenceDto"},"documentCurrencyCode":{"description":"Currency code used for the invoice (null if not available).","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"accountingSupplierParty":{"description":"Supplier party on the invoice (null if not available).","$ref":"#/components/schemas/SupplierPartyDto"},"accountingCustomerParty":{"description":"Customer party on the invoice (null if not available).","$ref":"#/components/schemas/CustomerPartyDto"},"invoicePeriod":{"description":"Billing period covered by the invoice (null if not available).","$ref":"#/components/schemas/PeriodDto"},"delivery":{"description":"Delivery details associated with the invoice (null if not available).","$ref":"#/components/schemas/DeliveryDto"},"deliveryTerms":{"description":"Delivery terms for the invoice (null if not available).","$ref":"#/components/schemas/DeliveryTermsDto"},"paymentTerms":{"description":"Payment terms for the invoice (null if not available).","$ref":"#/components/schemas/PaymentTermsDto"},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents the payment means associated with an invoice.","$ref":"#/components/schemas/PaymentMeansDto"},"description":"Collection of payment means for the invoice."},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or line item.","$ref":"#/components/schemas/AllowanceChargeDto"},"description":"Collection of allowance and charge adjustments on the invoice."},"taxTotals":{"type":["null","array"],"items":{"description":"Represents the total tax amount for an invoice or line item.","$ref":"#/components/schemas/TaxTotalDto"},"description":"Collection of tax totals for the invoice."},"withholdingTaxTotals":{"type":["null","array"],"items":{"description":"Represents the total withholding tax amount for an invoice.","$ref":"#/components/schemas/WithholdingTaxTotalDto"},"description":"Collection of withholding tax totals for the invoice."},"totalBalanceAmount":{"description":"Remaining balance amount on the invoice. Differs from tax-inclusive amount if partly paid; zero if fully paid (null if not available).","$ref":"#/components/schemas/AmountTypeDto"},"additionalDocumentReferences":{"type":["null","array"],"items":{"description":"Represents an additional document reference associated with an invoice.","$ref":"#/components/schemas/AdditionalDocumentReferenceDto"},"description":"Collection of additional document references attached to the invoice."},"legalMonetaryTotal":{"description":"Legal monetary totals for the invoice (null if not available).","$ref":"#/components/schemas/LegalMonetaryTotalDto"},"paymentStatus":{"description":"Payment status of the invoice (null if not available).","$ref":"#/components/schemas/PaymentStatusDto"},"invoiceLines":{"type":["null","array"],"items":{"description":"Represents a single line item on a supplier invoice.","$ref":"#/components/schemas/SupplierInvoiceLineDto"},"description":"Collection of supplier invoice line items."},"sellerReference":{"type":["null","string"],"description":"External reference or number assigned by the seller (null if not available)."}},"additionalProperties":false,"description":"Represents a supplier (purchase) invoice with full detail."},"CreditInvoiceDto":{"type":"object","properties":{"creditInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is a credit invoice or credit note."},"creditInvoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a reference to a credited invoice document.","$ref":"#/components/schemas/CreditInvoiceDocumentReferenceDto"},"description":"Collection of document references to credited or credit invoices."}},"additionalProperties":false,"description":"Represents credit invoice details associated with an invoice."},"SupplierPartyDto":{"type":"object","properties":{"customerAssignedAccountId":{"description":"Account identifier assigned to the supplier by the customer.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details associated with the supplier.","$ref":"#/components/schemas/PartyDto"}},"additionalProperties":false,"description":"Represents the supplier party on an invoice."},"PartyDto":{"type":"object","properties":{"partyIdentification":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of identifiers for the party."},"partyName":{"description":"Name of the party.","$ref":"#/components/schemas/PartyNameDto"},"postalAddress":{"description":"Postal address of the party.","$ref":"#/components/schemas/AddressDto"},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"},"contact":{"description":"Contact details for the party.","$ref":"#/components/schemas/ContactDto"},"endpointId":{"description":"Electronic endpoint identifier for the party.","$ref":"#/components/schemas/IdentifierDto"}},"additionalProperties":false,"description":"Represents a party (organization or individual) involved in a transaction."},"CustomerPartyDto":{"type":"object","properties":{"supplierAssignedAccountId":{"description":"Account identifier assigned to the customer by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details associated with the customer.","$ref":"#/components/schemas/PartyDto"},"type":{"enum":["PrivatePerson","Company"],"type":["null","string"],"description":"Customer type classification."}},"additionalProperties":false,"description":"Represents the customer party on an invoice."},"PaymentTermsDto":{"type":"object","properties":{"paymentTermsId":{"description":"Unique identifier for the payment terms.","$ref":"#/components/schemas/IdentifierDto"},"notes":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of notes describing the payment terms."}},"additionalProperties":false,"description":"Represents payment terms associated with an invoice."},"PaymentMeansDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"paymentDueDate":{"type":["null","string"],"description":"Date the payment is due."},"paymentIds":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of payment identifiers."},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents the payment means associated with an invoice."},"FinancialAccountDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the financial account."},"financialInstitution":{"type":["null","string"],"description":"Name or identifier of the financial institution."}},"additionalProperties":false,"description":"Represents a financial account used for payments."},"AllowanceChargeDto":{"type":"object","properties":{"allowanceChargeId":{"description":"Unique identifier for the allowance or charge.","$ref":"#/components/schemas/IdentifierDto"},"chargeIndicator":{"type":"boolean","description":"Indicates whether this entry is a charge (true) or an allowance (false)."},"allowanceChargeReason":{"type":["null","string"],"description":"Reason for the allowance or charge."},"allowanceChargeAmount":{"description":"Monetary amount of the allowance or charge.","$ref":"#/components/schemas/AmountTypeDto"},"taxTotal":{"description":"Tax total associated with the allowance or charge.","$ref":"#/components/schemas/TaxTotalDto"},"taxCategory":{"description":"Tax category for the allowance or charge.","$ref":"#/components/schemas/TaxCategoryDto"},"allowanceChargeBaseAmount":{"description":"Monetary amount used as the base for calculating the allowance or charge.","$ref":"#/components/schemas/AmountTypeDto"},"multiplierFactorNumeric":{"type":["null","number"],"description":"Multiplier factor used to calculate the allowance or charge.","format":"double"}},"additionalProperties":false,"description":"Represents an allowance or charge applied to an invoice or line item."},"TaxTotalDto":{"type":"object","properties":{"taxAmount":{"description":"Monetary amount of the total tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxIncludedIndicator":{"type":["null","boolean"],"description":"Indicates whether the tax is included in the line amounts."},"taxSubtotals":{"type":["null","array"],"items":{"description":"Represents a tax subtotal within a tax total.","$ref":"#/components/schemas/TaxSubtotalDto"},"description":"Collection of tax subtotals broken down by category."}},"additionalProperties":false,"description":"Represents the total tax amount for an invoice or line item."},"WithholdingTaxTotalDto":{"type":"object","properties":{"taxAmount":{"description":"Monetary amount of the withholding tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxSubtotals":{"type":["null","array"],"items":{"description":"Represents a tax subtotal within a tax total.","$ref":"#/components/schemas/TaxSubtotalDto"},"description":"Collection of withholding tax subtotals broken down by category."}},"additionalProperties":false,"description":"Represents the total withholding tax amount for an invoice."},"SupplierInvoiceLineDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the supplier invoice line."},"type":{"type":["null","string"],"description":"Line type classification."},"account":{"description":"Accounting account associated with the line.","$ref":"#/components/schemas/AccountingAccountDto"},"invoicedQuantity":{"description":"Quantity invoiced for this line.","$ref":"#/components/schemas/InvoicedQuantityDto"},"lineExtensionAmount":{"description":"Monetary amount for the line before tax.","$ref":"#/components/schemas/AmountTypeDto"},"item":{"description":"Item details for the invoice line.","$ref":"#/components/schemas/ItemDto"},"price":{"description":"Price information for the invoiced item.","$ref":"#/components/schemas/PriceDto"},"delivery":{"description":"Delivery details for the invoice line.","$ref":"#/components/schemas/InvoiceLineDeliveryDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions for the line."},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or line item.","$ref":"#/components/schemas/AllowanceChargeDto"},"description":"Collection of allowances or charges applied to the line."},"subInvoiceLines":{"type":["null","array"],"items":{"description":"Represents a sub-line within an invoice line.","$ref":"#/components/schemas/SubInvoiceLineDto"},"description":"Collection of sub-lines within this invoice line."}},"additionalProperties":false,"description":"Represents a single line item on a supplier invoice."},"AccountingAccountDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier generated by the accounting system."},"accountingAccountId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.AccountingAccountDto.Reference instead. (Deprecated: Use Reference instead.)","deprecated":true},"reference":{"type":["null","string"],"description":"External reference or number assigned to the account."},"standardAccountingAccountId":{"type":["null","string"],"description":"Standard accounting account identifier used for classification."},"name":{"type":["null","string"],"description":"Display name of the accounting account."},"active":{"type":["null","boolean"],"description":"Indicates whether the account is active."},"postable":{"type":["null","boolean"],"description":"Indicates whether transactions can be posted to the account."},"description":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.AccountingAccountDto.Descriptions instead. (Deprecated: Use Descriptions instead.)","deprecated":true,"$ref":"#/components/schemas/DescriptionDto"},"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the accounting account."},"accountingAccountTypeCode":{"description":"Type code classifying the accounting account.","$ref":"#/components/schemas/PriceTypeCodeDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions associated with the account."}},"additionalProperties":false,"description":"Represents an accounting account in the chart of accounts."},"ItemDto":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Name of the item."},"description":{"type":["null","string"],"description":"Textual description of the item."},"sellersItemIdentification":{"description":"Seller's identification for the item.","$ref":"#/components/schemas/SellersItemIdentificationDto"},"classifiedTaxCategories":{"type":["null","array"],"items":{"description":"Represents a tax category with its percentage rate and scheme.","$ref":"#/components/schemas/TaxCategoryDto"},"description":"Collection of tax categories classified for the item."}},"additionalProperties":false,"description":"Represents an item referenced in an invoice line."},"PriceDto":{"type":"object","properties":{"priceAmount":{"description":"Monetary amount of the unit price.","$ref":"#/components/schemas/AmountTypeDto"},"priceTypeCode":{"description":"Code indicating the price type.","$ref":"#/components/schemas/PriceTypeCodeDto"},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or line item.","$ref":"#/components/schemas/AllowanceChargeDto"},"description":"Collection of allowances or charges applied to the price."},"baseQuantity":{"description":"Base quantity to which the price applies.","$ref":"#/components/schemas/InvoicedQuantityDto"}},"additionalProperties":false,"description":"Represents price information for an invoiced item."},"SubInvoiceLineDto":{"type":"object","properties":{"invoicedQuantity":{"description":"Quantity invoiced for this sub-line.","$ref":"#/components/schemas/InvoicedQuantityDto"},"item":{"description":"Item details for the sub-line.","$ref":"#/components/schemas/ItemDto"}},"additionalProperties":false,"description":"Represents a sub-line within an invoice line."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"ProviderRateLimitInformation":{"type":"object","properties":{"responseHeaders":{"type":["null","object"],"additionalProperties":{"type":"string"}}},"additionalProperties":false}}},"paths":{"/api/v1/consents/{consentId}/supplierinvoices":{"post":{"tags":["Supplier Invoices"],"summary":"Create a supplier invoice","description":"Creates a new supplier invoice in the connected accounting system.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | 📞 Not supported / contact us |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | 📞 Not supported / contact us |\n| Visma Netvisor | 📞 Not supported / contact us |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | 📞 Not supported / contact us |\n| Bokio | ✅ Supported |\n| Kleer | 📞 Not supported / contact us |\n| DATEV | 📞 Not supported / contact us |","operationId":"CreateSupplierInvoice","parameters":[{"name":"consentId","in":"path","description":"Identifier of the consent representing the connection to the accounting system.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"x-correlation-id","in":"header","description":"Unique identifier used to correlate and trace this request.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Supplier invoice entity.","content":{"application/json":{"schema":{"description":"Represents input data for a supplier invoice.","$ref":"#/components/schemas/SupplierInvoiceInputDto"}},"text/json":{"schema":{"description":"Represents input data for a supplier invoice.","$ref":"#/components/schemas/SupplierInvoiceInputDto"}},"application/*+json":{"schema":{"description":"Represents input data for a supplier invoice.","$ref":"#/components/schemas/SupplierInvoiceInputDto"}}}},"responses":{"201":{"description":"The supplier invoice was created. Response includes a Location header with the URL of the created resource.","headers":{"Location":{"description":"URL of the created resource.","schema":{"type":"string","format":"uri-reference"}}},"content":{"application/json":{"schema":{"description":"Represents a supplier (purchase) invoice with full detail.","$ref":"#/components/schemas/SupplierInvoiceDto"}}}},"401":{"description":"Missing or invalid authentication credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorized to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"The request was rate-limited. The response may include Retry-After and ErpError.responseHeaders with retry and quota information from the accounting system.","headers":{"Retry-After":{"description":"Delay in seconds or an HTTP date supplied by the accounting system. Wait until this interval has elapsed before retrying. Optional; availability depends on the integration.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"ErpError":{"$ref":"#/components/schemas/ProviderRateLimitInformation"}}}]}}}},"501":{"description":"This operation is not supported by the connected accounting system.","content":{"application/json":{}}}}}}}}
```
## Get a supplier invoice by ID
> Retrieves a single supplier invoice by its identifier.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \ Fortnox | ✅ Supported |\
> \| \ Bjorn Lunden | ✅ Supported |\
> \| \ Spiris | ✅ Supported |\
> \| \ Tripletex | 📞 Not supported / contact us |\
> \| \ Visma e-conomic | 📞 Not supported / contact us |\
> \| \ Billy | ✅ Supported |\
> \| \ Visma Dinero | 📞 Not supported / contact us |\
> \| \ Procountor | ✅ Supported |\
> \| \ Visma Netvisor | ✅ Supported |\
> \| \ Microsoft Business Central | ✅ Supported |\
> \| \ Exact Online | 📞 Not supported / contact us |\
> \| \ QuickBooks | 📞 Not supported / contact us |\
> \| \ Xero | ✅ Supported |\
> \| \ Bokio | ✅ Supported |\
> \| \ Kleer | ✅ Supported |\
> \| \ DATEV | 📞 Not supported / contact us |
```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices","description":"Create and retrieve supplier (purchase) invoices for a given consent."}],"servers":[{"url":"https://apione.zwapgrid.com/accounting"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Use the API key to access all API endpoints.","name":"x-api-key","in":"header"}},"schemas":{"SupplierInvoiceDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier generated by the accounting system."},"reference":{"type":["null","string"],"description":"External reference or number assigned to the invoice."},"buyerReference":{"type":["null","string"],"description":"Reference for the buyer, usually the buyer's purchase order number."},"bookedInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is booked."},"cancelledInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is cancelled."},"issueDate":{"type":["null","string"],"description":"Date when the invoice was issued. Format: yyyy-MM-dd."},"issueTime":{"type":["null","string"],"description":"Time when the invoice was issued (null if not available)."},"dueDate":{"type":["null","string"],"description":"Date when the invoice payment is due. Format: yyyy-MM-dd."},"creditInvoice":{"description":"Credit invoice details, if the invoice is a credit invoice (null if not applicable).","$ref":"#/components/schemas/CreditInvoiceDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions associated with the invoice."},"notes":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of notes attached to the invoice."},"orderReference":{"description":"Order reference linked to the invoice (null if not available).","$ref":"#/components/schemas/OrderReferenceDto"},"documentCurrencyCode":{"description":"Currency code used for the invoice (null if not available).","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"accountingSupplierParty":{"description":"Supplier party on the invoice (null if not available).","$ref":"#/components/schemas/SupplierPartyDto"},"accountingCustomerParty":{"description":"Customer party on the invoice (null if not available).","$ref":"#/components/schemas/CustomerPartyDto"},"invoicePeriod":{"description":"Billing period covered by the invoice (null if not available).","$ref":"#/components/schemas/PeriodDto"},"delivery":{"description":"Delivery details associated with the invoice (null if not available).","$ref":"#/components/schemas/DeliveryDto"},"deliveryTerms":{"description":"Delivery terms for the invoice (null if not available).","$ref":"#/components/schemas/DeliveryTermsDto"},"paymentTerms":{"description":"Payment terms for the invoice (null if not available).","$ref":"#/components/schemas/PaymentTermsDto"},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents the payment means associated with an invoice.","$ref":"#/components/schemas/PaymentMeansDto"},"description":"Collection of payment means for the invoice."},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or line item.","$ref":"#/components/schemas/AllowanceChargeDto"},"description":"Collection of allowance and charge adjustments on the invoice."},"taxTotals":{"type":["null","array"],"items":{"description":"Represents the total tax amount for an invoice or line item.","$ref":"#/components/schemas/TaxTotalDto"},"description":"Collection of tax totals for the invoice."},"withholdingTaxTotals":{"type":["null","array"],"items":{"description":"Represents the total withholding tax amount for an invoice.","$ref":"#/components/schemas/WithholdingTaxTotalDto"},"description":"Collection of withholding tax totals for the invoice."},"totalBalanceAmount":{"description":"Remaining balance amount on the invoice. Differs from tax-inclusive amount if partly paid; zero if fully paid (null if not available).","$ref":"#/components/schemas/AmountTypeDto"},"additionalDocumentReferences":{"type":["null","array"],"items":{"description":"Represents an additional document reference associated with an invoice.","$ref":"#/components/schemas/AdditionalDocumentReferenceDto"},"description":"Collection of additional document references attached to the invoice."},"legalMonetaryTotal":{"description":"Legal monetary totals for the invoice (null if not available).","$ref":"#/components/schemas/LegalMonetaryTotalDto"},"paymentStatus":{"description":"Payment status of the invoice (null if not available).","$ref":"#/components/schemas/PaymentStatusDto"},"invoiceLines":{"type":["null","array"],"items":{"description":"Represents a single line item on a supplier invoice.","$ref":"#/components/schemas/SupplierInvoiceLineDto"},"description":"Collection of supplier invoice line items."},"sellerReference":{"type":["null","string"],"description":"External reference or number assigned by the seller (null if not available)."}},"additionalProperties":false,"description":"Represents a supplier (purchase) invoice with full detail."},"CreditInvoiceDto":{"type":"object","properties":{"creditInvoiceIndicator":{"type":["null","boolean"],"description":"Indicates whether the invoice is a credit invoice or credit note."},"creditInvoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a reference to a credited invoice document.","$ref":"#/components/schemas/CreditInvoiceDocumentReferenceDto"},"description":"Collection of document references to credited or credit invoices."}},"additionalProperties":false,"description":"Represents credit invoice details associated with an invoice."},"CreditInvoiceDocumentReferenceDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the document reference."},"reference":{"type":["null","string"],"description":"Reference number of the credited invoice."},"documentType":{"enum":["Invoice","CreditInvoice"],"type":["null","string"],"description":"Type of the referenced document."}},"additionalProperties":false,"description":"Represents a reference to a credited invoice document."},"FinancialDimensionDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the financial dimension."},"reference":{"type":["null","string"],"description":"Reference code for the financial dimension."},"type":{"type":["null","string"],"description":"Type or code of the financial dimension as exposed by the connected accounting system.\n\nKnown values currently emitted by supported connectors include:\n\n- businessGroup\n- campaign\n- costBearer\n- costCode\n- costUnit\n- customerGroup\n- department\n- employee\n- product\n- project\n- purchaser\n- salesPerson\n- salesRegion\n- supplierGroup\n\nSome connectors can also return additional system-specific dimension codes (for example custom Business Central dimension codes)."},"name":{"type":["null","string"],"description":"Display name of the financial dimension."},"description":{"type":["null","string"],"description":"Description of the financial dimension."},"isActive":{"type":["null","boolean"],"description":"Indicates whether the financial dimension is active."}},"additionalProperties":false,"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project)."},"NoteDto":{"type":"object","properties":{"text":{"type":["null","string"],"description":"Content of the note."},"languageId":{"type":["null","string"],"description":"ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."}},"additionalProperties":false,"description":"Represents a textual note with an optional language identifier."},"OrderReferenceDto":{"type":"object","properties":{"buyerOrderId":{"type":["null","string"],"description":"Order number of the buyer (generated by the customer's system)."},"sellerOrderId":{"type":["null","string"],"description":"Order number of the seller (generated by the seller's system)."}},"additionalProperties":false,"description":"Represents a reference to the order from which the invoice originates."},"DocumentCurrencyCodeDto":{"type":"object","properties":{"currency":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Common.DocumentCurrencyCodeDto.CurrencyId instead. Currency code of the document (e.g. SEK, EUR). (Deprecated: Use CurrencyId instead)","deprecated":true},"currencyId":{"type":["null","string"],"description":"Currency code of the document (e.g. SEK, EUR)."},"currencyRate":{"type":["null","number"],"description":"Exchange rate applied to the document currency.","format":"double"}},"additionalProperties":false,"description":"Represents the document currency and its exchange rate."},"SupplierPartyDto":{"type":"object","properties":{"customerAssignedAccountId":{"description":"Account identifier assigned to the supplier by the customer.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details associated with the supplier.","$ref":"#/components/schemas/PartyDto"}},"additionalProperties":false,"description":"Represents the supplier party on an invoice."},"IdentifierDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Legal identifier."},"schemeId":{"type":["null","string"],"description":"Legal identifier scheme (e.g. SE:ORGNR)."}},"additionalProperties":false,"description":"Represents a legal identifier with an associated scheme."},"PartyDto":{"type":"object","properties":{"partyIdentification":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of identifiers for the party."},"partyName":{"description":"Name of the party.","$ref":"#/components/schemas/PartyNameDto"},"postalAddress":{"description":"Postal address of the party.","$ref":"#/components/schemas/AddressDto"},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"},"contact":{"description":"Contact details for the party.","$ref":"#/components/schemas/ContactDto"},"endpointId":{"description":"Electronic endpoint identifier for the party.","$ref":"#/components/schemas/IdentifierDto"}},"additionalProperties":false,"description":"Represents a party (organization or individual) involved in a transaction."},"PartyNameDto":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Name of the party."},"languageId":{"type":["null","string"],"description":"ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."}},"additionalProperties":false,"description":"Represents the name of a party with an optional language identifier."},"AddressDto":{"type":"object","properties":{"buildingNumber":{"type":["null","string"],"description":"Building number of the address."},"streetName":{"type":["null","string"],"description":"Primary street name."},"additionalStreetName":{"type":["null","string"],"description":"Secondary street name or additional address line."},"cityName":{"type":["null","string"],"description":"City or locality name."},"postalZone":{"type":["null","string"],"description":"Postal or ZIP code."},"country":{"description":"Country associated with the address.","$ref":"#/components/schemas/CountryDto"}},"additionalProperties":false,"description":"Represents a postal address."},"CountryDto":{"type":"object","properties":{"identificationCode":{"type":["null","string"],"description":"ISO 3166-1 alpha-2 country code."},"name":{"type":["null","string"],"description":"Country name."}},"additionalProperties":false,"description":"Represents a country with its identification code and name."},"PartyLegalEntityDto":{"type":"object","properties":{"registrationName":{"type":["null","string"],"description":"Registered legal name of the entity."},"companyId":{"description":"Company identifier (e.g. organization number).","$ref":"#/components/schemas/IdentifierDto"}},"additionalProperties":false,"description":"Represents the legal entity information of a party."},"ContactDto":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Contact person name."},"telephone":{"type":["null","string"],"description":"Primary telephone number."},"email":{"type":["null","string"],"description":"Primary email address."},"secondaryEmail":{"type":["null","string"],"description":"Secondary email address."}},"additionalProperties":false,"description":"Represents contact information for a party."},"CustomerPartyDto":{"type":"object","properties":{"supplierAssignedAccountId":{"description":"Account identifier assigned to the customer by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details associated with the customer.","$ref":"#/components/schemas/PartyDto"},"type":{"enum":["PrivatePerson","Company"],"type":["null","string"],"description":"Customer type classification."}},"additionalProperties":false,"description":"Represents the customer party on an invoice."},"PeriodDto":{"type":"object","properties":{"startDate":{"type":["null","string"],"description":"Start date of the period."},"endDate":{"type":["null","string"],"description":"End date of the period."}},"additionalProperties":false,"description":"Represents a date period defined by a start and end date."},"DeliveryDto":{"type":"object","properties":{"deliveryParty":{"description":"Party receiving the delivery.","$ref":"#/components/schemas/DeliveryPartyDto"},"carrierParty":{"description":"Party responsible for carrying out the delivery.","$ref":"#/components/schemas/DeliveryPartyDto"},"actualDeliveryDate":{"type":["null","string"],"description":"Actual date of delivery."},"trackingId":{"type":["null","string"],"description":"Tracking identifier for the delivery shipment."},"deliveryAddress":{"description":"Address where the delivery is made.","$ref":"#/components/schemas/AddressDto"}},"additionalProperties":false,"description":"Represents delivery information for an invoice."},"DeliveryPartyDto":{"type":"object","properties":{"partyIdentification":{"description":"Identifier of the delivery party.","$ref":"#/components/schemas/IdentifierDto"},"partyName":{"description":"Name of the delivery party.","$ref":"#/components/schemas/PartyNameDto"}},"additionalProperties":false,"description":"Represents a party involved in a delivery."},"DeliveryTermsDto":{"type":"object","properties":{"deliveryTermsId":{"description":"Identifier of the delivery terms (e.g. Incoterms code).","$ref":"#/components/schemas/IdentifierDto"},"specialTerms":{"description":"Special delivery terms described as a note.","$ref":"#/components/schemas/NoteDto"}},"additionalProperties":false,"description":"Represents delivery terms associated with an invoice."},"PaymentTermsDto":{"type":"object","properties":{"paymentTermsId":{"description":"Unique identifier for the payment terms.","$ref":"#/components/schemas/IdentifierDto"},"notes":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of notes describing the payment terms."}},"additionalProperties":false,"description":"Represents payment terms associated with an invoice."},"PaymentMeansDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"paymentDueDate":{"type":["null","string"],"description":"Date the payment is due."},"paymentIds":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of payment identifiers."},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents the payment means associated with an invoice."},"FinancialAccountDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the financial account."},"financialInstitution":{"type":["null","string"],"description":"Name or identifier of the financial institution."}},"additionalProperties":false,"description":"Represents a financial account used for payments."},"AllowanceChargeDto":{"type":"object","properties":{"allowanceChargeId":{"description":"Unique identifier for the allowance or charge.","$ref":"#/components/schemas/IdentifierDto"},"chargeIndicator":{"type":"boolean","description":"Indicates whether this entry is a charge (true) or an allowance (false)."},"allowanceChargeReason":{"type":["null","string"],"description":"Reason for the allowance or charge."},"allowanceChargeAmount":{"description":"Monetary amount of the allowance or charge.","$ref":"#/components/schemas/AmountTypeDto"},"taxTotal":{"description":"Tax total associated with the allowance or charge.","$ref":"#/components/schemas/TaxTotalDto"},"taxCategory":{"description":"Tax category for the allowance or charge.","$ref":"#/components/schemas/TaxCategoryDto"},"allowanceChargeBaseAmount":{"description":"Monetary amount used as the base for calculating the allowance or charge.","$ref":"#/components/schemas/AmountTypeDto"},"multiplierFactorNumeric":{"type":["null","number"],"description":"Multiplier factor used to calculate the allowance or charge.","format":"double"}},"additionalProperties":false,"description":"Represents an allowance or charge applied to an invoice or line item."},"AmountTypeDto":{"type":"object","properties":{"amount":{"type":"number","description":"The balance amount.","format":"double"},"currencyId":{"type":["null","string"],"description":"The currency code (e.g. SEK)."}},"additionalProperties":false,"description":"Represents a monetary amount with an associated currency."},"TaxTotalDto":{"type":"object","properties":{"taxAmount":{"description":"Monetary amount of the total tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxIncludedIndicator":{"type":["null","boolean"],"description":"Indicates whether the tax is included in the line amounts."},"taxSubtotals":{"type":["null","array"],"items":{"description":"Represents a tax subtotal within a tax total.","$ref":"#/components/schemas/TaxSubtotalDto"},"description":"Collection of tax subtotals broken down by category."}},"additionalProperties":false,"description":"Represents the total tax amount for an invoice or line item."},"TaxSubtotalDto":{"type":"object","properties":{"taxableAmount":{"description":"Monetary amount subject to tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxAmount":{"description":"Monetary amount of the tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxCategory":{"description":"Tax category applied to this subtotal.","$ref":"#/components/schemas/TaxSubtotalTaxCategoryDto"}},"additionalProperties":false,"description":"Represents a tax subtotal within a tax total."},"TaxSubtotalTaxCategoryDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the tax category."},"percent":{"type":["null","number"],"description":"Tax rate percentage for this category.","format":"double"},"taxScheme":{"description":"Tax scheme associated with this tax category.","$ref":"#/components/schemas/TaxCategoryTaxSchemeDto"},"taxExemptionReason":{"type":["null","string"],"description":"Reason for tax exemption, if applicable."},"taxExemptionReasonCode":{"type":["null","string"],"description":"Code identifying the tax exemption reason."}},"additionalProperties":false,"description":"Represents the tax category details within a tax subtotal."},"TaxCategoryTaxSchemeDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the tax scheme."}},"additionalProperties":false,"description":"Represents the tax scheme associated with a tax category."},"TaxCategoryDto":{"type":"object","properties":{"percent":{"type":"number","description":"Tax rate percentage for this category.","format":"double"},"taxScheme":{"description":"Tax scheme that this category belongs to.","$ref":"#/components/schemas/TaxSchemeDto"},"id":{"type":["null","string"],"description":"Unique identifier for the tax category."}},"additionalProperties":false,"description":"Represents a tax category with its percentage rate and scheme."},"TaxSchemeDto":{"type":"object","properties":{"taxSchemeId":{"description":"Identifier of the tax scheme.","$ref":"#/components/schemas/IdentifierDto"}},"additionalProperties":false,"description":"Represents a tax scheme."},"WithholdingTaxTotalDto":{"type":"object","properties":{"taxAmount":{"description":"Monetary amount of the withholding tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxSubtotals":{"type":["null","array"],"items":{"description":"Represents a tax subtotal within a tax total.","$ref":"#/components/schemas/TaxSubtotalDto"},"description":"Collection of withholding tax subtotals broken down by category."}},"additionalProperties":false,"description":"Represents the total withholding tax amount for an invoice."},"AdditionalDocumentReferenceDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the document reference."},"reference":{"type":["null","string"],"description":"Reference value of the additional document."}},"additionalProperties":false,"description":"Represents an additional document reference associated with an invoice."},"LegalMonetaryTotalDto":{"type":"object","properties":{"taxInclusiveAmount":{"description":"Total amount of the invoice (tax included). This amount does not change regardless of payment status.","$ref":"#/components/schemas/AmountTypeDto"},"prepaidAmount":{"description":"Advance payment deducted from the invoice (if the accounting system supports it).","$ref":"#/components/schemas/AmountTypeDto"},"payableRoundingAmount":{"description":"Rounding amount applied to the payable total (e.g. 499.95 rounded to 500 yields 0.05).","$ref":"#/components/schemas/AmountTypeDto"},"payableAmount":{"description":"Remaining amount to be paid, should equal the total balance amount.","$ref":"#/components/schemas/AmountTypeDto"},"lineExtensionAmount":{"description":"Sum of all invoice line extension amounts before tax.","$ref":"#/components/schemas/AmountTypeDto"},"taxExclusiveAmount":{"description":"Total amount of the invoice excluding tax.","$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents the legal monetary totals of an invoice."},"PaymentStatusDto":{"type":"object","properties":{"status":{"enum":["UNPAID","PARTLY_PAID","FULLY_PAID"],"type":["null","string"],"description":"Current payment status."},"settlementDate":{"type":["null","string"],"description":"Date when the payment was settled."}},"additionalProperties":false,"description":"Represents the payment status of an invoice."},"SupplierInvoiceLineDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the supplier invoice line."},"type":{"type":["null","string"],"description":"Line type classification."},"account":{"description":"Accounting account associated with the line.","$ref":"#/components/schemas/AccountingAccountDto"},"invoicedQuantity":{"description":"Quantity invoiced for this line.","$ref":"#/components/schemas/InvoicedQuantityDto"},"lineExtensionAmount":{"description":"Monetary amount for the line before tax.","$ref":"#/components/schemas/AmountTypeDto"},"item":{"description":"Item details for the invoice line.","$ref":"#/components/schemas/ItemDto"},"price":{"description":"Price information for the invoiced item.","$ref":"#/components/schemas/PriceDto"},"delivery":{"description":"Delivery details for the invoice line.","$ref":"#/components/schemas/InvoiceLineDeliveryDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions for the line."},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or line item.","$ref":"#/components/schemas/AllowanceChargeDto"},"description":"Collection of allowances or charges applied to the line."},"subInvoiceLines":{"type":["null","array"],"items":{"description":"Represents a sub-line within an invoice line.","$ref":"#/components/schemas/SubInvoiceLineDto"},"description":"Collection of sub-lines within this invoice line."}},"additionalProperties":false,"description":"Represents a single line item on a supplier invoice."},"AccountingAccountDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier generated by the accounting system."},"accountingAccountId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.AccountingAccountDto.Reference instead. (Deprecated: Use Reference instead.)","deprecated":true},"reference":{"type":["null","string"],"description":"External reference or number assigned to the account."},"standardAccountingAccountId":{"type":["null","string"],"description":"Standard accounting account identifier used for classification."},"name":{"type":["null","string"],"description":"Display name of the accounting account."},"active":{"type":["null","boolean"],"description":"Indicates whether the account is active."},"postable":{"type":["null","boolean"],"description":"Indicates whether transactions can be posted to the account."},"description":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.AccountingAccountDto.Descriptions instead. (Deprecated: Use Descriptions instead.)","deprecated":true,"$ref":"#/components/schemas/DescriptionDto"},"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the accounting account."},"accountingAccountTypeCode":{"description":"Type code classifying the accounting account.","$ref":"#/components/schemas/PriceTypeCodeDto"},"financialDimensions":{"type":["null","array"],"items":{"description":"Represents a financial dimension used to assign granularity to financial reports (e.g. cost center, project).","$ref":"#/components/schemas/FinancialDimensionDto"},"description":"Collection of financial dimensions associated with the account."}},"additionalProperties":false,"description":"Represents an accounting account in the chart of accounts."},"DescriptionDto":{"type":"object","properties":{"text":{"type":["null","string"],"description":"Content of the description."},"languageId":{"type":["null","string"],"description":"ISO 639-2 three-letter language code for the associated text, for example `ENG`, `SWE`, `DAN`, or `FIN`. Omit this value when the source system does not provide a language."}},"additionalProperties":false,"description":"Represents a description with an optional language identifier."},"PriceTypeCodeDto":{"type":"object","properties":{"code":{"type":["null","string"],"description":"Price type code value."},"listId":{"type":["null","string"],"description":"Identifier of the code list the code belongs to."}},"additionalProperties":false,"description":"Represents a price type classification code."},"InvoicedQuantityDto":{"type":"object","properties":{"quantity":{"type":["null","number"],"description":"Number of units invoiced.","format":"double"},"unitCode":{"type":["null","string"],"description":"Unit of measure code (e.g. EA, KG)."}},"additionalProperties":false,"description":"Represents an invoiced quantity with its unit of measure."},"ItemDto":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Name of the item."},"description":{"type":["null","string"],"description":"Textual description of the item."},"sellersItemIdentification":{"description":"Seller's identification for the item.","$ref":"#/components/schemas/SellersItemIdentificationDto"},"classifiedTaxCategories":{"type":["null","array"],"items":{"description":"Represents a tax category with its percentage rate and scheme.","$ref":"#/components/schemas/TaxCategoryDto"},"description":"Collection of tax categories classified for the item."}},"additionalProperties":false,"description":"Represents an item referenced in an invoice line."},"SellersItemIdentificationDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the item assigned by the seller."},"extendedId":{"type":["null","string"],"description":"Extended identifier for the item assigned by the seller."}},"additionalProperties":false,"description":"Represents the seller's identification of an item."},"PriceDto":{"type":"object","properties":{"priceAmount":{"description":"Monetary amount of the unit price.","$ref":"#/components/schemas/AmountTypeDto"},"priceTypeCode":{"description":"Code indicating the price type.","$ref":"#/components/schemas/PriceTypeCodeDto"},"allowanceCharges":{"type":["null","array"],"items":{"description":"Represents an allowance or charge applied to an invoice or line item.","$ref":"#/components/schemas/AllowanceChargeDto"},"description":"Collection of allowances or charges applied to the price."},"baseQuantity":{"description":"Base quantity to which the price applies.","$ref":"#/components/schemas/InvoicedQuantityDto"}},"additionalProperties":false,"description":"Represents price information for an invoiced item."},"InvoiceLineDeliveryDto":{"type":"object","properties":{"actualDeliveryDate":{"type":["null","string"],"description":"Actual date of delivery for the invoice line."}},"additionalProperties":false,"description":"Represents delivery information at the invoice line level."},"SubInvoiceLineDto":{"type":"object","properties":{"invoicedQuantity":{"description":"Quantity invoiced for this sub-line.","$ref":"#/components/schemas/InvoicedQuantityDto"},"item":{"description":"Item details for the sub-line.","$ref":"#/components/schemas/ItemDto"}},"additionalProperties":false,"description":"Represents a sub-line within an invoice line."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"ProviderRateLimitInformation":{"type":"object","properties":{"responseHeaders":{"type":["null","object"],"additionalProperties":{"type":"string"}}},"additionalProperties":false}}},"paths":{"/api/v1/consents/{consentId}/supplierinvoices/{supplierInvoiceId}":{"get":{"tags":["Supplier Invoices"],"summary":"Get a supplier invoice by ID","description":"Retrieves a single supplier invoice by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| Fortnox | ✅ Supported |\n| Bjorn Lunden | ✅ Supported |\n| Spiris | ✅ Supported |\n| Tripletex | 📞 Not supported / contact us |\n| Visma e-conomic | 📞 Not supported / contact us |\n| Billy | ✅ Supported |\n| Visma Dinero | 📞 Not supported / contact us |\n| Procountor | ✅ Supported |\n| Visma Netvisor | ✅ Supported |\n| Microsoft Business Central | ✅ Supported |\n| Exact Online | 📞 Not supported / contact us |\n| QuickBooks | 📞 Not supported / contact us |\n| Xero | ✅ Supported |\n| Bokio | ✅ Supported |\n| Kleer | ✅ Supported |\n| DATEV | 📞 Not supported / contact us |","operationId":"GetSupplierInvoice","parameters":[{"name":"consentId","in":"path","description":"Identifier of the consent representing the connection to the accounting system.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"x-correlation-id","in":"header","description":"Unique identifier used to correlate and trace this request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Include","in":"query","description":"Comma-separated list of optional data to include in the response.\n \nAvailable values:\n1. `paymentStatus` — Include the payment status.","schema":{"type":"string"}},{"name":"supplierInvoiceId","in":"path","description":"Identifier of the supplier invoice.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the requested supplier invoice.","content":{"application/json":{"schema":{"description":"Represents a supplier (purchase) invoice with full detail.","$ref":"#/components/schemas/SupplierInvoiceDto"}}}},"401":{"description":"Missing or invalid authentication credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorized to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The requested supplier invoice was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"The request was rate-limited. The response may include Retry-After and ErpError.responseHeaders with retry and quota information from the accounting system.","headers":{"Retry-After":{"description":"Delay in seconds or an HTTP date supplied by the accounting system. Wait until this interval has elapsed before retrying. Optional; availability depends on the integration.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"ErpError":{"$ref":"#/components/schemas/ProviderRateLimitInformation"}}}]}}}},"501":{"description":"This operation is not supported by the connected accounting system.","content":{"application/json":{}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.zwapgrid.com/api-guide/accounting-api-guide/supplier-invoices.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.