> This is part 1 of 2 of the full documentation (pages 1–100 of 172).
> The content is paginated: fetch every part to see all of it.
> Next part: https://docs.zwapgrid.com/llms-full.txt/1
> Page index: https://docs.zwapgrid.com/llms.txt

# 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
This site has an agentic ask interface you may use to query the documentation dynamically 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/index.md?ask=<question>&goal=<user_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.

---

# Overview

Zwapgrid makes getting Your Customer's data simple and secure. Ditch the endless integrations. Just connect once, invite Your Customer, and seamlessly access the data you need.

Zwapgrid is a platform for accessing Your Customer's accounting data through one integration.

**New to Zwapgrid?** Start here: (1) Overview (this page), (2) [Terminology](/key-concepts/terminology), (3) [How the platform works](/get-started/how-the-platform-works), (4) [Get Started overview](/get-started/get-started), (5) [Onboard Your Customer](/get-started/onboard-your-customer), (6) [Access Your Customer Data](/get-started/access-your-customer-data).

It combines a unified API, a consent-driven onboarding flow, and a file ingestion service. You ship your product. We handle the system-by-system complexity behind the scenes.

### What is API.1?

API.1 is the single connection point for reading data from many accounting systems.

You integrate once. Your Customer connects their system during onboarding. You then fetch data in a consistent format.

### Why Zwapgrid + API.1 works well

* **One integration, many systems.** Avoid building and maintaining one-off connectors.
* **Unified schema.** API.1 normalizes system differences into one data model.
* **Less operational burden.** We handle auth flows, token refresh, and connector upkeep.
* **Customer-friendly onboarding.** Customers grant access in a guided, branded flow.
* **API-first with a file fallback.** If there is no API, use [File.1](/file-1/file-1) for uploads and parsing.
* **Built for controlled access.** Data access is consent-based and auditable by design.
* **Security-focused defaults.** See [API Security](/security/api-security) for specifics.

### What you get (building blocks)

* **Consent API** to create and manage customer consent.
* **Onboarding Flow** for Your Customer to connect their Accounting System.
* **Accounting API** to fetch normalized data after consent is granted.
* **File.1** – Use when there is no API for the system or you need to ingest files (e.g. PDF invoices). See [File.1 overview](/file-1/file-1).
* **Proxy.1** – Use when you need to call the underlying accounting system's API directly through Zwapgrid (same auth, normalized base URL). See [Proxy.1 overview](/proxy.1/proxy.1).
* **Client Portal** to manage environments and API keys.

<figure><img src="https://2802285108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQCvVWgo58AdpQJMipzpD%2Fuploads%2FESx11Y3EckJ3D08lLbnF%2Fflow.1.png?alt=media&amp;token=1a61edbf-e689-4dff-bd9b-f061b377760d" alt=""><figcaption><p>End-to-end flow: consent, onboarding, and data access.</p></figcaption></figure>

### End-to-end flow

1. Create a consent in the Consent API.
2. Invite Your Customer to the Onboarding Flow.
3. Your Customer connects their accounting system (or uploads files).
4. Poll the Accounting API to retrieve Your Customer’s data.

For the practical steps, start here:

* [Get Started overview](/get-started/get-started)
* [Onboard Your Customer](/get-started/onboard-your-customer)
* [Access Your Customer Data](/get-started/access-your-customer-data)

### Technical model (at a glance)

API.1 is split into two APIs:

* **Consent API** for consent lifecycle and status.
* **Accounting API** for reading data from connected systems.

Use the **Consent API** to create consents and generate One-Time Codes; use the **Accounting API** (with that Consent ID in the path) to read invoices, company information, and other accounting data.

Operationally, API.1 is designed for polling-based data retrieval. It also supports traceability via correlation IDs.

Next reads:

* [API.1 overview](/api.1/api.1)
* [API Keys](/client-portal/api-keys)


# Systems in the grid

These systems and functionality are available through the API.1.

Need another system?

Missing any systems? Get in touch at <hello@zwapgrid.com>.

#### Legend

* ✅ = Supported
* ⚠️ = Supported (deprecated)
* 📞 = Not supported / contact us
* 🔧 = Not currently available / contact us about support
* 🚫 = Won't be supported (product/deprecation decision)
* ⛔ = Can't be supported (system/API limitation)

#### Accounting API functionality

| Endpoint                                                                                                            | What it does                                              | Fortnox | Bjorn Lunden | Spiris | Tripletex | Visma e-conomic | Billy | Visma Dinero | Procountor | Visma Netvisor | Microsoft Business Central | Exact Online | QuickBooks | Xero | Bokio | Kleer         | DATEV |
| ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------- | ------------ | ------ | --------- | --------------- | ----- | ------------ | ---------- | -------------- | -------------------------- | ------------ | ---------- | ---- | ----- | ------------- | ----- |
| [GET /accountingaccounts](https://apidocs.zwapgrid.com/accounting-api)                                              | List chart of accounts (accounting accounts).             | ✅       | 📞           | ✅      | 📞        | ✅               | ✅     | ✅            | 📞         | ✅              | ✅                          | ✅            | ✅          | ✅    | 📞    | ✅             | 🔧    |
| [GET /accountingperiods](https://apidocs.zwapgrid.com/accounting-api)                                               | List accounting periods / fiscal years.                   | ✅       | 📞           | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | ✅              | 📞                         | ✅            | 📞         | ✅    | 📞    | ✅             | ✅     |
| [GET /balancesheet](https://apidocs.zwapgrid.com/accounting-api)                                                    | Retrieve balance sheet report.                            | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | ✅              | 📞                         | 📞           | 📞         | 📞   | 📞    | 📞            | 🔧    |
| [GET /companyinformation](https://apidocs.zwapgrid.com/accounting-api)                                              | Retrieve company information.                             | ✅       | ✅            | ✅      | ✅         | 📞              | ✅     | ✅            | 📞         | 📞             | ✅                          | ✅            | ✅          | ✅    | 📞    | ✅             | 🔧    |
| [GET /customers](https://apidocs.zwapgrid.com/accounting-api)                                                       | List customers.                                           | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | 📞             | 📞                         | ✅            | ✅          | ✅    | 📞    | ✅             | 📞    |
| [GET /customers/{customerId}](https://apidocs.zwapgrid.com/accounting-api)                                          | Get a customer by ID.                                     | ✅       | 📞           | 📞     | 📞        | ✅               | ✅     | ✅            | ✅          | 📞             | 📞                         | ✅            | ✅          | ✅    | 📞    | ✅             | 📞    |
| [GET /financialdimensions](https://apidocs.zwapgrid.com/accounting-api)                                             | List financial dimensions (cost centers, projects, etc.). | ✅       | ✅            | ✅      | 📞        | 📞              | 📞    | 📞           | 📞         | 📞             | ✅                          | 📞           | 📞         | ✅    | 📞    | ✅             | 📞    |
| [GET /incomestatement](https://apidocs.zwapgrid.com/accounting-api)                                                 | Retrieve income statement (profit & loss).                | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | ✅              | 📞                         | 📞           | 📞         | 📞   | 📞    | 📞            | 🔧    |
| [GET /journals](https://apidocs.zwapgrid.com/accounting-api)                                                        | List journals.                                            | ✅       | ✅            | 📞     | 📞        | 📞              | 📞    | 📞           | ✅          | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | ✅             | 📞    |
| [GET /journals/{journalId}](https://apidocs.zwapgrid.com/accounting-api)                                            | Get a journal by ID.                                      | ✅       | ✅            | ✅      | ✅         | 📞              | ✅     | 📞           | ✅          | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | ✅             | 📞    |
| [POST /journals](https://apidocs.zwapgrid.com/accounting-api)                                                       | Create a journal.                                         | ✅       | ✅            | ✅      | ✅         | ✅               | ✅     | ✅            | ✅          | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [GET /journals/{journalId}/attachments/{attachmentId}](https://apidocs.zwapgrid.com/accounting-api)                 | Get a journal attachment by ID.                           | ✅       | 📞           | 📞     | 📞        | 📞              | 📞    | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [POST /journals/{journalId}/attachments](https://apidocs.zwapgrid.com/accounting-api)                               | Create a journal attachment.                              | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | 📞         | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [GET /proxy/{systemUrl}](https://apidocs.zwapgrid.com/accounting-api)                                               | Proxy a GET request to the underlying system.             | ✅       | ✅            | ✅      | ✅         | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | ✅             | ✅     |
| [POST /proxy/{systemUrl}](https://apidocs.zwapgrid.com/accounting-api)                                              | Proxy a POST request to the underlying system.            | ✅       | ✅            | ✅      | ✅         | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | ✅             | ✅     |
| [PUT /proxy/{systemUrl}](https://apidocs.zwapgrid.com/accounting-api)                                               | Proxy a PUT request to the underlying system.             | ✅       | ✅            | ✅      | ✅         | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | ✅             | ✅     |
| [PATCH /proxy/{systemUrl}](https://apidocs.zwapgrid.com/accounting-api)                                             | Proxy a PATCH request to the underlying system.           | ✅       | ✅            | ✅      | ✅         | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | 📞            | ✅     |
| [DELETE /proxy/{systemUrl}](https://apidocs.zwapgrid.com/accounting-api)                                            | Proxy a DELETE request to the underlying system.          | ✅       | ✅            | ✅      | ✅         | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | ✅             | ✅     |
| [GET /salesinvoices](https://apidocs.zwapgrid.com/accounting-api)                                                   | List sales invoices.                                      | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | ✅             | 📞    |
| [GET /salesinvoices/{salesInvoiceId}](https://apidocs.zwapgrid.com/accounting-api)                                  | Get a sales invoice by ID.                                | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | ✅             | 📞    |
| [POST /salesinvoices](https://apidocs.zwapgrid.com/accounting-api)                                                  | Create a sales invoice.                                   | ✅       | 📞           | ✅      | 📞        | ✅               | 📞    | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | 📞   | 📞    | ✅ Drafts only | 📞    |
| [GET /salesinvoices/{salesInvoiceId}/attachments](https://apidocs.zwapgrid.com/accounting-api)                      | List sales invoice attachments.                           | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | 📞            | 📞    |
| [GET /salesinvoices/{salesInvoiceId}/attachments/{attachmentId}](https://apidocs.zwapgrid.com/accounting-api)       | Get a sales invoice attachment by ID.                     | ✅       | ✅            | ✅      | 📞        | 📞              | ✅     | 📞           | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | 📞            | 📞    |
| [GET /salesinvoices/{salesInvoiceId}/attachments/printable](https://apidocs.zwapgrid.com/accounting-api)            | Get a printable sales invoice.                            | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | ✅              | ✅                          | ✅            | ✅          | ✅    | ✅     | ✅             | 📞    |
| [POST /salesinvoices/{salesInvoiceId}/attachments](https://apidocs.zwapgrid.com/accounting-api)                     | Create a sales invoice attachment.                        | ✅       | ✅            | ✅      | 📞        | 📞              | 📞    | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [POST /salesinvoices/{salesInvoiceId}/notes](https://apidocs.zwapgrid.com/accounting-api)                           | Add a note to a sales invoice.                            | 📞      | 📞           | ✅      | 📞        | 📞              | 📞    | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | 📞   | 📞    | 📞            | 📞    |
| [GET /salesinvoices/payments](https://apidocs.zwapgrid.com/accounting-api)                                          | List payments across sales invoices.                      | ✅       | ⛔            | ✅      | 📞        | ✅               | ✅     | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [GET /salesinvoices/{salesInvoiceId}/payments](https://apidocs.zwapgrid.com/accounting-api)                         | List payments for one sales invoice.                      | ✅       | ✅            | 📞     | 📞        | 📞              | ✅     | ✅            | ✅          | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [POST /salesinvoices/{salesInvoiceId}/payments](https://apidocs.zwapgrid.com/accounting-api)                        | Create a sales invoice payment.                           | ✅       | ✅            | ✅      | 📞        | 📞              | ✅     | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [GET /supplierinvoices](https://apidocs.zwapgrid.com/accounting-api)                                                | List supplier invoices.                                   | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | 📞           | ✅          | ✅              | ✅                          | 📞           | 📞         | ✅    | ✅     | ✅             | 📞    |
| [GET /supplierinvoices/{supplierInvoiceId}](https://apidocs.zwapgrid.com/accounting-api)                            | Get a supplier invoice by ID.                             | ✅       | ✅            | ✅      | 📞        | 📞              | ✅     | 📞           | ✅          | ✅              | ✅                          | 📞           | 📞         | ✅    | ✅     | ✅             | 📞    |
| [POST /supplierinvoices](https://apidocs.zwapgrid.com/accounting-api)                                               | Create a supplier invoice.                                | ✅       | ✅            | ✅      | 📞        | 📞              | 📞    | 📞           | 📞         | 📞             | ✅                          | 📞           | 📞         | 📞   | ✅     | 📞            | 📞    |
| [GET /supplierinvoices/{supplierInvoiceId}/attachments](https://apidocs.zwapgrid.com/accounting-api)                | List supplier invoice attachments.                        | 📞      | 📞           | 📞     | 📞        | 📞              | 📞    | 📞           | ✅          | ✅              | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [GET /supplierinvoices/{supplierInvoiceId}/attachments/{attachmentId}](https://apidocs.zwapgrid.com/accounting-api) | Get a supplier invoice attachment by ID.                  | 📞      | 📞           | 📞     | 📞        | 📞              | 📞    | 📞           | ✅          | ✅              | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [GET /supplierinvoices/{supplierInvoiceId}/attachments/printable](https://apidocs.zwapgrid.com/accounting-api)      | Get a printable supplier invoice attachment.              | 📞      | 📞           | 📞     | 📞        | 📞              | 📞    | 📞           | ✅          | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | ✅             | 📞    |
| [POST /supplierinvoices/{supplierInvoiceId}/attachments](https://apidocs.zwapgrid.com/accounting-api)               | Create a supplier invoice attachment.                     | ✅       | ✅            | ✅      | 📞        | 📞              | 📞    | 📞           | 📞         | ✅              | ✅                          | 📞           | 📞         | ✅    | ✅     | 📞            | 📞    |
| [GET /supplierinvoices/payments](https://apidocs.zwapgrid.com/accounting-api)                                       | List payments across supplier invoices.                   | ✅       | 📞           | 📞     | 📞        | 📞              | 📞    | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | ✅             | 📞    |
| [GET /supplierinvoices/{supplierInvoiceId}/payments](https://apidocs.zwapgrid.com/accounting-api)                   | List payments for one supplier invoice.                   | ✅       | 📞           | 📞     | 📞        | 📞              | 📞    | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | ✅             | 📞    |
| [POST /supplierinvoices/{supplierInvoiceId}/payments](https://apidocs.zwapgrid.com/accounting-api)                  | Create a supplier invoice payment.                        | ✅       | 📞           | ✅      | 📞        | 📞              | 📞    | 📞           | 📞         | 📞             | 📞                         | 📞           | 📞         | ✅    | 📞    | 📞            | 📞    |
| [GET /suppliers](https://apidocs.zwapgrid.com/accounting-api)                                                       | List suppliers.                                           | ✅       | 📞           | 📞     | 📞        | 📞              | ✅     | ✅            | ✅          | 📞             | ✅                          | ✅            | ✅          | ✅    | 📞    | ✅             | 📞    |
| [GET /suppliers/{supplierId}](https://apidocs.zwapgrid.com/accounting-api)                                          | Get a supplier by ID.                                     | ✅       | 📞           | 📞     | 📞        | 📞              | ✅     | ✅            | ✅          | 📞             | ✅                          | ✅            | ✅          | ✅    | 📞    | ✅             | 📞    |
| [GET /trialbalances (V2)](https://apidocs.zwapgrid.com/accounting-api)                                              | Retrieve trial balances (V2).                             | ✅       | ✅            | ✅      | 📞        | ✅               | ✅     | ✅            | ✅          | ✅              | 📞                         | 📞           | 📞         | 📞   | 📞    | 📞            | 🔧    |

Kleer connections require API access arranged with Kleer. See the [Kleer setup guide](/client-portal/systems/setup-guides/kleer) before planning a connection.

#### Platform functionality

| Entity       | API.1 Functionality                                                                                                                                                    | Fortnox | Bjorn Lunden | Spiris | Visma e-conomic | Billy | Visma Dinero | Procountor | Visma Netvisor | Tripletex | Microsoft Business Central | Exact Online | QuickBooks | Xero | Bokio | Kleer | DATEV |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----: | :----------: | :----: | :-------------: | :---: | :----------: | :--------: | :------------: | :-------: | :------------------------: | :----------: | :--------: | :--: | :---: | :---: | :---: |
| **Platform** | [Zwapgrid-managed connection to systems](/client-portal/systems/zwapgrid-managed-connection)                                                                           |    ✅    |       ✅      |    ✅   |        ✅        |   ✅   |       ✅      |      ✅     |        ✅       |     ✅     |              ✅             |       ✅      |      ⛔     |  🚫  |   🚫  |   ✅   |   📞  |
|              | [Client-managed connection to systems](/client-portal/systems/client-managed-connection)                                                                               |    ✅    |       ✅      |    ✅   |        🔧       |   🔧  |      🔧      |     🔧     |       🔧       |     🔧    |              ✅             |       ✅      |      ✅     |   ✅  |   ✅   |   🔧  |   ✅   |
|              | Custom scope selection for Zwapgrid connection                                                                                                                         |    ✅    |      🚫      |    ✅   |        🚫       |   🚫  |      🚫      |     🚫     |       🚫       |     🚫    |             🚫             |       ⛔      |      ⛔     |  🚫  |   🚫  |   🔧  |   📞  |
|              | <p><a href="https://apidocs.zwapgrid.com/accounting-api#tag/proxy1">Proxy.1</a><br><a href="https://docs.zwapgrid.com/proxy.1/overview">Additional information</a></p> |    ✅    |       ✅      |    ✅   |        ✅        |   🔧  |      🔧      |      ✅     |        ✅       |     ✅     |              ✅             |       ✅      |      ✅     |   ✅  |   ✅   |   ✅   |   ✅   |

#### File.1 functionality

| Entity                   | API.1 Functionality                   | Peppol (BIS Billing 3.0 - UBL Invoice) | Svefaktura 1.0 | Finvoice 3.0 PDF | ASIX (single & multi file formats) |
| ------------------------ | ------------------------------------- | :------------------------------------: | :------------: | :--------------: | :--------------------------------: |
| **File.1 Functionality** | GET a list of sales invoices          |                    ✅                   |        ✅       |         ✅        |                  ✅                 |
|                          | GET a sales invoice                   |                    ✅                   |        ✅       |         ✅        |                  ✅                 |
|                          | GET attachments for a sales invoice   |                    ✅                   |        ✅       |         ✅        |                  ✅                 |
|                          | GET an attachment for a sales invoice |                    ✅                   |        ✅       |         ✅        |                  ✅                 |
|                          | GET a printable sales invoice         |                    ✅                   |        ✅       |         ✅        |                  ✅                 |


# Terminology

This is the terminology you will find throughout the documentation and in your communication with us.

| Term              | Meaning                                                                                                                                                                 |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| The Client        | You are The Client. You invite Your Customer to Consent to share data from their Accounting System. You can then consume this data using API.1.                         |
| Your Customer     | Your Customer can connect their Accounting Systems and share their data with The Client.                                                                                |
| Your Platform     | The public-facing or internal software system(s) you develop and use within your organization.                                                                          |
| Consent           | Consent is the link between Your Customer in Your Platform and the connection to their Accounting System through API.1.                                                 |
| Consent ID        | A Consent ID is a unique GUID generated when you create a Consent. You can then use it when inviting Your Customer to connect so that you can consume data using API.1. |
| Accounting System | An Accounting System is a software system that helps organizations automate and manage accounting for optimal performance.                                              |
| Client Portal     | This is where you can manage The Client - here you can manage the Onboarding Flow and API Key creation, for example.                                                    |
| Onboarding Flow   | This is the platform that Zwapgrid has developed to enable Your Customer to log in and connect to their Accounting System.                                              |
| API.1             | API.1 is the set of APIs that are used by The Client to access the data from the Accounting System that Your Customer uses.                                             |
| API Key           | The API Key is your access to API.1 APIs. You create and manage API Keys in the Client Portal.                                                                          |
| One-Time Code     | A unique code that is generated and used together with the Onboarding Flow, in order to ensure that only Your Customer can access a created Consent.                    |


# Fair-usage Policy

Zwapgrid enforces fair usage to keep the platform reliable. This policy applies to all Zwapgrid services, including API.1.

Usage limits can be applied per client, environment, or API key. Exceeding limits may result in throttling or additional charges. Serious or repeated abuse may result in access revocation.

{% hint style="info" %}
If you need higher limits, contact <sales@zwapgrid.com>.
{% endhint %}

### Acceptable use

The Client and its users must not:

* Disrupt the platform or degrade performance for others.
* Attempt unauthorized access to data, services, accounts, or networks.
* Use the platform in violation of applicable laws or regulations.
* Provide false, misleading, or fraudulent information.

The Client and its users must:

* Follow internal policies for data access, privacy, and security.

### Environment and consent separation

Use **Development** for testing and non-production workflows. Use **Production** for live customer onboarding and data access.

* Do not use Production Consents for development or testing.
* Do not use Development Consents to onboard live customers. This violates our Terms of Service.

#### Test Consents

Development Consents used for testing are considered Test Consents. Zwapgrid reserves the right to remove any Test Consent that:

* Is more than 21 days old.
* Places excessive load on our systems.
* Otherwise falls outside this Fair-usage Policy.

### Authentication and API key security

API keys must be created, stored, and used securely. You are responsible for all activity performed using your keys.

* Do not share API keys publicly or with unauthorized parties.
* Do not embed API keys in client-side apps or public code.
* Rotate keys regularly and remove keys you no longer need.

Misuse of API keys may result in rate limiting or access revocation.


# Overview

Get started with API.1 to retrieve Your Customer's data from their Accounting System. This section describes how to call API.1: authentication, request conventions, and how to retrieve data. You'll work with RESTful APIs, JSON responses, and an API Key for authentication.

### RESTful APIs

Our APIs are built using a RESTful architecture.

***

### JSON Responses

All our responses are in JSON format.

***

### API Key

To access API.1, you'll need to create an API Key in the [Client Portal](https://github.com/Zwapgrid/documentation-external/blob/main/api-1-documentation/get-started/client-portal/api-keys.md).

You must pass your API key in the following HTTP header with every API call:

```
x-api-key: YOUR_API_KEY_HERE
```

{% hint style="info" %}
Remember to replace `YOUR_API_KEY_HERE` with your actual API key.
{% endhint %}

***

### Correlation ID

For better traceability and support, you must generate and pass a unique Correlation ID (GUID) with each API request.

For example:

```
x-correlation-id: YOUR_UNIQUE_GUID
```

{% hint style="info" %}
A GUID (Globally Unique Identifier) is a unique reference number used for identification.
{% endhint %}

***

### Polling

You access data from connected accounting systems by polling API.1. You can poll the Consent API for consent status until it is Accepted; then call the Accounting API (for example for invoices or reports) whenever you need data. When calling the Accounting API, you pass the Consent ID in the request path.


# How the platform works

This page gives you one place to see how the Zwapgrid platform fits together: who does what, in what order, and where to find the details.

### Actors

* **You (The Client)** – You build or run the product that needs Your Customer's accounting data. You create consents, invite Your Customer to the Onboarding Flow, and call API.1 to read data.
* **Your Customer** – The end user who connects their Accounting System and grants Consent so you can access their data.
* **Zwapgrid** – The platform that provides the Consent API, Accounting API, Onboarding Flow, and Client Portal. Zwapgrid connects to Your Customer's Accounting System and normalizes data for you.

### Ordered sequence

1. **Get an API key** from the [Client Portal](https://clients.zwapgrid.com/).
2. **Create a consent** via the Consent API and get a **Consent ID**.
3. **Generate a One-Time Code (OTC)** via the Consent API.
4. **Build the onboarding URL** with the Consent ID and OTC, and send Your Customer to the Onboarding Flow.
5. **Your Customer completes the Onboarding Flow** and connects their Accounting System (or uploads files via File.1).
6. **Consent status becomes Accepted** once they have finished.
7. **You call the Accounting API** with the Consent ID and your API key to read their data (invoices, company info, and more).

### Implementation checklist

| Step | What to do                                      | Where to read more                                                                                          |
| ---- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| 1    | Get API key from Client Portal                  | [Get Started overview](/get-started/get-started), [API Keys](/client-portal/api-keys)                       |
| 2    | Create consent (Consent API) and get Consent ID | [Create Consent](/client-portal/consents/create-consent)                                                    |
| 3    | Generate One-Time Code (Consent API)            | [One-Time Code](/onboarding-flow/one-time-code)                                                             |
| 4    | Build onboarding URL with Consent ID + OTC      | [URL and parameters](/onboarding-flow/url-and-parameters)                                                   |
| 5    | Your Customer completes Onboarding Flow         | [Onboarding Flow](/onboarding-flow/onboarding-flow), [Grant Consent](/client-portal/consents/grant-consent) |
| 6    | Check consent status until Accepted             | [Consent Status](/client-portal/consents/consent-status)                                                    |
| 7    | Call Accounting API with Consent ID + API key   | [Access Your Customer Data](/get-started/access-your-customer-data)                                         |

For full endpoint details and URL structure, see the [API Reference](https://apidocs.zwapgrid.com/).


# Onboard Your Customer

To integrate Your Customer with API.1, you must first use the Consent API to create a Consent - you then use the generated Consent ID in order to invite Your Customer to share data from their Accounting System using the Onboarding Flow.

Once Your Customer has accepted the Consent you can use API.1 to consume data from their Accounting System from within Your Platform.

<figure><img src="https://2802285108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQCvVWgo58AdpQJMipzpD%2Fuploads%2FESx11Y3EckJ3D08lLbnF%2Fflow.1.png?alt=media&amp;token=1a61edbf-e689-4dff-bd9b-f061b377760d" alt=""><figcaption><p>End-to-end flow: consent, onboarding, and data access.</p></figcaption></figure>

## Onboard from your backend

If your client backend owns the connection experience, use [Headless Onboarding (Preview)](/onboarding-flow/headless-onboarding). It describes the shared workflow and the request bodies for supported systems. Provider login and customer approval still apply where required.


# Access Your Customer Data

Once Your Customer has successfully completed the Onboarding Flow and granted Consent so that you, as The Client, can access their data, their Consent status will have changed.

You can then use the Consent ID when calling API.1 to retrieve data from Your Customer's Accounting System.

**What you need for each request:** the Consent ID and the API Key you created in the Client Portal. Use them to access any API.1 endpoint and filter or list invoices. Accounting API requests are scoped by Consent: the Consent ID is included in the request path (for example `.../consents/{consentId}/...`). See the [API Reference](https://apidocs.zwapgrid.com/) for the exact URL structure.

For full endpoint details, see the [API Reference](https://apidocs.zwapgrid.com/) section of our documentation.


# Overview

{% hint style="info" %}
**What is the Client Portal?**

The Client Portal is where you manage The Client experience. It provides API Key management, management of Consent and the ability to customise the Onboarding Flow.
{% endhint %}

You can access the Client Portal at <https://clients.zwapgrid.com/> with a valid login.

### What can I do from the Client Portal?

The Client Portal is where you manage API keys, consents, branding, and environment settings. The table below summarises what is available today.

### Current Functionality

| Area                                            | Description                                                                                                                                                                                                                                                |
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**Environments**](/client-portal/environments) | Development and Production environments and API Keys per environment.                                                                                                                                                                                      |
| [**Consents**](/client-portal/consents)         | Consent overview and managing Consents in the portal (list, rename, revoke, delete); includes [Consent Lifecycle](/client-portal/consents/consent-lifecycle), Create Consent, Grant Consent, and [Consent Status](/client-portal/consents/consent-status). |
| [**API Keys**](/client-portal/api-keys)         | Create and manage API Keys per environment; [Usage](/client-portal/api-keys/usage), [Security](/client-portal/api-keys/security), [API Key Lifecycle](/client-portal/api-keys/api-key-lifecycle).                                                          |
| [**Users**](/client-portal/users)               | List users, invite new users, delete user access to the Client Portal.                                                                                                                                                                                     |
| [**Onboarding**](/client-portal/onboarding)     | Customise the Onboarding Flow: logo, company name, company URL, redirect URL, theme.                                                                                                                                                                       |
| [**Systems**](/client-portal/systems)           | Enable which systems appear in the Onboarding Flow and configure system-specific settings; includes [Connection Management](/client-portal/systems/connection-management) (e.g. Fortnox, Visma e-conomic, File.1).                                         |


# Environments

{% hint style="info" %}
If you are a Trial customer, you can only create Development Consents. Please contact <sales@zwapgrid.com> for further information on upgrading.
{% endhint %}

We offer two environments within the Client Portal. These are:

* [Development](/client-portal/environments/development)
* [Production](/client-portal/environments/production)

Use a **Development** API key and Development consents for sandbox and testing (e.g. Test.1). Use a **Production** API key and Production consents for live Your Customer data.

We recommend creating a [**Development API Key**](/client-portal/environments/development) during your development phase to allow you to create Development Consents. These API Keys should be stored securely and used in your non-production workflows.

We recommend that once you are ready to go live with your integration to API.1, you create a [**Production API Key**](/client-portal/api-keys) that you should store securely and use when retrieving data from live customers.

{% hint style="info" %}
You must use the appropriate API key to create consent for the corresponding environment.
{% endhint %}


# Development

{% hint style="info" %}
To create Development consents via the API, you must use a Development API Key
{% endhint %}

This environment is used for development against API.1 in the non-production environment of Your Platform.

This environment enables you to integrate with a test version of the Onboarding Flow and allows you to create and manage test Consent.

This environment offers the ability to connect to Accounting Systems as well as pull dummy data for a number of endpoints from our test Accounting System - TEST.1.

{% hint style="danger" %}
To avoid incurring additional usage charges, you should not use Production consent during development.
{% endhint %}


# Production

{% hint style="info" %}
To create Production consents via the API, you must use a Production API Key
{% endhint %}

This environment is used for development against API.1 in the production environment of Your Platform.

This environment enables you to integrate with a production version of the Onboarding Flow and allows you to create and manage actual Consent for Your Customer.


# Consents

Consent links Your Platform to Your Customer's Accounting System so you can access their data through API.1.

{% hint style="info" %}
**What is Consent?**

Consent is the link between Your Customer in Your Platform and the connection to their Accounting System through API.1.
{% endhint %}

You create a Consent (and generate a Consent ID) which you use to **invite Your Customer** to connect their Accounting System, and then connect to API.1 to **fetch their data** and use it in Your Platform. For how consent is managed over time (keeping it active, purging, and retention), see [Consent Lifecycle](/client-portal/consents/consent-lifecycle).

***

### Managing Consents in the Client Portal

In the Client Portal you can view and manage all Consents for your Client. Switch between [Development and Production](/client-portal/environments) to see Consents for each environment.

#### List Consents

The Consents view shows all Consents created for your Client. For each Consent you can see:

* **Name** – The label you gave the Consent (you can change this).
* **Created date** – When the Consent was created.
* **Status** – Created, Accepted, Revoked, or Inactive (see [Consent Status](/client-portal/consents/consent-status)).
* **Connected system** – The Accounting System Your Customer connected, once they have completed the Onboarding Flow.

Use **search and filter** to find Consents by name, status, or other criteria.

#### Rename Consent

You can edit a Consent's name at any time. This is for your own use so you can identify it easily (e.g. which of Your Customers or which use case it relates to). Renaming does not change the Consent ID or affect API.1 access.

#### Revoke Consent

Revoking a Consent immediately removes access via the customer-granted connection. You can no longer call the Accounting API for that Consent ID. Use Revoke when you need to stop using a Consent but may want to keep a record of it. A Revoked Consent is removed from the system after 180 days.

#### Delete Consent

Deleting a Consent removes it from the Client Portal immediately and completely. The Consent is no longer visible and cannot be restored. You cannot access data via API.1 for that Consent. Use Delete when you want to remove the Consent record permanently (e.g. for compliance or cleanup). Your Customer would need to go through the Onboarding Flow again with a new Consent if you need to restore access.


# Consent Lifecycle

This section describes how consent is managed over its lifecycle: staying active, becoming inactive, and when Zwapgrid purges consent records.

### Keeping consent active (30-day rule)

A Consent in **Accepted** status remains active only if it is **used at least once every 30 days**. Usage means calling the Accounting API (API.1) with that Consent ID. If a Consent is not used for 30 consecutive days, it becomes **Inactive**. An Inactive Consent cannot be re-activated; to restore access, you must create a new Consent and Your Customer must complete the Onboarding Flow again.

Use the Consent regularly in Your Platform (e.g. when syncing or fetching Your Customer's data) so it stays Active. If you do not need the data for a period, the Consent will lapse and Your Customer will need to reconnect.

### When consent is removed (purging policy)

Zwapgrid removes consent records according to our retention rules so we do not keep data longer than necessary:

* **Created** – A Consent that is never accepted (Your Customer never completes the Onboarding Flow) is removed after **30 days**.
* **Inactive** – A Consent that has become Inactive (e.g. unused for 30 days, or Your Customer removed access) is removed after **180 days**.
* **Revoked** – A Consent that you or the system has revoked is removed after **180 days**.
* **Deleted** – A Consent that you delete is removed **immediately** and is no longer visible.

Until a Consent is removed, you can still see it in the Client Portal (where applicable) and use it only if it is still in Accepted status. For more about the various consent statuses, see [Consent Status](/client-portal/consents/consent-status).


# Create Consent

{% hint style="info" %}
**How do you create Consent?**

The Client can create Consent using API.1 before you invite Your Customer to the Onboarding Flow to share data from their Accounting System.
{% endhint %}

### Create a consent using API.1

The Client must use API.1 to create a Consent which will generate a Consent ID.

#### Providing System Settings during Consent Creation

When creating a Consent, you can optionally specify which published system settings to use for each [configurable Accounting System](/client-portal/systems#configure-system-settings). This allows you to direct Your Customer to use specific credentials and configuration.

Include the `systemsSettings` object in your API request, mapping each system to its corresponding system settings ID:

```json
{
    "name": "{{consentName}}",
    "systemsSettings": {
        "fortnox": "{{systemSettingsId}}"
    }
}
```

### Onboarding Flow

The Client must direct Your Customer to the Onboarding Flow requesting Consent to access data from their Accounting System.

Your Customer will use the Onboarding Flow to connect to their Accounting System.

<figure><img src="https://2802285108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQCvVWgo58AdpQJMipzpD%2Fuploads%2FESx11Y3EckJ3D08lLbnF%2Fflow.1.png?alt=media&amp;token=1a61edbf-e689-4dff-bd9b-f061b377760d" alt=""><figcaption><p>Create Consent flow.</p></figcaption></figure>


# Grant Consent

{% hint style="info" %}
**How does Your Customer grant Consent?**

Your Customer uses the Onboarding Flow to authorize a connection to their Accounting System so that The Client can access their data using API.1.
{% endhint %}

### Your Customer grants Consent to access their data

* Your Customer is prompted to Consent to share data between their Accounting System and Your Platform using API.1.
* Your Customer must then connect to their Accounting System in order to begin sharing their data through API.1.


# Consent Status

Consent can have one of the following statuses. For how we manage consent over time—including how to keep it active (30-day usage rule), when consents are removed (retention and purging), and what happens when status changes—see [Consent Lifecycle](/client-portal/consents/consent-lifecycle).

### Created

The initial status of a Consent – it has this status as soon as it is created and has not yet been accepted by Your Customer.

### Accepted

The status of a Consent once Your Customer has completed the Onboarding Flow and connected their Accounting System. You can now call API.1 to get their data and use it in Your Platform. It remains in this state unless it is Revoked, deleted, or becomes Inactive.

### Revoked

The status of a Consent that has been revoked via the Consent API or from the Client Portal. It is not possible to access data via API.1.

### Inactive

The status of a Consent that no longer has an active connection. This can happen if Your Customer has removed access via their Accounting System, or when the consent is no longer in active use. It is not possible to access data via API.1.

An Inactive Consent **cannot be re-activated**. To restore access, you must create a **new** Consent and Your Customer must go through the Onboarding Flow again with that new Consent.

### Deleted

A Consent that has been deleted. In this state the Consent is not visible and has been removed from the system. It is not possible to access data via API.1 or to restore the Consent.


# API Keys

API Keys are required to call API.1 (Consent API and Accounting API). You create and manage API Keys in the Client Portal per [environment](/client-portal/environments). For how to use your key in API.1 requests, see [Usage](/client-portal/api-keys/usage).

### Create Development API Key

Create a **Development** API Key for non-production use—e.g. when building or testing your integration. Development keys let you create Development Consents and access sandbox data. For how to use the key in requests, see [Usage](/client-portal/api-keys/usage). For the full lifecycle, see [API Key Lifecycle](/client-portal/api-keys/api-key-lifecycle).

### Create Production API Key

Create a **Production** API Key when you are ready to go live. Production keys let you create Production Consents and access real data from Your Customer's Accounting Systems. Store it securely—see [Security](/client-portal/api-keys/security). For creation and lifecycle, see [API Key Lifecycle](/client-portal/api-keys/api-key-lifecycle).

### Naming and expiry

When creating an API Key you can set a **descriptive name** and an **expiry**. For details and recommendations on expiry and rotation, see [API Key Lifecycle](/client-portal/api-keys/api-key-lifecycle).

### Delete API Key

You can delete an API Key from the Client Portal. Once deleted, it can no longer be used for API.1 requests. For the full lifecycle and rotation steps, see [API Key Lifecycle](/client-portal/api-keys/api-key-lifecycle).

{% hint style="info" %}
**Expiry reminder emails**

To support business continuity, we send expiry reminder emails as an API Key's expiry date approaches and again 24 hours before it expires.
{% endhint %}


# Usage

To access API.1 (Consent API and Accounting API), you must create an API Key. You create and manage API Keys in the [Client Portal](/client-portal/api-keys) per [environment](/client-portal/environments).

### Pass the key in requests

When you call API.1, pass your API Key in every request using the `x-api-key` HTTP header:

```
x-api-key: YOUR_API_KEY_HERE
```

Replace `YOUR_API_KEY_HERE` with the key you created in the Client Portal. Use a **Development** key for Development consents and sandbox data (e.g. Test.1); use a **Production** key for Production consents and live data from Your Customer's Accounting Systems.

For full request conventions, correlation IDs, and authentication, see [Get Started](/get-started/get-started).


# Security

API Key security is your responsibility. Follow these practices to keep keys safe.

### Store and protect your key

Zwapgrid does not store your API Key after creation. **Copy the key when it is shown** and store it securely. Limit who has access to see or use the key.

### Where not to use API Keys

Do **not** use API Keys in front-end code or anywhere the key could be exposed, including:

* Web browsers or client-side applications
* Public repositories or shared code
* Logs, URLs, or error messages

Use API Keys only in secure server-side or backend environments where the key cannot be exposed to end users or the public.

### Refresh keys regularly

We encourage you to refresh your API Keys regularly as a security best practice. Create a new key, update your applications to use it, then delete the old key. See [API Key Lifecycle](/client-portal/api-keys/api-key-lifecycle) for creating and deleting keys.

{% hint style="danger" %}
It is your responsibility to keep your API Keys safe.
{% endhint %}


# API Key Lifecycle

This page describes how an API Key moves through its lifecycle: from creation and active use to expiry or rotation and removal. For the steps to create or delete keys in the Client Portal, see [API Keys](/client-portal/api-keys). For keeping keys safe, see [Security](/client-portal/api-keys/security).

### Creation

You create an API Key in the Client Portal per [environment](/client-portal/environments). At creation you set a **name** (to identify it later) and an **expiry** (30, 90, or 365 days). Zwapgrid does not store the key after creation—copy it when it is shown and store it securely. From that point the key is active and can be used for API.1 requests.

### Active use

While the key is within its expiry period and has not been deleted, you use it to authenticate API.1 calls (Consent API and Accounting API). Use a **Development** key for Development consents and sandbox data; use a **Production** key for Production consents and live data. See [Usage](/client-portal/api-keys/usage) for how to pass the key in requests.

### Expiry and rotation

When the key approaches its expiry date, or when you want to rotate for security, create a **new** API Key in the Client Portal. Update your applications or scripts to use the new key, then delete the old key. Rotating before deleting avoids downtime: the old key continues to work until you remove it.

If you do not rotate before expiry, the key will no longer work for new requests once the expiry date has passed. Any applications still using it will receive authentication errors. Create a new key and update your integration.

### Deletion

Deleting an API Key in the Client Portal removes it immediately. That key can no longer be used for API.1 requests. There is no way to restore a deleted key—create a new one if you need to continue calling API.1.


# Users

You can manage who has access to the Client Portal for your organisation. User management applies to the Client Portal only (login to [clients.zwapgrid.com](https://clients.zwapgrid.com)); it does not control access to API.1 (that is done via API Keys and Consents).

### List Users

View all users who have access to your Client Portal. You can see who is invited, active, or removed. Use this to audit access and ensure only the right people can manage Consents, API Keys, and other Client Portal settings.

### Invite User

Invite a new user to the Client Portal by email. They will receive an invitation to create or link an account and sign in. Once they accept, they can access the Client Portal according to your organisation’s permissions. Use this when a new team member needs to manage API Keys, Consents, branding, or system configuration.

### Delete User

Removing a user revokes their access to the Client Portal. They will no longer be able to sign in or perform actions in the portal. This does not affect existing API Keys or Consents; those continue to work until you revoke or delete them. Use Delete when someone leaves your team or no longer needs portal access.


# Onboarding

In the Client Portal you can customise how the [Onboarding Flow](/onboarding-flow/onboarding-flow) looks and behaves when Your Customer connects their Accounting System. These settings apply to the experience Your Customer sees (e.g. your logo, company name, and which systems they can choose).

### Logo

Upload or update the **logo** that appears in the Onboarding Flow. This is typically your company or product logo so Your Customer recognises they are connecting to you. You can replace the logo at any time; the new logo is used for new onboarding sessions.

### Company name

Set or change the **company display name** shown in the Onboarding Flow. This is the name Your Customer sees (e.g. your product or company name). Use it to keep the experience consistent with your brand.

### Company URL

Set or change the **company URL**. This is the link used when Your Customer clicks your logo in the Onboarding Flow (e.g. your website or app). It helps Your Customer verify they are connecting to the right organisation.

### Restrict redirect URL

You can **restrict the redirect URL** that is allowed when Your Customer finishes the Onboarding Flow. By limiting which URLs are valid for the `redirecturl` parameter, you reduce the risk of redirects to unexpected sites. Configure one or more allowed redirect URLs in the Client Portal; only those URLs will be accepted when you send Your Customer to the Onboarding Flow with a redirect back to Your Platform.

### Theme

**Configure theme** (e.g. colours) for the Onboarding Flow is under development. When available, you will be able to align the look and feel of the flow with your brand (e.g. primary and secondary colours).

### Which systems are shown

In **Systems** (see [Systems](/client-portal/systems)) you can choose which Accounting Systems are available in the Onboarding Flow. Your Customer will only see and be able to connect the systems you enable.

### Headless onboarding (Preview)

If your backend owns the customer connection experience, see [Headless Onboarding (Preview)](/onboarding-flow/headless-onboarding) for supported systems and integration instructions. The branding and redirect settings above describe the guided Onboarding Flow.


# Systems

Enable accounting systems and configure System Settings for customer connections.

Use **Systems** in the [Client Portal](https://clients.zwapgrid.com/) to control which Accounting Systems Your Customer can select in the Onboarding Flow and to configure the credentials used for those connections.

System Settings are the standard setup path for new integrations wherever they are supported. Your organisation registers and owns the vendor application, and Zwapgrid uses the published System Setting when Your Customer connects. Zwapgrid is moving toward this model across all Accounting Systems.

## Enable a system

Enable a system when you are ready to offer it to Your Customer. Enabled systems appear in the standard [Onboarding Flow](/onboarding-flow/onboarding-flow); disabled systems do not.

Test.1 is the exception. It is always available for Development Consents, does not appear in the Client Portal, and cannot be enabled or disabled.

{% hint style="info" %}
For systems with System Settings, enabling the system is not enough. Publish a System Setting and either make it the default or provide its ID when you [create the Consent](/client-portal/consents/create-consent#providing-system-settings-during-consent-creation).
{% endhint %}

## Set up the connection

For a new integration, create and publish a System Setting whenever the Accounting System supports it. This is a **client-managed connection**: you supply credentials from your own vendor application and retain control of its permissions and lifecycle.

Some systems do not yet expose System Settings. Those systems currently use a **Zwapgrid-managed connection**, where Zwapgrid supplies the application configuration. Existing integrations may also continue to use this setup.

These are not presented as interchangeable options for each connection. Follow the relevant [System Setup Guide](/client-portal/systems/setup-guides); it tells you whether to create a System Setting or use the current Zwapgrid-managed process. See [Connection Management](/client-portal/systems/connection-management) for ownership and maintenance responsibilities.

## Configure System Settings

A System Setting stores the credentials and system-specific options for your integration. Creating and publishing it is a normal part of setting up a supported Accounting System. Settings use a Draft, Published, and Archived lifecycle and can be selected during Consent creation.

Read [System Settings](/client-portal/systems/system-settings) for the complete workflow, lifecycle rules, and credential-safety guidance.

## System setup guides

Vendor requirements differ. The [System Setup Guides](/client-portal/systems/setup-guides) explain how to prepare a test account or vendor application, configure Zwapgrid when applicable, and validate the connection before production.

The following systems currently expose configuration in the Client Portal:

| System            | Setup guide                                                         |
| ----------------- | ------------------------------------------------------------------- |
| Bjorn Lunden      | [Open guide](/client-portal/systems/setup-guides/bjorn-lunden)      |
| Bokio             | [Open guide](/client-portal/systems/setup-guides/bokio)             |
| Business Central  | [Open guide](/client-portal/systems/setup-guides/business-central)  |
| DATEV Online      | [Open guide](/client-portal/systems/setup-guides/datev)             |
| Exact Online      | [Open guide](/client-portal/systems/setup-guides/exact-online)      |
| Finago Procountor | [Open guide](/client-portal/systems/setup-guides/procountor)        |
| Fortnox           | [Open guide](/client-portal/systems/setup-guides/fortnox)           |
| QuickBooks Online | [Open guide](/client-portal/systems/setup-guides/quickbooks-online) |
| Spiris            | [Open guide](/client-portal/systems/setup-guides/visma-eaccounting) |
| Xero              | [Open guide](/client-portal/systems/setup-guides/xero)              |

The setup index also covers systems that do not yet expose a System Setting and therefore use the current Zwapgrid-managed process.

## File.1

File.1 ingests PDF invoices and supported XML invoice formats. Enabling and configuring File.1 allows Your Customer to use file-based ingestion in the Onboarding Flow. File.1 offers an agentic model as a selectable PDF parsing option; see [How does File.1 work?](/file-1/how-does-file.1-work) for the processing and approval workflow.

## Next steps

1. Open the relevant [system setup guide](/client-portal/systems/setup-guides).
2. Create and publish a [System Setting](/client-portal/systems/system-settings) whenever the system supports it.
3. If System Settings are not yet available, follow the documented [Zwapgrid-managed process](/client-portal/systems/zwapgrid-managed-connection).
4. Create a Consent and test the complete [Onboarding Flow](/onboarding-flow/onboarding-flow).


# System Settings

Configure credentials and provider options for Accounting System connections.

A System Setting tells Zwapgrid which vendor application credentials and options to use when Your Customer connects an Accounting System. Settings are created in the [Client Portal](https://clients.zwapgrid.com/) and belong to one Accounting System.

Treat System Settings as a standard part of setting up a new integration whenever they are supported. For a **client-managed connection**, your organisation owns the vendor application registration and Zwapgrid uses its credentials to complete authorisation and make API requests. Some settings instead configure options for a **Zwapgrid-managed integration**, whose application credentials are managed by Zwapgrid.

Zwapgrid is moving toward System Settings as the default connection model across all Accounting Systems. Where System Settings are not yet available, the system-specific guide explains the current Zwapgrid-managed process. Existing integrations may also remain Zwapgrid-managed until a migration is agreed.

## Enablement and configuration are different

Enabling a system makes it available in the Onboarding Flow. Configuring a system selects the credentials and options used by its connections.

For systems where System Settings are available, complete all three actions before inviting Your Customer:

1. Enable the Accounting System.
2. Create and publish a System Setting.
3. Make the setting the default where supported, or provide it explicitly when creating the Consent.

## What a System Setting contains

The available fields depend on the Accounting System and can include:

* A name that helps your team identify the configuration.
* A vendor application client ID and client secret.
* OAuth scopes or feature permissions.
* A redirect URI to register with the vendor.
* Environment-specific or connection-specific options.

Some vendors control permissions in their own developer portal instead of the Zwapgrid Client Portal. Always follow the relevant [System Setup Guide](/client-portal/systems/setup-guides).

{% hint style="warning" %}
Never place real client secrets, API keys, access tokens, or customer data in documentation, screenshots, support tickets, or chat messages.
{% endhint %}

## Create and publish a setting

1. Sign in to the [Client Portal](https://clients.zwapgrid.com/).
2. Open **Systems** and locate the Accounting System.
3. Select **Configure**, then create a setting with a descriptive name.
4. Copy any redirect URI shown by Zwapgrid to the corresponding field in the vendor application.
5. Enter the required credentials and permissions, or select the connection options available for that system.
6. Save the setting and review the configuration while it is in Draft.
7. Publish the setting when it is ready for Consent creation and onboarding.

Use names that identify the application and purpose without including secrets, for example `Production - reporting` or `Development - invoice sync`.

## Lifecycle

| State         | Behaviour                                                                     |
| ------------- | ----------------------------------------------------------------------------- |
| **Draft**     | Editable preparation state. Publish it before selecting it for a new Consent. |
| **Published** | Available for Consent creation and customer onboarding.                       |
| **Archived**  | Retained for lifecycle management but unavailable for new connections.        |

An archived setting must remain archived for 30 days before permanent deletion. Deletion is blocked if an accepted Consent becomes linked to the setting during that period.

## Select a setting for a Consent

You can use either of these approaches:

* **Default setting:** Use the published default whenever Your Customer selects that Accounting System.
* **Consent-specific setting:** Provide a published setting ID in the `systemsSettings` object when you [create the Consent](/client-portal/consents/create-consent#providing-system-settings-during-consent-creation).

You can maintain multiple named settings for the same Accounting System. This is useful when separate products, environments, or permission profiles require different configurations. Each connection still uses one setting for one Accounting System.

## Select a provider environment

Where supported, a System Setting lets you select the vendor's production or test environment. Available options, default behaviour, and rules for changing environments depend on the Accounting System. Follow its [System Setup Guide](/client-portal/systems/setup-guides); a Development Consent alone does not guarantee a connection to a vendor's test environment.

## Rotate a client secret

When you rotate the client secret for the same vendor application, you can update the existing Published System Setting. The client ID and scopes must remain unchanged.

1. Generate a new client secret in the vendor's developer portal.
2. In the Client Portal, open the existing Published System Setting.
3. Replace the client secret without changing the client ID or scopes.
4. Save the setting and validate that the integration can still authenticate and access the required data.
5. Revoke the previous secret after validation, when the vendor supports an overlap period.

## Change application or scopes

Changing the vendor application, client ID, or scopes requires a new System Setting. Application and permission changes can affect existing authorisations and must be tested before migration.

1. Create or update the replacement vendor application and confirm its scopes or permissions.
2. Create and publish a new System Setting instead of changing or removing the active setting.
3. Ask the vendor whether existing customers must authorise the new application or scopes.
4. Validate the complete workflow with a test company.
5. Move one production connection first and confirm the result.
6. Archive the previous setting only after all affected connections have been accounted for.

## Security checklist

* Request only the permissions required by your integration.
* Use separate vendor credentials for development and production when the vendor supports it.
* Store client secrets in the System Setting rather than application logs or internal notes.
* Rotate credentials immediately if they may have been exposed.
* Test credential replacements before migrating production connections.
* Never include secrets when contacting Zwapgrid or vendor support.

## Configure a specific system

Open the [System Setup Guides](/client-portal/systems/setup-guides) for vendor-specific prerequisites, fields, permissions, test environments, and production considerations.

{% hint style="info" %}
Need help with a particular configuration? Contact <support@zwapgrid.com> with the Accounting System, Consent ID, UTC timestamp, and correlation or request ID. Do not include credentials or tokens.
{% endhint %}


# System Setup Guides

Prepare, configure, and test each Accounting System supported by API.1.

Each Accounting System has different requirements for test access, vendor applications, credentials, and production approval. These guides describe the parts that differ by system and link back to the shared [System Settings](/client-portal/systems/system-settings) workflow.

System Settings are the standard setup path for new integrations wherever supported. If a system does not yet expose System Settings, its guide documents the current Zwapgrid-managed process instead.

## Choose a system

| System            | Connection setup                                    | Recommended test option                   | Guide                                                                      |
| ----------------- | --------------------------------------------------- | ----------------------------------------- | -------------------------------------------------------------------------- |
| Billy             | Current Zwapgrid-managed setup                      | Dedicated Billy test company              | [Billy](/client-portal/systems/setup-guides/billy)                         |
| Bjorn Lunden      | System Setting                                      | Vendor-provided sandbox                   | [Bjorn Lunden](/client-portal/systems/setup-guides/bjorn-lunden)           |
| Bokio             | System Setting                                      | Test-mode app and test company            | [Bokio](/client-portal/systems/setup-guides/bokio)                         |
| Business Central  | System Setting                                      | Trial or sandbox environment              | [Business Central](/client-portal/systems/setup-guides/business-central)   |
| DATEV Online      | System Setting                                      | DATEV Sandbox with an eligible dataset    | [DATEV Online](/client-portal/systems/setup-guides/datev)                  |
| Exact Online      | System Setting                                      | Developer account and test administration | [Exact Online](/client-portal/systems/setup-guides/exact-online)           |
| Fortnox           | System Setting                                      | Developer sandbox                         | [Fortnox](/client-portal/systems/setup-guides/fortnox)                     |
| Finago Procountor | System Setting                                      | Private test environment                  | [Procountor](/client-portal/systems/setup-guides/procountor)               |
| QuickBooks Online | System Setting                                      | Intuit sandbox company                    | [QuickBooks Online](/client-portal/systems/setup-guides/quickbooks-online) |
| Tripletex         | Current Zwapgrid-managed setup                      | Tripletex API test account                | [Tripletex](/client-portal/systems/setup-guides/tripletex)                 |
| Visma Dinero      | Current Zwapgrid-managed setup                      | Dedicated Dinero test company             | [Visma Dinero](/client-portal/systems/setup-guides/visma-dinero)           |
| Visma e-conomic   | Current Zwapgrid-managed setup                      | Demo agreement                            | [Visma e-conomic](/client-portal/systems/setup-guides/visma-economic)      |
| Visma Netvisor    | System Setting: Zwapgrid-managed Production/Sandbox | Partner test environment                  | [Visma Netvisor](/client-portal/systems/setup-guides/visma-netvisor)       |
| Visma Spiris      | System Setting                                      | Partner sandbox                           | [Visma Spiris](/client-portal/systems/setup-guides/visma-eaccounting)      |
| Xero              | System Setting                                      | Xero demo company                         | [Xero](/client-portal/systems/setup-guides/xero)                           |
| Kleer             | Current Zwapgrid-managed setup                      | Kleer API access arranged with Kleer      | [Kleer](/client-portal/systems/setup-guides/kleer)                         |

**System Setting** means that you configure the credentials or connection options supported by that system. **Current Zwapgrid-managed setup** means that System Settings are not yet exposed for that system; follow the existing process until a client-managed setup becomes available or Zwapgrid agrees a migration with you.

## Shared testing checklist

For every system:

1. Use a test company that contains no real personal or financial data.
2. Configure the minimum permissions needed by your API.1 and Proxy.1 operations.
3. Create a Development Consent and complete the Onboarding Flow.
4. Test every read and write operation your product will use.
5. Record any vendor approval or reauthorisation requirements before production rollout.

The endpoint support matrix is maintained separately in [Systems in the grid](/systems-in-the-grid).

## Connect from your backend

See [Headless Onboarding (Preview)](/onboarding-flow/headless-onboarding) for the workflow and per-system authorization, request bodies and recovery. These setup guides remain the starting point for application registration and credentials.


# Billy

Prepare a Billy company and test its API.1 connection.

Billy is a Danish cloud-accounting product for small businesses. Billy does not yet expose a separate System Setting in the Zwapgrid Client Portal, so the current setup is Zwapgrid-managed.

| Item                        | Details                                                |
| --------------------------- | ------------------------------------------------------ |
| Client Portal configuration | No separate System Setting                             |
| Test option                 | A dedicated Billy company used only for testing        |
| Vendor access               | [Create a Billy account](https://www.billy.dk/signup/) |

## Before you start

Prepare a Billy company that does not contain live customer data. Add enough representative accounting data to test every API.1 operation your product uses.

If you need direct Billy API access outside the Zwapgrid connection, Billy documents how to create an [API access key](https://www.billy.dk/support/article/saadan-opretter-du-en-api-noegle-adgangsnoegle/). Do not send that key to Zwapgrid support.

## Connect the test company

1. In the Client Portal, enable Billy under **Systems**.
2. Create a Development Consent.
3. Generate an [Onboarding Flow](/onboarding-flow/onboarding-flow) link for the Consent.
4. Complete the flow with the Billy test company.
5. Use the Consent ID to test the required API.1 operations.

## Production checklist

* Use a new Production Consent for each company you connect.
* Confirm the Billy user completing onboarding can access the intended company.
* Test both empty and populated data sets where applicable.
* Keep any vendor access keys outside logs, tickets, and documentation.

{% hint style="info" %}
For connection problems, contact <support@zwapgrid.com> with the Consent ID, UTC timestamp, and correlation or request ID. Do not include credentials.
{% endhint %}


# Bjorn Lunden

Configure and test a Bjorn Lunden connection with API.1.

Bjorn Lunden provides accounting, invoicing, payroll, and tax products for small and medium-sized businesses. Set up new Bjorn Lunden integrations with a System Setting in the Zwapgrid Client Portal.

| Item                        | Details                                                            |
| --------------------------- | ------------------------------------------------------------------ |
| Client Portal configuration | Available                                                          |
| Test option                 | Sandbox supplied with the vendor integration                       |
| Vendor documentation        | [Bjorn Lunden Developer Portal](https://developer.bjornlunden.se/) |

## Before you start

You need a Bjorn Lunden integration with an App Client ID, App Client Secret, and access to a sandbox company. Request access through the [developer onboarding page](https://developer.bjornlunden.se/get-started/).

The application Client ID and Client Secret are separate from the company's Public Key (`User-Key`). Enter the application credentials in System Settings and the company's Public Key during onboarding.

List every API.1 and Proxy.1 operation your product will use before requesting permissions.

## Confirm vendor permissions

Bjorn Lunden manages permissions for your application. They are not selected in the Zwapgrid System Setting.

Contact [Bjorn Lunden API support](mailto:api.se@bjornlunden.com) with your application name, client ID, and the complete list of methods and endpoints you require. Include Proxy.1 calls in that list. Never include the client secret.

Changing application credentials does not copy permissions from the previous application. Ask Bjorn Lunden whether already connected companies must reactivate the integration after a change.

## Configure Zwapgrid

1. In the Client Portal, open **Systems → Bjorn Lunden → Configure**.
2. Create a clearly named System Setting.
3. Enter the App Client ID and App Client Secret supplied for your integration. Use the Client ID exactly as issued: it may be a GUID or the integration name. Endpoint selection is automatic; no authentication or API URL is required.
4. Save and review the Draft.
5. Publish the setting when vendor permissions have been confirmed.

See [System Settings](/client-portal/systems/system-settings) for lifecycle and Consent-selection rules.

## Test the connection

1. Add representative data to the sandbox company.
2. Create a Development Consent using the published setting.
3. Complete the [Onboarding Flow](/onboarding-flow/onboarding-flow).
4. Test every required read and write operation.
5. For a credential migration, validate one production company before moving the remaining connections.

## Troubleshooting

* **`502` authentication error from API.1:** An unexpected `401` from a Bjorn Lunden resource request is returned as `502`, and the consent remains active. Check the application credentials and company Public Key with Bjorn Lunden. Contact Zwapgrid support with the Consent ID, UTC timestamp, and request ID if they are correct. Proxy.1 preserves the provider's response status, including `401`.
* **Out of allowed scope:** Ask Bjorn Lunden to review the application and the full endpoint list together.
* **`403 Operation is forbidden` without details:** Contact [Zwapgrid support](mailto:support@zwapgrid.com) with the Consent ID, UTC timestamp, and correlation or request ID.

Never send client secrets, API keys, or access tokens in a support message.

## Headless onboarding (Preview)

To connect from your client backend, follow the [Björn Lundén headless onboarding guide (Preview)](/onboarding-flow/headless-onboarding/bjorn-lunden). It covers the required settings, provider-specific request body and recovery.


# Bokio

Create a Bokio test application and configure its Zwapgrid System Setting.

Bokio is a cloud-accounting product for small businesses. Zwapgrid uses a client-managed Bokio application, so publish a System Setting before onboarding a Bokio company.

| Item                        | Details                                                 |
| --------------------------- | ------------------------------------------------------- |
| Client Portal configuration | Required                                                |
| Test option                 | Test-mode application and Bokio test company            |
| Vendor documentation        | [Bokio developer documentation](https://docs.bokio.se/) |

## Create a Bokio test application

1. Sign in to the [Bokio Developer Portal](https://dev.bokio.se/).
2. Select **Create New Application**.
3. Enter a clear application name and description.
4. Register the callback URL provided by the Zwapgrid System Setting.
5. Select **Test mode** while developing.
6. Store the Client ID and Client Secret securely.

Bokio recommends testing public integrations in a test company. In Bokio, open the company menu and select **Create a test company**, then add representative data.

## Configure Zwapgrid

1. In the Client Portal, open **Systems → Bokio → Configure**.
2. Create a System Setting for the test application.
3. Enter the Bokio Client ID and Client Secret.
4. Verify that the callback URL matches the Bokio application exactly.
5. Save, review, and publish the setting.

See [System Settings](/client-portal/systems/system-settings) for the shared workflow and lifecycle rules.

## Test and move to production

1. Create a Development Consent using the published test setting.
2. Connect the Bokio test company through the [Onboarding Flow](/onboarding-flow/onboarding-flow).
3. Test all required API.1 and Proxy.1 operations.
4. Follow Bokio's production-app process when the integration is ready.
5. Create a separate Zwapgrid System Setting for production credentials.

{% hint style="warning" %}
Do not place real financial data in a Bokio test company. Bokio currently describes its API as beta, so review its documentation and changelog before production releases.
{% endhint %}


# Business Central

Register a Microsoft Entra application and configure Business Central in Zwapgrid.

Microsoft Dynamics 365 Business Central is a cloud ERP for financial and operational processes. Set up new integrations with an application registered in Microsoft Entra ID and stored in a Zwapgrid System Setting.

| Item                        | Details                                                                                                                         |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Client Portal configuration | Available                                                                                                                       |
| Test option                 | Business Central trial or sandbox environment                                                                                   |
| Vendor documentation        | [Business Central developer documentation](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/) |

## Prepare a test environment

Create a [Business Central trial](https://learn.microsoft.com/en-us/dynamics365/business-central/trial-signup) or use an existing sandbox environment. The sample CRONUS company can provide representative data for initial testing.

## Register the Microsoft Entra application

1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com/).
2. Open **Entra ID → App registrations** and create a registration.
3. For an integration offered to organisations in different Microsoft Entra tenants, select the multitenant organisational-directory account type.
4. Record the Application (client) ID.
5. Under **Certificates & secrets**, create a client secret and store its value securely. The value is shown only when it is created.
6. Under **API permissions**, add the required Dynamics 365 Business Central application permissions. The existing Zwapgrid connection requires `API.ReadWrite.All`.
7. Grant administrator consent and confirm that the permission status is granted.

Microsoft documents the general process in [Register an application in Microsoft Entra ID](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app).

## Configure Zwapgrid

1. In the Client Portal, open **Systems → Business Central → Configure**.
2. Create a System Setting with a name that identifies its environment and purpose.
3. Enter the Application (client) ID and client secret value.
4. Save, review, and publish the setting.

See [System Settings](/client-portal/systems/system-settings) for the shared workflow and lifecycle rules.

## Test and move to production

1. Create a Development Consent using the published setting.
2. Complete the [Onboarding Flow](/onboarding-flow/onboarding-flow) with the test tenant.
3. Confirm that tenant consent and Business Central permissions allow every required operation.
4. Test with a representative company and environment.
5. Before production, document who owns Entra application administration and client-secret rotation.

{% hint style="warning" %}
Creating an application registration does not by itself grant access to Business Central data. The required permissions and administrator consent must also be in place.
{% endhint %}

## Headless onboarding (Preview)

To connect from your client backend, follow the [Business Central headless onboarding guide (Preview)](/onboarding-flow/headless-onboarding/business-central). It covers the required settings, provider-specific request body and recovery.


# DATEV Online

Prepare a DATEV Online connection for API.1.

DATEV Online supports accounting-period reads and company-scoped Accounting Data Exchange access through API.1. Production access requires separate provider approval and configuration. Contact [Zwapgrid](mailto:hello@zwapgrid.com) to confirm the connection setup for your environment.

## Supported scope

API.1 provides `GET /accountingperiods` for the selected DATEV accounting dataset. Proxy.1 can access DATEV Accounting Data Exchange routes within that same dataset. Other DATEV products and typed invoice, payment, customer, supplier, and accounting-write endpoints are not part of this integration.

An Accounting Data Exchange `POST` can start an export job; it does not post accounting entries.

## Before you start

You need a DATEV application with access to the Accounting Data Exchange product and a company dataset eligible for its export service. Confirm the required application approval, product subscription, and dataset permissions with DATEV. A successful Sandbox connection does not establish production approval.

## Configure and test

1. Confirm with Zwapgrid that DATEV is enabled for your environment.
2. In the Client Portal, create and publish a DATEV System Setting with the application credentials for that environment. Keep Sandbox and production credentials in separate settings.
3. Create a Development Consent using the published setting and complete the DATEV connection flow. The customer selects the accounting dataset to authorize.
4. Test `GET /accountingperiods` and any required Accounting Data Exchange export routes through Proxy.1 against that dataset.

See [System Settings](/client-portal/systems/system-settings) for the setting lifecycle. For proxy path and response limits, see the [Proxy.1 overview](/proxy.1/proxy.1#datev-online).


# Exact Online

Register an Exact Online application and configure its Zwapgrid System Setting.

Exact Online is a cloud business-software platform with accounting and ERP functionality. Set up new Exact Online integrations with a System Setting in the Zwapgrid Client Portal.

| Item                        | Details                                                       |
| --------------------------- | ------------------------------------------------------------- |
| Client Portal configuration | Available                                                     |
| Test option                 | Exact Online Developer account and test administration        |
| Vendor information          | [Exact developer programme](https://www.exact.com/developers) |

## Before you start

Exact offers different products and regional environments. Confirm that your developer account, test administration, and application are created in the same country or region that you intend to test.

## Register an Exact Online application

1. Obtain Exact Online developer access for the relevant region.
2. Create or select a test administration.
3. Register an application in the Exact Online App Center.
4. Use the redirect URI displayed in the Zwapgrid System Setting.
5. Store the generated Client ID and Client Secret securely.
6. Confirm the application's scopes cover every API.1 and Proxy.1 operation you plan to use.

Exact's available subscription and application-management options can differ by market. Follow the regional instructions shown in your Exact account.

## Configure Zwapgrid

1. In the Client Portal, open **Systems → Exact Online → Configure**.
2. Create a System Setting for the Exact application.
3. Enter the Client ID and Client Secret.
4. Confirm that the registered redirect URI matches the value displayed by Zwapgrid.
5. Save, review, and publish the setting.

See [System Settings](/client-portal/systems/system-settings) for lifecycle and Consent-selection rules.

## Test and move to production

1. Create a Development Consent using the published setting.
2. Connect the test administration through the [Onboarding Flow](/onboarding-flow/onboarding-flow).
3. Test all required operations and company-selection behaviour.
4. Confirm Exact's current production and App Center requirements before customer rollout.
5. Use a separate production System Setting when the vendor issues different credentials.

{% hint style="info" %}
If the authorisation flow opens the wrong Exact region or cannot find the expected administration, first confirm the region of the Exact account and registered application.
{% endhint %}


# Fortnox

Create a Fortnox integration, select scopes, and configure Zwapgrid.

Fortnox is a Swedish cloud-accounting and business-administration platform. Set up new Fortnox integrations with a System Setting containing the application credentials and scopes.

| Item                        | Details                                                                             |
| --------------------------- | ----------------------------------------------------------------------------------- |
| Client Portal configuration | Available                                                                           |
| Test option                 | Fortnox developer sandbox                                                           |
| Vendor documentation        | [Fortnox Developer Portal guide](https://www.fortnox.se/developer/developer-portal) |

## Create a Fortnox integration

1. Register for [Fortnox developer access](https://apps.fortnox.se/integration-developer/signup).
2. In Fortnox, open **Menu → Developer Portal**.
3. Create an integration and select only the scopes your product requires.
4. Record the Client ID and Client Secret securely.
5. Create a sandbox in the developer portal and complete the invitation sent by Fortnox.

Fortnox documents its available permissions in [Scopes](https://www.fortnox.se/developer/guides-and-good-to-know/scopes).

## Configure Zwapgrid

1. In the Client Portal, open **Systems → Fortnox → Configure**.
2. Create a System Setting with a descriptive name.
3. Copy the redirect URI displayed by Zwapgrid to the Fortnox integration.
4. Select the scopes required by your API.1 and Proxy.1 operations.
5. Make sure the Zwapgrid scopes match the scopes registered in Fortnox.
6. Enter the Fortnox Client ID and Client Secret when using your own application.
7. Save, review, and publish the setting.

See [System Settings](/client-portal/systems/system-settings) for lifecycle and Consent-selection rules.

## Test and move to production

1. Add representative accounting data to the Fortnox sandbox.
2. Create a Development Consent using the published setting.
3. Complete the [Onboarding Flow](/onboarding-flow/onboarding-flow).
4. Test every required operation, including write operations where applicable.
5. Follow Fortnox's publication or private-integration process before onboarding production customers.

{% hint style="warning" %}
Adding scopes to an existing Fortnox application does not automatically grant them to previously activated customers. Those customers may need to reactivate the integration.
{% endhint %}

## Headless onboarding (Preview)

To connect from your client backend, follow the [Fortnox headless onboarding guide (Preview)](/onboarding-flow/headless-onboarding/fortnox). It covers the required settings, provider-specific request body and recovery.


# Procountor

Request a Procountor test environment and configure its Zwapgrid System Setting.

Finago Procountor is a cloud financial-management product used in the Nordic region. Set up new Procountor integrations through Zwapgrid System Settings.

| Item                        | Details                                              |
| --------------------------- | ---------------------------------------------------- |
| Client Portal configuration | Available                                            |
| Test option                 | Private environment on Procountor's testing server   |
| Vendor documentation        | [Procountor Developers](https://dev.procountor.com/) |

## Request a test environment

Submit Procountor's [testing-environment request](https://dev.procountor.com/contact/request-testing-environment/). Procountor supplies test credentials, a company, and the client credentials required by its OAuth flow.

The redirect URI is registered against the Procountor API client. It must not contain a query string. If it changes, contact Procountor with the client ID and replacement URI.

Do not enter real or customer-specific information in the Procountor test environment.

## Configure Zwapgrid

1. In the Client Portal, open **Systems → Procountor → Configure**.
2. Create a System Setting for the test client.
3. Enter the Procountor Client ID and Client Secret.
4. Confirm that the redirect URI registered by Procountor matches the value shown by Zwapgrid.
5. Save, review, and publish the setting.

See [System Settings](/client-portal/systems/system-settings) for lifecycle and Consent-selection rules.

## Test and move to production

1. Create a Development Consent using the published test setting.
2. Connect the Procountor test company through the [Onboarding Flow](/onboarding-flow/onboarding-flow).
3. Test all required endpoints and user permissions.
4. Review Procountor's [API certification checkpoints](https://dev.procountor.com/api-certification/).
5. Request production API credentials when the integration is ready.
6. Store production credentials in a separate Zwapgrid System Setting.

{% hint style="warning" %}
Procountor test and production environments use different server addresses and credentials. Do not reuse a test System Setting for production.
{% endhint %}

## Headless onboarding (Preview)

To connect from your client backend, follow the [Procountor headless onboarding guide (Preview)](/onboarding-flow/headless-onboarding/procountor). It covers the required settings, provider-specific request body and recovery.


# QuickBooks Online

Create an Intuit app and configure QuickBooks Online in Zwapgrid.

QuickBooks Online is Intuit's cloud-accounting product. Zwapgrid uses a client-managed Intuit application, so a published System Setting is required before onboarding a QuickBooks Online company.

| Item                        | Details                                                                                                      |
| --------------------------- | ------------------------------------------------------------------------------------------------------------ |
| Client Portal configuration | Required                                                                                                     |
| Test option                 | Intuit sandbox company                                                                                       |
| Vendor documentation        | [QuickBooks Online developer documentation](https://developer.intuit.com/app/developer/qbo/docs/get-started) |

## Create an Intuit app

1. Create or sign in to an [Intuit Developer](https://developer.intuit.com/) account.
2. In **My Hub → App dashboard**, create an application for QuickBooks Online.
3. Add the QuickBooks Online Accounting permission and any other permissions your integration requires.
4. Register the redirect URI displayed in the Zwapgrid System Setting.
5. Open **Keys and credentials** and store the development Client ID and Client Secret securely.

Intuit provides development credentials and sandbox companies for testing. Manage the companies from **My Hub → Sandboxes** and choose a region that represents your intended customers.

## Configure Zwapgrid

1. In the Client Portal, open **Systems → QuickBooks Online → Configure**.
2. Create a System Setting for the development application.
3. Enter the development Client ID and Client Secret.
4. Confirm that the registered redirect URI matches the value shown by Zwapgrid.
5. Save, review, and publish the setting.

See [System Settings](/client-portal/systems/system-settings) for lifecycle and Consent-selection rules.

## Test and move to production

1. Create a Development Consent using the published setting.
2. Connect an Intuit sandbox company through the [Onboarding Flow](/onboarding-flow/onboarding-flow).
3. Test company selection and every required API.1 or Proxy.1 operation.
4. Complete Intuit's current go-live requirements.
5. Create a separate System Setting with production credentials.

{% hint style="warning" %}
Do not use Intuit development credentials for production onboarding. Development and production credentials are managed separately.
{% endhint %}


# Tripletex

Prepare a Tripletex API test account and connect it through Zwapgrid.

Tripletex is a Norwegian cloud ERP with accounting and business-management functionality. Tripletex does not yet expose a separate System Setting in the Zwapgrid Client Portal, so the current setup is Zwapgrid-managed.

| Item                        | Details                                                                                 |
| --------------------------- | --------------------------------------------------------------------------------------- |
| Client Portal configuration | No separate System Setting                                                              |
| Test option                 | Tripletex API test account                                                              |
| Vendor documentation        | [Tripletex developer documentation](https://developer.tripletex.no/docs/documentation/) |

## Create a test account

Register for a [Tripletex API test account](https://developer.tripletex.no/docs/documentation/getting-started/1-creating-a-test-account/). The test environment is separate from production and supplies the credentials needed to access its user interface and API.

Store the tokens and application name shown during registration. Tripletex cannot recover them if they are lost. Do not put real or customer data in the test environment.

## Connect the test company

1. In the Client Portal, enable Tripletex under **Systems**.
2. Add representative data to the Tripletex test company.
3. Create a Development Consent.
4. Complete the [Onboarding Flow](/onboarding-flow/onboarding-flow) with the test account.
5. Use the Consent ID to test every required API.1 operation.

## Production checklist

* Treat Tripletex test and production accounts as separate environments.
* Confirm that the user completing onboarding has the required company access and entitlements.
* Validate the integration with a controlled production pilot before a broader rollout.
* Review Tripletex's current [authentication and token guidance](https://developer.tripletex.no/docs/documentation/authentication-and-tokens/) when troubleshooting vendor access.

{% hint style="info" %}
For a Zwapgrid connection problem, contact <support@zwapgrid.com> with the Consent ID, UTC timestamp, and correlation or request ID. Do not include tokens.
{% endhint %}


# Visma Dinero

Prepare a Dinero test company and connect it through Zwapgrid.

Dinero is a Danish cloud-accounting and invoicing product. Dinero does not yet expose a separate System Setting in the Zwapgrid Client Portal, so the current setup is Zwapgrid-managed.

| Item                        | Details                                                     |
| --------------------------- | ----------------------------------------------------------- |
| Client Portal configuration | No separate System Setting                                  |
| Test option                 | A dedicated Dinero company used only for testing            |
| Vendor documentation        | [Dinero API Developer Portal](https://developer.dinero.dk/) |

## Prepare a test company

Create a [Dinero account](https://dinero.dk/) for testing and add representative accounting data. Use a company that does not contain live customer information.

You do not need to register a separate Visma Connect application for the current Zwapgrid-managed setup. If System Settings become available, confirm the required vendor application and production-review process with Zwapgrid before migrating.

## Connect the test company

1. In the Client Portal, enable Visma Dinero under **Systems**.
2. Create a Development Consent.
3. Complete the [Onboarding Flow](/onboarding-flow/onboarding-flow) with the Dinero test company.
4. If the flow asks for a company identifier, use the organisation ID shown in the Dinero account.
5. Test every required API.1 operation.

## Production checklist

* Use a separate Production Consent for each connected company.
* Confirm that the Dinero user completing onboarding can access the intended organisation.
* Test date ranges and reporting periods that match your production use case.
* Review current Dinero API announcements before major integration releases.

{% hint style="info" %}
For connection problems, contact <support@zwapgrid.com> with the Consent ID, UTC timestamp, and correlation or request ID. Do not include credentials.
{% endhint %}


# Visma e-conomic

Prepare a Visma e-conomic demo agreement and test its Zwapgrid connection.

Visma e-conomic is a Danish cloud-accounting product. Visma e-conomic does not yet expose a separate System Setting in the Zwapgrid Client Portal, so the current setup is Zwapgrid-managed.

| Item                        | Details                                                    |
| --------------------------- | ---------------------------------------------------------- |
| Client Portal configuration | No separate System Setting                                 |
| Test option                 | e-conomic demo agreement                                   |
| Vendor documentation        | [e-conomic API documentation](https://apis.e-conomic.com/) |

## Prepare a demo agreement

Request an [e-conomic demo account](https://www.e-conomic.dk/regnskabsprogram/demo-alle) and choose a demo agreement with data when available. This provides representative accounting records without using a production agreement.

The e-conomic API also documents a limited demo authentication mode for direct vendor-API exploration. That mode is not a substitute for completing the Zwapgrid Onboarding Flow.

## Connect the demo agreement

1. In the Client Portal, enable Visma e-conomic under **Systems**.
2. Create a Development Consent.
3. Complete the [Onboarding Flow](/onboarding-flow/onboarding-flow) with the demo agreement.
4. Confirm that the correct agreement is selected when the user has access to more than one.
5. Test every required API.1 operation.

## Production checklist

* Create a separate Production Consent for each e-conomic agreement.
* Confirm that the onboarding user has access to the intended agreement.
* Test the operations and data ranges used by your product.
* Do not reuse demo credentials or data in production.

{% hint style="info" %}
For connection problems, contact <support@zwapgrid.com> with the Consent ID, UTC timestamp, and correlation or request ID. Do not include credentials.
{% endhint %}


# Visma Netvisor

Select the Netvisor production or sandbox integration and connect a company.

Netvisor is a Finnish cloud financial-management product. Netvisor System Settings select **Production** or **Sandbox (test)** while Zwapgrid manages the integration's partner credentials. You do not enter your own partner ID or partner key in these settings.

| Item                        | Details                                                                                                                                              |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Client Portal configuration | A name and a Netvisor environment: Production or Sandbox                                                                                             |
| Integration credentials     | Managed by Zwapgrid                                                                                                                                  |
| Test option                 | Netvisor partner test environment                                                                                                                    |
| Vendor documentation        | [Implementing a Netvisor integration](https://support.netvisor.fi/en/articles/766840-implementing-new-integration-and-netvisor-software-partnership) |

{% hint style="info" %}
This requires Netvisor environment selection to be available in your Zwapgrid deployment and the selected integration to be configured by Zwapgrid. If it is unavailable, contact support. A Development Consent alone does not select the Netvisor sandbox.
{% endhint %}

## Request a test environment

Netvisor provides test environments through its software-partner process. Register through the form linked in the vendor guide and request test access.

The environment is initially empty. Add representative data through the Netvisor user interface or ask Netvisor partner support about available test-data options. Never copy real customer data into the test environment.

## Connect the test company

1. In the Client Portal, enable Visma Netvisor under **Systems**.
2. Select **Configure** and create a System Setting with a descriptive name.
3. Open **Manage**, choose **Sandbox (test)**, and select **Save changes**. Review and publish the setting. Its environment cannot change after publication.
4. Create a Consent using this published setting. You can make it the client default before creating the Consent, or select it for this Consent. For an explicit selection in Quick Start, use the **Netvisor System Setting** field. For an explicit API selection, provide its ID in `systemsSettings`:

```json
{
  "name": "Netvisor sandbox connection",
  "systemsSettings": {
    "VismaNetvisor": "YOUR_PUBLISHED_SANDBOX_SETTING_ID"
  }
}
```

5. Complete the [Onboarding Flow](/onboarding-flow/onboarding-flow) with the Netvisor test company's user ID, API key and business ID. Use the integration search key displayed by that flow when granting Netvisor access.
6. Test every required API.1 and Proxy.1 operation and record the Netvisor interface-resource permissions your use case needs.

When Sandbox is the client default, new consents without an explicit Netvisor setting use Sandbox, including consents classified as Production. An explicit setting overrides the default. Changing the default does not change existing consents or connections.

Use the normal Zwapgrid production endpoints for both Netvisor Sandbox and Production connections.

## Consent type and Netvisor environment

A Consent's **Development/Production** classification and its **Netvisor environment** are separate choices. The public Consent API derives the classification from your API key; the Client Portal selects it when creating the Consent. The selected System Setting chooses the Netvisor integration independently of that classification.

Existing consents retain their existing integration. When using Zwapgrid's production endpoints, new consents with neither an explicit Netvisor setting nor a Netvisor client default use Netvisor Production. Creating a Sandbox setting or making it the client default does not move existing connections.

To change a connection's environment, create a new System Setting and a new Consent, then complete onboarding again. Do not reuse production company credentials in a sandbox connection.

## Connect a production company

Create a named Netvisor System Setting. Open **Manage**, choose **Production**, save the changes, then publish the setting. You can use it explicitly for a Consent or make it the client's default for new Netvisor consents. Production settings also use Zwapgrid-managed partner credentials.

* Confirm that the customer has activated the required Netvisor interface service.
* Confirm that the onboarding user can grant access to the required resources.
* Validate the integration with a controlled production pilot after sandbox testing.
* Review Netvisor's current production-validation requirements before rollout.

Support for supplying your own Netvisor partner credentials is not part of this setting. Environment choices for other Accounting Systems follow their own setup guides; this selector does not add sandbox support to every provider.

{% hint style="info" %}
For a Zwapgrid connection problem, contact <support@zwapgrid.com> with the Consent ID, UTC timestamp, and correlation or request ID. Do not include Netvisor identifiers or keys.
{% endhint %}

## Headless onboarding (Preview)

To connect from your client backend, follow the [Netvisor headless onboarding guide (Preview)](/onboarding-flow/headless-onboarding/netvisor). It covers the required settings, provider-specific request body and recovery.


# Visma Spiris

Configure Visma Spiris credentials and scopes in Zwapgrid.

Visma Spiris, previously known as Visma eAccounting and Visma Spcs, provides bookkeeping, invoicing, and payroll products. Set up new Spiris integrations with a System Setting in the Zwapgrid Client Portal.

| Item                        | Details                                                                                                             |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Client Portal configuration | Available                                                                                                           |
| Test option                 | Spiris partner sandbox                                                                                              |
| Vendor documentation        | [Spiris/eAccounting API documentation](https://developer.vismaonline.com/docs/spiris-eaccounting-api-documentation) |

## Register for partner access

Register through the [Spiris API sandbox form](https://selfservice.developer.vismaonline.com/). Spiris supplies the application credentials and a sandbox company by email.

Use the sandbox only for application development. It cannot access production customers and some connected services are mocked or unavailable.

## Choose permissions

List every API.1 and Proxy.1 operation your product will use. Select the minimum matching Spiris scopes, including the required API and offline-access scopes documented by Spiris.

Read the vendor's current [authentication and scope reference](https://developer.vismaonline.com/docs/authentication) before publishing your configuration.

## Configure Zwapgrid

1. In the Client Portal, open **Systems → Spiris → Configure**.
2. Create a System Setting for the sandbox application.
3. Enter the Spiris Client ID and Client Secret.
4. Select the scopes required by your integration and confirm they match the vendor registration.
5. Save, review, and publish the setting.

See [System Settings](/client-portal/systems/system-settings) for lifecycle and Consent-selection rules.

## Test and move to production

1. Create a Development Consent using the published sandbox setting.
2. Connect the sandbox company through the [Onboarding Flow](/onboarding-flow/onboarding-flow).
3. Test all required operations and retain any vendor error IDs for troubleshooting.
4. Contact Spiris API support when you are ready for production access.
5. Store production credentials in a separate Zwapgrid System Setting.

{% hint style="warning" %}
Never send the Spiris client secret to vendor or Zwapgrid support. Include the vendor error ID and client ID when required for troubleshooting.
{% endhint %}

## Headless onboarding (Preview)

To connect from your client backend, follow the [Spiris headless onboarding guide (Preview)](/onboarding-flow/headless-onboarding/spiris). It covers the required settings, provider-specific request body and recovery.


# Xero

Create a Xero OAuth app and configure its Zwapgrid System Setting.

Xero is a cloud-accounting platform used by small businesses and advisers. Zwapgrid uses a client-managed Xero application, so a published System Setting is required before onboarding a Xero organisation.

| Item                        | Details                                                                                       |
| --------------------------- | --------------------------------------------------------------------------------------------- |
| Client Portal configuration | Required                                                                                      |
| Test option                 | Xero demo company                                                                             |
| Vendor documentation        | [Xero getting-started guide](https://developer.xero.com/documentation/getting-started-guide/) |

## Prepare a demo company and application

1. Create or sign in to a Xero account.
2. From **My Xero**, enable the demo company and choose the appropriate country.
3. In [Xero My Apps](https://developer.xero.com/app/manage), create an OAuth 2.0 application using the authorization-code flow.
4. Register the redirect URI displayed in the Zwapgrid System Setting.
5. Store the Client ID and generated Client Secret securely.
6. Confirm the scopes required by every API.1 and Proxy.1 operation you will use.

The demo company contains sample data and can be reset. Xero resets demo-company data periodically, which can require the application connection to be created again.

## Configure Zwapgrid

1. In the Client Portal, open **Systems → Xero → Configure**.
2. Create a System Setting for the Xero application.
3. Enter the Client ID and Client Secret.
4. Confirm that the registered redirect URI matches the Zwapgrid value exactly.
5. Save, review, and publish the setting.

See [System Settings](/client-portal/systems/system-settings) for lifecycle and Consent-selection rules.

## Test and move to production

1. Create a Development Consent using the published setting.
2. Connect the Xero demo company through the [Onboarding Flow](/onboarding-flow/onboarding-flow).
3. Test organisation selection and every required operation.
4. Review Xero's current connection limits, plan requirements, and certification rules before customer rollout.
5. Create a separate System Setting if your production application uses different credentials.

## Headless onboarding from your backend (Preview)

Use the [Xero headless onboarding guide (Preview)](/onboarding-flow/headless-onboarding/xero) for backend authorization, organization selection, the connection request body and recovery. Register your backend callback for that flow; the Zwapgrid redirect URI above is for guided onboarding.

{% hint style="warning" %}
Request only the Xero scopes your product needs. Treat the client secret and OAuth tokens as credentials and never include them in support messages.
{% endhint %}


# Kleer

Set up a Zwapgrid-managed Kleer connection.

Kleer connections use the current Zwapgrid-managed setup. System Settings and custom scope selection are not available for Kleer.

## Before you start

You need the following from the Kleer company:

* An API token. The customer supplies this token.
* A positive Kleer company ID.

Contact [Kleer](https://api-doc.kleer.se/) to arrange API access before connecting the company.

## Connect Kleer

1. Create or open the relevant consent and choose Kleer in the onboarding flow.
2. Enter the API token and positive company ID.
3. Complete the connection and test the API.1 and Proxy.1 operations your product needs.

## Testing

Ask Kleer to arrange a dedicated test company and confirm its API host, token, and company ID. Confirm with Zwapgrid that the provided environment is supported before connecting it. Test access and credentials must be arranged with Kleer; do not assume a public, self-service sandbox.


# Connection Management

Connection management describes who owns and maintains the vendor application used when Your Customer connects an Accounting System.

For new integrations, use a [client-managed connection](/client-portal/systems/client-managed-connection) with [System Settings](/client-portal/systems/system-settings) whenever the Accounting System supports it. Your organisation owns the vendor application and controls its credentials, permissions, and lifecycle. Zwapgrid is moving toward this as the standard model across all systems.

A [Zwapgrid-managed connection](/client-portal/systems/zwapgrid-managed-connection) remains in use for systems that do not yet expose System Settings and for some existing integrations. It is the current fallback or an agreed exception, rather than an interchangeable setup choice.

Follow the relevant [System Setup Guide](/client-portal/systems/setup-guides) to see which process currently applies. Contact <support@zwapgrid.com> before changing the model for an existing production integration.


# Client-managed Connection

A client-managed connection offers a flexible approach where your organization directly controls and maintains the link between Your Customer's chosen systems and the Zwapgrid platform. While Your Customer still connects their system in the usual way, the ownership and ongoing management of that specific connection are handled by you.

Client-managed connections are configured through [System Settings](/client-portal/systems/system-settings) in the Client Portal. A System Setting stores the application credentials and options that Zwapgrid uses when Your Customer connects.

### How It Works

When your organization chooses a client-managed connection, you'll be responsible for configuring and maintaining the access to Your Customer's system, integrating it with Zwapgrid's secure infrastructure. This typically involves:

* Configuring Application Clients: For some systems, your organization will set up and manage the Application Clients that establish and maintain the connection to Your Customer's system.
* Utilizing Other Relevant Connection Methods: For other systems, your organization will configure and manage the specific connection protocols that depend on the system's requirements, ensuring reliable data flow to Zwapgrid.

***

#### Example: Visma Spiris

When Your Customer connects their Visma Spiris via a client-managed Connection, they will typically perform a straightforward authorization process within Visma eAccounting, granting the necessary permissions for data access. The key difference is that your organization will then be responsible for managing and maintaining this connection, ensuring that data, like invoices, flows smoothly from Your Customer's Visma eAccounting account to you via API.1.

Your Customer will see the following:

<figure><img src="https://2802285108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQCvVWgo58AdpQJMipzpD%2Fuploads%2FUWzUh5mP79Qc06irCLtM%2Fimage.png?alt=media&amp;token=514b5665-e98c-4b6a-a631-d883b3541716" alt=""><figcaption><p>Client-managed connection flow.</p></figcaption></figure>


# Zwapgrid-managed Connection

***

A Zwapgrid-managed connection uses an application configuration supplied and maintained by Zwapgrid. This setup remains in use for Accounting Systems that do not yet expose System Settings and for some existing integrations.

For new integrations, use a [client-managed connection](/client-portal/systems/client-managed-connection) with [System Settings](/client-portal/systems/system-settings) whenever the system supports it. Zwapgrid-managed and client-managed setups are not interchangeable options for every system; follow the relevant [System Setup Guide](/client-portal/systems/setup-guides).

### How It Works

When Your Customer connects a system, they share access through Zwapgrid's secure infrastructure. Depending on the Accounting System, this can involve:

* An application client registered and maintained by Zwapgrid.
* Another vendor-specific connection method maintained by Zwapgrid.

You do not create a separate System Setting for this setup. If System Settings later become available for the system, coordinate the migration with Zwapgrid before changing a production integration.

***

### Example: Visma Spiris

For an existing Zwapgrid-managed Visma Spiris integration, previously known as Visma eAccounting, Your Customer authorises access within Spiris. Zwapgrid's application configuration is then used to exchange the permitted data through API.1.

Your Customer will see the following:

<figure><img src="https://2802285108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQCvVWgo58AdpQJMipzpD%2Fuploads%2FWLAAgcxz6qtHKKDN90o1%2Fimage.png?alt=media&amp;token=2f87183d-ab00-446d-be35-92ba0bde59bc" alt=""><figcaption><p>Zwapgrid-managed connection flow.</p></figcaption></figure>


# Overview

{% hint style="info" %}
**What is the Onboarding Flow?**

The Onboarding Flow is how The Client invites Your Customer to connect their Accounting System and share their data with you via API.1.
{% endhint %}

The Onboarding Flow is available at <https://onboarding.zwapgrid.com>. You use a valid Consent ID and [One-Time Code](/onboarding-flow/one-time-code) to build the URL and invite Your Customer.

* [**Inviting Your Customer**](/onboarding-flow/inviting-your-customer) – Embed in an iframe, redirect from Your Platform, or use a direct link (with caveats).
* [**URL and parameters**](/onboarding-flow/url-and-parameters) – How to build the Onboarding Flow URL (Consent ID, OTC, redirect URL, redirect delay).
* [**One-Time Code**](/onboarding-flow/one-time-code) – Generating the OTC via the Consent API, validity, and URL encoding.
* [**Accounting Systems**](/onboarding-flow/accounting-systems) – Let Your Customer choose a system or deep link to a specific one; supported systems and IDs.

## Headless onboarding (Preview)

For a connection experience owned by your client backend, see [Headless Onboarding (Preview)](/onboarding-flow/headless-onboarding). The provider guides explain authorization, credential handover and recovery. The guided flow described above remains available.


# Inviting Your Customer

To establish a connection and retrieve data from Your Customer's Accounting System, you must invite them to use the [Onboarding Flow](/onboarding-flow/onboarding-flow). You can do this in several ways.

### Embed it within Your Platform

You can embed the Onboarding Flow in an iframe so that you control the size and layout of the flow, and the area outside the iframe (e.g. your app chrome or branding). Your Customer completes the flow without leaving Your Platform.

### Redirect to the Onboarding Flow

You can redirect Your Customer from Your Platform to the Onboarding Flow. When they finish, they can be redirected back to Your Platform automatically. Use the [redirect URL parameters](/onboarding-flow/url-and-parameters) to configure the return URL and delay.

### Direct link

If you share a link to the Onboarding Flow with Your Customer (e.g. via email), you should first direct them to Your Platform, where you create a new Consent, generate a [One-Time Code](/onboarding-flow/one-time-code), and then redirect them to the Onboarding Flow. Do not share a direct link via another channel (e.g. email) without this flow—the One-Time Code could expire or be consumed by link previews (e.g. email scanners, Slack), causing the link to fail.

{% hint style="danger" %}
Do not share a direct link to the Onboarding Flow except from within Your Platform. If you share a direct link via another method (e.g. email), the One-Time Code could expire or be invalidated by link previews, causing unexpected behaviour.
{% endhint %}


# URL and parameters

The Onboarding Flow is available at <https://onboarding.zwapgrid.com>. You build the URL using your Consent ID, a [One-Time Code](/onboarding-flow/one-time-code), and optional parameters for redirect behaviour.

### Base URL with required parameters

You must include the **Consent ID** and **One-Time Code** (OTC) in the URL. Generate the OTC via the Consent API—see [One-Time Code](/onboarding-flow/one-time-code).

```
https://onboarding.zwapgrid.com/consent/<Consent ID>/?otc=<one-time-code>
```

Replace `<Consent ID>` and `<one-time-code>` with your actual values. The One-Time Code must be [URL-encoded](/onboarding-flow/one-time-code) before use.

### Redirect back to Your Platform (optional)

To send Your Customer back to Your Platform when they finish the Onboarding Flow, add the `redirecturl` query parameter:

```
https://onboarding.zwapgrid.com/consent/<Consent ID>/?otc=<one-time-code>&redirecturl=<url>
```

Replace `<url>` with the URL in Your Platform where they should land (e.g. a success or dashboard page).

### Redirect delay (optional)

To control whether we redirect automatically and how long we wait before redirecting, add `redirectdelay` (in seconds):

```
https://onboarding.zwapgrid.com/consent/<Consent ID>/?otc=<one-time-code>&redirecturl=<url>&redirectdelay=<delay-in-seconds>
```

Use this when you want to show a completion message before the redirect.


# One-Time Code

To invite Your Customer to the [Onboarding Flow](/onboarding-flow/onboarding-flow) securely, you must generate a One-Time Code (OTC). You generate this secure, single-use code when inviting them; once it is used, it becomes invalid. Include the OTC in the Onboarding Flow URL—see [URL and parameters](/onboarding-flow/url-and-parameters) for the full URL format.

### Generating an OTC

Call the Consent API to generate an OTC; the response contains the One-Time Code. Use it in the [Onboarding Flow URL](/onboarding-flow/url-and-parameters) when embedding the flow, redirecting Your Customer, or building a direct link.

### URL encoding

The One-Time Code is not URL-encoded in the API response. **You must URL-encode it before including it in the Onboarding Flow URL.**

### Validity

A One-Time Code is **valid for one hour** from its creation. Use it by embedding the Onboarding Flow in Your Platform or by redirecting Your Customer to the flow from Your Platform. Avoid sharing the link via channels that generate link previews (e.g. email, Slack)—**the OTC is invalidated once it is consumed**, and previews can consume it so the link no longer works.

{% hint style="warning" %}
**OTC validity**

A One-Time Code is **valid for one hour** from its creation and is **single-use** (invalidated once consumed).
{% endhint %}


# Accounting Systems

Your Customer can either choose their Accounting System in the Onboarding Flow or be sent directly to a specific one. Build the URL using [URL and parameters](/onboarding-flow/url-and-parameters).

### Let them choose their Accounting System

If you want Your Customer to pick from the systems you support, use the standard Onboarding Flow URL. They will see a screen to choose any of the [supported systems](#supported-systems):

```
https://onboarding.zwapgrid.com/consent/<Consent ID>/?otc=<one-time-code>
```

### Direct link to a specific Accounting System

To send Your Customer straight to a specific Accounting System (or build your own system picker in Your Platform), deep link by adding the system ID to the path:

```
https://onboarding.zwapgrid.com/consent/<Consent ID>/<Accounting System>/?otc=<one-time-code>
```

Replace **Consent ID** and **Accounting System** with your values. Use the IDs in the [Supported Systems](#supported-systems) table below.

{% hint style="warning" %}
With this approach, you must create links to all of the accounting systems that you wish to offer support for.
{% endhint %}

### Supported Systems

You can use any of the IDs in the table below in the Onboarding Flow if you wish to invite Your Customer directly to a specific Accounting System.

| Accounting System | ID               |
| ----------------- | ---------------- |
| Test.1            | testone          |
| File.1            | fileone          |
| Fortnox           | fortnox          |
| Spiris            | spiris           |
| Bjorn Lunden      | bjornlunden      |
| Visma e‑conomic   | vismaeconomic    |
| Billy             | billy            |
| Visma Dinero      | vismadinero      |
| Finago Procountor | finagoprocountor |
| Visma Netvisor    | vismanetvisor    |
| Tripletex         | tripletex        |
| Business Central  | businesscentral  |
| Exact Online      | exactonline      |
| QuickBooks Online | quickbooks       |
| Xero              | xero             |
| Bokio             | bokio            |


# Headless Onboarding

Connect your customers' accounting systems from your backend.

Build your own onboarding experience and connect your customers' accounting systems through the Consent API.

Headless Onboarding is in **Preview**. See [what Preview means for your integration](/onboarding-flow/headless-onboarding/headless-onboarding#preview).

Start with the [overview](/onboarding-flow/headless-onboarding/headless-onboarding) for the shared steps, then follow your system's guide:

* [Fortnox](/onboarding-flow/headless-onboarding/fortnox)
* [Xero](/onboarding-flow/headless-onboarding/xero)
* [Business Central](/onboarding-flow/headless-onboarding/business-central)
* [Procountor](/onboarding-flow/headless-onboarding/procountor)
* [Spiris](/onboarding-flow/headless-onboarding/spiris)
* [Björn Lundén](/onboarding-flow/headless-onboarding/bjorn-lunden)
* [Netvisor](/onboarding-flow/headless-onboarding/netvisor)


# Overview

Connect your customers' accounting systems from your backend.

With headless onboarding, your application manages the connection screens for your customers. Your backend sends their authorization or credentials to the Consent API. Zwapgrid checks access, connects the accounting system and accepts the Consent.

This guide is for developers building that backend. In these guides, **you** means the client integrating with Zwapgrid; **your customer** means the company connecting its accounting system.

Your backend must complete three steps:

1. Create a Consent for your customer.
2. Obtain authorization or credentials for their accounting system.
3. Send one connection request to Zwapgrid.

After a successful response, you can optionally [check the connection and read accounting data](#optional-verify-the-connection).

For OAuth systems, your customer still signs in and approves access at the provider. Zwapgrid manages token refresh after the connection is complete. You can also use the [guided Onboarding Flow](/onboarding-flow/onboarding-flow) to let Zwapgrid host the connection screens.

## Preview

{% hint style="info" %}
Headless Onboarding is in **Preview**. The feature and its API may change or improve with short notice. Check the documentation when updating your integration.
{% endhint %}

## Before you start

You need:

* The accounting system enabled for your client in the Client Portal.
* A published [System Setting](/client-portal/systems/system-settings) for the application or provider environment you will use. Your system's guide explains the requirements and any supported defaults.

## Security

Keep each onboarding attempt bound to the correct customer session and Consent, and confirm that the selected company is the one your customer intends to connect. For OAuth, validate `state` at your backend callback before using the code. Keep credentials on your backend and never share them between customer sessions. Mixing sessions or credentials can connect the wrong company and expose its data.

## Choose your system

Each system has a different connection request. Open its guide for the exact steps and JSON body.

| System and guide                                                          | `source` value     | What you send                                                     | How the company is chosen                           |
| ------------------------------------------------------------------------- | ------------------ | ----------------------------------------------------------------- | --------------------------------------------------- |
| [Fortnox](/onboarding-flow/headless-onboarding/fortnox)                   | `fortnox`          | Unused authorization code and redirect URI                        | Your customer authorizes the company in Fortnox     |
| [Xero](/onboarding-flow/headless-onboarding/xero)                         | `xero`             | Access token, refresh token and tenant ID                         | Your backend selects an accessible organization     |
| [Business Central](/onboarding-flow/headless-onboarding/business-central) | `businesscentral`  | Access token, refresh token, tenant, environment and company      | Your backend selects an environment, then a company |
| [Procountor](/onboarding-flow/headless-onboarding/procountor)             | `procountor`       | Unused authorization code and redirect URI                        | Your customer selects the company in Procountor     |
| [Spiris](/onboarding-flow/headless-onboarding/spiris)                     | `vismaeaccounting` | Unused authorization code and redirect URI; PKCE verifier if used | Your customer selects the company in Spiris         |
| [Björn Lundén](/onboarding-flow/headless-onboarding/bjorn-lunden)         | `bjornlunden`      | Company public key                                                | The key identifies the company                      |
| [Netvisor](/onboarding-flow/headless-onboarding/netvisor)                 | `vismanetvisor`    | User identifier, customer key and business ID                     | The business ID identifies the company              |

## Set up the examples

Run the cURL examples on your backend. Replace placeholders such as `<consent-UUID>` with your own values. Set these variables before running a request:

| Variable                | Value to use                                                                                                                                                               |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CONSENTS_API_BASE_URL` | The Consent API base URL from the [API Reference](https://apidocs.zwapgrid.com/), without a trailing slash or `/api/v1`. Keep any gateway prefix included in the base URL. |
| `ZWAPGRID_API_KEY`      | Your backend API key for the selected client and environment.                                                                                                              |
| `CORRELATION_ID`        | A new non-empty UUID for each request. Also called a GUID; retain it to help trace requests with support.                                                                  |
| `CONSENT_ID`            | The Consent ID returned when you create a Consent in step 1.                                                                                                               |

Keep API keys, application secrets, codes and tokens on your backend. Exclude OAuth callback query parameters from logs and redirect to a clean URL after processing. Never include credentials in browser storage or support messages.

The examples read JSON from a file. Restrict the file to your backend user and delete it when finished. In your application, use protected memory or secret storage for credentials.

## 1. Create a Consent

Create one new Consent for the company you want to connect. Use the same client and API-key environment for Consent creation, connection creation and accounting reads.

Select your published setting in `systemsSettings`, using the `source` value from the table above. For example, save this Fortnox request as `consent.json`:

```json
{
  "name": "Headless onboarding",
  "systemsSettings": {
    "fortnox": "<published-system-settings-UUID>"
  }
}
```

Then send it:

```sh
curl --include --request POST \
  "$CONSENTS_API_BASE_URL/api/v1/consents" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID" \
  --header 'Content-Type: application/json' \
  --data-binary @consent.json
```

The response is HTTP **201**. Take the Consent ID from the response's `Location` header and set `CONSENT_ID` to that ID.

The setting must be Published and belong to your client and accounting system. Fortnox, Xero, Business Central, Procountor and Spiris require you to select your application's setting on the Consent. For Björn Lundén and Netvisor, follow the guide if you intend to use a default. Choose settings here, before creating the connection.

See [Create Consent](/client-portal/consents/create-consent) for more details. The Consent must still have status `Created` and no existing connection when you submit credentials.

## 2. Follow your system's authorization steps

Open your [system guide](#choose-your-system) and complete its authorization or credential-collection steps. It explains what you must do and what Zwapgrid handles.

For OAuth, your backend must check the callback's `state` value against a random, expiring value stored for that customer's session and Consent. This confirms that the callback belongs to the connection you started.

* **Fortnox, Procountor and Spiris:** send the unused code to Zwapgrid. Zwapgrid exchanges it for tokens.
* **Xero and Business Central:** your backend exchanges the code and selects the company first, then sends tokens and the selected company details to Zwapgrid.
* **Björn Lundén and Netvisor:** collect the company credentials described in the guide. There is no customer OAuth callback.

## 3. Send the connection request

Use the JSON body and cURL command in your system guide to call:

```
POST /api/v1/consents/{consentId}/connection
```

Use your `x-api-key`, a new UUID in `x-correlation-id`, and `Content-Type: application/json`. Send only the documented fields. The maximum body size is 16 KiB; query parameters and additional fields are rejected. Application secrets stay in System Settings.

Send the request **once**. Turn off automatic retries for this POST, including retries after timeouts. If you cannot tell whether it succeeded, check the connection as described below.

A successful response is HTTP **201** with this body and `Cache-Control: no-store`:

```json
{
  "id": "<connection-UUID>",
  "source": "<submitted-source>",
  "state": "completed"
}
```

Zwapgrid has completed the connection and accepted the Consent. It does not return credentials or tokens. A connection request cannot replace an existing connection.

## Optional: Verify the connection

After a successful HTTP 201 response, no additional request is needed to complete headless onboarding. You can use the GET below to check the connection. Use this same GET to recover the result if the POST response is lost.

Set a new `CORRELATION_ID`, then read the connection:

```sh
curl --request GET \
  "$CONSENTS_API_BASE_URL/api/v1/consents/$CONSENT_ID/connection" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID"
```

HTTP **200** returns the same `id`, `source` and `state: completed`. Check that they match the connection you created.

You can also [read accounting data](/get-started/access-your-customer-data) using that Consent to verify data access. This is optional and is not required to complete headless onboarding.

## If the result is uncertain

If POST times out or you lose its response:

1. **Do not submit the credentials again.** Run the [connection GET above](#optional-verify-the-connection) for the same Consent.
2. If GET returns **200** with the expected completed connection, onboarding is complete.
3. If it returns **404**, confirm the Consent ID, client and API-key environment. A missing connection does not mean a code is unused or a refresh token is still valid.
4. If you still cannot confirm the result, contact [Zwapgrid support](mailto:support@zwapgrid.com) with the Consent ID, UTC timestamp and correlation IDs for both requests. For OAuth systems, authorize again if you cannot confirm whether the code or tokens are still usable.

For **Xero and Business Central**, stop any refresh running in your backend and wait for it to finish **before** submitting tokens. Keep it stopped while checking an uncertain result. After success, let Zwapgrid refresh this authorization; do not refresh it yourself or use the same refresh tokens for another connection.

Authorization codes can be used once, and a refresh can replace the submitted refresh token before a later step fails. This is why repeating a POST after a lost response is unsafe. The correlation ID helps trace requests; it does not make repeated requests safe. Send one connection request at a time for a Consent.

## Common errors

| HTTP status     | What to do                                                                                                                            |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| 400             | Check the request fields, selected settings and access to the selected company. For a used or expired OAuth code, authorize again.    |
| 401 / 403       | Check your API key and whether the system is enabled for your client.                                                                 |
| 404             | Check the Consent ID, client and API-key environment. After an uncertain POST, follow the recovery steps above.                       |
| 409             | Check the Consent's current status and connection. It may already be linked, inactive or have another connection request in progress. |
| 413             | Keep the body within 16 KiB and use only the fields in your system's example.                                                         |
| 429             | Wait before reading again, following any retry guidance. Do not automatically repeat a connection POST.                               |
| 502 / 503 / 504 | Check the connection with GET and retain correlation IDs for support.                                                                 |

## API reference

See the [API Reference](https://apidocs.zwapgrid.com/) for Consent and Accounting operations, including connection creation and recovery. Use these guides for the complete onboarding workflow and system-specific examples.


# Fortnox

Complete Fortnox onboarding from your client backend.

**Preview** · [What this means for your integration](/onboarding-flow/headless-onboarding/headless-onboarding#preview)

Your backend sends an unused Fortnox authorization code and your registered callback URL. **Zwapgrid exchanges the code and manages token refresh.**

First, complete the [shared prerequisites and example setup](/onboarding-flow/headless-onboarding/headless-onboarding#before-you-start).

## What you need

* Your own Fortnox application, with the permissions your integration needs. See the [Fortnox setup guide](/client-portal/systems/setup-guides/fortnox).
* A Published Fortnox System Setting containing that application's client ID and secret, belonging to your Zwapgrid client.
* Your backend callback URL registered on the Fortnox application. Use this exact URL when starting authorization and submitting the code.

The Zwapgrid callback in the setup guide is for guided onboarding. Keep it if you also use that flow; confirm Fortnox's callback options or register a separate application for headless use. Headless onboarding requires your own application credentials.

## 1. Prepare the connection

{% hint style="info" %}
PKCE is not currently supported for Fortnox headless onboarding. Support is planned. For now, start authorization without a PKCE challenge and do not send `codeVerifier` in the connection request.
{% endhint %}

1. Use the [Consent created in the shared workflow](/onboarding-flow/headless-onboarding/headless-onboarding#1-create-a-consent). Make sure `systemsSettings.fortnox` contains your published setting ID.
2. Start Fortnox authorization at `https://apps.fortnox.se/oauth-v1/auth` with `response_type=code`, `access_type=offline`, your application's `client_id`, registered `redirect_uri`, required `scope` and random, expiring `state` bound to the session and Consent. Offline access lets Zwapgrid refresh tokens when your customer is not signed in.
3. The customer signs in and authorizes the intended company. Validate `state` at your callback and retain the unused code briefly on your backend. Do not exchange it yourself.
4. Submit the code and exact redirect URI once. Zwapgrid exchanges the code using the selected application and completes the connection; no additional Zwapgrid company-selection call is needed.

## 2. Send the request

```json
{
  "source": "fortnox",
  "credentials": {
    "authorizationCode": "<unused-authorization-code>",
    "redirectUri": "https://client.example/fortnox/callback"
  }
}
```

Both fields are required and limited to 2048 characters each. Use an absolute HTTPS redirect URI without a fragment or user information; HTTP loopback is accepted for local development. Do not include token, tenant, company or PKCE fields.

Replace the placeholders and save this body as a protected `connection.json` on your backend. Set the [example variables](/onboarding-flow/headless-onboarding/headless-onboarding#set-up-the-examples), including a new UUID in `CORRELATION_ID`, then send the request once:

```sh
curl --request POST \
  "$CONSENTS_API_BASE_URL/api/v1/consents/$CONSENT_ID/connection" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID" \
  --header 'Content-Type: application/json' \
  --data-binary @connection.json
```

## 3. Check the result

Expect HTTP 201 with `source: fortnox` and `state: completed`. [Optionally verify the connection](/onboarding-flow/headless-onboarding/headless-onboarding#optional-verify-the-connection). Zwapgrid owns token refresh after completion.

Codes are single-use: submit promptly and never automatically retry. After an uncertain outcome, use GET. A GET 404 does not mean the code is safe to reuse; if you cannot confirm the result, authorize again to get a fresh code.


# Xero

Complete Xero onboarding from your client backend.

**Preview** · [What this means for your integration](/onboarding-flow/headless-onboarding/headless-onboarding#preview)

Your backend completes Xero authorization, selects an organization and sends its tokens and tenant ID. **Zwapgrid checks access and takes over token refresh.**

First, complete the [shared prerequisites and example setup](/onboarding-flow/headless-onboarding/headless-onboarding#before-you-start).

## What you need

* Your own Xero OAuth web application. See the [Xero setup guide](/client-portal/systems/setup-guides/xero).
* A Published Xero System Setting containing that application's client ID and secret, belonging to your Zwapgrid client.
* The same client ID and secret available securely to your backend for code exchange.
* Your backend callback URL registered on the Xero application. Use this URL for headless authorization; keep the guided callback if you also use guided onboarding.

## 1. Prepare the connection

1. Use the [Consent created in the shared workflow](/onboarding-flow/headless-onboarding/headless-onboarding#1-create-a-consent). Make sure `systemsSettings.xero` contains your published setting ID.
2. Start Xero's authorization-code flow at `https://login.xero.com/identity/connect/authorize` with `response_type=code`, your application's `client_id`, registered backend callback, `openid`, `offline_access`, the accounting scopes your operations require, and random, expiring session/Consent-bound `state`.
3. Validate callback state and exchange the code in your backend at `https://identity.xero.com/connect/token`. Send a form-encoded POST with `grant_type=authorization_code`, the code and exact `redirect_uri`, authenticating with HTTP Basic using your application's client ID and secret.
4. Call `GET https://api.xero.com/connections` with the resulting bearer access token. Choose an accessible entry with `tenantType: ORGANISATION`. You can select the sole organization automatically, or ask the customer to choose when several are available. Use its `tenantId`, not the Xero connection `id`.
5. If your backend is refreshing these tokens, stop it and wait for any refresh in progress to finish. Send the latest tokens and selected tenant ID once. Keep your refresh process stopped until you confirm the result.

See [Xero's authorization-code flow](https://developer.xero.com/documentation/guides/oauth2/auth-flow/) for provider authorization and token requests.

## 2. Send the request

```json
{
  "source": "xero",
  "credentials": {
    "accessToken": "<latest-access-token>",
    "refreshToken": "<latest-refresh-token>",
    "tenantId": "<selected-organization-UUID>"
  }
}
```

All three fields are required. Access tokens are limited to 8192 characters and refresh tokens to 4096 characters. `tenantId` must be a non-empty UUID. Do not send the authorization code, redirect URI, PKCE verifier or application secret.

Send both tokens for the selected organization. Zwapgrid verifies access before completing the connection. Your customer does not need to authorize again or choose an organization in Zwapgrid.

Replace the placeholders and save this body as a protected `connection.json` on your backend. Set the [example variables](/onboarding-flow/headless-onboarding/headless-onboarding#set-up-the-examples), including a new UUID in `CORRELATION_ID`, then send the request once:

```sh
curl --request POST \
  "$CONSENTS_API_BASE_URL/api/v1/consents/$CONSENT_ID/connection" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID" \
  --header 'Content-Type: application/json' \
  --data-binary @connection.json
```

## 3. Check the result

Expect HTTP 201 with `source: xero` and `state: completed`. [Optionally verify the connection](/onboarding-flow/headless-onboarding/headless-onboarding#optional-verify-the-connection).

After confirmed success, Zwapgrid owns refresh. Let Zwapgrid manage refresh for this authorization. Do not keep refreshing it in your backend or submit its tokens for another connection. If POST is uncertain, keep refresh paused and recover with GET. A missing result does not prove the submitted refresh token is usable. Authorize again if you cannot confirm whether the tokens are still valid; do not resubmit old tokens.


# Business Central

Complete Business Central onboarding from your client backend.

**Preview** · [What this means for your integration](/onboarding-flow/headless-onboarding/headless-onboarding#preview)

Your backend completes Microsoft authorization and selects a tenant, environment and company. You send the tokens and that selection to Zwapgrid. **Zwapgrid checks access and takes over token refresh.**

First, complete the [shared prerequisites and example setup](/onboarding-flow/headless-onboarding/headless-onboarding#before-you-start).

## What you need

* A Microsoft Entra confidential **web application**: an application whose secret is kept on your backend. See the [Business Central setup guide](/client-portal/systems/setup-guides/business-central) for registration and test access.
* A Published Business Central System Setting containing that application's ID and secret, belonging to your Zwapgrid client. Your backend also needs those credentials for code exchange.
* Your backend callback registered as a **Web** redirect in Entra.
* Delegated `https://api.businesscentral.dynamics.com/user_impersonation` and `offline_access` permissions. The authorizing user must be able to discover environments, list companies and read the accounting data you need.

For this headless flow, configure the delegated permissions above even if you already followed the setup guide's application-permission instructions. Register a Web callback so your backend can receive a refresh token suitable for ongoing access.

## 1. Prepare the connection

1. Use the [Consent created in the shared workflow](/onboarding-flow/headless-onboarding/headless-onboarding#1-create-a-consent). Make sure `systemsSettings.businesscentral` contains your published setting ID.
2. Start Microsoft authorization using the authorization URL below, your application ID, registered callback, delegated scopes and the `state` value described in the [shared workflow](/onboarding-flow/headless-onboarding/headless-onboarding#2-follow-your-systems-authorization-steps).
3. At your callback, validate `state` and exchange the code on your backend using the token URL below. Keep the access token and the latest refresh token.
4. Call `GET https://api.businesscentral.dynamics.com/environments/v1.2` with the bearer access token. Select an environment. Keep its `aadTenantId` as `tenantId` and its `name` as `environment`.
5. List companies with `GET https://api.businesscentral.dynamics.com/v2.0/{tenantId}/{environment}/api/v2.0/companies`. URL-encode the environment path segment. Select the company's `id` as `companyId`. If you change environments, select a company again from the new environment.
6. If your backend is refreshing these tokens, stop it and wait for any refresh in progress to finish. Send the latest tokens and selected company details once. Keep your refresh process stopped while Zwapgrid handles the request or you check its result.

Use these Microsoft endpoints:

| Request                 | URL and parameters                                                                                                                                                                               |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Authorization (browser) | `https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize` with `response_type=code`, `client_id`, `redirect_uri`, `scope` and `state`.                                             |
| Code exchange (backend) | Form-encoded POST to `https://login.microsoftonline.com/organizations/oauth2/v2.0/token` with `grant_type=authorization_code`, `code`, `redirect_uri`, `scope`, `client_id` and `client_secret`. |

## 2. Send the request

```json
{
  "source": "businesscentral",
  "credentials": {
    "accessToken": "<latest-delegated-access-token>",
    "refreshToken": "<latest-refresh-token>",
    "tenantId": "<selected-Entra-tenant-UUID>",
    "environment": "<selected-environment-name>",
    "companyId": "<selected-company-UUID>"
  }
}
```

Every field is required. Access tokens are limited to 8192 characters, refresh tokens to 4096, and environment names to 100 letters, digits, underscores or hyphens. Tenant and company IDs must be non-empty UUIDs. Do not send the application secret, code, redirect URI, PKCE verifier or setting ID.

Zwapgrid refreshes the tokens using your selected application and checks access to the exact tenant, environment and company before saving the connection.

Replace the placeholders and save this body as a protected `connection.json` on your backend. Set the [example variables](/onboarding-flow/headless-onboarding/headless-onboarding#set-up-the-examples), including a new UUID in `CORRELATION_ID`, then send the request once:

```sh
curl --request POST \
  "$CONSENTS_API_BASE_URL/api/v1/consents/$CONSENT_ID/connection" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID" \
  --header 'Content-Type: application/json' \
  --data-binary @connection.json
```

## 3. Check the result

Expect HTTP 201 with `source: businesscentral` and `state: completed`. [Optionally verify the connection](/onboarding-flow/headless-onboarding/headless-onboarding#optional-verify-the-connection) against the selected company.

Zwapgrid owns refresh after confirmed creation. Do not keep refreshing these tokens in your backend or submit them for another connection. After an uncertain response, keep refresh paused and use GET. A missing connection does not prove the submitted refresh token remains current; authorize again if you cannot confirm whether the tokens are still valid.


# Procountor

Complete Procountor onboarding from your client backend.

**Preview** · [What this means for your integration](/onboarding-flow/headless-onboarding/headless-onboarding#preview)

Your customer selects the company in Procountor. Your backend sends the unused authorization code and callback URL. **Zwapgrid exchanges the code and manages token refresh.**

First, complete the [shared prerequisites and example setup](/onboarding-flow/headless-onboarding/headless-onboarding#before-you-start).

## What you need

* Your own Procountor application and access to a supported company in Sweden, Denmark or Finland. See the [Procountor setup guide](/client-portal/systems/setup-guides/procountor).
* A Published Procountor System Setting containing that application's client ID and secret, belonging to your Zwapgrid client.
* A backend callback registered for that application, without a query string. Procountor registers one callback per application: use a separate application if your existing one is used for guided onboarding.
* Confirmation from Zwapgrid of which Procountor host to use: `https://pts-api.procountor.com` for test or `https://api.procountor.com` for live. Authorization, code exchange and refresh must use the same host.

## 1. Prepare the connection

1. Use the [Consent created in the shared workflow](/onboarding-flow/headless-onboarding/headless-onboarding#1-create-a-consent). Make sure `systemsSettings.procountor` contains your published setting ID.
2. Start authorization at the selected provider host's `/login` route with `response_type=code`, your `client_id`, registered `redirect_uri` and random, expiring session/Consent-bound `state`.
3. The customer logs in, selects the company and approves access in Procountor. Validate callback state on your backend; do not exchange the returned code.
4. Submit the unused code and exact redirect URI promptly, within its five-minute lifetime. Zwapgrid exchanges it and verifies company access and a supported company country (SE, DK or FI). No additional company selection is needed.

This flow requires a user who can sign in and select a company. Procountor API-login-only users need its separate machine-to-machine (M2M) flow. See [Procountor authentication](https://dev.procountor.com/api-authentication/).

## 2. Send the request

```json
{
  "source": "procountor",
  "credentials": {
    "authorizationCode": "<unused-authorization-code>",
    "redirectUri": "https://client.example/procountor/callback"
  }
}
```

Both fields are required, at most 2048 characters each. Redirects must be HTTPS (HTTP loopback is accepted locally), with no query, fragment or user information. Do not send tokens, tenant/company/environment fields or a PKCE verifier.

Replace the placeholders and save this body as a protected `connection.json` on your backend. Set the [example variables](/onboarding-flow/headless-onboarding/headless-onboarding#set-up-the-examples), including a new UUID in `CORRELATION_ID`, then send the request once:

```sh
curl --request POST \
  "$CONSENTS_API_BASE_URL/api/v1/consents/$CONSENT_ID/connection" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID" \
  --header 'Content-Type: application/json' \
  --data-binary @connection.json
```

## 3. Check the result

Expect HTTP 201 with `source: procountor` and `state: completed`. [Optionally verify the connection](/onboarding-flow/headless-onboarding/headless-onboarding#optional-verify-the-connection). Zwapgrid uses the selected application for token refresh.

Submit once. A GET 404 does not mean the code is safe to reuse. If you cannot confirm the result, authorize again; never automatically replay the code.


# Spiris

Complete Spiris onboarding from your client backend.

**Preview** · [What this means for your integration](/onboarding-flow/headless-onboarding/headless-onboarding#preview)

Your customer selects the company in Spiris. Your backend sends the unused authorization code and callback URL, plus a PKCE verifier if used. **Zwapgrid exchanges the code and manages token refresh.**

First, complete the [shared prerequisites and example setup](/onboarding-flow/headless-onboarding/headless-onboarding#before-you-start).

## What you need

* Your own Spiris application and the scopes your integration needs. See the [Spiris setup guide](/client-portal/systems/setup-guides/visma-eaccounting).
* A Published Spiris System Setting containing that application's ID and secret, belonging to your Zwapgrid client.
* Your exact backend callback registered for the application. Keep any guided callback you use; confirm the provider's registration limits or use a separate application.
* Confirmation of whether your registered application uses **PKCE**, an OAuth check that links the authorization request to the code exchange. If it does, follow the PKCE instructions below.

## 1. Prepare the connection

1. Use the [Consent created in the shared workflow](/onboarding-flow/headless-onboarding/headless-onboarding#1-create-a-consent). Make sure `systemsSettings.vismaeaccounting` contains your published setting ID.
2. Start authorization at `https://identity.vismaonline.com/connect/authorize` with `response_type=code`, your `client_id`, exact `redirect_uri`, required `scope`, random expiring session/Consent-bound `state` and `prompt=select_account` for deliberate company selection. Include `acr_values=service:44643EB1-3F76-4C1C-A672-402AE8085934` to filter the selector to companies with access to the accounting product.
3. Request `ea:api`, `offline_access` and sales/purchase/accounting permissions appropriate to your operations; read-only variants can be used for reads.
4. If your registered application uses PKCE, generate and retain a verifier on your backend, send its S256 challenge in the authorization request and include that original verifier when sending the code to Zwapgrid.
5. The customer signs in, deliberately selects the company and approves access. Validate callback state; retain the unused code without exchanging it.
6. Submit once within five minutes, with the exact redirect URI and matching verifier when PKCE was used. Zwapgrid exchanges the code and verifies company settings/product access before completing the connection.

See [Spiris authentication](https://developer.vismaonline.com/docs/authentication) for provider parameters and application requirements.

## 2. Send the request

```json
{
  "source": "vismaeaccounting",
  "credentials": {
    "authorizationCode": "<unused-authorization-code>",
    "redirectUri": "https://client.example/spiris/callback"
  }
}
```

The code and redirect URI are required, at most 2048 characters each. Use HTTPS (HTTP loopback is accepted locally), without fragments or user information. Do not send tokens or company/tenant/environment fields.

When authorization used PKCE, add `codeVerifier` inside `credentials` with the exact original verifier. It must contain 43–128 ASCII letters, digits or `-._~`. Omitted, null or empty means no PKCE verifier; whitespace-only values are invalid. Do not omit the verifier when authorization used PKCE. Other ERP sources do not accept this field.

For PKCE authorization, the complete body is:

```json
{
  "source": "vismaeaccounting",
  "credentials": {
    "authorizationCode": "<unused-authorization-code>",
    "redirectUri": "https://client.example/spiris/callback",
    "codeVerifier": "<matching-original-PKCE-verifier>"
  }
}
```

Choose the body that matches your authorization, replace the placeholders and save it as a protected `connection.json` on your backend. Set the [example variables](/onboarding-flow/headless-onboarding/headless-onboarding#set-up-the-examples), including a new UUID in `CORRELATION_ID`, then send the request once:

```sh
curl --request POST \
  "$CONSENTS_API_BASE_URL/api/v1/consents/$CONSENT_ID/connection" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID" \
  --header 'Content-Type: application/json' \
  --data-binary @connection.json
```

## 3. Check the result

Expect HTTP 201 with `source: vismaeaccounting` and `state: completed`. [Optionally verify the connection](/onboarding-flow/headless-onboarding/headless-onboarding#optional-verify-the-connection). Zwapgrid owns refresh using the selected application.

Codes are single-use. A GET 404 does not mean the code is safe to reuse. If the company check fails after code exchange, or you cannot confirm the result, authorize again with a fresh code and a new PKCE verifier if used. Do not automatically repeat the connection request.


# Björn Lundén

Complete Björn Lundén onboarding from your client backend.

**Preview** · [What this means for your integration](/onboarding-flow/headless-onboarding/headless-onboarding#preview)

Your backend sends the public key for the company you want to connect. **Zwapgrid checks company access and completes the connection.** No customer OAuth login is required for this request.

First, complete the [shared prerequisites and example setup](/onboarding-flow/headless-onboarding/headless-onboarding#before-you-start).

## What you need

* Application access and permissions for the accounting operations you need. See the [Björn Lundén setup guide](/client-portal/systems/setup-guides/bjorn-lunden).
* The public key of the company to connect, obtained through the provider setup process. The company must have enabled your integration.
* A Published Björn Lundén System Setting with valid application ID and secret, belonging to your Zwapgrid client, or a default that Zwapgrid has confirmed your client can use.

Select the published setting on your Consent for an explicit application choice. If you omit the selection, confirm the configured default with Zwapgrid first. An invalid selected setting is rejected.

## 1. Prepare the connection

1. Use the [Consent created in the shared workflow](/onboarding-flow/headless-onboarding/headless-onboarding#1-create-a-consent). If selecting settings explicitly, set `systemsSettings.bjornlunden` to their published ID.
2. Obtain the public key for the exact company to connect. Your backend does not exchange a customer OAuth code.
3. Submit the key once. Zwapgrid checks access to the company identified by the key and confirms that the integration is enabled. No separate company-selection request is needed.

## 2. Send the request

```json
{
  "source": "bjornlunden",
  "credentials": {
    "companyPublicKey": "<company-public-key>"
  }
}
```

`companyPublicKey` is required and must contain 1–256 ASCII letters, digits, hyphens or underscores. Do not send application credentials, codes, redirect URIs, tokens or tenant/environment/company fields. Treat the public key as a credential.

Replace the placeholders and save this body as a protected `connection.json` on your backend. Set the [example variables](/onboarding-flow/headless-onboarding/headless-onboarding#set-up-the-examples), including a new UUID in `CORRELATION_ID`, then send the request once:

```sh
curl --request POST \
  "$CONSENTS_API_BASE_URL/api/v1/consents/$CONSENT_ID/connection" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID" \
  --header 'Content-Type: application/json' \
  --data-binary @connection.json
```

## 3. Check the result

Expect HTTP 201 with `source: bjornlunden` and `state: completed`. [Optionally verify the connection](/onboarding-flow/headless-onboarding/headless-onboarding#optional-verify-the-connection) for that company.

Do not automatically replay a credential submission after an uncertain outcome. Use GET first and contact support if you cannot confirm the result. For rejected access, confirm the company's integration activation and the application's vendor permissions before a new attempt. Zwapgrid manages application authentication; your backend does not need a customer refresh token.


# Netvisor

Complete Netvisor onboarding from your client backend.

**Preview** · [What this means for your integration](/onboarding-flow/headless-onboarding/headless-onboarding#preview)

Your backend sends the Netvisor user identifier, customer key and business ID. **Zwapgrid checks company access and completes the connection.** No customer OAuth login is required for this request.

First, complete the [shared prerequisites and example setup](/onboarding-flow/headless-onboarding/headless-onboarding#before-you-start).

## What you need

* The company's **user identifier**, **customer key** and **Finnish business ID**. These are the three values your backend will submit.
* Netvisor interface access enabled for the company and access granted to the intended Zwapgrid integration. Ask Zwapgrid for its integration search key if needed during setup.
* A Published Netvisor System Setting for **Sandbox** or **Production**, belonging to your Zwapgrid client, or a default that Zwapgrid has confirmed your client can use.

Follow the [Netvisor setup guide](/client-portal/systems/setup-guides/visma-netvisor) for interface permissions and environment settings. Zwapgrid manages the integration credentials. You supply the company credentials listed above.

For testing, explicitly select a published Sandbox setting on the Consent. If you omit the selection, confirm which default integration will be used. An invalid selected setting is rejected.

## 1. Prepare the connection

1. Use the [Consent created in the shared workflow](/onboarding-flow/headless-onboarding/headless-onboarding#1-create-a-consent). If selecting settings explicitly, set `systemsSettings.vismanetvisor` to their published ID.
2. Collect the user identifier, customer key and business ID for the company in the selected Netvisor environment.
3. Submit all three values once. Zwapgrid checks access to the company using the selected integration. The business ID selects the company; no additional company-selection request is needed.

## 2. Send the request

```json
{
  "source": "vismanetvisor",
  "credentials": {
    "userIdentifier": "<integration-user-identifier>",
    "customerKey": "<customer-key>",
    "businessId": "<Finnish-business-ID>"
  }
}
```

All three fields are required. `userIdentifier` accepts 1–256 ASCII letters, digits, hyphens or underscores. `customerKey` accepts 1–256 visible ASCII characters without whitespace. Replace `<Finnish-business-ID>` with seven digits, a hyphen and one digit, for example `1234567-8` (format illustration only).

Do not send integration application credentials, codes, redirect URIs, tokens or an environment field. Production/Sandbox selection belongs in System Settings, not this request.

Replace the placeholders and save this body as a protected `connection.json` on your backend. Set the [example variables](/onboarding-flow/headless-onboarding/headless-onboarding#set-up-the-examples), including a new UUID in `CORRELATION_ID`, then send the request once:

```sh
curl --request POST \
  "$CONSENTS_API_BASE_URL/api/v1/consents/$CONSENT_ID/connection" \
  --header "x-api-key: $ZWAPGRID_API_KEY" \
  --header "x-correlation-id: $CORRELATION_ID" \
  --header 'Content-Type: application/json' \
  --data-binary @connection.json
```

## 3. Check the result

Expect HTTP 201 with `source: vismanetvisor` and `state: completed`. [Optionally verify the connection](/onboarding-flow/headless-onboarding/headless-onboarding#optional-verify-the-connection) against the intended company.

After an uncertain POST, use GET before further action; do not automatically replay credentials. For access rejection, confirm the selected integration, company credentials, business ID and interface permissions with the authorized administrator. Contact Zwapgrid with correlation IDs if you cannot confirm whether the connection succeeded. Your backend does not need to exchange or refresh OAuth tokens.


# Overview

Zwapgrid's API.1 is a unified API designed to simplify and standardize access to Your Customer's data from various accounting systems. It acts as a single connection point, eliminating the need for businesses to build and maintain complex, individual integrations with multiple accounting platforms.

### Key Purpose and Benefits

The primary goal of API.1 is to enable businesses to effortlessly access real-time accounting data from Your Customer, streamlining financial processes and enhancing data-driven insights. Key benefits include:

* **Unified Data Access:** Connects to a multitude of accounting systems (e.g., Microsoft Business Central) and provides standardized data through one unified schema, eliminating inconsistencies.
* **Simplified Integrations:** Removes the complexity of intricate integrations, allowing businesses to focus on their core operations rather than data mapping, system knowledge, or regulatory compliance.
* **Easy Customer Onboarding:** Features a simple, customizable onboarding flow that allows customers to securely connect and authorize data sharing with just a few clicks.
* **Scalability and Reliability:** Engineered for performance and reliability, handling growing data demands with enterprise-grade uptime and robust security.
* **Accelerated Market Expansion:** Facilitates expansion into new markets by continuously adding new systems and file formats to the platform.
* **Automation of Key Processes:** Ideal for financial institutions (streamlining credit assessments, factoring) and payment solution providers (automating accounting of payouts).

### How it Works

API.1 operates on a straightforward principle:

1. **Invite Customer:** The Client invites Your Customer to securely connect and share their accounting data.
2. **Customer Connects:** Your Customer goes through a guided onboarding flow, choosing their Accounting System and granting Consent for data sharing by signing into their system.
3. **Access Data:** Once Consent is established and Your Customer's system is connected, The Client can access real-time accounting data through API.1.


# Use Cases


# Invoicing

Supplier and sales invoices are fundamental documents in a business's accounting, but they represent opposite sides of a transaction from the perspective of a single company.

### Sales Invoices

A sales invoice is a commercial document that a business issues to a customer. It is a formal request for payment for goods or services that have been sold and delivered.

* Purpose: To inform the customer of the amount owed and to provide them with the necessary details to make a payment. It serves as proof of a sale and a legal record of the transaction.
* Role in Accounting:
  * When a sales invoice is issued, the business's accounting system records an increase in revenue and an increase in accounts receivable (money owed to the business).
  * When the customer pays, the accounts receivable balance is decreased, and the cash balance is increased.

### Supplier Invoices

A supplier invoice (also known as a purchase invoice or vendor invoice) is a document that a business receives from a vendor or supplier. It is a request for payment for goods or services the business has purchased.

* Purpose: To inform the business of the amount it owes to the supplier for products or services received. It is a critical document for managing and paying a business's expenses.
* Role in Accounting:
  * When a supplier invoice is received, the business's accounting system records an increase in an expense (or an asset, depending on the purchase) and an increase in accounts payable (money owed by the business).
  * When the business pays the invoice, the accounts payable balance is decreased, and the cash balance is decreased.


# Bookkeeping

Bookkeeping is the foundational process of recording a company's financial transactions. The two central components of this process are payments and journals. They work in tandem to ensure that every financial event is accurately and chronologically captured, forming the basis for a company's financial statements.

### Journals

A journal is the "book of original entry," the very first place a financial transaction is recorded. It provides a detailed, chronological record of all business activities.

* Journal Entries: Each transaction is logged as a journal entry. In a double-entry bookkeeping system, every journal entry has two components: a debit and a credit. The total debits must always equal the total credits, ensuring the books remain balanced.
* Key Information: A journal entry typically includes:
  * The date of the transaction.
  * The accounts affected (e.g., Cash, Accounts Payable, Rent Expense).
  * The debit and credit amounts.
  * A brief description of the transaction.
* Specialized Journals: For efficiency, businesses often use specialized journals for common, repetitive transactions, such as a Sales Journal for credit sales, a Cash Receipts Journal for incoming cash, and a Purchases Journal for purchases on credit.

### Payments

Payments represent the actual movement of money, either in or out of the business. In bookkeeping, payments are the specific events that trigger the creation of a journal entry.

* Outgoing Payments: When a business pays for a purchase, such as paying a supplier invoice, this is a payment. This event is recorded as a journal entry that decreases the Cash account (a credit) and decreases the liability account, such as Accounts Payable (a debit).
* Incoming Payments: When a business receives a payment from a customer, this is also a financial event. The corresponding journal entry would increase the Cash account (a debit) and decrease the Accounts Receivable account (a credit).

#### The Bookkeeping Process

Payments and journals are inseparable in the bookkeeping process. The process generally follows these steps:

1. Identify a Transaction: A financial event occurs, such as a customer payment, a supplier payment, or a cash purchase.
2. Create a Journal Entry: The bookkeeper records the transaction in the appropriate journal. This entry details which accounts are debited and credited.
3. Post to the General Ledger: The information from the journal is then "posted," or summarized, to the general ledger. The general ledger organizes all of the journal entries by account, providing a total balance for each account.
4. Reporting: The balances from the general ledger are then used to create [financial reports](/api.1/use-cases/financial-reporting) like the trial balance, income statement, and balance sheet.

In essence, a payment is a specific financial event, while a journal is the system used to formally record that event in a structured, chronological, and balanced manner.


# Financial Reporting

Financial statements provide a crucial snapshot of a company's financial health. Three key reports in this process are the trial balance, the income statement, and the balance sheet. While they are all interconnected, they serve distinct purposes and provide different views of a company's financial position.

### **Trial Balance**

A trial balance is an internal accounting worksheet that lists all the debit and credit balances from a company's general ledger accounts at a specific point in time. Its primary purpose is to ensure that the total of all debit balances equals the total of all credit balances, a fundamental principle of double-entry bookkeeping.

* Key features:
  * An internal, working document.
  * Lists every account from the general ledger.
  * Divided into two columns: one for debit balances and one for credit balances.
  * It is the first step in preparing formal financial statements.

### **Income Statement**

An income statement (also known as a profit and loss statement or P\&L) is a formal financial statement that shows a company's revenues, expenses, gains, and losses over a specific period of time (e.g., a quarter or a year). It's designed to show the company's profitability and financial performance. The final line of the income statement is the net income (or loss).

* Key features:
  * A formal financial statement.
  * Reports on a period of time.
  * Shows revenues, expenses, and net income.
  * Used by both internal and external stakeholders to evaluate a company's performance.

### **Balance Sheet**

A balance sheet is a formal financial statement that provides a snapshot of a company's financial position at a specific point in time. It's built on the fundamental accounting equation:

$$Assets=Liabilities+Owner′sEquity$$

It shows what a company owns (assets), what it owes (liabilities), and the amount invested in the business by its owners (equity).

* Key features:
  * A formal financial statement.
  * Reports on a specific date.
  * Shows assets, liabilities, and owner's equity.
  * Used by stakeholders to assess a company's financial health, solvency, and liquidity.


# Overview

{% hint style="info" %}
**What is File.1?**

File.1 processes invoice files, including PDFs and supported XML formats, and makes the extracted data available through API.1.
{% endhint %}

For PDF invoice extraction, File.1 includes an **agentic model** among its selectable parsing options. See [How does File.1 work?](/file-1/how-does-file.1-work) for the file processing and approval workflow.

File.1 is available at <https://fileone.zwapgrid.com> using a valid Consent ID and One-Time Code.


# How does File.1 work?

Zwapgrid's File.1 platform facilitates the ingestion and processing of invoice data. Invoices can be uploaded to File.1 through two primary methods: a web interface or via SFTP (Secure File Transfer Protocol).

File.1 supports various invoice formats for processing:

* **PDF documents:** These are parsed using AI-driven extraction to identify and extract invoice data.
* **Supported XML formats:** These are parsed from their structured invoice data.

## Choose a PDF parsing model

File.1 offers an **agentic model** as a selectable option for PDF invoice parsing. Choose the parsing model when configuring File.1 for your invoice workflow. The selected model determines how data is extracted from PDFs; the approval mode determines how the resulting invoices are reviewed and submitted.

Upon successful upload and parsing, the extracted and structured invoice data is then made available for consumption through Zwapgrid's API.1.

## Review and approve invoices

File.1 supports various operational modes for invoice handling:

* **Single Approval (default):** Review and approve invoices one by one, correcting extracted data where needed.
* **Mass Approval:** Approve all valid invoices together in one batch.
* **Automatic Approval:** Invoices that meet the configured requirements are approved at upload; invoices that do not meet them require review.

For mass and automatic approval, you can configure two confidence thresholds:

* **Minimum Value:** Extracted data below this threshold is discarded and will not be returned through API.1.
* **Approval Threshold:** Invoices meeting this threshold can be approved automatically; invoices below it require manual review.

This system is designed to provide structured invoice data via API.1, supporting diverse operational requirements for data accuracy and submission.


# Overview

Proxy.1 enables you to utilise Zwapgrid-supported onboarding, and exposes the underlying APIs for supported systems so that you can interact directly without the need to set up and manage a deep integration with those systems. You can make use of API.1 in order to simplify how you connect to each supported API in a standard way, using Zwapgrid API keys.

## Proxy Base URL

For all systems, replace the original API URL with:

`https://apione.zwapgrid.com/accounting/api/v1/consents/<consent_id>/proxy`

## Supported Systems

Today, we support the following systems:

* **Spiris**
  * Replace: `https://eaccountingapi.vismaonline.com/v2` with the proxy base URL
  * API Documentation: <https://eaccountingapi.vismaonline.com/scalar/v2>
* **Microsoft Business Central**
  * REST API: Replace `https://api.businesscentral.dynamics.com/v2.0/<tenantid>/Production/api/v2.0/companies(<company-id>)` with the proxy base URL
    * API Documentation: <https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/>
  * OData API: Replace `https://api.businesscentral.dynamics.com/v2.0/<tenantid>/Production/ODataV4/Company('<company-name>')` with the proxy base URL
    * Use request header: `x-use-odata: true`
    * API Documentation: <https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/webservices/odata-web-services>
* **Fortnox**
  * Replace: `https://api.fortnox.se` with the proxy base URL
  * API Documentation: <https://api.fortnox.se/apidocs>
* **Bjorn Lunden**
  * Replace either `https://apigateway.blinfo.se/bla-api/v1/sp` or `https://api.bjornlunden.com/bla-api/sp` with the proxy base URL. Zwapgrid selects the matching endpoint from the application Client ID.
  * API Documentation: <https://developer.bjornlunden.se/api-documentation/>
* **Visma e-conomic**
  * REST API: Replace `https://restapi.e-conomic.com` with the proxy base URL
    * REST API Documentation: <https://restdocs.e-conomic.com/#tl-dr>
  * OpenAPI: Replace `https://apis.e-conomic.com` with the proxy base URL
    * Use request header: `x-use-openapi: true`
    * REST API Documentation: <https://apis.e-conomic.com/>
* **Tripletex**
  * Replace: `https://tripletex.no/v2` with the proxy base URL
  * API Documentation: <https://tripletex.no/v2-docs/>
* **Procountor**
  * Replace: `https://api.procountor.com/api` with the proxy base URL
  * API Documentation: <https://dev.procountor.com/api-reference/>
* **Visma Netvisor**
  * Replace: `https://isvapi.netvisor.fi` with the proxy base URL
  * API Documentation: <https://developer.visma.com/api/netvisor>
* **Billy**
  * Replace: `https://api.billysbilling.com/v2` with the proxy base URL
  * API Documentation: <https://www.billy.dk/api/>
* **Visma Dinero**
  * Replace any of the following with the proxy base URL:
    * `https://api.dinero.dk/v1/<organizationId>`
    * `https://api.dinero.dk/v1.2/<organizationId>`
  * API Documentation: <https://api.dinero.dk/openapi/index.html>
* **Exact Online**
  * Replace any of the following with the proxy base URL:
    * `https://start.exactonline.nl/api/v1/<division>`
    * `https://start.exactonline.nl/api/v1/beta/<division>`
    * `https://start.exactonline.nl` (for endpoints without division)
  * API Documentation: <https://start.exactonline.nl/docs/HlpRestAPIResources.aspx?SourceAction=10>
* **QuickBooks Online**
  * Replace: `https://quickbooks.api.intuit.com/v3/company/<realmId>` with the proxy base URL
  * API Documentation: <https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account>
* **Xero**
  * Replace: `https://api.xero.com/api.xro/2.0` with the proxy base URL
  * API Documentation: <https://developer.xero.com/documentation/api/accounting/overview>
* **Bokio**
  * Replace: `https://api.bokio.se/v1/companies/<companyId>` with the proxy base URL
  * API Documentation: <https://docs.bokio.se/reference/overview>
* **Kleer**
  * Kleer Proxy.1 supports `GET`, `POST`, `PUT`, and `DELETE`.
  * Use relative Kleer company resource paths such as `client/invoice` or `supplier/invoice/{invoiceId}`. Omit the Kleer host, `/v1/`, and the `company/{companyId}/` prefix; Zwapgrid supplies the token and company ID from the consent.
  * To request JSON, set `Content-Type: application/json` even for `GET`. For XML, use `application/xml`. Use the exact value without charset parameters; `Accept` does not select the response format.
  * API Documentation: [Kleer API documentation](https://api-doc.kleer.se/)
* **DATEV Online**
  * Replace the DATEV Accounting Data Exchange base URL for your environment (`https://accounting-data-exchange.api.datev.de/platform/v1` or `https://accounting-data-exchange.api.datev.de/platform-sandbox/v1`) with the proxy base URL.
  * Use relative paths beginning with `clients/{selectedCompanyId}/`, such as `clients/{selectedCompanyId}/fiscal-years`. The connection fixes the environment and selected company; another company or DATEV product cannot be targeted.
  * Proxy.1 accepts `GET`, `POST`, `PUT`, `PATCH`, and `DELETE` within that boundary, subject to DATEV's route and method rules. An account-postings `POST` starts an export job; it does not post accounting entries.
  * Request and successful-response bodies are limited to 16 MiB. Oversized responses fail rather than returning partial data; check provider pagination metadata against each export response.
  * API Documentation: [DATEV Accounting Data Exchange](https://developer.datev.de/en/product-detail/accounting-dataexchange/1/reference)
  * Setup: [DATEV Online setup guide](/client-portal/systems/setup-guides/datev)


# Company Security

Overview of how the security/encryption setup is within Zwapgrid.

Making sure that our partners and end customers credentials are safe has always been the top priority within Zwapgrid and we are proud to say that we have passed a number of technical due diligence processes as well as KYC and "Reputational Risk" assessments from several of the largest banks in northern Europe.

### Zero Trust

We operate a zero-trust approach with regard to access to our environments. Access is only granted as necessary, with limited or no access depending on the needs of the employee. Access to sensitive production systems is restricted to a limited number of individuals and access policies are in place to prevent unauthorised access.

### Multi Factor Authentication

We enforce multi factor authentication for our employees across all services we use at Zwapgrid, and this is enabled by default for sensitive systems such as Microsoft Azure, and business apps such as Google Workspace and Slack.


# Platform Security

### Cloud-first

First and foremost, we are a cloud-first company. What this means is that we do not own or operate our own physical hardware or servers, and therefore have no need to ensure that physical access is protected. This also means that we do not need to manage software updates or patches. Our software systems are deployed and run in Microsoft Azure and are therefore covered by comprehensive SLAs with regard to security, as well as performance and up-time.

We make use of Microsoft Defender for Cloud which provides insight and recommendations as to how best to ensure the security of our software system.

We ensure our cloud services are hosted in the EU for the purposes of protection under GDPR regulations.

### Encryption

Data is encrypted at rest, to ensure that in the unlikely event of unauthorised access, it is not possible to decrypt sensitive data.

Data is stored in Azure Cosmos DB, which is encrypted at rest using AES-256 algorithms. Additionally, sensitive field-level data is encrypted using the same industry-standard AES-256 encryption algorithms, with encryption keys stored in Azure Key Vault. Access is restricted to a small set of authorised employees only.

### Environment segregation

We have a logical separation of environments between production and non-production, to prevent accidental loss of data.

### TLS

APIs are served over HTTPS as standard.


# API Security

API endpoints are protected by the industry standard OAuth2.0 for authorization and authentication. We use RBAC (Role Based Access Control) to ensure that only authorised users are able to access data.

### User Accounts

Client user accounts and access management are enabled using Auth0. This means that we leverage Auth0 to do what it is best at—managing user access to our systems using best practices in cryptography and data security.

We restrict access to production systems to authorised individuals only.


# Data Residency and Compliance

### Data Residency

We do not store any data from third party ERP systems, and this includes within our logs and cached data. We act as a pass-through layer, connecting you with Your Customer's data. However, given that data must pass through our systems when it is being served via API.1, we recognise that there is a requirement to be bound by EU data regulations.

We ensure that all services that we use are hosted in regions located within the EU.

You can find out more about what this means at the following resources:

### Azure

* EU Data Boundary: <https://learn.microsoft.com/en-us/privacy/eudb/eu-data-boundary-learn>
* Customer Success Stories: <https://customers.microsoft.com/en-us/search?sq=&ff=story_industry_friendlyname%26%3EBanking%20and%20Capital%20Markets%26%26story_product_categories%26%3EAzure%26%26story_country_region%26%3EEurope&p=8&so=story_publish_date%20desc>

### Auth0

* Security: <https://auth0.com/security>
* Data Privacy: <https://auth0.com/explore/data-privacy/>


# Data Retention Periods

Data retention is limited to the period necessary to fulfill the purposes for which it was collected and processed. Once the defined retention period expires, the data is systematically purged or anonymized according to our data lifecycle management policies.

Refer to the following table for the standard data retention periods associated with key entities within our systems:

| Entity                 | State     | Retention Period                    |
| ---------------------- | --------- | ----------------------------------- |
| Client                 | Active    | Indefinitely                        |
| Client                 | Inactive  | Following termination of contract   |
| Consent                | Created   | 30 days                             |
| Consent                | Accepted  | Until revoked                       |
| Consent                | Revoked   | 180 days                            |
| Connection Credentials | Active    | Until associated consent is revoked |
| Connection Credentials | Inactive  | Removed immediately                 |
| File.1 File            | Draft     | 30 days after last modified date    |
| File.1 File            | Submitted | 30 days after submission            |


# Compliance

Zwapgrid is currently going through the process of becoming compliant with ISO-27001.

You can see more over in our [Trust Center](http://trust.zwapgrid.com).


# Postman

We have our APIs hosted in Postman so you can pull the collections and you can get started by visiting our collection

You can find our collection at: <https://www.postman.com/zwapgrid/zwapgrid-api-1>


# Demos

**Client Portal - Create API Key**

{% @storylane/embed subdomain="zwapgrid" url="<https://zwapgrid.storylane.io/share/6n3klcmvwhlu>" linkValue="6n3klcmvwhlu" %}

Create an API key in order to access our APIs to create consent and access Your Customer's data

**Onboarding Flow - Accept Consent**

{% @storylane/embed subdomain="zwapgrid" url="<https://zwapgrid.storylane.io/share/yneyjdimifx5>" linkValue="yneyjdimifx5" %}


# Connections

## Get connection

> \*\*Preview (beta):\*\* Headless Onboarding and its API may change or improve with short notice.\
> \
> Get the connection linked to this Consent. Returns its ID, accounting system and state.\
> \
> See the \[onboarding overview]\(<https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/headless-onboarding>) and \[recovery steps]\(<https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/headless-onboarding#if-the-result-is-uncertain>).

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"tags":[{"name":"Connections"}],"servers":[{"url":"https://apione.zwapgrid.com/consents"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You must generate an API Key by logging into the [Client Portal](https://clients.zwapgrid.com).<br/><br/>You should use the API Key when calling all API endpoints in API.1.","name":"x-api-key","in":"header"}},"schemas":{"ConnectionResponse":{"title":"Completed connection","required":["id","source","state"],"type":"object","properties":{"id":{"type":"string","description":"Connection ID.","format":"uuid"},"source":{"enum":["fortnox","xero","businesscentral","procountor","vismaeaccounting","bjornlunden","vismanetvisor"],"type":"string"},"state":{"enum":["completed"],"type":"string"}},"additionalProperties":false}}},"paths":{"/api/v1/consents/{consentId}/connection":{"get":{"tags":["Connections"],"summary":"Get connection","description":"**Preview (beta):** Headless Onboarding and its API may change or improve with short notice.\n\nGet the connection linked to this Consent. Returns its ID, accounting system and state.\n\nSee the [onboarding overview](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/headless-onboarding) and [recovery steps](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/headless-onboarding#if-the-result-is-uncertain).","operationId":"GetConnection","parameters":[{"name":"consentId","in":"path","required":true,"schema":{"type":"string","description":"Consent ID.","format":"uuid"}},{"name":"x-correlation-id","in":"header","required":true,"schema":{"type":"string","description":"New non-empty request correlation UUID.","format":"uuid"}}],"responses":{"200":{"description":"Completed connection linked to the Consent.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionResponse"}}}},"400":{"description":"Invalid request or unexpected query parameters.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"401":{"description":"Authentication failed or correlation ID is missing or empty.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"403":{"description":"Access denied.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"404":{"description":"Consent unavailable or no connection found.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"409":{"description":"Consent inactive or linked connection incomplete/unsupported.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"429":{"description":"Request rate limit reached. Do not automatically retry a credential submission.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"502":{"description":"Provider verification or communication failed.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"503":{"description":"Service temporarily unavailable.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"504":{"description":"Upstream timeout.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}}}}}}}
```

## Create connection

> \*\*Preview (beta):\*\* Headless Onboarding and its API may change or improve with short notice.\
> \
> Create a connection for this Consent using the request body for your accounting system. Submit once; if the result is uncertain, read the connection before taking further action.\
> \
> See the \[onboarding overview]\(<https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/headless-onboarding>) for setup and security guidance, and \[recovery steps]\(<https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/headless-onboarding#if-the-result-is-uncertain>) for an uncertain result. Each system schema links to its guide.

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"tags":[{"name":"Connections"}],"servers":[{"url":"https://apione.zwapgrid.com/consents"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You must generate an API Key by logging into the [Client Portal](https://clients.zwapgrid.com).<br/><br/>You should use the API Key when calling all API endpoints in API.1.","name":"x-api-key","in":"header"}},"schemas":{"FortnoxConnectionRequest":{"title":"Fortnox","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["fortnox"],"type":"string"},"credentials":{"$ref":"#/components/schemas/FortnoxConnectionCredentials"}},"additionalProperties":false,"description":"[Fortnox onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/fortnox). PKCE is not currently supported; support is planned."},"FortnoxConnectionCredentials":{"title":"Fortnox credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information.","format":"uri"}},"additionalProperties":false},"XeroConnectionRequest":{"title":"Xero","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["xero"],"type":"string"},"credentials":{"$ref":"#/components/schemas/XeroConnectionCredentials"}},"additionalProperties":false,"description":"[Xero onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/xero)."},"XeroConnectionCredentials":{"title":"Xero credentials","required":["accessToken","refreshToken","tenantId"],"type":"object","properties":{"accessToken":{"maxLength":8192,"minLength":1,"type":"string","description":"Access token.","writeOnly":true},"refreshToken":{"maxLength":4096,"minLength":1,"type":"string","description":"Refresh token.","writeOnly":true},"tenantId":{"type":"string","description":"Selected tenant or organization UUID.","format":"uuid"}},"additionalProperties":false},"BusinessCentralConnectionRequest":{"title":"Business Central","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["businesscentral"],"type":"string"},"credentials":{"$ref":"#/components/schemas/BusinessCentralConnectionCredentials"}},"additionalProperties":false,"description":"[Business Central onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/business-central)."},"BusinessCentralConnectionCredentials":{"title":"Business Central credentials","required":["accessToken","refreshToken","tenantId","environment","companyId"],"type":"object","properties":{"accessToken":{"maxLength":8192,"minLength":1,"type":"string","description":"Access token.","writeOnly":true},"refreshToken":{"maxLength":4096,"minLength":1,"type":"string","description":"Refresh token.","writeOnly":true},"tenantId":{"type":"string","description":"Selected tenant or organization UUID.","format":"uuid"},"environment":{"maxLength":100,"minLength":1,"type":"string","description":"Environment name: letters, digits, underscores or hyphens.","writeOnly":true},"companyId":{"type":"string","description":"Selected company UUID.","format":"uuid"}},"additionalProperties":false},"ProcountorConnectionRequest":{"title":"Procountor","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["procountor"],"type":"string"},"credentials":{"$ref":"#/components/schemas/ProcountorConnectionCredentials"}},"additionalProperties":false,"description":"[Procountor onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/procountor)."},"ProcountorConnectionCredentials":{"title":"Procountor credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information. No query string.","format":"uri"}},"additionalProperties":false},"SpirisConnectionRequest":{"title":"Spiris","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["vismaeaccounting"],"type":"string"},"credentials":{"$ref":"#/components/schemas/SpirisConnectionCredentials"}},"additionalProperties":false,"description":"[Spiris onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/spiris)."},"SpirisConnectionCredentials":{"title":"Spiris credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information.","format":"uri"},"codeVerifier":{"maxLength":128,"type":"string","description":"Original PKCE verifier when used: 43–128 ASCII letters, digits or -._~. Omit, null or empty if unused.","nullable":true,"writeOnly":true}},"additionalProperties":false},"BjornLundenConnectionRequest":{"title":"Björn Lundén","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["bjornlunden"],"type":"string"},"credentials":{"$ref":"#/components/schemas/BjornLundenConnectionCredentials"}},"additionalProperties":false,"description":"[Björn Lundén onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/bjorn-lunden)."},"BjornLundenConnectionCredentials":{"title":"Björn Lundén credentials","required":["companyPublicKey"],"type":"object","properties":{"companyPublicKey":{"maxLength":256,"minLength":1,"type":"string","description":"Company public key obtained through the provider setup process. Treat it as a credential.","writeOnly":true}},"additionalProperties":false},"NetvisorConnectionRequest":{"title":"Netvisor","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["vismanetvisor"],"type":"string"},"credentials":{"$ref":"#/components/schemas/NetvisorConnectionCredentials"}},"additionalProperties":false,"description":"[Netvisor onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/netvisor)."},"NetvisorConnectionCredentials":{"title":"Netvisor credentials","required":["userIdentifier","customerKey","businessId"],"type":"object","properties":{"userIdentifier":{"maxLength":256,"minLength":1,"type":"string","description":"Netvisor integration user identifier.","writeOnly":true},"customerKey":{"maxLength":256,"minLength":1,"type":"string","description":"Netvisor customer key; visible ASCII without whitespace.","writeOnly":true},"businessId":{"maxLength":9,"minLength":1,"type":"string","description":"Finnish business ID: seven digits, a hyphen and one digit.","writeOnly":true}},"additionalProperties":false},"ConnectionResponse":{"title":"Completed connection","required":["id","source","state"],"type":"object","properties":{"id":{"type":"string","description":"Connection ID.","format":"uuid"},"source":{"enum":["fortnox","xero","businesscentral","procountor","vismaeaccounting","bjornlunden","vismanetvisor"],"type":"string"},"state":{"enum":["completed"],"type":"string"}},"additionalProperties":false}}},"paths":{"/api/v1/consents/{consentId}/connection":{"post":{"tags":["Connections"],"summary":"Create connection","description":"**Preview (beta):** Headless Onboarding and its API may change or improve with short notice.\n\nCreate a connection for this Consent using the request body for your accounting system. Submit once; if the result is uncertain, read the connection before taking further action.\n\nSee the [onboarding overview](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/headless-onboarding) for setup and security guidance, and [recovery steps](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/headless-onboarding#if-the-result-is-uncertain) for an uncertain result. Each system schema links to its guide.","operationId":"CreateConnection","parameters":[{"name":"consentId","in":"path","required":true,"schema":{"type":"string","description":"Consent ID.","format":"uuid"}},{"name":"x-correlation-id","in":"header","required":true,"schema":{"type":"string","description":"New non-empty request correlation UUID.","format":"uuid"}}],"requestBody":{"description":"Choose the schema and example for your accounting system. Send only its fields, at most 16 KiB.","content":{"application/json":{"schema":{"title":"Choose an accounting system","oneOf":[{"$ref":"#/components/schemas/FortnoxConnectionRequest"},{"$ref":"#/components/schemas/XeroConnectionRequest"},{"$ref":"#/components/schemas/BusinessCentralConnectionRequest"},{"$ref":"#/components/schemas/ProcountorConnectionRequest"},{"$ref":"#/components/schemas/SpirisConnectionRequest"},{"$ref":"#/components/schemas/BjornLundenConnectionRequest"},{"$ref":"#/components/schemas/NetvisorConnectionRequest"}],"description":"Send exactly one of these request bodies. The source selects the matching credentials; do not combine fields from different systems.","discriminator":{"propertyName":"source","mapping":{"fortnox":"#/components/schemas/FortnoxConnectionRequest","xero":"#/components/schemas/XeroConnectionRequest","businesscentral":"#/components/schemas/BusinessCentralConnectionRequest","procountor":"#/components/schemas/ProcountorConnectionRequest","vismaeaccounting":"#/components/schemas/SpirisConnectionRequest","bjornlunden":"#/components/schemas/BjornLundenConnectionRequest","vismanetvisor":"#/components/schemas/NetvisorConnectionRequest"}}}}},"required":true},"responses":{"201":{"description":"Connection completed and Consent accepted.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionResponse"}}}},"400":{"description":"Invalid request, credentials, selected settings, or inaccessible company/tenant/environment. Query parameters are not accepted.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"401":{"description":"Authentication failed or correlation ID is missing or empty.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"403":{"description":"Access denied.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"404":{"description":"Consent unavailable or no connection found.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"409":{"description":"Consent inactive/already connected, or a concurrent creation conflict.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"413":{"description":"Request body exceeds 16 KiB.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"429":{"description":"Request rate limit reached. Do not automatically retry a credential submission.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"502":{"description":"Provider verification or communication failed.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"503":{"description":"Service temporarily unavailable.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}},"504":{"description":"Upstream timeout.","headers":{"Cache-Control":{"description":"Responses must not be cached.","schema":{"enum":["no-store"],"type":"string"}}}}}}}}}
```


# Consents

Create, read, update, and delete consents; create one-time codes used in the Onboarding Flow. See the API description for consent statuses and supported accounting systems.

## Get a consent

> Use this endpoint to fetch the full details of a consent (e.g. after creating one via the Location header, or to check status and system settings for a specific connection).

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"tags":[{"name":"Consents","description":"Create, read, update, and delete consents; create one-time codes used in the Onboarding Flow. See the API description for consent statuses and supported accounting systems."}],"servers":[{"url":"https://apione.zwapgrid.com/consents"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You must generate an API Key by logging into the [Client Portal](https://clients.zwapgrid.com).<br/><br/>You should use the API Key when calling all API endpoints in API.1.","name":"x-api-key","in":"header"}},"schemas":{"ConsentDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Consent","format":"uuid"},"name":{"type":"string","description":"The name of the Consent","nullable":true},"status":{"$ref":"#/components/schemas/ConsentStatus"},"source":{"type":"string","description":"The source of the consent (i.e. what system has been connected)","nullable":true},"systemSettingsId":{"type":"string","description":"The selected system settings ID once the consent is accepted. Populated when the consent has a single connected system; see systemSettings for the full dictionary of available system settings.","format":"uuid","nullable":true},"systemSettings":{"type":"object","additionalProperties":{"type":"string","description":"System settings ID (UUID) for this accounting system (value in the dictionary).","format":"uuid"},"description":"\nDictionary of available system settings for the consent.\n\nKey: lower-case system identifier (e.g. fortnox, fileone).\n\nValue: system settings ID (UUID).\n\nSee API description for supported system identifiers.","nullable":true},"createdOn":{"type":"string","description":"The date the consent was created on","format":"date-time"},"updatedOn":{"type":"string","description":"The date the consent was updated on","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Consent resource returned by get and list endpoints. Represents the link between your customer and their connection to an accounting system."},"ConsentStatus":{"enum":[0,1,2,3],"type":"integer","description":"Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/consents/{consentId}":{"get":{"tags":["Consents"],"summary":"Get a consent","description":"Use this endpoint to fetch the full details of a consent (e.g. after creating one via the Location header, or to check status and system settings for a specific connection).","operationId":"GetConsent","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"}}],"responses":{"200":{"description":"Returns a consent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentDto"}}}},"401":{"description":"Not authenticated to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorised to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The consent does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## Delete a consent

> Use this endpoint to permanently remove a consent. After deletion, the consent ID can no longer be used and the customer would need a new consent to reconnect.

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"tags":[{"name":"Consents","description":"Create, read, update, and delete consents; create one-time codes used in the Onboarding Flow. See the API description for consent statuses and supported accounting systems."}],"servers":[{"url":"https://apione.zwapgrid.com/consents"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You must generate an API Key by logging into the [Client Portal](https://clients.zwapgrid.com).<br/><br/>You should use the API Key when calling all API endpoints in API.1.","name":"x-api-key","in":"header"}},"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/consents/{consentId}":{"delete":{"tags":["Consents"],"summary":"Delete a consent","description":"Use this endpoint to permanently remove a consent. After deletion, the consent ID can no longer be used and the customer would need a new consent to reconnect.","operationId":"DeleteConsent","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"}}],"responses":{"204":{"description":"If consent is removed"},"400":{"description":"If request is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## Update a consent

> Use this endpoint to change the consent display name or to revoke the consent (set status to REVOKED so the customer's connection is no longer active). Send the If-Match header with the ETag from the last GET consent response to avoid overwriting concurrent changes.

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"tags":[{"name":"Consents","description":"Create, read, update, and delete consents; create one-time codes used in the Onboarding Flow. See the API description for consent statuses and supported accounting systems."}],"servers":[{"url":"https://apione.zwapgrid.com/consents"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You must generate an API Key by logging into the [Client Portal](https://clients.zwapgrid.com).<br/><br/>You should use the API Key when calling all API endpoints in API.1.","name":"x-api-key","in":"header"}},"schemas":{"UpdateConsentDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ConsentStatus"},"name":{"type":"string","description":"New display name for the consent.","nullable":true}},"additionalProperties":false,"description":"Request body for updating an existing consent. Only provided properties are updated."},"ConsentStatus":{"enum":[0,1,2,3],"type":"integer","description":"Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/consents/{consentId}":{"patch":{"tags":["Consents"],"summary":"Update a consent","description":"Use this endpoint to change the consent display name or to revoke the consent (set status to REVOKED so the customer's connection is no longer active). Send the If-Match header with the ETag from the last GET consent response to avoid overwriting concurrent changes.","operationId":"PatchConsent","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":"If-Match","in":"header","description":"Value of the ETag returned as a response header from the get-consent endpoint.","required":true,"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"}}],"requestBody":{"description":"Request body containing the optional status and name to update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConsentDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateConsentDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateConsentDto"}}}},"responses":{"204":{"description":"The consent was updated successfully."},"400":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Not authenticated to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorised to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The consent does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"412":{"description":"If-Match header does not match Etag - this means that the resource has been changed and now has a different Etag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## List consents

> Use this endpoint to retrieve all consents (connections to accounting systems) for your client. Filter by status, source, name, dates, or other query parameters to find specific consents.

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"tags":[{"name":"Consents","description":"Create, read, update, and delete consents; create one-time codes used in the Onboarding Flow. See the API description for consent statuses and supported accounting systems."}],"servers":[{"url":"https://apione.zwapgrid.com/consents"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You must generate an API Key by logging into the [Client Portal](https://clients.zwapgrid.com).<br/><br/>You should use the API Key when calling all API endpoints in API.1.","name":"x-api-key","in":"header"}},"schemas":{"ConsentDtoPagedResultDto":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ConsentDto"},"description":"The list of items for the current page.","nullable":true}},"additionalProperties":false,"description":"Paginated list response. Contains a page of items and metadata for total count and pagination."},"PagedResultMetadataDto":{"type":"object","properties":{"totalResources":{"type":"integer","description":"Total number of resources across all pages.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages given the page size.","format":"int32"},"currentPage":{"type":"integer","description":"One-based index of the current page.","format":"int32"}},"additionalProperties":false,"description":"Metadata for a paginated result: total count and current page information."},"ConsentDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Consent","format":"uuid"},"name":{"type":"string","description":"The name of the Consent","nullable":true},"status":{"$ref":"#/components/schemas/ConsentStatus"},"source":{"type":"string","description":"The source of the consent (i.e. what system has been connected)","nullable":true},"systemSettingsId":{"type":"string","description":"The selected system settings ID once the consent is accepted. Populated when the consent has a single connected system; see systemSettings for the full dictionary of available system settings.","format":"uuid","nullable":true},"systemSettings":{"type":"object","additionalProperties":{"type":"string","description":"System settings ID (UUID) for this accounting system (value in the dictionary).","format":"uuid"},"description":"\nDictionary of available system settings for the consent.\n\nKey: lower-case system identifier (e.g. fortnox, fileone).\n\nValue: system settings ID (UUID).\n\nSee API description for supported system identifiers.","nullable":true},"createdOn":{"type":"string","description":"The date the consent was created on","format":"date-time"},"updatedOn":{"type":"string","description":"The date the consent was updated on","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Consent resource returned by get and list endpoints. Represents the link between your customer and their connection to an accounting system."},"ConsentStatus":{"enum":[0,1,2,3],"type":"integer","description":"Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/consents":{"get":{"tags":["Consents"],"summary":"List consents","description":"Use this endpoint to retrieve all consents (connections to accounting systems) for your client. Filter by status, source, name, dates, or other query parameters to find specific consents.","operationId":"GetConsents","parameters":[{"name":"x-correlation-id","in":"header","description":"Unique identifier used to correlate and trace this request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Count","in":"query","description":"Number of records to return per page.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}},{"name":"CurrentPage","in":"query","description":"One-based index of the page to return.","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"CreatedOn","in":"query","description":"Filter by creation date. Format: yyyy-MM-dd.","schema":{"type":"string"}},{"name":"UpdatedOn","in":"query","description":"Filter by last update date. Format: yyyy-MM-dd.","schema":{"type":"string"}},{"name":"OrderBy","in":"query","description":"Sort order for the results.","schema":{"type":"string"}},{"name":"Status","in":"query","description":"Filter by consent status. Use the status name or numeric value: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).","schema":{"type":"string"}},{"name":"Source","in":"query","description":"Filter by source (accounting system identifier).","schema":{"type":"string"}},{"name":"IsTest","in":"query","description":"Filter by test flag. When true, only test consents are returned.","schema":{"type":"boolean"}},{"name":"SystemSettingsId","in":"query","description":"Filter by the selected system settings ID (the system setting in effect once a consent is accepted).","schema":{"type":"string","format":"uuid"}},{"name":"Name","in":"query","description":"Filter by consent name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of consents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentDtoPagedResultDto"}}}},"401":{"description":"Not authenticated to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorised to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The client does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## Create a consent

> Use this endpoint to create a consent that links your customer to a future connection in API.1. After creating, use the Location header to get the consent ID, then create a one-time code (POST /consents/{consentId}/otc) and use it only inside your embedded client integration when starting the Onboarding Flow. Do not expose the OTC in share links because it can be prematurely consumed. The 201 response includes a Location header with the URI of the created consent.

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"tags":[{"name":"Consents","description":"Create, read, update, and delete consents; create one-time codes used in the Onboarding Flow. See the API description for consent statuses and supported accounting systems."}],"servers":[{"url":"https://apione.zwapgrid.com/consents"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You must generate an API Key by logging into the [Client Portal](https://clients.zwapgrid.com).<br/><br/>You should use the API Key when calling all API endpoints in API.1.","name":"x-api-key","in":"header"}},"schemas":{"CreateConsentDto":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Display name for the consent (e.g. your customer or integration name)."},"systemsSettings":{"type":"object","additionalProperties":{"type":"string","description":"System settings ID (UUID) for this accounting system (value in the dictionary).","format":"uuid"},"description":"\nOptional dictionary of available system settings for the consent.\n\nKey: lower-case system identifier (e.g. fortnox, fileone).\n\nValue: system settings ID (UUID).\n\nOmit to use client defaults where applicable.\n\nSee API description for supported system identifiers.","nullable":true}},"additionalProperties":false,"description":"Request body for creating a new consent. Links a customer in your system to a connection that is completed in the Onboarding Flow."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/consents":{"post":{"tags":["Consents"],"summary":"Create a consent","description":"Use this endpoint to create a consent that links your customer to a future connection in API.1. After creating, use the Location header to get the consent ID, then create a one-time code (POST /consents/{consentId}/otc) and use it only inside your embedded client integration when starting the Onboarding Flow. Do not expose the OTC in share links because it can be prematurely consumed. The 201 response includes a Location header with the URI of the created consent.","operationId":"PostConsent","parameters":[{"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":"Request body containing the consent name and optional system settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConsentDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateConsentDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateConsentDto"}}}},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"URI of the created consent. Use this URL to retrieve the created resource (e.g. GET /api/v1/consents/{consentId}).","schema":{"type":"string","format":"uri"}}},"content":{"application/json":{"schema":{"type":"object","description":"No body; use the Location header to fetch the created consent."}}},"links":{"getCreatedConsent":{"operationId":"GetConsent","description":"Get the created consent using the Location header from this response."}}},"400":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Not authenticated to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorised to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The consent does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## Create a one-time code

> Use this endpoint after creating a consent to obtain a one-time code (OTC). Use the OTC only inside your embedded client integration when starting the Onboarding Flow. Do not expose the OTC in share links because it can be prematurely consumed.

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"tags":[{"name":"Consents","description":"Create, read, update, and delete consents; create one-time codes used in the Onboarding Flow. See the API description for consent statuses and supported accounting systems."}],"servers":[{"url":"https://apione.zwapgrid.com/consents"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You must generate an API Key by logging into the [Client Portal](https://clients.zwapgrid.com).<br/><br/>You should use the API Key when calling all API endpoints in API.1.","name":"x-api-key","in":"header"}},"schemas":{"OtcDto":{"type":"object","properties":{"code":{"type":"string","description":"The one-time code used by the embedded client integration when starting the Onboarding Flow.","nullable":true}},"additionalProperties":false,"description":"One-time code returned when creating an OTC. Use it only inside your embedded client integration when starting the Onboarding Flow. Do not expose it in share links because it can be prematurely consumed."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/consents/{consentId}/otc":{"post":{"tags":["Consents"],"summary":"Create a one-time code","description":"Use this endpoint after creating a consent to obtain a one-time code (OTC). Use the OTC only inside your embedded client integration when starting the Onboarding Flow. Do not expose the OTC in share links because it can be prematurely consumed.","operationId":"PostOtc","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"}}],"responses":{"201":{"description":"One-time code was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtcDto"}}}},"400":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Not authenticated to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorised to access this API endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The consent does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```


# Models

## The BjornLundenConnectionCredentials object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"BjornLundenConnectionCredentials":{"title":"Björn Lundén credentials","required":["companyPublicKey"],"type":"object","properties":{"companyPublicKey":{"maxLength":256,"minLength":1,"type":"string","description":"Company public key obtained through the provider setup process. Treat it as a credential.","writeOnly":true}},"additionalProperties":false}}}}
```

## The BjornLundenConnectionRequest object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"BjornLundenConnectionRequest":{"title":"Björn Lundén","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["bjornlunden"],"type":"string"},"credentials":{"$ref":"#/components/schemas/BjornLundenConnectionCredentials"}},"additionalProperties":false,"description":"[Björn Lundén onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/bjorn-lunden)."},"BjornLundenConnectionCredentials":{"title":"Björn Lundén credentials","required":["companyPublicKey"],"type":"object","properties":{"companyPublicKey":{"maxLength":256,"minLength":1,"type":"string","description":"Company public key obtained through the provider setup process. Treat it as a credential.","writeOnly":true}},"additionalProperties":false}}}}
```

## The BusinessCentralConnectionCredentials object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"BusinessCentralConnectionCredentials":{"title":"Business Central credentials","required":["accessToken","refreshToken","tenantId","environment","companyId"],"type":"object","properties":{"accessToken":{"maxLength":8192,"minLength":1,"type":"string","description":"Access token.","writeOnly":true},"refreshToken":{"maxLength":4096,"minLength":1,"type":"string","description":"Refresh token.","writeOnly":true},"tenantId":{"type":"string","description":"Selected tenant or organization UUID.","format":"uuid"},"environment":{"maxLength":100,"minLength":1,"type":"string","description":"Environment name: letters, digits, underscores or hyphens.","writeOnly":true},"companyId":{"type":"string","description":"Selected company UUID.","format":"uuid"}},"additionalProperties":false}}}}
```

## The BusinessCentralConnectionRequest object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"BusinessCentralConnectionRequest":{"title":"Business Central","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["businesscentral"],"type":"string"},"credentials":{"$ref":"#/components/schemas/BusinessCentralConnectionCredentials"}},"additionalProperties":false,"description":"[Business Central onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/business-central)."},"BusinessCentralConnectionCredentials":{"title":"Business Central credentials","required":["accessToken","refreshToken","tenantId","environment","companyId"],"type":"object","properties":{"accessToken":{"maxLength":8192,"minLength":1,"type":"string","description":"Access token.","writeOnly":true},"refreshToken":{"maxLength":4096,"minLength":1,"type":"string","description":"Refresh token.","writeOnly":true},"tenantId":{"type":"string","description":"Selected tenant or organization UUID.","format":"uuid"},"environment":{"maxLength":100,"minLength":1,"type":"string","description":"Environment name: letters, digits, underscores or hyphens.","writeOnly":true},"companyId":{"type":"string","description":"Selected company UUID.","format":"uuid"}},"additionalProperties":false}}}}
```

## The ConnectionResponse object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"ConnectionResponse":{"title":"Completed connection","required":["id","source","state"],"type":"object","properties":{"id":{"type":"string","description":"Connection ID.","format":"uuid"},"source":{"enum":["fortnox","xero","businesscentral","procountor","vismaeaccounting","bjornlunden","vismanetvisor"],"type":"string"},"state":{"enum":["completed"],"type":"string"}},"additionalProperties":false}}}}
```

## The ConsentDto object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"ConsentDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Consent","format":"uuid"},"name":{"type":"string","description":"The name of the Consent","nullable":true},"status":{"$ref":"#/components/schemas/ConsentStatus"},"source":{"type":"string","description":"The source of the consent (i.e. what system has been connected)","nullable":true},"systemSettingsId":{"type":"string","description":"The selected system settings ID once the consent is accepted. Populated when the consent has a single connected system; see systemSettings for the full dictionary of available system settings.","format":"uuid","nullable":true},"systemSettings":{"type":"object","additionalProperties":{"type":"string","description":"System settings ID (UUID) for this accounting system (value in the dictionary).","format":"uuid"},"description":"\nDictionary of available system settings for the consent.\n\nKey: lower-case system identifier (e.g. fortnox, fileone).\n\nValue: system settings ID (UUID).\n\nSee API description for supported system identifiers.","nullable":true},"createdOn":{"type":"string","description":"The date the consent was created on","format":"date-time"},"updatedOn":{"type":"string","description":"The date the consent was updated on","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Consent resource returned by get and list endpoints. Represents the link between your customer and their connection to an accounting system."},"ConsentStatus":{"enum":[0,1,2,3],"type":"integer","description":"Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).","format":"int32"}}}}
```

## The ConsentDtoPagedResultDto object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"ConsentDtoPagedResultDto":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ConsentDto"},"description":"The list of items for the current page.","nullable":true}},"additionalProperties":false,"description":"Paginated list response. Contains a page of items and metadata for total count and pagination."},"PagedResultMetadataDto":{"type":"object","properties":{"totalResources":{"type":"integer","description":"Total number of resources across all pages.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages given the page size.","format":"int32"},"currentPage":{"type":"integer","description":"One-based index of the current page.","format":"int32"}},"additionalProperties":false,"description":"Metadata for a paginated result: total count and current page information."},"ConsentDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Consent","format":"uuid"},"name":{"type":"string","description":"The name of the Consent","nullable":true},"status":{"$ref":"#/components/schemas/ConsentStatus"},"source":{"type":"string","description":"The source of the consent (i.e. what system has been connected)","nullable":true},"systemSettingsId":{"type":"string","description":"The selected system settings ID once the consent is accepted. Populated when the consent has a single connected system; see systemSettings for the full dictionary of available system settings.","format":"uuid","nullable":true},"systemSettings":{"type":"object","additionalProperties":{"type":"string","description":"System settings ID (UUID) for this accounting system (value in the dictionary).","format":"uuid"},"description":"\nDictionary of available system settings for the consent.\n\nKey: lower-case system identifier (e.g. fortnox, fileone).\n\nValue: system settings ID (UUID).\n\nSee API description for supported system identifiers.","nullable":true},"createdOn":{"type":"string","description":"The date the consent was created on","format":"date-time"},"updatedOn":{"type":"string","description":"The date the consent was updated on","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Consent resource returned by get and list endpoints. Represents the link between your customer and their connection to an accounting system."},"ConsentStatus":{"enum":[0,1,2,3],"type":"integer","description":"Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).","format":"int32"}}}}
```

## The ConsentStatus object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"ConsentStatus":{"enum":[0,1,2,3],"type":"integer","description":"Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).","format":"int32"}}}}
```

## The CreateConsentDto object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"CreateConsentDto":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Display name for the consent (e.g. your customer or integration name)."},"systemsSettings":{"type":"object","additionalProperties":{"type":"string","description":"System settings ID (UUID) for this accounting system (value in the dictionary).","format":"uuid"},"description":"\nOptional dictionary of available system settings for the consent.\n\nKey: lower-case system identifier (e.g. fortnox, fileone).\n\nValue: system settings ID (UUID).\n\nOmit to use client defaults where applicable.\n\nSee API description for supported system identifiers.","nullable":true}},"additionalProperties":false,"description":"Request body for creating a new consent. Links a customer in your system to a connection that is completed in the Onboarding Flow."}}}}
```

## The FortnoxConnectionCredentials object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"FortnoxConnectionCredentials":{"title":"Fortnox credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information.","format":"uri"}},"additionalProperties":false}}}}
```

## The FortnoxConnectionRequest object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"FortnoxConnectionRequest":{"title":"Fortnox","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["fortnox"],"type":"string"},"credentials":{"$ref":"#/components/schemas/FortnoxConnectionCredentials"}},"additionalProperties":false,"description":"[Fortnox onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/fortnox). PKCE is not currently supported; support is planned."},"FortnoxConnectionCredentials":{"title":"Fortnox credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information.","format":"uri"}},"additionalProperties":false}}}}
```

## The NetvisorConnectionCredentials object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"NetvisorConnectionCredentials":{"title":"Netvisor credentials","required":["userIdentifier","customerKey","businessId"],"type":"object","properties":{"userIdentifier":{"maxLength":256,"minLength":1,"type":"string","description":"Netvisor integration user identifier.","writeOnly":true},"customerKey":{"maxLength":256,"minLength":1,"type":"string","description":"Netvisor customer key; visible ASCII without whitespace.","writeOnly":true},"businessId":{"maxLength":9,"minLength":1,"type":"string","description":"Finnish business ID: seven digits, a hyphen and one digit.","writeOnly":true}},"additionalProperties":false}}}}
```

## The NetvisorConnectionRequest object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"NetvisorConnectionRequest":{"title":"Netvisor","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["vismanetvisor"],"type":"string"},"credentials":{"$ref":"#/components/schemas/NetvisorConnectionCredentials"}},"additionalProperties":false,"description":"[Netvisor onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/netvisor)."},"NetvisorConnectionCredentials":{"title":"Netvisor credentials","required":["userIdentifier","customerKey","businessId"],"type":"object","properties":{"userIdentifier":{"maxLength":256,"minLength":1,"type":"string","description":"Netvisor integration user identifier.","writeOnly":true},"customerKey":{"maxLength":256,"minLength":1,"type":"string","description":"Netvisor customer key; visible ASCII without whitespace.","writeOnly":true},"businessId":{"maxLength":9,"minLength":1,"type":"string","description":"Finnish business ID: seven digits, a hyphen and one digit.","writeOnly":true}},"additionalProperties":false}}}}
```

## The OtcDto object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"OtcDto":{"type":"object","properties":{"code":{"type":"string","description":"The one-time code used by the embedded client integration when starting the Onboarding Flow.","nullable":true}},"additionalProperties":false,"description":"One-time code returned when creating an OTC. Use it only inside your embedded client integration when starting the Onboarding Flow. Do not expose it in share links because it can be prematurely consumed."}}}}
```

## The PagedResultMetadataDto object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"PagedResultMetadataDto":{"type":"object","properties":{"totalResources":{"type":"integer","description":"Total number of resources across all pages.","format":"int32"},"totalPages":{"type":"integer","description":"Total number of pages given the page size.","format":"int32"},"currentPage":{"type":"integer","description":"One-based index of the current page.","format":"int32"}},"additionalProperties":false,"description":"Metadata for a paginated result: total count and current page information."}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The ProcountorConnectionCredentials object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"ProcountorConnectionCredentials":{"title":"Procountor credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information. No query string.","format":"uri"}},"additionalProperties":false}}}}
```

## The ProcountorConnectionRequest object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"ProcountorConnectionRequest":{"title":"Procountor","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["procountor"],"type":"string"},"credentials":{"$ref":"#/components/schemas/ProcountorConnectionCredentials"}},"additionalProperties":false,"description":"[Procountor onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/procountor)."},"ProcountorConnectionCredentials":{"title":"Procountor credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information. No query string.","format":"uri"}},"additionalProperties":false}}}}
```

## The SpirisConnectionCredentials object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"SpirisConnectionCredentials":{"title":"Spiris credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information.","format":"uri"},"codeVerifier":{"maxLength":128,"type":"string","description":"Original PKCE verifier when used: 43–128 ASCII letters, digits or -._~. Omit, null or empty if unused.","nullable":true,"writeOnly":true}},"additionalProperties":false}}}}
```

## The SpirisConnectionRequest object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"SpirisConnectionRequest":{"title":"Spiris","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["vismaeaccounting"],"type":"string"},"credentials":{"$ref":"#/components/schemas/SpirisConnectionCredentials"}},"additionalProperties":false,"description":"[Spiris onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/spiris)."},"SpirisConnectionCredentials":{"title":"Spiris credentials","required":["authorizationCode","redirectUri"],"type":"object","properties":{"authorizationCode":{"maxLength":2048,"minLength":1,"type":"string","description":"Unused authorization code.","writeOnly":true},"redirectUri":{"maxLength":2048,"minLength":1,"type":"string","description":"Registered HTTPS redirect URI, or HTTP loopback. No fragment or user information.","format":"uri"},"codeVerifier":{"maxLength":128,"type":"string","description":"Original PKCE verifier when used: 43–128 ASCII letters, digits or -._~. Omit, null or empty if unused.","nullable":true,"writeOnly":true}},"additionalProperties":false}}}}
```

## The UpdateConsentDto object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"UpdateConsentDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ConsentStatus"},"name":{"type":"string","description":"New display name for the consent.","nullable":true}},"additionalProperties":false,"description":"Request body for updating an existing consent. Only provided properties are updated."},"ConsentStatus":{"enum":[0,1,2,3],"type":"integer","description":"Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).","format":"int32"}}}}
```

## The XeroConnectionCredentials object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"XeroConnectionCredentials":{"title":"Xero credentials","required":["accessToken","refreshToken","tenantId"],"type":"object","properties":{"accessToken":{"maxLength":8192,"minLength":1,"type":"string","description":"Access token.","writeOnly":true},"refreshToken":{"maxLength":4096,"minLength":1,"type":"string","description":"Refresh token.","writeOnly":true},"tenantId":{"type":"string","description":"Selected tenant or organization UUID.","format":"uuid"}},"additionalProperties":false}}}}
```

## The XeroConnectionRequest object

```json
{"openapi":"3.0.4","info":{"title":"Consents API","version":"v1"},"components":{"schemas":{"XeroConnectionRequest":{"title":"Xero","required":["source","credentials"],"type":"object","properties":{"source":{"enum":["xero"],"type":"string"},"credentials":{"$ref":"#/components/schemas/XeroConnectionCredentials"}},"additionalProperties":false,"description":"[Xero onboarding guide](https://docs.zwapgrid.com/onboarding-flow/headless-onboarding/xero)."},"XeroConnectionCredentials":{"title":"Xero credentials","required":["accessToken","refreshToken","tenantId"],"type":"object","properties":{"accessToken":{"maxLength":8192,"minLength":1,"type":"string","description":"Access token.","writeOnly":true},"refreshToken":{"maxLength":4096,"minLength":1,"type":"string","description":"Refresh token.","writeOnly":true},"tenantId":{"type":"string","description":"Selected tenant or organization UUID.","format":"uuid"}},"additionalProperties":false}}}}
```


# Accounting Accounts

Retrieve the chart of accounts (accounting accounts) for a given consent.

## List accounting accounts

> Retrieves a paginated list of accounting accounts for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Accounting Accounts","description":"Retrieve the chart of accounts (accounting accounts) 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":{"AccountingAccountDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents an accounting account in the chart of accounts.","$ref":"#/components/schemas/AccountingAccountDto"},"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."},"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."},"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)."},"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}/accountingaccounts":{"get":{"tags":["Accounting Accounts"],"summary":"List accounting accounts","description":"Retrieves a paginated list of accounting accounts for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListAccountingAccounts","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":"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 accounting accounts for the specified consent.","content":{"text/plain":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/AccountingAccountDtoPagedResultDto"}},"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/AccountingAccountDtoPagedResultDto"}},"text/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/AccountingAccountDtoPagedResultDto"}}}},"401":{"description":"Missing or invalid authentication credentials.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorized to access this resource.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/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/problem+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":{}}}}}}}}
```


# Accounting Periods

Retrieve accounting periods (fiscal years) for a given consent.

## List accounting periods

> Retrieves a paginated list of accounting periods for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | ✅ Supported |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Accounting Periods","description":"Retrieve accounting periods (fiscal years) 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":{"AccountingPeriodDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents an accounting period (fiscal year or sub-period).","$ref":"#/components/schemas/AccountingPeriodDto"},"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."},"AccountingPeriodDto":{"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 accounting period."},"accountingMethod":{"type":["null","string"],"description":"Accounting method used during the period (null if not available)."},"startDate":{"type":["null","string"],"description":"Date when the accounting period starts. Format: yyyy-MM-dd."},"endDate":{"type":["null","string"],"description":"Date when the accounting period ends. Format: yyyy-MM-dd."},"isOpen":{"type":["null","boolean"],"description":"Indicates whether the accounting period is currently open for transactions."}},"additionalProperties":false,"description":"Represents an accounting period (fiscal year or sub-period)."},"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}/accountingperiods":{"get":{"tags":["Accounting Periods"],"summary":"List accounting periods","description":"Retrieves a paginated list of accounting periods for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | ✅ Supported |","operationId":"ListAccountingPeriods","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"}}],"responses":{"200":{"description":"Returns a paginated list of accounting periods for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/AccountingPeriodDtoPagedResultDto"}}}},"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 accounting periods were 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":{}}}}}}}}
```


# Balance Sheet

Retrieve balance sheet reports for a given consent.

## Get balance sheet

> Retrieves the balance sheet report for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Balance Sheet","description":"Retrieve balance sheet reports 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":{"BalanceSheetDto":{"type":"object","properties":{"accountBalancePeriod":{"description":"Period covered by the balance sheet.","$ref":"#/components/schemas/PeriodDto"},"financialReport":{"description":"Financial report containing balance sheet categories.","$ref":"#/components/schemas/FinancialReportDto"}},"additionalProperties":false,"description":"Represents a balance sheet financial statement."},"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."},"FinancialReportDto":{"type":"object","properties":{"categories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of financial report categories."}},"additionalProperties":false,"description":"Represents a financial report composed of categorized account data."},"FinancialReportCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the category."},"balance":{"description":"Aggregated balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents an account balance summary within a financial report.","$ref":"#/components/schemas/FinancialReportAccountBalanceSummaryDto"},"description":"Collection of account balance summaries within this category."}},"additionalProperties":false,"description":"Represents a category within a financial report, supporting hierarchical sub-categories."},"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."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"FinancialReportAccountBalanceSummaryDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the balance.","$ref":"#/components/schemas/AccountingAccountDto"},"balance":{"description":"Balance for the accounting account.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an account balance summary within a financial report."},"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."},"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."},"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)."},"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}/balancesheet":{"get":{"tags":["Balance Sheet"],"summary":"Get balance sheet","description":"Retrieves the balance sheet report for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetBalanceSheet","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":"EndDate","in":"query","description":"End date for the balance sheet period. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).\nDefaults to the current server date/time when omitted.","schema":{"type":"string","format":"date-time"}},{"name":"Level","in":"query","description":"Heading level depth for the balance sheet. API range: 1-5; the connected system may support fewer levels. Defaults to 1.","schema":{"maximum":5,"minimum":1,"type":"integer","format":"int32"}},{"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 the requested balance sheet.","content":{"application/json":{"schema":{"description":"Represents a balance sheet financial statement.","$ref":"#/components/schemas/BalanceSheetDto"}}}},"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 balance sheet 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":{}}}}}}}}
```


# Company Information

Retrieve company information for a given consent.

## Get company information

> Retrieves company information for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Company Information","description":"Retrieve company information 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":{"CompanyInformationDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the company."},"reference":{"type":["null","string"],"description":"Reference code for the company."},"partyIdentification":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of party identification entries."},"partyName":{"description":"Legal or trading name of the party.","$ref":"#/components/schemas/PartyNameDto"},"postalAddress":{"description":"Postal address of the company.","$ref":"#/components/schemas/AddressDto"},"phone":{"type":["null","string"],"description":"Phone number of the company."},"email":{"type":["null","string"],"description":"Email address of the company."},"fax":{"type":["null","string"],"description":"Fax number of the company."},"website":{"type":["null","string"],"description":"Website URL of the company."},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"},"contacts":{"type":["null","array"],"items":{"description":"Represents contact information for a party.","$ref":"#/components/schemas/ContactDto"},"description":"Collection of contact persons for the company."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means with financial account details.","$ref":"#/components/schemas/PaymentMeansNewDto"},"description":"Collection of payment means for the company."}},"additionalProperties":false,"description":"Represents company information details in the accounting system."},"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."},"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."},"PaymentMeansNewDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means with financial account details."},"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."},"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}/companyinformation":{"get":{"tags":["Company Information"],"summary":"Get company information","description":"Retrieves company information for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetCompanyInformation","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.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returns the requested company information.","content":{"application/json":{"schema":{"description":"Represents company information details in the accounting system.","$ref":"#/components/schemas/CompanyInformationDto"}}}},"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"}}}]}}}}}}}}}
```


# Customers

Retrieve customer records for a given consent.

## List customers

> Retrieves a paginated list of customers for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Customers","description":"Retrieve customer records 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":{"CustomerDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a customer entity in the accounting system.","$ref":"#/components/schemas/CustomerDto"},"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."},"CustomerDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the customer."},"supplierAssignedAccountId":{"description":"System-generated account identifier assigned by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"type":{"enum":["PrivatePerson","Company"],"type":["null","string"],"description":"Customer type classification (e.g. PrivatePerson, Company)."},"party":{"description":"Party details associated with the customer.","$ref":"#/components/schemas/PartyDto"},"deliveryAddresses":{"type":["null","array"],"items":{"description":"Represents a postal address.","$ref":"#/components/schemas/AddressDto"},"description":"Collection of delivery addresses for the customer."},"description":{"description":"Descriptive note for the customer.","$ref":"#/components/schemas/NoteDto"},"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 customer."},"active":{"type":["null","boolean"],"description":"Indicates whether the customer is active."},"currency":{"type":["null","string"],"description":"Currency code associated with the customer."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means with financial account details.","$ref":"#/components/schemas/PaymentMeansNewDto"},"description":"Collection of payment means for the customer."}},"additionalProperties":false,"description":"Represents a customer entity in the accounting system."},"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."},"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."},"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)."},"PaymentMeansNewDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means with financial account details."},"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."},"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}/customers":{"get":{"tags":["Customers"],"summary":"List customers","description":"Retrieves a paginated list of customers for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListCustomers","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":"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 customers for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/CustomerDtoPagedResultDto"}}}},"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 customer by ID

> Retrieves a single customer by its identifier.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Customers","description":"Retrieve customer records 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":{"CustomerDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the customer."},"supplierAssignedAccountId":{"description":"System-generated account identifier assigned by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"type":{"enum":["PrivatePerson","Company"],"type":["null","string"],"description":"Customer type classification (e.g. PrivatePerson, Company)."},"party":{"description":"Party details associated with the customer.","$ref":"#/components/schemas/PartyDto"},"deliveryAddresses":{"type":["null","array"],"items":{"description":"Represents a postal address.","$ref":"#/components/schemas/AddressDto"},"description":"Collection of delivery addresses for the customer."},"description":{"description":"Descriptive note for the customer.","$ref":"#/components/schemas/NoteDto"},"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 customer."},"active":{"type":["null","boolean"],"description":"Indicates whether the customer is active."},"currency":{"type":["null","string"],"description":"Currency code associated with the customer."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means with financial account details.","$ref":"#/components/schemas/PaymentMeansNewDto"},"description":"Collection of payment means for the customer."}},"additionalProperties":false,"description":"Represents a customer entity in the accounting system."},"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."},"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."},"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)."},"PaymentMeansNewDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means with financial account details."},"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."},"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}/customers/{customerId}":{"get":{"tags":["Customers"],"summary":"Get a customer by ID","description":"Retrieves a single customer by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetCustomer","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":"customerId","in":"path","description":"The id of the customer you wish to retrieve.","required":true,"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 the requested customer.","content":{"application/json":{"schema":{"description":"Represents a customer entity in the accounting system.","$ref":"#/components/schemas/CustomerDto"}}}},"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 customer 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":{}}}}}}}}
```


# Financial Dimensions

Retrieve financial dimensions (cost centers, projects, etc.) for a given consent.

## List financial dimensions

> Retrieves a paginated list of financial dimensions for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Financial Dimensions","description":"Retrieve financial dimensions (cost centers, projects, etc.) 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":{"FinancialDimensionDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"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 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."},"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)."},"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}/financialdimensions":{"get":{"tags":["Financial Dimensions"],"summary":"List financial dimensions","description":"Retrieves a paginated list of financial dimensions for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListFinancialDimensions","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":"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 financial dimensions for the specified consent.","content":{"text/plain":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/FinancialDimensionDtoPagedResultDto"}},"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/FinancialDimensionDtoPagedResultDto"}},"text/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/FinancialDimensionDtoPagedResultDto"}}}},"401":{"description":"Missing or invalid authentication credentials.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorized to access this resource.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/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/problem+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":{}}}}}}}}
```


# Income Statement

Retrieve income statement (profit & loss) reports for a given consent.

## Get income statement

> Retrieves the income statement for the specified consent and date range.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Income Statement","description":"Retrieve income statement (profit & loss) reports 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":{"IncomeStatementDto":{"type":"object","properties":{"accountBalancePeriod":{"description":"Period covered by the income statement.","$ref":"#/components/schemas/PeriodDto"},"financialReport":{"description":"Financial report containing income statement categories.","$ref":"#/components/schemas/FinancialReportDto"},"profitLossBalance":{"description":"Net profit or loss balance for the period.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an income statement (profit and loss) financial report."},"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."},"FinancialReportDto":{"type":"object","properties":{"categories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of financial report categories."}},"additionalProperties":false,"description":"Represents a financial report composed of categorized account data."},"FinancialReportCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the category."},"balance":{"description":"Aggregated balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents an account balance summary within a financial report.","$ref":"#/components/schemas/FinancialReportAccountBalanceSummaryDto"},"description":"Collection of account balance summaries within this category."}},"additionalProperties":false,"description":"Represents a category within a financial report, supporting hierarchical sub-categories."},"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."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"FinancialReportAccountBalanceSummaryDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the balance.","$ref":"#/components/schemas/AccountingAccountDto"},"balance":{"description":"Balance for the accounting account.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an account balance summary within a financial report."},"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."},"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."},"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)."},"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}/incomestatement":{"get":{"tags":["Income Statement"],"summary":"Get income statement","description":"Retrieves the income statement for the specified consent and date range.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetIncomeStatement","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":"StartDate","in":"query","description":"Start date for the income statement period. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).\nIf omitted, defaults to the start of the current fiscal year.","schema":{"type":"string","format":"date-time"}},{"name":"EndDate","in":"query","description":"End date for the income statement period. Format: ISO 8601 date-time (e.g. yyyy-MM-ddTHH:mm:ssZ).\nDefaults to the current server date/time when omitted.","schema":{"type":"string","format":"date-time"}},{"name":"Level","in":"query","description":"Heading level depth for the income statement. API range: 1-5; the connected system may support fewer levels. Defaults to 1.","schema":{"maximum":5,"minimum":1,"type":"integer","format":"int32"}},{"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 the requested income statement.","content":{"application/json":{"schema":{"description":"Represents an income statement (profit and loss) financial report.","$ref":"#/components/schemas/IncomeStatementDto"}}}},"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 income statement 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":{}}}}}}}}
```


# Journals

Create and retrieve journal entries for a given consent.

## List journals

> Retrieves a paginated list of journals for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Journals","description":"Create and retrieve journal entries 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":{"JournalDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a journal entry with its accounting entries.","$ref":"#/components/schemas/JournalDto"},"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."},"JournalDto":{"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 journal."},"transactionDate":{"type":["null","string"],"description":"Date when the transaction occurred. Format: yyyy-MM-dd."},"accountingSeries":{"description":"Accounting series the journal belongs to (null if not available).","$ref":"#/components/schemas/AccountingSeriesDto"},"description":{"description":"Description of the journal entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"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 journal."},"accountingEntries":{"type":["null","array"],"items":{"description":"Represents an accounting entry line within a journal.","$ref":"#/components/schemas/AccountingEntryDto"},"description":"Collection of accounting entries within the journal."}},"additionalProperties":false,"description":"Represents a journal entry with its accounting entries."},"AccountingSeriesDto":{"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 accounting series."},"accountingSeriesId":{"type":["null","string"],"description":"Accounting-system-specific identifier for the series."}},"additionalProperties":false,"description":"Represents an accounting series used to categorize journal entries."},"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."},"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)."},"AccountingEntryDto":{"type":"object","properties":{"description":{"description":"Description of the accounting entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"accountingAccount":{"description":"Accounting account associated with the entry (null if not available).","$ref":"#/components/schemas/AccountingAccountDto"},"debitAmount":{"description":"Monetary amount debited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"creditAmount":{"description":"Monetary amount credited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"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 entry."}},"additionalProperties":false,"description":"Represents an accounting entry line within a journal."},"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."},"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."},"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."},"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}/journals":{"get":{"tags":["Journals"],"summary":"List journals","description":"Retrieves a paginated list of journals for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListJournals","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":"StartDate","in":"query","description":"Start date for the journal filter. Format: yyyy-MM-dd.","schema":{"type":"string","format":"date"}},{"name":"EndDate","in":"query","description":"End date for the journal filter. Format: yyyy-MM-dd.","schema":{"type":"string","format":"date"}},{"name":"OrderBy","in":"query","description":"Sort order for the results.","schema":{"enum":["DateDescending","DateAscending"],"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 journals for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/JournalDtoPagedResultDto"}}}},"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 journal

> Creates a new journal entry for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Journals","description":"Create and retrieve journal entries 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":{"CreateJournalDto":{"type":"object","properties":{"reference":{"type":["null","string"],"description":"Reference identifier for the journal."},"transactionDate":{"type":["null","string"],"description":"Date of the journal transaction.","format":"date-time"},"accountingSeries":{"description":"Accounting series the journal belongs to.","$ref":"#/components/schemas/AccountingSeriesInputDto"},"description":{"description":"Description of the journal entry.","$ref":"#/components/schemas/DescriptionDto"},"bookedJournalIndicator":{"type":["null","boolean"],"description":"Indicates whether the journal should be booked immediately."},"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 journal."},"accountingEntries":{"type":["null","array"],"items":{"description":"Represents a single accounting entry within a journal.","$ref":"#/components/schemas/AccountingEntryInputDto"},"description":"Collection of accounting entries in the journal."}},"additionalProperties":false,"description":"Represents input data for creating a journal entry."},"AccountingSeriesInputDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the accounting series."},"accountingSeriesId":{"type":["null","string"],"description":"External identifier for the accounting series."}},"additionalProperties":false,"description":"Represents an accounting series used to group journal entries."},"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."},"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)."},"AccountingEntryInputDto":{"type":"object","properties":{"description":{"description":"Description of the accounting entry.","$ref":"#/components/schemas/NoteDto"},"accountingAccount":{"description":"Accounting account for the entry.","$ref":"#/components/schemas/AccountingAccountInputDto"},"debitAmount":{"description":"Monetary amount for the debit side.","$ref":"#/components/schemas/AccountingEntryAmountInputDto"},"creditAmount":{"description":"Monetary amount for the credit side.","$ref":"#/components/schemas/AccountingEntryAmountInputDto"},"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 entry."}},"additionalProperties":false,"description":"Represents a single accounting entry within a journal."},"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."},"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."},"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."},"AccountingEntryAmountInputDto":{"type":"object","properties":{"amount":{"type":["null","number"],"description":"Monetary amount for the entry. Must be non-negative.","format":"double"},"currencyId":{"type":["null","string"],"description":"Currency code for the amount (e.g. SEK)."}},"additionalProperties":false,"description":"Represents the monetary amount of an accounting entry."},"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}/journals":{"post":{"tags":["Journals"],"summary":"Create a journal","description":"Creates a new journal entry for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"CreateJournal","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":"Journal entity.","content":{"application/json":{"schema":{"description":"Represents input data for creating a journal entry.","$ref":"#/components/schemas/CreateJournalDto"}},"text/json":{"schema":{"description":"Represents input data for creating a journal entry.","$ref":"#/components/schemas/CreateJournalDto"}},"application/*+json":{"schema":{"description":"Represents input data for creating a journal entry.","$ref":"#/components/schemas/CreateJournalDto"}}},"required":true},"responses":{"201":{"description":"The journal 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"}}}},"400":{"description":"The request body or parameters are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"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"}}}},"409":{"description":"Conflict","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":{}}},"502":{"description":"Bad Gateway"}}}}}}
```

## Get a journal by ID

> Retrieves a single journal by its identifier.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Journals","description":"Create and retrieve journal entries 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":{"JournalDto":{"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 journal."},"transactionDate":{"type":["null","string"],"description":"Date when the transaction occurred. Format: yyyy-MM-dd."},"accountingSeries":{"description":"Accounting series the journal belongs to (null if not available).","$ref":"#/components/schemas/AccountingSeriesDto"},"description":{"description":"Description of the journal entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"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 journal."},"accountingEntries":{"type":["null","array"],"items":{"description":"Represents an accounting entry line within a journal.","$ref":"#/components/schemas/AccountingEntryDto"},"description":"Collection of accounting entries within the journal."}},"additionalProperties":false,"description":"Represents a journal entry with its accounting entries."},"AccountingSeriesDto":{"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 accounting series."},"accountingSeriesId":{"type":["null","string"],"description":"Accounting-system-specific identifier for the series."}},"additionalProperties":false,"description":"Represents an accounting series used to categorize journal entries."},"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."},"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)."},"AccountingEntryDto":{"type":"object","properties":{"description":{"description":"Description of the accounting entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"accountingAccount":{"description":"Accounting account associated with the entry (null if not available).","$ref":"#/components/schemas/AccountingAccountDto"},"debitAmount":{"description":"Monetary amount debited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"creditAmount":{"description":"Monetary amount credited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"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 entry."}},"additionalProperties":false,"description":"Represents an accounting entry line within a journal."},"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."},"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."},"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."},"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}/journals/{journalId}":{"get":{"tags":["Journals"],"summary":"Get a journal by ID","description":"Retrieves a single journal by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetJournal","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":"journalId","in":"path","description":"The id of the journal you wish to retrieve.","required":true,"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 the requested journal.","content":{"application/json":{"schema":{"description":"Represents a journal entry with its accounting entries.","$ref":"#/components/schemas/JournalDto"}}}},"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 journal 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":{}}}}}}}}
```


# Journals Attachments

Retrieve attachments associated with journal entries.

## Get a journal attachment by ID

> Retrieves a single journal attachment by its identifier.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Journals - Attachments","description":"Retrieve attachments associated with journal entries."}],"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":{"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}/journals/{journalId}/attachments/{attachmentId}":{"get":{"tags":["Journals - Attachments"],"summary":"Get a journal attachment by ID","description":"Retrieves a single journal attachment by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetJournalAttachment","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":"journalId","in":"path","description":"The id of the journal you wish to retrieve attachment for.","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"The id of the attachment you wish to retrieve.","required":true,"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":"The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).","content":{"application/octet-stream":{"schema":{"type":"string","description":"File content (e.g. PDF or image). Actual Content-Type is in the response headers.","format":"binary"}},"application/pdf":{"schema":{"type":"string","description":"PDF file content when the attachment is a PDF.","format":"binary"}}}},"401":{"description":"Missing or invalid authentication credentials.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorized to access this resource.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"The requested journal attachment was not found.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/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/problem+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 journal attachment

> Creates a new attachment for the specified journal.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Journals - Attachments","description":"Retrieve attachments associated with journal entries."}],"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":{"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}/journals/{journalId}/attachments":{"post":{"tags":["Journals - Attachments"],"summary":"Create a journal attachment","description":"Creates a new attachment for the specified journal.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"CreateJournalAttachment","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":"journalId","in":"path","description":"The journal for which you wish to create an attachment.","required":true,"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"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment":{"type":"string","description":"Attachment file.","format":"binary"}}},"encoding":{"attachment":{"style":"form"}}}}},"responses":{"201":{"description":"The journal attachment 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"}}}},"400":{"description":"The request body or parameters are invalid.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing or invalid authentication credentials.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"403":{"description":"Not authorized to access this resource.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/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/problem+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":{}}}}}}}}
```


# Proxy.1

Proxy raw requests to the underlying accounting system.

## Proxy request to accounting system

> Forwards a request to the underlying accounting system and returns its response.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | ✅ Supported |\
> \
> DATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Proxy.1","description":"Proxy raw requests to the underlying accounting system."}],"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"}}},"paths":{"/api/v1/consents/{consentId}/proxy/{*systemUrl}":{"get":{"tags":["Proxy.1"],"summary":"Proxy request to accounting system","description":"Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | ✅ Supported |\n\nDATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.","operationId":"ProxyRequest_GET","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":"*systemUrl","in":"path","description":"The URL of the accounting system endpoint to proxy the request to.","required":true,"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":"OK"}}}}}}
```

## Proxy request to accounting system

> Forwards a request to the underlying accounting system and returns its response.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | ✅ Supported |\
> \
> DATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Proxy.1","description":"Proxy raw requests to the underlying accounting system."}],"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"}}},"paths":{"/api/v1/consents/{consentId}/proxy/{*systemUrl}":{"post":{"tags":["Proxy.1"],"summary":"Proxy request to accounting system","description":"Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | ✅ Supported |\n\nDATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.","operationId":"ProxyRequest_POST","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":"*systemUrl","in":"path","description":"The URL of the accounting system endpoint to proxy the request to.","required":true,"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":"OK"}}}}}}
```

## Proxy request to accounting system

> Forwards a request to the underlying accounting system and returns its response.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | ✅ Supported |\
> \
> DATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Proxy.1","description":"Proxy raw requests to the underlying accounting system."}],"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"}}},"paths":{"/api/v1/consents/{consentId}/proxy/{*systemUrl}":{"put":{"tags":["Proxy.1"],"summary":"Proxy request to accounting system","description":"Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | ✅ Supported |\n\nDATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.","operationId":"ProxyRequest_PUT","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":"*systemUrl","in":"path","description":"The URL of the accounting system endpoint to proxy the request to.","required":true,"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":"OK"}}}}}}
```

## Proxy request to accounting system

> Forwards a request to the underlying accounting system and returns its response.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | ✅ Supported |\
> \
> DATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Proxy.1","description":"Proxy raw requests to the underlying accounting system."}],"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"}}},"paths":{"/api/v1/consents/{consentId}/proxy/{*systemUrl}":{"delete":{"tags":["Proxy.1"],"summary":"Proxy request to accounting system","description":"Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | ✅ Supported |\n\nDATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.","operationId":"ProxyRequest_DELETE","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":"*systemUrl","in":"path","description":"The URL of the accounting system endpoint to proxy the request to.","required":true,"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":"OK"}}}}}}
```

## Proxy request to accounting system

> Forwards a request to the underlying accounting system and returns its response.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | ✅ Supported |\
> \
> DATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Proxy.1","description":"Proxy raw requests to the underlying accounting system."}],"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"}}},"paths":{"/api/v1/consents/{consentId}/proxy/{*systemUrl}":{"patch":{"tags":["Proxy.1"],"summary":"Proxy request to accounting system","description":"Forwards a request to the underlying accounting system and returns its response.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | ✅ Supported |\n\nDATEV proxy support is limited to the selected company's Accounting Data Exchange routes. DATEV determines which route and method combinations are available; an export-job POST does not create accounting entries.","operationId":"ProxyRequest_PATCH","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":"*systemUrl","in":"path","description":"The URL of the accounting system endpoint to proxy the request to.","required":true,"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":"OK"}}}}}}
```


# Sales Invoices

Create and retrieve sales invoices for a given consent.

## List sales invoices

> Retrieves a paginated list of sales invoices for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices","description":"Create and retrieve sales 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":{"SalesInvoiceSummaryDtoPagedResultDto":{"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 sales invoice.","$ref":"#/components/schemas/SalesInvoiceSummaryDto"},"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."},"SalesInvoiceSummaryDto":{"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."},"isSent":{"type":["null","boolean"],"description":"Indicates whether the invoice has been sent."},"accountingCustomerParty":{"description":"Customer party on the invoice (null if not available).","$ref":"#/components/schemas/CustomerPartySummaryDto"},"paymentTerms":{"description":"Payment terms for the invoice (null if not available).","$ref":"#/components/schemas/PaymentTermsDto"},"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 sales invoice."},"CustomerPartySummaryDto":{"type":"object","properties":{"supplierAssignedAccountId":{"description":"Account identifier assigned to the customer by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Summarized party details for the customer.","$ref":"#/components/schemas/SalesInvoicePartySummaryDto"}},"additionalProperties":false,"description":"Represents a summarized customer party view for sales 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."},"SalesInvoicePartySummaryDto":{"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"},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"}},"additionalProperties":false,"description":"Represents a summarized party view for sales invoice listings."},"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."},"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."},"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."},"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}/salesinvoices":{"get":{"tags":["Sales Invoices"],"summary":"List sales invoices","description":"Retrieves a paginated list of sales invoices for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListSalesInvoices","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":"CreatedDateTime","in":"query","description":"Return invoices created 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":"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            \nLegend:\n- ✅ = Supported\n- ⛔ = Not supported\n            \n| System | Paid | Unpaid | Overdue | Cancelled | Unbooked | Unsent | Draft |\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| Exact Online | ✅ | ✅ | ✅ | ⛔ | ⛔ | ⛔ | ✅ |\n| QuickBooks | ✅ | ✅ | ✅ | ⛔ | ⛔ | ⛔ | ⛔ |\n| Xero | ✅ | ✅ | ✅ | ✅ | ⛔ | ⛔ | ✅ |\n| FileOne | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ | ⛔ |","schema":{"enum":["Paid","Unpaid","Overdue","Cancelled","Unbooked","Unsent","Draft"],"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.\n2. `paymentTerms` — Include the payment terms.","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 sales invoices for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/SalesInvoiceSummaryDtoPagedResultDto"}}}},"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":{}}}}}}}}
```

## Post a sales invoice

> Creates a new sales invoice for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices","description":"Create and retrieve sales 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":{"SalesInvoiceInputDto":{"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"},"isSent":{"type":["null","boolean"],"description":"Indicates whether the invoice has been sent."},"sellerReference":{"type":["null","string"],"description":"Reference for the seller."},"invoiceLines":{"type":["null","array"],"items":{"description":"Represents a line item on a sales invoice.","$ref":"#/components/schemas/SalesInvoiceLineInputDto"},"description":"Collection of sales invoice lines."}},"additionalProperties":false,"description":"Represents input data for a sales 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."},"SalesInvoiceLineInputDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice line."},"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 sales invoice."},"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."},"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."},"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."},"SalesInvoiceDto":{"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"},"sellerReference":{"type":["null","string"],"description":"External reference or number assigned by the seller."},"isSent":{"type":["null","boolean"],"description":"Indicates whether the invoice has been sent."},"isSold":{"type":["null","boolean"],"description":"Indicates whether the invoice is sold to a factoring company for lending purposes."},"reminder":{"description":"Reminder details associated with the invoice (null if not available).","$ref":"#/components/schemas/ReminderDto"},"invoiceLines":{"type":["null","array"],"items":{"description":"Represents a single line item on an invoice.","$ref":"#/components/schemas/InvoiceLineDto"},"description":"Collection of invoice line items."}},"additionalProperties":false,"description":"Represents a sales 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."},"ReminderDto":{"type":"object","properties":{"reminderSequence":{"type":["null","integer"],"description":"Sequence number of the reminder.","format":"int32"},"lastReminderDate":{"type":["null","string"],"description":"Date of the most recent reminder sent."}},"additionalProperties":false,"description":"Represents reminder information for an invoice."},"InvoiceLineDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice line."},"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 an invoice."},"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}/salesinvoices":{"post":{"tags":["Sales Invoices"],"summary":"Post a sales invoice","description":"Creates a new sales invoice for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"CreateSalesInvoice","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":"The sales invoice to create.","content":{"application/json":{"schema":{"description":"Represents input data for a sales invoice.","$ref":"#/components/schemas/SalesInvoiceInputDto"}},"text/json":{"schema":{"description":"Represents input data for a sales invoice.","$ref":"#/components/schemas/SalesInvoiceInputDto"}},"application/*+json":{"schema":{"description":"Represents input data for a sales invoice.","$ref":"#/components/schemas/SalesInvoiceInputDto"}}}},"responses":{"201":{"description":"The sales 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 sales invoice with full detail.","$ref":"#/components/schemas/SalesInvoiceDto"}}}},"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 sales invoice by ID

> Retrieves a single sales invoice by its identifier.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices","description":"Create and retrieve sales 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":{"SalesInvoiceDto":{"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"},"sellerReference":{"type":["null","string"],"description":"External reference or number assigned by the seller."},"isSent":{"type":["null","boolean"],"description":"Indicates whether the invoice has been sent."},"isSold":{"type":["null","boolean"],"description":"Indicates whether the invoice is sold to a factoring company for lending purposes."},"reminder":{"description":"Reminder details associated with the invoice (null if not available).","$ref":"#/components/schemas/ReminderDto"},"invoiceLines":{"type":["null","array"],"items":{"description":"Represents a single line item on an invoice.","$ref":"#/components/schemas/InvoiceLineDto"},"description":"Collection of invoice line items."}},"additionalProperties":false,"description":"Represents a sales 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."},"ReminderDto":{"type":"object","properties":{"reminderSequence":{"type":["null","integer"],"description":"Sequence number of the reminder.","format":"int32"},"lastReminderDate":{"type":["null","string"],"description":"Date of the most recent reminder sent."}},"additionalProperties":false,"description":"Represents reminder information for an invoice."},"InvoiceLineDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice line."},"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 an invoice."},"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."},"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."},"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}/salesinvoices/{salesInvoiceId}":{"get":{"tags":["Sales Invoices"],"summary":"Get a sales invoice by ID","description":"Retrieves a single sales invoice by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetSalesInvoice","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":"salesInvoiceId","in":"path","description":"Identifier of the sales invoice.","required":true,"schema":{"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 the requested sales invoice.","content":{"application/json":{"schema":{"description":"Represents a sales invoice with full detail.","$ref":"#/components/schemas/SalesInvoiceDto"}}}},"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 sales 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":{}}}}}}}}
```


# Sales Invoices Attachments

Create and retrieve attachments for sales invoices, including printable invoice PDFs.

## List attachments for a sales invoice

> Retrieves a paginated list of attachments for the specified sales invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices - Attachments","description":"Create and retrieve attachments for sales invoices, including printable invoice PDFs."}],"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":{"InvoiceAttachmentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents an attachment associated with an invoice.","$ref":"#/components/schemas/InvoiceAttachmentDto"},"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."},"InvoiceAttachmentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the attachment."},"invoiceId":{"type":["null","string"],"description":"Identifier of the invoice this attachment belongs to."},"type":{"enum":["Attachment","Invoice"],"type":"string","description":"Type of the attachment (e.g. Attachment or Invoice)."},"fileName":{"type":["null","string"],"description":"Original file name of the attachment."}},"additionalProperties":false,"description":"Represents an attachment associated with 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}/salesinvoices/{salesInvoiceId}/attachments":{"get":{"tags":["Sales Invoices - Attachments"],"summary":"List attachments for a sales invoice","description":"Retrieves a paginated list of attachments for the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListSalesInvoiceAttachments","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":"salesInvoiceId","in":"path","description":"Identifier of the sales invoice.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a paginated list of sales invoice attachments for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/InvoiceAttachmentDtoPagedResultDto"}}}},"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 sales 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":{}}}}}}}}
```

## Create an attachment for a sales invoice

> Creates a new attachment for the specified sales invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices - Attachments","description":"Create and retrieve attachments for sales invoices, including printable invoice PDFs."}],"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":{"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}/salesinvoices/{salesInvoiceId}/attachments":{"post":{"tags":["Sales Invoices - Attachments"],"summary":"Create an attachment for a sales invoice","description":"Creates a new attachment for the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"CreateSalesInvoiceAttachment","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":"salesInvoiceId","in":"path","description":"Identifier of the sales invoice.","required":true,"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"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["attachment"],"type":"object","properties":{"attachment":{"type":"string","description":"Attachment file entity.","format":"binary"}}},"encoding":{"attachment":{"style":"form"}}}}},"responses":{"201":{"description":"The sales invoice attachment 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"}}}},"400":{"description":"The request body or parameters are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"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 an attachment for a sales invoice by attachment ID

> Retrieves a specific attachment file for the specified sales invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices - Attachments","description":"Create and retrieve attachments for sales invoices, including printable invoice PDFs."}],"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":{"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}/salesinvoices/{salesInvoiceId}/attachments/{attachmentId}":{"get":{"tags":["Sales Invoices - Attachments"],"summary":"Get an attachment for a sales invoice by attachment ID","description":"Retrieves a specific attachment file for the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetSalesInvoiceAttachment","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":"salesInvoiceId","in":"path","description":"Identifier of the sales invoice.","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"Identifier of the attachment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).","content":{"application/octet-stream":{"schema":{"type":"string","description":"File content (e.g. PDF or image). Actual Content-Type is in the response headers.","format":"binary"}},"application/pdf":{"schema":{"type":"string","description":"PDF file content when the attachment is a PDF.","format":"binary"}}}},"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 sales invoice attachment 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":{}}}}}}}}
```

## Get a printable sales invoice

> Retrieves a printable version of the specified sales invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices - Attachments","description":"Create and retrieve attachments for sales invoices, including printable invoice PDFs."}],"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":{"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}/salesinvoices/{salesInvoiceId}/attachments/printable":{"get":{"tags":["Sales Invoices - Attachments"],"summary":"Get a printable sales invoice","description":"Retrieves a printable version of the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetPrintableSalesInvoice","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":"salesInvoiceId","in":"path","description":"Identifier of the sales invoice.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).","content":{"application/octet-stream":{"schema":{"type":"string","description":"File content (e.g. PDF or image). Actual Content-Type is in the response headers.","format":"binary"}},"application/pdf":{"schema":{"type":"string","description":"PDF file content when the attachment is a PDF.","format":"binary"}}}},"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 sales 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":{}}}}}}}}
```


# Sales Invoices Notes

Add notes to sales invoices.

## Add a note to a sales invoice

> Adds a note to the specified sales invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices - Notes","description":"Add notes to sales invoices."}],"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":{"CreateSalesInvoiceNoteDto":{"type":"object","properties":{"note":{"type":["null","string"],"description":"The note text to attach to the sales invoice."}},"additionalProperties":false,"description":"Represents the data required to create a note on a sales 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}/salesinvoices/{salesInvoiceId}/notes":{"post":{"tags":["Sales Invoices - Notes"],"summary":"Add a note to a sales invoice","description":"Adds a note to the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"CreateSalesInvoiceNote","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":"salesInvoiceId","in":"path","description":"Identifier of the sales invoice.","required":true,"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"}}],"requestBody":{"description":"The note to add to the sales invoice.","content":{"application/json":{"schema":{"description":"Represents the data required to create a note on a sales invoice.","$ref":"#/components/schemas/CreateSalesInvoiceNoteDto"}},"text/json":{"schema":{"description":"Represents the data required to create a note on a sales invoice.","$ref":"#/components/schemas/CreateSalesInvoiceNoteDto"}},"application/*+json":{"schema":{"description":"Represents the data required to create a note on a sales invoice.","$ref":"#/components/schemas/CreateSalesInvoiceNoteDto"}}}},"responses":{"201":{"description":"The sales invoice note 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"}}}},"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 sales 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":{}}}}}}}}
```


# Sales Invoices Payments

Create and retrieve payment records for sales invoices.

## List sales invoices payments

> Retrieves a paginated list of all sales invoice payments for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ⛔ Can't be supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices - Payments","description":"Create and retrieve payment records for sales invoices."}],"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":{"InvoicePaymentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a payment associated with an invoice.","$ref":"#/components/schemas/InvoicePaymentDto"},"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."},"InvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice payment."},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true},"reference":{"type":["null","string"],"description":"Payment reference string."},"receivedDate":{"type":["null","string"],"description":"Date the payment was received."},"paidDate":{"type":["null","string"],"description":"Date the payment was made."},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment has been booked."},"bookedDate":{"type":["null","string"],"description":"Date the payment was booked."},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references linked to the payment."},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount.","format":"double"},"creditAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount credited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount debited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents a payment associated with an 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."},"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)."},"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."},"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."},"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."},"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."},"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}/salesinvoices/payments":{"get":{"tags":["Sales Invoices - Payments"],"summary":"List sales invoices payments","description":"Retrieves a paginated list of all sales invoice payments for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ⛔ Can't be supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListSalesInvoicePayments","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"}}],"responses":{"200":{"description":"Returns a paginated list of sales invoice payments for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/InvoicePaymentDtoPagedResultDto"}}}},"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":{}}}}}}}}
```

## List payments from a single sales invoice

> Retrieves a paginated list of payments for a specific sales invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices - Payments","description":"Create and retrieve payment records for sales invoices."}],"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":{"InvoicePaymentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a payment associated with an invoice.","$ref":"#/components/schemas/InvoicePaymentDto"},"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."},"InvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice payment."},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true},"reference":{"type":["null","string"],"description":"Payment reference string."},"receivedDate":{"type":["null","string"],"description":"Date the payment was received."},"paidDate":{"type":["null","string"],"description":"Date the payment was made."},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment has been booked."},"bookedDate":{"type":["null","string"],"description":"Date the payment was booked."},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references linked to the payment."},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount.","format":"double"},"creditAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount credited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount debited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents a payment associated with an 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."},"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)."},"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."},"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."},"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."},"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."},"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}/salesinvoices/{salesInvoiceId}/payments":{"get":{"tags":["Sales Invoices - Payments"],"summary":"List payments from a single sales invoice","description":"Retrieves a paginated list of payments for a specific sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListSalesInvoicePaymentsByInvoice","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":"salesInvoiceId","in":"path","description":"Identifier of the sales invoice.","required":true,"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 sales invoice payments for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/InvoicePaymentDtoPagedResultDto"}}}},"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 sales invoice payment

> Creates a new payment for the specified sales invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Sales Invoices - Payments","description":"Create and retrieve payment records for sales invoices."}],"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":{"CreateSalesInvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the payment."},"reference":{"type":["null","string"],"description":"Reference identifier for the payment."},"receivedDate":{"type":["null","string"],"description":"Date when the payment was received.","format":"date-time"},"paidDate":{"type":["null","string"],"description":"Date when the payment was made.","format":"date-time"},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment is booked."},"bookedDate":{"type":["null","string"],"description":"Date when the payment was booked.","format":"date-time"},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountInputDto"},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount for the payment.","format":"double"},"creditAmount":{"description":"Monetary amount for the credit side of the payment.","$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Monetary amount for the debit side of the payment.","$ref":"#/components/schemas/AmountTypeDto"},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Input.CreateInvoicePaymentDtoBase.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true}},"additionalProperties":false,"description":"Represents input data for creating a sales invoice payment."},"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."},"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)."},"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."},"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."},"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}/salesinvoices/{salesInvoiceId}/payments":{"post":{"tags":["Sales Invoices - Payments"],"summary":"Create a sales invoice payment","description":"Creates a new payment for the specified sales invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"CreateSalesInvoicePayment","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":"salesInvoiceId","in":"path","description":"Identifier of the sales invoice.","required":true,"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"}}],"requestBody":{"description":"The sales invoice payment to create.","content":{"application/json":{"schema":{"description":"Represents input data for creating a sales invoice payment.","$ref":"#/components/schemas/CreateSalesInvoicePaymentDto"}},"text/json":{"schema":{"description":"Represents input data for creating a sales invoice payment.","$ref":"#/components/schemas/CreateSalesInvoicePaymentDto"}},"application/*+json":{"schema":{"description":"Represents input data for creating a sales invoice payment.","$ref":"#/components/schemas/CreateSalesInvoicePaymentDto"}}},"required":true},"responses":{"201":{"description":"The sales invoice payment 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"}}}},"400":{"description":"The request body or parameters are invalid.","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":{}}}}}}}}
```


# 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 |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> 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| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> 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 |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> 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| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> 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 |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> 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| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> 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":{}}}}}}}}
```


# Supplier Invoices Attachments

Create and retrieve attachments for supplier invoices.

## Get a supplier invoice attachment

> Downloads a supplier invoice attachment file by its identifier.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices - Attachments","description":"Create and retrieve attachments for supplier invoices."}],"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":{"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}/attachments/{attachmentId}":{"get":{"tags":["Supplier Invoices - Attachments"],"summary":"Get a supplier invoice attachment","description":"Downloads a supplier invoice attachment file by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetSupplierInvoiceAttachment","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":"supplierInvoiceId","in":"path","description":"Identifier of the supplier invoice.","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"Identifier of the attachment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).","content":{"application/octet-stream":{"schema":{"type":"string","description":"File content (e.g. PDF or image). Actual Content-Type is in the response headers.","format":"binary"}},"application/pdf":{"schema":{"type":"string","description":"PDF file content when the attachment is a PDF.","format":"binary"}}}},"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 attachment 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":{}}}}}}}}
```

## Get a printable supplier invoice attachment

> Retrieves a printable attachment for the specified supplier invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices - Attachments","description":"Create and retrieve attachments for supplier invoices."}],"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":{"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}/attachments/printable":{"get":{"tags":["Supplier Invoices - Attachments"],"summary":"Get a printable supplier invoice attachment","description":"Retrieves a printable attachment for the specified supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetPrintableSupplierInvoiceAttachment","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":"supplierInvoiceId","in":"path","description":"Identifier of the supplier invoice.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested file. Content-Type is determined by the attachment (e.g. application/pdf, image/png).","content":{"application/octet-stream":{"schema":{"type":"string","description":"File content (e.g. PDF or image). Actual Content-Type is in the response headers.","format":"binary"}},"application/pdf":{"schema":{"type":"string","description":"PDF file content when the attachment is a PDF.","format":"binary"}}}},"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":{}}}}}}}}
```

## List supplier invoice attachments

> Retrieves a paginated list of attachments for the specified supplier invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices - Attachments","description":"Create and retrieve attachments for supplier invoices."}],"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":{"InvoiceAttachmentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents an attachment associated with an invoice.","$ref":"#/components/schemas/InvoiceAttachmentDto"},"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."},"InvoiceAttachmentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the attachment."},"invoiceId":{"type":["null","string"],"description":"Identifier of the invoice this attachment belongs to."},"type":{"enum":["Attachment","Invoice"],"type":"string","description":"Type of the attachment (e.g. Attachment or Invoice)."},"fileName":{"type":["null","string"],"description":"Original file name of the attachment."}},"additionalProperties":false,"description":"Represents an attachment associated with 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/{supplierInvoiceId}/attachments":{"get":{"tags":["Supplier Invoices - Attachments"],"summary":"List supplier invoice attachments","description":"Retrieves a paginated list of attachments for the specified supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListSupplierInvoiceAttachments","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":"supplierInvoiceId","in":"path","description":"Identifier of the supplier invoice.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a paginated list of supplier invoice attachments for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/InvoiceAttachmentDtoPagedResultDto"}}}},"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 attachment 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":{}}}}}}}}
```

## Create a supplier invoice attachment

> Uploads and creates a new attachment for the specified supplier invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices - Attachments","description":"Create and retrieve attachments for supplier invoices."}],"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":{"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}/attachments":{"post":{"tags":["Supplier Invoices - Attachments"],"summary":"Create a supplier invoice attachment","description":"Uploads and creates a new attachment for the specified supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"CreateSupplierInvoiceAttachment","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":"supplierInvoiceId","in":"path","description":"Identifier of the supplier invoice.","required":true,"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"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["attachment"],"type":"object","properties":{"attachment":{"type":"string","description":"Attachment file entity.","format":"binary"}}},"encoding":{"attachment":{"style":"form"}}}}},"responses":{"201":{"description":"The supplier invoice attachment 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"}}}},"400":{"description":"The request body or parameters are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"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":{}}}}}}}}
```


# Supplier Invoices Payments

Create and retrieve payment records for supplier invoices.

## List payments from supplier invoices

> Retrieves a paginated list of payments across all supplier invoices for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices - Payments","description":"Create and retrieve payment records for supplier invoices."}],"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":{"InvoicePaymentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a payment associated with an invoice.","$ref":"#/components/schemas/InvoicePaymentDto"},"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."},"InvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice payment."},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true},"reference":{"type":["null","string"],"description":"Payment reference string."},"receivedDate":{"type":["null","string"],"description":"Date the payment was received."},"paidDate":{"type":["null","string"],"description":"Date the payment was made."},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment has been booked."},"bookedDate":{"type":["null","string"],"description":"Date the payment was booked."},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references linked to the payment."},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount.","format":"double"},"creditAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount credited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount debited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents a payment associated with an 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."},"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)."},"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."},"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."},"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."},"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."},"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/payments":{"get":{"tags":["Supplier Invoices - Payments"],"summary":"List payments from supplier invoices","description":"Retrieves a paginated list of payments across all supplier invoices for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListSupplierInvoicePayments","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"}}],"responses":{"200":{"description":"Returns a paginated list of supplier invoice payments for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/InvoicePaymentDtoPagedResultDto"}}}},"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":{}}}}}}}}
```

## List payments from a single supplier invoice

> Retrieves a paginated list of payments for a specific supplier invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices - Payments","description":"Create and retrieve payment records for supplier invoices."}],"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":{"InvoicePaymentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a payment associated with an invoice.","$ref":"#/components/schemas/InvoicePaymentDto"},"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."},"InvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice payment."},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true},"reference":{"type":["null","string"],"description":"Payment reference string."},"receivedDate":{"type":["null","string"],"description":"Date the payment was received."},"paidDate":{"type":["null","string"],"description":"Date the payment was made."},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment has been booked."},"bookedDate":{"type":["null","string"],"description":"Date the payment was booked."},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references linked to the payment."},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount.","format":"double"},"creditAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount credited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount debited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents a payment associated with an 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."},"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)."},"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."},"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."},"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."},"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."},"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}/payments":{"get":{"tags":["Supplier Invoices - Payments"],"summary":"List payments from a single supplier invoice","description":"Retrieves a paginated list of payments for a specific supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListSupplierInvoicePaymentsByInvoice","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":"supplierInvoiceId","in":"path","description":"Identifier of the supplier invoice.","required":true,"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 invoice payments for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/InvoicePaymentDtoPagedResultDto"}}}},"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 payment

> Creates a new payment for the specified supplier invoice.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Supplier Invoices - Payments","description":"Create and retrieve payment records for supplier invoices."}],"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":{"CreateSupplierInvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the payment."},"reference":{"type":["null","string"],"description":"Reference identifier for the payment."},"receivedDate":{"type":["null","string"],"description":"Date when the payment was received.","format":"date-time"},"paidDate":{"type":["null","string"],"description":"Date when the payment was made.","format":"date-time"},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment is booked."},"bookedDate":{"type":["null","string"],"description":"Date when the payment was booked.","format":"date-time"},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountInputDto"},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount for the payment.","format":"double"},"creditAmount":{"description":"Monetary amount for the credit side of the payment.","$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Monetary amount for the debit side of the payment.","$ref":"#/components/schemas/AmountTypeDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references for the payment."}},"additionalProperties":false,"description":"Represents input data for creating a supplier invoice payment."},"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."},"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)."},"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."},"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."},"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."},"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."},"InvoicePaymentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a payment associated with an invoice.","$ref":"#/components/schemas/InvoicePaymentDto"},"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."},"InvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice payment."},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true},"reference":{"type":["null","string"],"description":"Payment reference string."},"receivedDate":{"type":["null","string"],"description":"Date the payment was received."},"paidDate":{"type":["null","string"],"description":"Date the payment was made."},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment has been booked."},"bookedDate":{"type":["null","string"],"description":"Date the payment was booked."},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references linked to the payment."},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount.","format":"double"},"creditAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount credited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount debited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents a payment associated with an 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."},"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}/payments":{"post":{"tags":["Supplier Invoices - Payments"],"summary":"Create a supplier invoice payment","description":"Creates a new payment for the specified supplier invoice.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"CreateSupplierInvoicePayment","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":"supplierInvoiceId","in":"path","description":"Identifier of the supplier invoice.","required":true,"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"}}],"requestBody":{"description":"Supplier invoice payment entity.","content":{"application/json":{"schema":{"description":"Represents input data for creating a supplier invoice payment.","$ref":"#/components/schemas/CreateSupplierInvoicePaymentDto"}},"text/json":{"schema":{"description":"Represents input data for creating a supplier invoice payment.","$ref":"#/components/schemas/CreateSupplierInvoicePaymentDto"}},"application/*+json":{"schema":{"description":"Represents input data for creating a supplier invoice payment.","$ref":"#/components/schemas/CreateSupplierInvoicePaymentDto"}}},"required":true},"responses":{"201":{"description":"The supplier invoice payment 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 paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/InvoicePaymentDtoPagedResultDto"}}}},"400":{"description":"The request body or parameters are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"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":{}}}}}}}}
```


# Suppliers

Retrieve supplier records for a given consent.

## List suppliers

> Retrieves a paginated list of suppliers for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Suppliers","description":"Retrieve supplier records 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":{"SupplierDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a supplier entity in the accounting system.","$ref":"#/components/schemas/SupplierDto"},"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."},"SupplierDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the supplier."},"customerAssignedAccountId":{"description":"System-generated account identifier assigned by the customer.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details associated with the supplier.","$ref":"#/components/schemas/PartyDto"},"deliveryAddresses":{"type":["null","array"],"items":{"description":"Represents a postal address.","$ref":"#/components/schemas/AddressDto"},"description":"Collection of delivery addresses for the supplier."},"description":{"description":"Descriptive note for the supplier.","$ref":"#/components/schemas/NoteDto"},"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 supplier."},"active":{"type":["null","boolean"],"description":"Indicates whether the supplier is active."},"currency":{"type":["null","string"],"description":"Currency code associated with the supplier."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means associated with a supplier.","$ref":"#/components/schemas/SupplierPaymentMeansDto"},"description":"Collection of payment means for the supplier."}},"additionalProperties":false,"description":"Represents a supplier entity in the accounting system."},"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."},"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."},"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)."},"SupplierPaymentMeansDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccounts":{"type":["null","array"],"items":{"description":"Represents a payee's financial account details.","$ref":"#/components/schemas/PayeeFinancialAccountDto"},"description":"Collection of payee financial accounts. Obsolete: use FinancialAccount instead. (Deprecated: Use PayeeFinancialAccount instead)","deprecated":true},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means associated with a supplier."},"PayeeFinancialAccountDto":{"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 payee's financial account details."},"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."},"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}/suppliers":{"get":{"tags":["Suppliers"],"summary":"List suppliers","description":"Retrieves a paginated list of suppliers for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListSuppliers","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":"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 suppliers for the specified consent.","content":{"application/json":{"schema":{"description":"Represents a paginated result containing metadata and a collection of items.","$ref":"#/components/schemas/SupplierDtoPagedResultDto"}}}},"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 by ID

> Retrieves a single supplier by its identifier.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Suppliers","description":"Retrieve supplier records 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":{"SupplierDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the supplier."},"customerAssignedAccountId":{"description":"System-generated account identifier assigned by the customer.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details associated with the supplier.","$ref":"#/components/schemas/PartyDto"},"deliveryAddresses":{"type":["null","array"],"items":{"description":"Represents a postal address.","$ref":"#/components/schemas/AddressDto"},"description":"Collection of delivery addresses for the supplier."},"description":{"description":"Descriptive note for the supplier.","$ref":"#/components/schemas/NoteDto"},"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 supplier."},"active":{"type":["null","boolean"],"description":"Indicates whether the supplier is active."},"currency":{"type":["null","string"],"description":"Currency code associated with the supplier."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means associated with a supplier.","$ref":"#/components/schemas/SupplierPaymentMeansDto"},"description":"Collection of payment means for the supplier."}},"additionalProperties":false,"description":"Represents a supplier entity in the accounting system."},"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."},"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."},"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)."},"SupplierPaymentMeansDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccounts":{"type":["null","array"],"items":{"description":"Represents a payee's financial account details.","$ref":"#/components/schemas/PayeeFinancialAccountDto"},"description":"Collection of payee financial accounts. Obsolete: use FinancialAccount instead. (Deprecated: Use PayeeFinancialAccount instead)","deprecated":true},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means associated with a supplier."},"PayeeFinancialAccountDto":{"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 payee's financial account details."},"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."},"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}/suppliers/{supplierId}":{"get":{"tags":["Suppliers"],"summary":"Get a supplier by ID","description":"Retrieves a single supplier by its identifier.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"GetSupplier","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":"supplierId","in":"path","description":"Identifier of the supplier.","required":true,"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 the requested supplier.","content":{"application/json":{"schema":{"description":"Represents a supplier entity in the accounting system.","$ref":"#/components/schemas/SupplierDto"}}}},"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 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":{}}}}}}}}
```


# Trial Balances

Retrieve trial balance reports for a given consent.

## Get trial balances

> Retrieves trial balances for the specified consent.\
> \
> \*\*System support\*\*\
> \
> \| System | Status |\
> \|---|---|\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/fortnox\\_20\\_20.svg>" alt="Fortnox" width="20" height="20" style="vertical-align:middle" /> Fortnox | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bjorn-lunden\\_20\\_20.svg>" alt="Bjorn Lunden" width="20" height="20" style="vertical-align:middle" /> Bjorn Lunden | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/spiris\\_20\\_20.svg>" alt="Spiris" width="20" height="20" style="vertical-align:middle" /> Spiris | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/tripletex\\_20\\_20.svg>" alt="Tripletex" width="20" height="20" style="vertical-align:middle" /> Tripletex | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-economic\\_20\\_20.svg>" alt="Visma e-conomic" width="20" height="20" style="vertical-align:middle" /> Visma e-conomic | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/billy\\_20\\_20.svg>" alt="Billy" width="20" height="20" style="vertical-align:middle" /> Billy | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-dinero\\_20\\_20.svg>" alt="Visma Dinero" width="20" height="20" style="vertical-align:middle" /> Visma Dinero | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/finago-procountor\\_20\\_20.png>" alt="Procountor" width="20" height="20" style="vertical-align:middle" /> Procountor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/visma-netvisor\\_20\\_20.svg>" alt="Visma Netvisor" width="20" height="20" style="vertical-align:middle" /> Visma Netvisor | ✅ Supported |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/business-central\\_20\\_20.svg>" alt="Microsoft Business Central" width="20" height="20" style="vertical-align:middle" /> Microsoft Business Central | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/exact-online\\_20\\_20.svg>" alt="Exact Online" width="20" height="20" style="vertical-align:middle" /> Exact Online | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/quickbooks\\_20\\_20.png>" alt="QuickBooks" width="20" height="20" style="vertical-align:middle" /> QuickBooks | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/xero\\_20\\_20.svg>" alt="Xero" width="20" height="20" style="vertical-align:middle" /> Xero | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/bokio\\_20\\_20.svg>" alt="Bokio" width="20" height="20" style="vertical-align:middle" /> Bokio | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/kleer\\_20\\_20.svg>" alt="Kleer" width="20" height="20" style="vertical-align:middle" /> Kleer | 📞 Not supported / contact us |\
> \| \<img src="<https://clients.zwapgrid.com/assets/logos/datev\\_20\\_20.svg>" alt="DATEV" width="20" height="20" style="vertical-align:middle" /> DATEV | 📞 Not supported / contact us |

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"tags":[{"name":"Trial Balances","description":"Retrieve trial balance reports 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":{"TrialBalancesDto":{"type":"object","properties":{"trialBalancePeriod":{"description":"Period covered by the trial balance.","$ref":"#/components/schemas/PeriodDto"},"financialReport":{"description":"Financial report containing trial balance data.","$ref":"#/components/schemas/TrialBalancesFinancialReportDto"}},"additionalProperties":false,"description":"Represents a trial balance report for a given period."},"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."},"TrialBalancesFinancialReportDto":{"type":"object","properties":{"accounts":{"type":["null","array"],"items":{"description":"Represents a trial balance entry for a specific accounting account.","$ref":"#/components/schemas/AccountTrialBalanceDto"},"description":"Collection of account-level trial balance entries."},"categories":{"type":["null","array"],"items":{"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/TrialBalanceCategoryDto"},"description":"Collection of trial balance categories."}},"additionalProperties":false,"description":"Represents the financial report structure for a trial balance."},"AccountTrialBalanceDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the trial balance entry.","$ref":"#/components/schemas/AccountingAccountDto"},"endingBalance":{"description":"Ending balance for the account.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the period.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents a trial balance entry for a specific accounting account."},"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."},"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)."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"TrialBalanceCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of descriptions for the category."},"endingBalance":{"description":"Ending balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/TrialBalanceCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents a trial balance entry for a specific accounting account.","$ref":"#/components/schemas/AccountTrialBalanceDto"},"description":"Collection of account-level trial balance entries within this category."}},"additionalProperties":false,"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories."},"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."},"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/v2/consents/{consentId}/trialbalances":{"get":{"tags":["Trial Balances"],"summary":"Get trial balances","description":"Retrieves trial balances for the specified consent.\n\n**System support**\n\n| System | Status |\n|---|---|\n| <img src=\"https://clients.zwapgrid.com/assets/logos/fortnox_20_20.svg\" alt=\"Fortnox\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Fortnox | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bjorn-lunden_20_20.svg\" alt=\"Bjorn Lunden\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bjorn Lunden | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/spiris_20_20.svg\" alt=\"Spiris\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Spiris | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/tripletex_20_20.svg\" alt=\"Tripletex\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Tripletex | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-economic_20_20.svg\" alt=\"Visma e-conomic\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma e-conomic | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/billy_20_20.svg\" alt=\"Billy\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Billy | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-dinero_20_20.svg\" alt=\"Visma Dinero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Dinero | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/finago-procountor_20_20.png\" alt=\"Procountor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Procountor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/visma-netvisor_20_20.svg\" alt=\"Visma Netvisor\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Visma Netvisor | ✅ Supported |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/business-central_20_20.svg\" alt=\"Microsoft Business Central\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Microsoft Business Central | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/exact-online_20_20.svg\" alt=\"Exact Online\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Exact Online | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/quickbooks_20_20.png\" alt=\"QuickBooks\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> QuickBooks | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/xero_20_20.svg\" alt=\"Xero\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Xero | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/bokio_20_20.svg\" alt=\"Bokio\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Bokio | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/kleer_20_20.svg\" alt=\"Kleer\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> Kleer | 📞 Not supported / contact us |\n| <img src=\"https://clients.zwapgrid.com/assets/logos/datev_20_20.svg\" alt=\"DATEV\" width=\"20\" height=\"20\" style=\"vertical-align:middle\" /> DATEV | 📞 Not supported / contact us |","operationId":"ListTrialBalances","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":"StartDate","in":"query","description":"Start date for the trial balance period. Format: yyyy-MM-dd.","schema":{"type":"string","format":"date"}},{"name":"EndDate","in":"query","description":"End date for the trial balance period. Format: yyyy-MM-dd.","schema":{"type":"string","format":"date"}},{"name":"Level","in":"query","description":"Heading level depth for the trial balance. Range: 1-5.","schema":{"maximum":5,"minimum":1,"type":"integer","format":"int32"}},{"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 the requested trial balances.","content":{"application/json":{"schema":{"description":"Represents a trial balance report for a given period.","$ref":"#/components/schemas/TrialBalancesDto"}}}},"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 trial balances were 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":{}}}}}}}}
```


# Models

## The AccountTrialBalanceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountTrialBalanceDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the trial balance entry.","$ref":"#/components/schemas/AccountingAccountDto"},"endingBalance":{"description":"Ending balance for the account.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the period.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents a trial balance entry for a specific accounting account."},"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."},"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)."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."}}}}
```

## The AccountingAccountDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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)."}}}}
```

## The AccountingAccountDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountingAccountDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents an accounting account in the chart of accounts.","$ref":"#/components/schemas/AccountingAccountDto"},"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."},"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."},"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)."}}}}
```

## The AccountingAccountInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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)."}}}}
```

## The AccountingEntryAmountInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountingEntryAmountInputDto":{"type":"object","properties":{"amount":{"type":["null","number"],"description":"Monetary amount for the entry. Must be non-negative.","format":"double"},"currencyId":{"type":["null","string"],"description":"Currency code for the amount (e.g. SEK)."}},"additionalProperties":false,"description":"Represents the monetary amount of an accounting entry."}}}}
```

## The AccountingEntryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountingEntryDto":{"type":"object","properties":{"description":{"description":"Description of the accounting entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"accountingAccount":{"description":"Accounting account associated with the entry (null if not available).","$ref":"#/components/schemas/AccountingAccountDto"},"debitAmount":{"description":"Monetary amount debited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"creditAmount":{"description":"Monetary amount credited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"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 entry."}},"additionalProperties":false,"description":"Represents an accounting entry line within a journal."},"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."},"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."},"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."},"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)."},"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."}}}}
```

## The AccountingEntryInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountingEntryInputDto":{"type":"object","properties":{"description":{"description":"Description of the accounting entry.","$ref":"#/components/schemas/NoteDto"},"accountingAccount":{"description":"Accounting account for the entry.","$ref":"#/components/schemas/AccountingAccountInputDto"},"debitAmount":{"description":"Monetary amount for the debit side.","$ref":"#/components/schemas/AccountingEntryAmountInputDto"},"creditAmount":{"description":"Monetary amount for the credit side.","$ref":"#/components/schemas/AccountingEntryAmountInputDto"},"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 entry."}},"additionalProperties":false,"description":"Represents a single accounting entry within a journal."},"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."},"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."},"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)."},"AccountingEntryAmountInputDto":{"type":"object","properties":{"amount":{"type":["null","number"],"description":"Monetary amount for the entry. Must be non-negative.","format":"double"},"currencyId":{"type":["null","string"],"description":"Currency code for the amount (e.g. SEK)."}},"additionalProperties":false,"description":"Represents the monetary amount of an accounting entry."}}}}
```

## The AccountingPeriodDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountingPeriodDto":{"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 accounting period."},"accountingMethod":{"type":["null","string"],"description":"Accounting method used during the period (null if not available)."},"startDate":{"type":["null","string"],"description":"Date when the accounting period starts. Format: yyyy-MM-dd."},"endDate":{"type":["null","string"],"description":"Date when the accounting period ends. Format: yyyy-MM-dd."},"isOpen":{"type":["null","boolean"],"description":"Indicates whether the accounting period is currently open for transactions."}},"additionalProperties":false,"description":"Represents an accounting period (fiscal year or sub-period)."}}}}
```

## The AccountingPeriodDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountingPeriodDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents an accounting period (fiscal year or sub-period).","$ref":"#/components/schemas/AccountingPeriodDto"},"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."},"AccountingPeriodDto":{"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 accounting period."},"accountingMethod":{"type":["null","string"],"description":"Accounting method used during the period (null if not available)."},"startDate":{"type":["null","string"],"description":"Date when the accounting period starts. Format: yyyy-MM-dd."},"endDate":{"type":["null","string"],"description":"Date when the accounting period ends. Format: yyyy-MM-dd."},"isOpen":{"type":["null","boolean"],"description":"Indicates whether the accounting period is currently open for transactions."}},"additionalProperties":false,"description":"Represents an accounting period (fiscal year or sub-period)."}}}}
```

## The AccountingSeriesDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountingSeriesDto":{"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 accounting series."},"accountingSeriesId":{"type":["null","string"],"description":"Accounting-system-specific identifier for the series."}},"additionalProperties":false,"description":"Represents an accounting series used to categorize journal entries."}}}}
```

## The AccountingSeriesInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"AccountingSeriesInputDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the accounting series."},"accountingSeriesId":{"type":["null","string"],"description":"External identifier for the accounting series."}},"additionalProperties":false,"description":"Represents an accounting series used to group journal entries."}}}}
```

## The AdditionalDocumentReferenceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The AddressDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The AllowanceChargeDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The AllowanceChargeInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The AmountTypeDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The BalanceSheetDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"BalanceSheetDto":{"type":"object","properties":{"accountBalancePeriod":{"description":"Period covered by the balance sheet.","$ref":"#/components/schemas/PeriodDto"},"financialReport":{"description":"Financial report containing balance sheet categories.","$ref":"#/components/schemas/FinancialReportDto"}},"additionalProperties":false,"description":"Represents a balance sheet financial statement."},"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."},"FinancialReportDto":{"type":"object","properties":{"categories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of financial report categories."}},"additionalProperties":false,"description":"Represents a financial report composed of categorized account data."},"FinancialReportCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the category."},"balance":{"description":"Aggregated balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents an account balance summary within a financial report.","$ref":"#/components/schemas/FinancialReportAccountBalanceSummaryDto"},"description":"Collection of account balance summaries within this category."}},"additionalProperties":false,"description":"Represents a category within a financial report, supporting hierarchical sub-categories."},"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."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"FinancialReportAccountBalanceSummaryDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the balance.","$ref":"#/components/schemas/AccountingAccountDto"},"balance":{"description":"Balance for the accounting account.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an account balance summary within a financial report."},"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."},"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."},"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)."}}}}
```

## The BaseCurrencyDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."}}}}
```

## The BillingReferenceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."}}}}
```

## The CompanyInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"CompanyInformationDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the company."},"reference":{"type":["null","string"],"description":"Reference code for the company."},"partyIdentification":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of party identification entries."},"partyName":{"description":"Legal or trading name of the party.","$ref":"#/components/schemas/PartyNameDto"},"postalAddress":{"description":"Postal address of the company.","$ref":"#/components/schemas/AddressDto"},"phone":{"type":["null","string"],"description":"Phone number of the company."},"email":{"type":["null","string"],"description":"Email address of the company."},"fax":{"type":["null","string"],"description":"Fax number of the company."},"website":{"type":["null","string"],"description":"Website URL of the company."},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"},"contacts":{"type":["null","array"],"items":{"description":"Represents contact information for a party.","$ref":"#/components/schemas/ContactDto"},"description":"Collection of contact persons for the company."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means with financial account details.","$ref":"#/components/schemas/PaymentMeansNewDto"},"description":"Collection of payment means for the company."}},"additionalProperties":false,"description":"Represents company information details in the accounting system."},"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."},"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."},"PaymentMeansNewDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means with financial account details."},"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."}}}}
```

## The ContactDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The CountryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The CreateJournalDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"CreateJournalDto":{"type":"object","properties":{"reference":{"type":["null","string"],"description":"Reference identifier for the journal."},"transactionDate":{"type":["null","string"],"description":"Date of the journal transaction.","format":"date-time"},"accountingSeries":{"description":"Accounting series the journal belongs to.","$ref":"#/components/schemas/AccountingSeriesInputDto"},"description":{"description":"Description of the journal entry.","$ref":"#/components/schemas/DescriptionDto"},"bookedJournalIndicator":{"type":["null","boolean"],"description":"Indicates whether the journal should be booked immediately."},"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 journal."},"accountingEntries":{"type":["null","array"],"items":{"description":"Represents a single accounting entry within a journal.","$ref":"#/components/schemas/AccountingEntryInputDto"},"description":"Collection of accounting entries in the journal."}},"additionalProperties":false,"description":"Represents input data for creating a journal entry."},"AccountingSeriesInputDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the accounting series."},"accountingSeriesId":{"type":["null","string"],"description":"External identifier for the accounting series."}},"additionalProperties":false,"description":"Represents an accounting series used to group journal entries."},"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."},"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)."},"AccountingEntryInputDto":{"type":"object","properties":{"description":{"description":"Description of the accounting entry.","$ref":"#/components/schemas/NoteDto"},"accountingAccount":{"description":"Accounting account for the entry.","$ref":"#/components/schemas/AccountingAccountInputDto"},"debitAmount":{"description":"Monetary amount for the debit side.","$ref":"#/components/schemas/AccountingEntryAmountInputDto"},"creditAmount":{"description":"Monetary amount for the credit side.","$ref":"#/components/schemas/AccountingEntryAmountInputDto"},"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 entry."}},"additionalProperties":false,"description":"Represents a single accounting entry within a journal."},"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."},"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."},"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."},"AccountingEntryAmountInputDto":{"type":"object","properties":{"amount":{"type":["null","number"],"description":"Monetary amount for the entry. Must be non-negative.","format":"double"},"currencyId":{"type":["null","string"],"description":"Currency code for the amount (e.g. SEK)."}},"additionalProperties":false,"description":"Represents the monetary amount of an accounting entry."}}}}
```

## The CreateSalesInvoiceNoteDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"CreateSalesInvoiceNoteDto":{"type":"object","properties":{"note":{"type":["null","string"],"description":"The note text to attach to the sales invoice."}},"additionalProperties":false,"description":"Represents the data required to create a note on a sales invoice."}}}}
```

## The CreateSalesInvoicePaymentDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"CreateSalesInvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the payment."},"reference":{"type":["null","string"],"description":"Reference identifier for the payment."},"receivedDate":{"type":["null","string"],"description":"Date when the payment was received.","format":"date-time"},"paidDate":{"type":["null","string"],"description":"Date when the payment was made.","format":"date-time"},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment is booked."},"bookedDate":{"type":["null","string"],"description":"Date when the payment was booked.","format":"date-time"},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountInputDto"},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount for the payment.","format":"double"},"creditAmount":{"description":"Monetary amount for the credit side of the payment.","$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Monetary amount for the debit side of the payment.","$ref":"#/components/schemas/AmountTypeDto"},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Input.CreateInvoicePaymentDtoBase.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true}},"additionalProperties":false,"description":"Represents input data for creating a sales invoice payment."},"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."},"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)."},"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."},"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."}}}}
```

## The CreateSupplierInvoicePaymentDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"CreateSupplierInvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the payment."},"reference":{"type":["null","string"],"description":"Reference identifier for the payment."},"receivedDate":{"type":["null","string"],"description":"Date when the payment was received.","format":"date-time"},"paidDate":{"type":["null","string"],"description":"Date when the payment was made.","format":"date-time"},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment is booked."},"bookedDate":{"type":["null","string"],"description":"Date when the payment was booked.","format":"date-time"},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountInputDto"},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount for the payment.","format":"double"},"creditAmount":{"description":"Monetary amount for the credit side of the payment.","$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Monetary amount for the debit side of the payment.","$ref":"#/components/schemas/AmountTypeDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references for the payment."}},"additionalProperties":false,"description":"Represents input data for creating a supplier invoice payment."},"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."},"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)."},"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."},"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."},"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."},"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."}}}}
```

## The CreditInvoiceDocumentReferenceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The CreditInvoiceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The CreditInvoiceInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The CustomerDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"CustomerDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the customer."},"supplierAssignedAccountId":{"description":"System-generated account identifier assigned by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"type":{"enum":["PrivatePerson","Company"],"type":["null","string"],"description":"Customer type classification (e.g. PrivatePerson, Company)."},"party":{"description":"Party details associated with the customer.","$ref":"#/components/schemas/PartyDto"},"deliveryAddresses":{"type":["null","array"],"items":{"description":"Represents a postal address.","$ref":"#/components/schemas/AddressDto"},"description":"Collection of delivery addresses for the customer."},"description":{"description":"Descriptive note for the customer.","$ref":"#/components/schemas/NoteDto"},"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 customer."},"active":{"type":["null","boolean"],"description":"Indicates whether the customer is active."},"currency":{"type":["null","string"],"description":"Currency code associated with the customer."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means with financial account details.","$ref":"#/components/schemas/PaymentMeansNewDto"},"description":"Collection of payment means for the customer."}},"additionalProperties":false,"description":"Represents a customer entity in the accounting system."},"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."},"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."},"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)."},"PaymentMeansNewDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means with financial account details."},"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."}}}}
```

## The CustomerDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"CustomerDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a customer entity in the accounting system.","$ref":"#/components/schemas/CustomerDto"},"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."},"CustomerDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the customer."},"supplierAssignedAccountId":{"description":"System-generated account identifier assigned by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"type":{"enum":["PrivatePerson","Company"],"type":["null","string"],"description":"Customer type classification (e.g. PrivatePerson, Company)."},"party":{"description":"Party details associated with the customer.","$ref":"#/components/schemas/PartyDto"},"deliveryAddresses":{"type":["null","array"],"items":{"description":"Represents a postal address.","$ref":"#/components/schemas/AddressDto"},"description":"Collection of delivery addresses for the customer."},"description":{"description":"Descriptive note for the customer.","$ref":"#/components/schemas/NoteDto"},"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 customer."},"active":{"type":["null","boolean"],"description":"Indicates whether the customer is active."},"currency":{"type":["null","string"],"description":"Currency code associated with the customer."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means with financial account details.","$ref":"#/components/schemas/PaymentMeansNewDto"},"description":"Collection of payment means for the customer."}},"additionalProperties":false,"description":"Represents a customer entity in the accounting system."},"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."},"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."},"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)."},"PaymentMeansNewDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means with financial account details."},"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."}}}}
```

## The CustomerPartyDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."}}}}
```

## The CustomerPartyInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."}}}}
```

## The CustomerPartySummaryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"CustomerPartySummaryDto":{"type":"object","properties":{"supplierAssignedAccountId":{"description":"Account identifier assigned to the customer by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Summarized party details for the customer.","$ref":"#/components/schemas/SalesInvoicePartySummaryDto"}},"additionalProperties":false,"description":"Represents a summarized customer party view for sales 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."},"SalesInvoicePartySummaryDto":{"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"},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"}},"additionalProperties":false,"description":"Represents a summarized party view for sales invoice listings."},"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."},"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."}}}}
```

## The DeliveryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The DeliveryPartyDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The DeliveryTermsDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The DescriptionDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The DocumentCurrencyCodeDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The FinancialAccountDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The FinancialDimensionDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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)."}}}}
```

## The FinancialDimensionDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"FinancialDimensionDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"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 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."},"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)."}}}}
```

## The FinancialReportAccountBalanceSummaryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"FinancialReportAccountBalanceSummaryDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the balance.","$ref":"#/components/schemas/AccountingAccountDto"},"balance":{"description":"Balance for the accounting account.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an account balance summary within a financial report."},"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."},"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)."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."}}}}
```

## The FinancialReportBalanceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."}}}}
```

## The FinancialReportCategoryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"FinancialReportCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the category."},"balance":{"description":"Aggregated balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents an account balance summary within a financial report.","$ref":"#/components/schemas/FinancialReportAccountBalanceSummaryDto"},"description":"Collection of account balance summaries within this category."}},"additionalProperties":false,"description":"Represents a category within a financial report, supporting hierarchical sub-categories."},"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."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"FinancialReportAccountBalanceSummaryDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the balance.","$ref":"#/components/schemas/AccountingAccountDto"},"balance":{"description":"Balance for the accounting account.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an account balance summary within a financial report."},"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."},"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."},"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)."}}}}
```

## The FinancialReportDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"FinancialReportDto":{"type":"object","properties":{"categories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of financial report categories."}},"additionalProperties":false,"description":"Represents a financial report composed of categorized account data."},"FinancialReportCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the category."},"balance":{"description":"Aggregated balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents an account balance summary within a financial report.","$ref":"#/components/schemas/FinancialReportAccountBalanceSummaryDto"},"description":"Collection of account balance summaries within this category."}},"additionalProperties":false,"description":"Represents a category within a financial report, supporting hierarchical sub-categories."},"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."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"FinancialReportAccountBalanceSummaryDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the balance.","$ref":"#/components/schemas/AccountingAccountDto"},"balance":{"description":"Balance for the accounting account.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an account balance summary within a financial report."},"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."},"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."},"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)."}}}}
```

## The IdentifierDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The IncomeStatementDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"IncomeStatementDto":{"type":"object","properties":{"accountBalancePeriod":{"description":"Period covered by the income statement.","$ref":"#/components/schemas/PeriodDto"},"financialReport":{"description":"Financial report containing income statement categories.","$ref":"#/components/schemas/FinancialReportDto"},"profitLossBalance":{"description":"Net profit or loss balance for the period.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an income statement (profit and loss) financial report."},"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."},"FinancialReportDto":{"type":"object","properties":{"categories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of financial report categories."}},"additionalProperties":false,"description":"Represents a financial report composed of categorized account data."},"FinancialReportCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a description with an optional language identifier.","$ref":"#/components/schemas/DescriptionDto"},"description":"Collection of descriptions for the category."},"balance":{"description":"Aggregated balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a financial report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/FinancialReportCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents an account balance summary within a financial report.","$ref":"#/components/schemas/FinancialReportAccountBalanceSummaryDto"},"description":"Collection of account balance summaries within this category."}},"additionalProperties":false,"description":"Represents a category within a financial report, supporting hierarchical sub-categories."},"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."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"FinancialReportAccountBalanceSummaryDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the balance.","$ref":"#/components/schemas/AccountingAccountDto"},"balance":{"description":"Balance for the accounting account.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents an account balance summary within a financial report."},"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."},"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."},"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)."}}}}
```

## The InvoiceAttachmentDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"InvoiceAttachmentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the attachment."},"invoiceId":{"type":["null","string"],"description":"Identifier of the invoice this attachment belongs to."},"type":{"enum":["Attachment","Invoice"],"type":"string","description":"Type of the attachment (e.g. Attachment or Invoice)."},"fileName":{"type":["null","string"],"description":"Original file name of the attachment."}},"additionalProperties":false,"description":"Represents an attachment associated with an invoice."}}}}
```

## The InvoiceAttachmentDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"InvoiceAttachmentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents an attachment associated with an invoice.","$ref":"#/components/schemas/InvoiceAttachmentDto"},"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."},"InvoiceAttachmentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the attachment."},"invoiceId":{"type":["null","string"],"description":"Identifier of the invoice this attachment belongs to."},"type":{"enum":["Attachment","Invoice"],"type":"string","description":"Type of the attachment (e.g. Attachment or Invoice)."},"fileName":{"type":["null","string"],"description":"Original file name of the attachment."}},"additionalProperties":false,"description":"Represents an attachment associated with an invoice."}}}}
```

## The InvoiceLineDeliveryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The InvoiceLineDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"InvoiceLineDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice line."},"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 an invoice."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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)."},"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."}}}}
```

## The InvoicePaymentDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"InvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice payment."},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true},"reference":{"type":["null","string"],"description":"Payment reference string."},"receivedDate":{"type":["null","string"],"description":"Date the payment was received."},"paidDate":{"type":["null","string"],"description":"Date the payment was made."},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment has been booked."},"bookedDate":{"type":["null","string"],"description":"Date the payment was booked."},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references linked to the payment."},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount.","format":"double"},"creditAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount credited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount debited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents a payment associated with an 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."},"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)."},"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."},"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."},"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."},"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."}}}}
```

## The InvoicePaymentDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"InvoicePaymentDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a payment associated with an invoice.","$ref":"#/components/schemas/InvoicePaymentDto"},"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."},"InvoicePaymentDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice payment."},"paymentId":{"type":["null","string"],"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Reference instead. External payment identifier. (Deprecated: Use Reference instead)","deprecated":true},"reference":{"type":["null","string"],"description":"Payment reference string."},"receivedDate":{"type":["null","string"],"description":"Date the payment was received."},"paidDate":{"type":["null","string"],"description":"Date the payment was made."},"bookedIndicator":{"type":["null","boolean"],"description":"Indicates whether the payment has been booked."},"bookedDate":{"type":["null","string"],"description":"Date the payment was booked."},"accountingAccount":{"description":"Accounting account associated with the payment.","$ref":"#/components/schemas/AccountingAccountDto"},"status":{"description":"Payment condition status.","$ref":"#/components/schemas/PaymentConditionDto"},"billingReferences":{"type":["null","array"],"items":{"description":"Represents a billing reference containing invoice document references.","$ref":"#/components/schemas/BillingReferenceDto"},"description":"Collection of billing references linked to the payment."},"documentCurrencyCode":{"description":"Currency and exchange rate of the payment document.","$ref":"#/components/schemas/DocumentCurrencyCodeDto"},"amount":{"type":["null","number"],"description":"Monetary amount.","format":"double"},"creditAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount credited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"},"debitAmount":{"description":"Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Output.InvoicePaymentDto.Amount instead. Monetary amount debited. (Deprecated: Use Amount instead)","deprecated":true,"$ref":"#/components/schemas/AmountTypeDto"}},"additionalProperties":false,"description":"Represents a payment associated with an 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."},"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)."},"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."},"BillingReferenceDto":{"type":"object","properties":{"invoiceDocumentReferences":{"type":["null","array"],"items":{"description":"Represents a legal identifier with an associated scheme.","$ref":"#/components/schemas/IdentifierDto"},"description":"Collection of invoice document reference identifiers."}},"additionalProperties":false,"description":"Represents a billing reference containing invoice document references."},"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."},"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."},"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."}}}}
```

## The InvoicedQuantityDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The ItemDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The ItemInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The JournalDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"JournalDto":{"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 journal."},"transactionDate":{"type":["null","string"],"description":"Date when the transaction occurred. Format: yyyy-MM-dd."},"accountingSeries":{"description":"Accounting series the journal belongs to (null if not available).","$ref":"#/components/schemas/AccountingSeriesDto"},"description":{"description":"Description of the journal entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"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 journal."},"accountingEntries":{"type":["null","array"],"items":{"description":"Represents an accounting entry line within a journal.","$ref":"#/components/schemas/AccountingEntryDto"},"description":"Collection of accounting entries within the journal."}},"additionalProperties":false,"description":"Represents a journal entry with its accounting entries."},"AccountingSeriesDto":{"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 accounting series."},"accountingSeriesId":{"type":["null","string"],"description":"Accounting-system-specific identifier for the series."}},"additionalProperties":false,"description":"Represents an accounting series used to categorize journal entries."},"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."},"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)."},"AccountingEntryDto":{"type":"object","properties":{"description":{"description":"Description of the accounting entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"accountingAccount":{"description":"Accounting account associated with the entry (null if not available).","$ref":"#/components/schemas/AccountingAccountDto"},"debitAmount":{"description":"Monetary amount debited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"creditAmount":{"description":"Monetary amount credited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"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 entry."}},"additionalProperties":false,"description":"Represents an accounting entry line within a journal."},"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."},"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."},"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."}}}}
```

## The JournalDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"JournalDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a journal entry with its accounting entries.","$ref":"#/components/schemas/JournalDto"},"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."},"JournalDto":{"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 journal."},"transactionDate":{"type":["null","string"],"description":"Date when the transaction occurred. Format: yyyy-MM-dd."},"accountingSeries":{"description":"Accounting series the journal belongs to (null if not available).","$ref":"#/components/schemas/AccountingSeriesDto"},"description":{"description":"Description of the journal entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"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 journal."},"accountingEntries":{"type":["null","array"],"items":{"description":"Represents an accounting entry line within a journal.","$ref":"#/components/schemas/AccountingEntryDto"},"description":"Collection of accounting entries within the journal."}},"additionalProperties":false,"description":"Represents a journal entry with its accounting entries."},"AccountingSeriesDto":{"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 accounting series."},"accountingSeriesId":{"type":["null","string"],"description":"Accounting-system-specific identifier for the series."}},"additionalProperties":false,"description":"Represents an accounting series used to categorize journal entries."},"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."},"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)."},"AccountingEntryDto":{"type":"object","properties":{"description":{"description":"Description of the accounting entry (null if not available).","$ref":"#/components/schemas/DescriptionDto"},"accountingAccount":{"description":"Accounting account associated with the entry (null if not available).","$ref":"#/components/schemas/AccountingAccountDto"},"debitAmount":{"description":"Monetary amount debited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"creditAmount":{"description":"Monetary amount credited in the entry (null if not applicable).","$ref":"#/components/schemas/AmountTypeDto"},"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 entry."}},"additionalProperties":false,"description":"Represents an accounting entry line within a journal."},"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."},"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."},"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."}}}}
```

## The LegalMonetaryTotalDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."}}}}
```

## The NoteDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The OrderReferenceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The PagedResultMetadataDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The PartyDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The PartyInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The PartyLegalEntityDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."}}}}
```

## The PartyNameDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The PartySummaryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The PayeeFinancialAccountDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"PayeeFinancialAccountDto":{"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 payee's financial account details."}}}}
```

## The PaymentConditionDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"PaymentConditionDto":{"type":"object","properties":{"conditionCode":{"type":["null","string"],"description":"Code identifying the payment condition."},"referenceDate":{"type":["null","string"],"description":"Reference date associated with the payment condition.","format":"date-time"},"statusReason":{"type":["null","string"],"description":"Reason describing the payment status."}},"additionalProperties":false,"description":"Represents the condition or status of a payment."}}}}
```

## The PaymentMeansDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The PaymentMeansInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."}}}}
```

## The PaymentMeansNewDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"PaymentMeansNewDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means with financial account details."},"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."}}}}
```

## The PaymentStatusDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The PaymentTermsDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The PaymentTermsInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The PeriodDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The PriceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."},"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."},"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."},"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."},"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."}}}}
```

## The PriceInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."},"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."},"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."},"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."}}}}
```

## The PriceTypeCodeDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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":{}}}}}
```

## The ProviderRateLimitInformation object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"ProviderRateLimitInformation":{"type":"object","properties":{"responseHeaders":{"type":["null","object"],"additionalProperties":{"type":"string"}}},"additionalProperties":false}}}}
```

## The ReminderDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"ReminderDto":{"type":"object","properties":{"reminderSequence":{"type":["null","integer"],"description":"Sequence number of the reminder.","format":"int32"},"lastReminderDate":{"type":["null","string"],"description":"Date of the most recent reminder sent."}},"additionalProperties":false,"description":"Represents reminder information for an invoice."}}}}
```

## The SalesInvoiceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SalesInvoiceDto":{"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"},"sellerReference":{"type":["null","string"],"description":"External reference or number assigned by the seller."},"isSent":{"type":["null","boolean"],"description":"Indicates whether the invoice has been sent."},"isSold":{"type":["null","boolean"],"description":"Indicates whether the invoice is sold to a factoring company for lending purposes."},"reminder":{"description":"Reminder details associated with the invoice (null if not available).","$ref":"#/components/schemas/ReminderDto"},"invoiceLines":{"type":["null","array"],"items":{"description":"Represents a single line item on an invoice.","$ref":"#/components/schemas/InvoiceLineDto"},"description":"Collection of invoice line items."}},"additionalProperties":false,"description":"Represents a sales 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."},"ReminderDto":{"type":"object","properties":{"reminderSequence":{"type":["null","integer"],"description":"Sequence number of the reminder.","format":"int32"},"lastReminderDate":{"type":["null","string"],"description":"Date of the most recent reminder sent."}},"additionalProperties":false,"description":"Represents reminder information for an invoice."},"InvoiceLineDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice line."},"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 an invoice."},"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."},"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."},"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."}}}}
```

## The SalesInvoiceInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SalesInvoiceInputDto":{"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"},"isSent":{"type":["null","boolean"],"description":"Indicates whether the invoice has been sent."},"sellerReference":{"type":["null","string"],"description":"Reference for the seller."},"invoiceLines":{"type":["null","array"],"items":{"description":"Represents a line item on a sales invoice.","$ref":"#/components/schemas/SalesInvoiceLineInputDto"},"description":"Collection of sales invoice lines."}},"additionalProperties":false,"description":"Represents input data for a sales 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."},"SalesInvoiceLineInputDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice line."},"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 sales invoice."},"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."},"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."},"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."}}}}
```

## The SalesInvoiceLineInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SalesInvoiceLineInputDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the invoice line."},"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 sales invoice."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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)."},"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."}}}}
```

## The SalesInvoicePartySummaryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SalesInvoicePartySummaryDto":{"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"},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"}},"additionalProperties":false,"description":"Represents a summarized party view for sales 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."},"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."},"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."}}}}
```

## The SalesInvoiceSummaryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SalesInvoiceSummaryDto":{"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."},"isSent":{"type":["null","boolean"],"description":"Indicates whether the invoice has been sent."},"accountingCustomerParty":{"description":"Customer party on the invoice (null if not available).","$ref":"#/components/schemas/CustomerPartySummaryDto"},"paymentTerms":{"description":"Payment terms for the invoice (null if not available).","$ref":"#/components/schemas/PaymentTermsDto"},"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 sales invoice."},"CustomerPartySummaryDto":{"type":"object","properties":{"supplierAssignedAccountId":{"description":"Account identifier assigned to the customer by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Summarized party details for the customer.","$ref":"#/components/schemas/SalesInvoicePartySummaryDto"}},"additionalProperties":false,"description":"Represents a summarized customer party view for sales 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."},"SalesInvoicePartySummaryDto":{"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"},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"}},"additionalProperties":false,"description":"Represents a summarized party view for sales invoice listings."},"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."},"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."},"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."},"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."}}}}
```

## The SalesInvoiceSummaryDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SalesInvoiceSummaryDtoPagedResultDto":{"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 sales invoice.","$ref":"#/components/schemas/SalesInvoiceSummaryDto"},"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."},"SalesInvoiceSummaryDto":{"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."},"isSent":{"type":["null","boolean"],"description":"Indicates whether the invoice has been sent."},"accountingCustomerParty":{"description":"Customer party on the invoice (null if not available).","$ref":"#/components/schemas/CustomerPartySummaryDto"},"paymentTerms":{"description":"Payment terms for the invoice (null if not available).","$ref":"#/components/schemas/PaymentTermsDto"},"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 sales invoice."},"CustomerPartySummaryDto":{"type":"object","properties":{"supplierAssignedAccountId":{"description":"Account identifier assigned to the customer by the supplier.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Summarized party details for the customer.","$ref":"#/components/schemas/SalesInvoicePartySummaryDto"}},"additionalProperties":false,"description":"Represents a summarized customer party view for sales 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."},"SalesInvoicePartySummaryDto":{"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"},"partyLegalEntity":{"description":"Legal entity information for the party.","$ref":"#/components/schemas/PartyLegalEntityDto"}},"additionalProperties":false,"description":"Represents a summarized party view for sales invoice listings."},"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."},"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."},"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."},"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."}}}}
```

## The SeedDataResponseDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SeedDataResponseDto":{"type":"object","properties":{"results":{"type":["null","array"],"items":{"$ref":"#/components/schemas/SeedDataResult"}}},"additionalProperties":false},"SeedDataResult":{"type":"object","properties":{"resourceName":{"type":["null","string"]},"resourceKey":{"type":["null","string"]},"isSuccess":{"type":"boolean"},"resourceId":{"type":["null","string"]},"message":{"type":["null","string"]}},"additionalProperties":false}}}}
```

## The SeedDataResult object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SeedDataResult":{"type":"object","properties":{"resourceName":{"type":["null","string"]},"resourceKey":{"type":["null","string"]},"isSuccess":{"type":"boolean"},"resourceId":{"type":["null","string"]},"message":{"type":["null","string"]}},"additionalProperties":false}}}}
```

## The SellersItemIdentificationDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The SubInvoiceLineDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."},"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."}}}}
```

## The SubInvoiceLineInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."},"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."}}}}
```

## The SupplierDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SupplierDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the supplier."},"customerAssignedAccountId":{"description":"System-generated account identifier assigned by the customer.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details associated with the supplier.","$ref":"#/components/schemas/PartyDto"},"deliveryAddresses":{"type":["null","array"],"items":{"description":"Represents a postal address.","$ref":"#/components/schemas/AddressDto"},"description":"Collection of delivery addresses for the supplier."},"description":{"description":"Descriptive note for the supplier.","$ref":"#/components/schemas/NoteDto"},"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 supplier."},"active":{"type":["null","boolean"],"description":"Indicates whether the supplier is active."},"currency":{"type":["null","string"],"description":"Currency code associated with the supplier."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means associated with a supplier.","$ref":"#/components/schemas/SupplierPaymentMeansDto"},"description":"Collection of payment means for the supplier."}},"additionalProperties":false,"description":"Represents a supplier entity in the accounting system."},"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."},"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."},"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)."},"SupplierPaymentMeansDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccounts":{"type":["null","array"],"items":{"description":"Represents a payee's financial account details.","$ref":"#/components/schemas/PayeeFinancialAccountDto"},"description":"Collection of payee financial accounts. Obsolete: use FinancialAccount instead. (Deprecated: Use PayeeFinancialAccount instead)","deprecated":true},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means associated with a supplier."},"PayeeFinancialAccountDto":{"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 payee's financial account details."},"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."}}}}
```

## The SupplierDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SupplierDtoPagedResultDto":{"type":"object","properties":{"meta":{"description":"Pagination metadata for the result set.","$ref":"#/components/schemas/PagedResultMetadataDto"},"data":{"type":["null","array"],"items":{"description":"Represents a supplier entity in the accounting system.","$ref":"#/components/schemas/SupplierDto"},"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."},"SupplierDto":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Unique identifier for the supplier."},"customerAssignedAccountId":{"description":"System-generated account identifier assigned by the customer.","$ref":"#/components/schemas/IdentifierDto"},"party":{"description":"Party details associated with the supplier.","$ref":"#/components/schemas/PartyDto"},"deliveryAddresses":{"type":["null","array"],"items":{"description":"Represents a postal address.","$ref":"#/components/schemas/AddressDto"},"description":"Collection of delivery addresses for the supplier."},"description":{"description":"Descriptive note for the supplier.","$ref":"#/components/schemas/NoteDto"},"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 supplier."},"active":{"type":["null","boolean"],"description":"Indicates whether the supplier is active."},"currency":{"type":["null","string"],"description":"Currency code associated with the supplier."},"paymentMeans":{"type":["null","array"],"items":{"description":"Represents payment means associated with a supplier.","$ref":"#/components/schemas/SupplierPaymentMeansDto"},"description":"Collection of payment means for the supplier."}},"additionalProperties":false,"description":"Represents a supplier entity in the accounting system."},"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."},"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."},"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)."},"SupplierPaymentMeansDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccounts":{"type":["null","array"],"items":{"description":"Represents a payee's financial account details.","$ref":"#/components/schemas/PayeeFinancialAccountDto"},"description":"Collection of payee financial accounts. Obsolete: use FinancialAccount instead. (Deprecated: Use PayeeFinancialAccount instead)","deprecated":true},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means associated with a supplier."},"PayeeFinancialAccountDto":{"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 payee's financial account details."},"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."}}}}
```

## The SupplierInvoiceDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"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."}}}}
```

## The SupplierInvoiceInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"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."}}}}
```

## The SupplierInvoiceLineDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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)."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."}}}}
```

## The SupplierInvoiceLineInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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)."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."}}}}
```

## The SupplierInvoiceSummaryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The SupplierInvoiceSummaryDtoPagedResultDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"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."}}}}
```

## The SupplierPartyDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The SupplierPartyInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The SupplierPartySummaryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The SupplierPaymentMeansDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"SupplierPaymentMeansDto":{"type":"object","properties":{"paymentChannelCode":{"type":["null","string"],"description":"Code identifying the payment channel."},"payeeFinancialAccounts":{"type":["null","array"],"items":{"description":"Represents a payee's financial account details.","$ref":"#/components/schemas/PayeeFinancialAccountDto"},"description":"Collection of payee financial accounts. Obsolete: use FinancialAccount instead. (Deprecated: Use PayeeFinancialAccount instead)","deprecated":true},"payeeFinancialAccount":{"type":["null","string"],"description":"Payee financial account identifier. Obsolete: use FinancialAccount.Id instead. (Deprecated: Use FinancialAccount.Id instead)","deprecated":true},"financialAccount":{"description":"Financial account used for the payment.","$ref":"#/components/schemas/FinancialAccountDto"}},"additionalProperties":false,"description":"Represents payment means associated with a supplier."},"PayeeFinancialAccountDto":{"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 payee's financial account details."},"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."}}}}
```

## The TaxCategoryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."}}}}
```

## The TaxCategoryTaxSchemeDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The TaxSchemeDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"TaxSchemeDto":{"type":"object","properties":{"taxSchemeId":{"description":"Identifier of the tax scheme.","$ref":"#/components/schemas/IdentifierDto"}},"additionalProperties":false,"description":"Represents a tax scheme."},"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."}}}}
```

## The TaxSubtotalDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The TaxSubtotalTaxCategoryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."}}}}
```

## The TaxTotalDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The TaxTotalInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The TrialBalanceCategoryDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"TrialBalanceCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of descriptions for the category."},"endingBalance":{"description":"Ending balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/TrialBalanceCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents a trial balance entry for a specific accounting account.","$ref":"#/components/schemas/AccountTrialBalanceDto"},"description":"Collection of account-level trial balance entries within this category."}},"additionalProperties":false,"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories."},"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."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"AccountTrialBalanceDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the trial balance entry.","$ref":"#/components/schemas/AccountingAccountDto"},"endingBalance":{"description":"Ending balance for the account.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the period.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents a trial balance entry for a specific accounting account."},"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."},"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)."}}}}
```

## The TrialBalancesDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"TrialBalancesDto":{"type":"object","properties":{"trialBalancePeriod":{"description":"Period covered by the trial balance.","$ref":"#/components/schemas/PeriodDto"},"financialReport":{"description":"Financial report containing trial balance data.","$ref":"#/components/schemas/TrialBalancesFinancialReportDto"}},"additionalProperties":false,"description":"Represents a trial balance report for a given period."},"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."},"TrialBalancesFinancialReportDto":{"type":"object","properties":{"accounts":{"type":["null","array"],"items":{"description":"Represents a trial balance entry for a specific accounting account.","$ref":"#/components/schemas/AccountTrialBalanceDto"},"description":"Collection of account-level trial balance entries."},"categories":{"type":["null","array"],"items":{"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/TrialBalanceCategoryDto"},"description":"Collection of trial balance categories."}},"additionalProperties":false,"description":"Represents the financial report structure for a trial balance."},"AccountTrialBalanceDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the trial balance entry.","$ref":"#/components/schemas/AccountingAccountDto"},"endingBalance":{"description":"Ending balance for the account.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the period.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents a trial balance entry for a specific accounting account."},"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."},"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)."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"TrialBalanceCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of descriptions for the category."},"endingBalance":{"description":"Ending balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/TrialBalanceCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents a trial balance entry for a specific accounting account.","$ref":"#/components/schemas/AccountTrialBalanceDto"},"description":"Collection of account-level trial balance entries within this category."}},"additionalProperties":false,"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories."},"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."}}}}
```

## The TrialBalancesFinancialReportDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"TrialBalancesFinancialReportDto":{"type":"object","properties":{"accounts":{"type":["null","array"],"items":{"description":"Represents a trial balance entry for a specific accounting account.","$ref":"#/components/schemas/AccountTrialBalanceDto"},"description":"Collection of account-level trial balance entries."},"categories":{"type":["null","array"],"items":{"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/TrialBalanceCategoryDto"},"description":"Collection of trial balance categories."}},"additionalProperties":false,"description":"Represents the financial report structure for a trial balance."},"AccountTrialBalanceDto":{"type":"object","properties":{"accountingAccount":{"description":"Accounting account associated with the trial balance entry.","$ref":"#/components/schemas/AccountingAccountDto"},"endingBalance":{"description":"Ending balance for the account.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the period.","$ref":"#/components/schemas/FinancialReportBalanceDto"}},"additionalProperties":false,"description":"Represents a trial balance entry for a specific accounting account."},"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."},"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)."},"FinancialReportBalanceDto":{"type":"object","properties":{"baseCurrencies":{"type":["null","array"],"items":{"description":"Represents a monetary amount in a specific base currency.","$ref":"#/components/schemas/BaseCurrencyDto"},"description":"Collection of base currency amounts for the balance."}},"additionalProperties":false,"description":"Represents a balance in a financial report expressed in one or more currencies."},"BaseCurrencyDto":{"type":"object","properties":{"currencyId":{"type":["null","string"],"description":"Currency code identifier (e.g. SEK, EUR)."},"baseAmount":{"type":"number","description":"Monetary amount in the base currency.","format":"double"}},"additionalProperties":false,"description":"Represents a monetary amount in a specific base currency."},"TrialBalanceCategoryDto":{"type":"object","properties":{"descriptions":{"type":["null","array"],"items":{"description":"Represents a textual note with an optional language identifier.","$ref":"#/components/schemas/NoteDto"},"description":"Collection of descriptions for the category."},"endingBalance":{"description":"Ending balance for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"accountMovement":{"description":"Account movement (net change) for the category.","$ref":"#/components/schemas/FinancialReportBalanceDto"},"subCategories":{"type":["null","array"],"items":{"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories.","$ref":"#/components/schemas/TrialBalanceCategoryDto"},"description":"Collection of child categories within this category."},"accounts":{"type":["null","array"],"items":{"description":"Represents a trial balance entry for a specific accounting account.","$ref":"#/components/schemas/AccountTrialBalanceDto"},"description":"Collection of account-level trial balance entries within this category."}},"additionalProperties":false,"description":"Represents a category within a trial balance report, supporting hierarchical sub-categories."},"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."}}}}
```

## The WithholdingTaxTotalDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```

## The WithholdingTaxTotalInputDto object

```json
{"openapi":"3.1.1","info":{"title":"Accounting API","version":"v1"},"components":{"schemas":{"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."},"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."},"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."}}}}
```


# 2026

{% updates format="full" %}
{% update date="2026-10-22" tags="new" %}

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added Headless Onboarding (Preview): build your own customer onboarding experience and connect accounting systems from your backend through the Consent API. Supported systems are Fortnox, Xero, Microsoft Dynamics 365 Business Central, Procountor, Spiris, Björn Lundén and Netvisor. See the <a href="https://docs.zwapgrid.com/onboarding-flow/headless-onboarding">Headless Onboarding guides</a> for setup, request examples and security guidance.</li><li>Preview features and APIs may change or improve with short notice.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-10-21" tags="new" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Procountor</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /customers/{customerId}</code> and <code>GET /suppliers/{supplierId}</code>. Use an ID returned by the corresponding customer or supplier list to retrieve that party's details.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-10-16" tags="new,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Microsoft Dynamics 365 Business Central</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /suppliers/{supplierId}</code>. Use a supplier ID returned by <code>GET /suppliers</code> to retrieve that supplier's details.</li></ul></td></tr><tr><td>Fortnox</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Customers with supplier-invoice status filtering enabled can use <code>status=PendingPayment</code> with <code>GET /supplierinvoices</code> to list invoices pending payment in Fortnox. This list filter does not add a new per-invoice <code>paymentStatus</code> value.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-10-13" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Visma Netvisor</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Updated authentication to Netvisor's required HMACSHA256 method. Existing connections continue to use their stored credentials.</li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /accountingaccounts</code> with paginated results.</li></ul></td></tr><tr><td>Visma eAccounting</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Extended Norwegian support for accounting account descriptions, invoice VAT information, notes, payment details and sales invoice bank-account selection.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected sales invoice creation during seed data runs. Failed items now include field-level validation details when available.</li></ul></td></tr><tr><td>Fortnox</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /suppliers/{supplierId}</code>.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-10-08" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Kleer</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /journals</code>, <code>GET /journals/{journalId}</code> and <code>GET /supplierinvoices/payments</code>.</li></ul></td></tr><tr><td>Visma eAccounting</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Added Norwegian account grouping for trial balances at levels 1–3. Accounts outside standard Norwegian report ranges are retained in an Other accounts group. Level 4 is not supported for Norwegian companies.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected currency handling when posting sales and supplier invoice payments, including NOK for Norwegian companies, and corrected payment date formatting. Payments and journals can now use the company's Swedish or Norwegian country when its currency code is missing.</li></ul></td></tr><tr><td>Visma Netvisor</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected sales invoice totals, outstanding balances and payment status for foreign-currency invoices. List and detail responses use the original invoice currency.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected supplier invoice totals and outstanding balances to consistently use EUR in list and detail responses. Document currency and line amounts retain their original currency. Read each monetary amount using its own <code>currencyId</code>.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected supplier invoice line discounts and VAT details. When source amounts reconcile, discounted lines now expose the unit price before discount, excluding VAT, together with an explicit line allowance amount. The returned line total remains after discount.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected sales invoice fractional quantities, product codes and list due dates, and timestamp-based invoice filtering.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Settlement-date lookup failures now preserve known invoice amounts and payment status.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected income statement date ranges spanning accounting periods, including transactions on the requested start date.</li></ul></td></tr><tr><td>Xero</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Improved handling of Xero request limits to avoid unnecessary timeout errors and provide retry guidance when available.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-10-02" tags="new,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Visma Netvisor</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for connecting Netvisor Sandbox companies to test your integration before connecting live companies. Choose Sandbox or Production in System Settings. Existing connections are unchanged.</li></ul></td></tr><tr><td>Visma eAccounting</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Corrected currency handling in <code>POST /journals</code> for Norwegian companies. Booked and draft journals now use the connected company's currency, such as NOK, instead of assuming SEK when converting foreign-currency amounts.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-09-28" tags="new,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>DATEV</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Introduced DATEV Online as a new accounting system, with company-bound offline connections, <code>GET /accountingperiods</code>, and company-scoped Accounting Data Exchange access through Proxy.1.</li></ul></td></tr><tr><td>Visma eAccounting</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Extended <code>GET /balancesheet</code> and <code>GET /incomestatement</code> with Norwegian account mappings, selected from the connected company's country.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-09-24" tags="new" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Visma eAccounting</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>POST /salesinvoices</code></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-09-17" tags="new" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Kleer</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /supplierinvoices</code></li><li><code>GET /supplierinvoices/:id</code></li><li><code>GET /supplierinvoices/:id/attachments/printable</code></li><li><code>GET /supplierinvoices/:id/payments</code></li><li><code>GET /salesinvoices</code></li><li><code>GET /salesinvoices/:id</code></li><li><code>GET /salesinvoices/:id/attachments/printable</code></li><li><code>GET /companyinformation</code></li><li><code>GET /customers</code></li><li><code>GET /customers/:id</code></li><li><code>GET /suppliers</code></li><li><code>GET /suppliers/:id</code></li><li><code>GET /accountingperiods</code></li><li><code>GET /accountingaccounts</code></li><li><code>GET /financialdimensions</code></li></ul></li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>POST /salesinvoices</code> to create unsent, uncertified sales invoice drafts. Kleer derives tax, accounting coding and totals from products; booking and sending are not supported.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-08-24" tags="new,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Björn Lundén</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for populating test companies with seed data</li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /accountingperiods</code></li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved seed-data validation against accounting-period locks and bookkeeping methods</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-08-11" tags="new" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Visma Dinero</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /customers</code></li><li><code>GET /customers/:id</code></li><li><code>GET /suppliers</code></li><li><code>GET /suppliers/:id</code></li><li><code>GET /companyinformation</code></li><li><code>GET /accountingaccounts</code></li><li><code>GET /accountingperiods</code></li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-08-06" tags="improved" %}

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Client Portal</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Expanded the Quick Start Guide to support every system, including seed data for Spiris</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-07-30" tags="improved" %}

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Client Portal</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved the Quick Start Guide experience and its optional seed data flow</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-07-24" tags="improved" %}

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Client Portal &#x26; Billing</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Removed plan-based creation blockers for users, systems, API keys and test API keys, while showing included usage allowances in the Client Portal</li></ul></li><li><p>Documentation</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] API documentation now shows the base URL alongside relative endpoint paths</li></ul></li><li><p>Security</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Applied routine platform security and dependency updates</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-07-17" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Exact Online</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /customers</code></li><li><code>GET /customers/:id</code></li><li><code>GET /suppliers</code></li><li><code>GET /suppliers/:id</code></li><li><code>GET /companyinformation</code></li><li><code>GET /accountingaccounts</code></li><li><code>GET /accountingperiods</code></li></ul></li></ul></td></tr><tr><td>Visma Dinero</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected date formatting for <code>GET /balancesheet</code> and <code>GET /incomestatement</code> requests</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Security</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Applied routine platform security and dependency updates</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-07-13" tags="new,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Billy</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /customers</code></li><li><code>GET /customers/:id</code></li><li><code>GET /suppliers</code></li><li><code>GET /suppliers/:id</code></li><li><code>GET /companyinformation</code></li><li><code>GET /accountingaccounts</code></li><li><code>GET /accountingperiods</code></li></ul></li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Client Portal</p><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Introduced a Quick Start Guide with an optional seed data path</li></ul></li><li><p>Onboarding</p><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved a logout issue during onboarding</li></ul></li><li><p>API</p><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for a seed data endpoint in the Accounting API</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-07-08" tags="new,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Bokio</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting attachments to supplier invoices (<code>POST /supplierinvoices/:id/attachments</code>)</li></ul></td></tr><tr><td>Procountor</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Clearer error response when Procountor is temporarily unavailable</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-06-29" tags="new,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Bokio</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for supplier invoices:</p><ul><li><code>GET /supplierinvoices</code></li><li><code>GET /supplierinvoices/:id</code></li><li><code>POST /supplierinvoices</code></li></ul></li></ul></td></tr><tr><td>QuickBooks</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /customers</code></li><li><code>GET /customers/:id</code></li><li><code>GET /suppliers</code></li><li><code>GET /suppliers/:id</code></li><li><code>GET /companyinformation</code></li><li><code>GET /accountingaccounts</code></li></ul></li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Allow creating draft supplier invoices without invoice lines when <code>bookedInvoiceIndicator</code> is <code>false</code></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-06-16" tags="improved,fixed" %}

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>API errors</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Customer API error responses now include the underlying ERP error alongside <code>errorCode</code> and <code>errorMessage</code></li></ul></li><li><p>System Settings</p><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Newly added systems now remain available by default while admin-configured own-credential requirements are preserved</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-06-15" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Bokio</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /salesinvoices</code></li><li><code>GET /salesinvoices/:id</code></li></ul></li></ul></td></tr><tr><td>File.1</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Added sorting, filtering and pagination support for uploaded file lists</li></ul></td></tr><tr><td>Fortnox</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Allow creating draft supplier invoices without invoice lines when <code>bookedInvoiceIndicator</code> is <code>false</code></li></ul></td></tr><tr><td>Procountor</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /salesinvoices/:id/payments</code></li></ul></td></tr><tr><td>QuickBooks</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /salesinvoices/:id</code></li><li><code>GET /salesinvoices/:id/attachments</code></li><li><code>GET /salesinvoices/:id/attachments/:attachmentId</code></li><li><code>GET /salesinvoices/:id/attachments/printable</code></li></ul></li></ul></td></tr><tr><td>Visma e-conomic</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>POST /salesinvoices</code></li><li>Fetching draft sales invoice lists using <code>GET /salesinvoices?status=Draft</code></li><li>Fetching draft sales invoice details using <code>GET /salesinvoices/:id</code></li><li><code>GET /supplierinvoices</code></li></ul></li></ul></td></tr><tr><td>Xero</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /salesinvoices</code></li><li><code>GET /salesinvoices/:id</code></li><li><code>GET /salesinvoices/payments</code></li><li><code>GET /salesinvoices/:id/attachments</code></li><li><code>GET /salesinvoices/:id/attachments/:attachmentId</code></li><li><code>GET /salesinvoices/:id/attachments/printable</code></li><li><code>GET /supplierinvoices</code></li><li><code>POST /journals</code></li></ul></li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Fixed incorrect date values in Xero responses.</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-06-11" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Billy</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved 500 error when Billy returns an invalid JSON response during journal attachment posting</li></ul></td></tr><tr><td>Xero</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /accountingperiods</code></li><li><code>GET /financialdimensions</code></li><li>Supplier invoice payments</li></ul></li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Documentation</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Updated API documentation status icons from under construction to available</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-06-10" tags="improved" %}

## Changelog RSS feed support

Now you can subscribe to this page using RSS feed.
{% endupdate %}

{% update date="2026-06-05" tags="improved" %}

## Systems

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Onboarding</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Added error codes for Visma Netvisor and Procountor so failed requests return clearer, context-specific error messages</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-06-03" tags="new,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Björn Lundén</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /trialbalances</code></li></ul></td></tr><tr><td>Procountor</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Standardized response when a requested trial balance level exceeds the level supported by the system</li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Returns <code>501 Not Implemented</code> when a requested trial balance level is not supported</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Billing</p><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Introduced a new pricing model with Explore and Growth plan selection in the Client Portal</li></ul></li><li><p>User Management</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Raised the maximum number of users per client</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-06-01" tags="new,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Fortnox</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /suppliers</code></li></ul></td></tr><tr><td>Procountor</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting draft journals using <code>POST /journals</code></li></ul></td></tr><tr><td>QuickBooks</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved 500 error when the connected user lacks access to a QuickBooks endpoint (now surfaced correctly as a 403)</li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting draft journals</li></ul></td></tr><tr><td>Visma Netvisor</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /incomestatement</code></li><li><code>GET /balancesheet</code></li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-05-28" tags="new,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Billy</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting attachments to journals (<code>POST /journals/:id/attachments</code>)</li></ul></td></tr><tr><td>Björn Lundén</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /companyinformation</code></li></ul></td></tr><tr><td>Bokio</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for retrieving sales invoice attachments and printable invoices (<code>GET /salesinvoices/:id</code>)</li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /companyinformation</code></li></ul></td></tr><tr><td>Visma Dinero</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting attachments to journals (<code>POST /journals/:id/attachments</code>)</li></ul></td></tr><tr><td>Visma e-conomic</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting attachments to journals (<code>POST /journals/:id/attachments</code>)</li></ul></td></tr><tr><td>Visma Netvisor</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /accountingperiods</code></li></ul></td></tr><tr><td>Xero</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /accountingaccounts</code></li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Onboarding &#x26; Credential Collection</p><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Introduced a pure credential-collection UI alternative, allowing clients to provide their own user instructions and use the service only to collect and handle credentials</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Fixed invitation acceptance incorrectly counting active invitations toward the member tier limit</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-05-26" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>All systems</td><td><ul><li><p>[<mark style="color:blue;"><strong>Improved</strong></mark>] Updated income statement &#x26; balance sheet mappings for more accurate financial reporting</p><ul><li>More granular breakouts for cash &#x26; bank, equity vs. liabilities, receivables risk and tax-related accounts on the balance sheet</li><li>Separated capitalized own work and refined financial-item groupings on the income statement</li></ul></li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Documentation</p><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Published API documentation on GitBook</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Fixed authentication for the accounting documentation job</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-05-22" tags="new,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Billy</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <strong>supplier invoice lines</strong></li></ul></td></tr><tr><td>Björn Lundén</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <strong>supplier invoice lines</strong></li></ul></td></tr><tr><td>Bokio</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <strong>connection creation</strong></li></ul></td></tr><tr><td>File.1</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved 502 error when uploading files</li></ul></td></tr><tr><td>Fortnox</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Fixed handling of item description on supplier invoice lines</li></ul></td></tr><tr><td>Microsoft Dynamics 365 Business Central</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved 500 error during onboarding when company lookup returned a 401</li></ul></td></tr><tr><td>Procountor</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <strong>supplier invoice lines</strong></li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting attachments to draft supplier invoices</li><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li>Fetching draft sales invoices and sales invoice by id</li><li><code>GET /supplierinvoicesdraft/:id</code></li></ul></li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved 500 error on <code>POST /supplierinvoice</code> payment</li></ul></td></tr><tr><td>Visma Dinero</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved handling of <code>POST</code> draft journal</li></ul></td></tr><tr><td>Visma Netvisor</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li>Supplier invoice lines</li><li><code>GET /trialbalances</code></li></ul></li></ul></td></tr><tr><td>Xero</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>/companyinformation</code></li><li>Suppliers</li></ul></li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved Proxy.1 request handling</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved onboarding flow</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Onboarding &#x26; Client Management</p><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Fixed connection creation during onboarding when no systems were available</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Onboarding now disables action buttons when the user cannot interact with them</li></ul></li><li><p>System Settings</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Removed the restriction on the number of System Settings that can be created</li></ul></li><li><p>Billing</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Aligned customer billing cycle with the 1st of the month</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Removed the <code>Card</code> filter for payment methods</li></ul></li><li><p>Platform Stability &#x26; Security</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved token refresh concurrency handling for Fortnox and OAuth-based systems</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved audit logging</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Addressed Dockerfile security issues</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-05-04" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Billy</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved support for <strong>Proxy.1 requests</strong>, including additional headers</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved handling of <strong>journal creation and draft posting</strong></li></ul></td></tr><tr><td>File.1</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Fixed issue preventing upload of attachments larger than 1 MB</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved handling of logout when consent is deleted during session</li></ul></td></tr><tr><td>Procountor</td><td><ul><li><p>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved support for financial reporting endpoints:</p><ul><li><code>GET /incomestatement</code></li><li><code>GET /balancesheet</code></li></ul></li></ul></td></tr><tr><td>QuickBooks</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li>Connection creation</li><li><code>GET /salesinvoices</code></li><li>Proxy.1 support</li></ul></li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Enforced <strong>System Settings</strong> for QuickBooks connections</li></ul></td></tr><tr><td>Tripletex</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>/companyinformation</code> endpoint</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved Proxy.1 request handling</li></ul></td></tr><tr><td>Xero</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li>Connection creation in onboarding</li><li>Proxy.1 support</li><li>GET /customers</li><li>GET /customers/{customerId}</li></ul></li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Onboarding &#x26; Client Management</p><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Trial client improvements:<br>Clients now have access to production systems for the entire 2 week period</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved onboarding reliability and logging<br>System Settings</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Added additional validation when publishing System Settings</li></ul></li><li><p>API &#x26; Data Model</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Standardized amount fields for sales invoices</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved validation for systems requiring own credentials</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved concurrency handling in Consents API</li></ul></li><li><p>Internationalization</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved language handling in URLs<br>Expanded language support in onboarding and File.1</li></ul></li><li><p>Security</p><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Addressed multiple security vulnerabilities, including:<br>Open redirect risks<br>Authorization bypass scenarios<br>Injection vulnerabilities</li></ul></li><li><p>Platform Stability</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved error handling and resilience:<br>Better handling of database concurrency issues<br>Improved handling of external API responses (e.g. 412 responses)</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] General platform improvements and dependency updates</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-04-07" tags="new,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Billy</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting draft journals using <code>POST /journals</code></p><ul><li>Use <code>bookedInvoiceIndicator = true</code> to post a draft journal</li></ul></li></ul></td></tr><tr><td>Bjorn Lunden</td><td><ul><li><p>[<mark style="color:blue;"><strong>Improved</strong></mark>] Restructure of Swedish <code>/balancesheet</code>, <code>/incomestatement</code> and <code>/trialbalances</code></p><ul><li><p><code>/balancesheet</code><strong>:</strong> Added one hierarchy level (now 4 total, excl. accounts) and restructured categories (updated account ranges + naming aligned with financial reporting standards).</p><ul><li>To keep previous response, change the level to be = 4</li></ul></li><li><code>/incomestatement</code><strong>:</strong> Restructured categories (updated account ranges + naming), no new levels.</li><li><p><code>/trialbalances</code><strong>:</strong> No model changes, but implicitly affected since it depends on updated account ranges. Documentation examples updated accordingly.</p><ul><li>To keep previous response, change the level to be = 4</li></ul></li></ul></li></ul></td></tr><tr><td>Fortnox</td><td><ul><li><p>[<mark style="color:blue;"><strong>Improved</strong></mark>] Restructure of Swedish <code>/balancesheet</code>, <code>/incomestatement</code> and <code>/trialbalances</code></p><ul><li><p><code>/balancesheet</code><strong>:</strong> Added one hierarchy level (now 4 total, excl. accounts) and restructured categories (updated account ranges + naming aligned with financial reporting standards).</p><ul><li>To keep previous response, change the level to be = 4</li></ul></li><li><code>/incomestatement</code><strong>:</strong> Restructured categories (updated account ranges + naming), no new levels.</li><li><p><code>/trialbalances</code><strong>:</strong> No model changes, but implicitly affected since it depends on updated account ranges. Documentation examples updated accordingly.</p><ul><li>To keep previous response, change the level to be = 4</li></ul></li></ul></li></ul></td></tr><tr><td>Procountor</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /suppliers</code></li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /customers</code></li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>POST /supplierInvoices/:id/payments</code></li><li><p>[<mark style="color:blue;"><strong>Improved</strong></mark>] Restructure of Swedish <code>/balancesheet</code>, <code>/incomestatement</code> and <code>/trialbalances</code></p><ul><li><p><code>/balancesheet</code><strong>:</strong> Added one hierarchy level (now 4 total, excl. accounts) and restructured categories (updated account ranges + naming aligned with financial reporting standards).</p><ul><li>To keep previous response, change the level to be = 4</li></ul></li><li><code>/incomestatement</code><strong>:</strong> Restructured categories (updated account ranges + naming), no new levels.</li><li><p><code>/trialbalances</code><strong>:</strong> No model changes, but implicitly affected since it depends on updated account ranges. Documentation examples updated accordingly.</p><ul><li>To keep previous response, change the level to be = 4</li></ul></li></ul></li></ul></td></tr><tr><td>Visma Dinero</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting draft journals using <code>POST /journals</code></p><ul><li>Use <code>bookedInvoiceIndicator = true</code> to post a draft journal</li></ul></li></ul></td></tr><tr><td>Visma e-conomic</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for posting draft journals using <code>POST /journals</code></p><ul><li>Use <code>bookedInvoiceIndicator = true</code> to post a draft journal</li></ul></li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Security updates</p><ul><li>Addressed vulnerabilities identified in dependencies.</li></ul></li><li><p>Reduced risk for broken integrations</p><ul><li>Reduced risk for inconsistent authentication errors in concurrent requests</li><li>Reduced risk for integrations getting stuck in invalid states due to failed token refresh</li><li>Reduced risk for missing consent invalidation leading to repeated failures</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-03-25" tags="new,improved,fixed,changed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>All systems</td><td><ul><li><p>Supplier Invoices &#x26; Payments</p><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added amount field to payments</li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for currency rate on payments</li><li><p>[<mark style="color:blue;"><strong>Improved</strong></mark>] Added filtering capabilities:</p><ul><li>Filter by status in supplier invoice list</li><li>Additional filtering options for <code>GET /supplierinvoices</code></li></ul></li></ul></li></ul></td></tr><tr><td>Exact Online</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added support for:</p><ul><li><code>GET /salesinvoices</code></li><li><code>GET /salesinvoices/:id</code></li><li>Attachments and printable versions for sales invoices</li></ul></li><li>[<mark style="color:green;"><strong>New</strong></mark>] Enabled Proxy 1 support for Exact Online</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with token refresh handling</li></ul></td></tr><tr><td>Fortnox</td><td><ul><li><mark style="color:green;"><strong>New</strong></mark>] Added support for <code>POST /supplierinvoices/:id/payments</code></li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Added taxInclusiveAmount mapping for <code>GET /salesinvoices</code></li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved errors during parallel API requests</li></ul></td></tr><tr><td>Procountor</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Supplier invoice list now filters out non-booked invoices</li></ul></td></tr><tr><td>Visma e-conomic</td><td><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved handling of 5xx responses</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Documentation</p><ul><li><p>[<mark style="color:blue;"><strong>Improved</strong></mark>] API documentation is now automatically generated from source code</p><ul><li>OpenAPI documentation always reflects the current implementation</li><li>Changes are available immediately upon release</li></ul></li></ul></li><li><p>API changes</p><ul><li>[<mark style="color:yellow;"><strong>Changed</strong></mark>] Removed <code>financialDimensionId</code> from <code>financialDimensions</code></li><li>[<mark style="color:yellow;"><strong>Changed</strong></mark>] Marked <code>paymentId</code> in payments as obsolete (see deprecation schedule for replacement)</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Corrected missing <code>deprecated: true</code> flags in Swagger</li></ul></li><li><p>Reliability &#x26; Error Handling</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved failure handling in file processing</li></ul></li><li><p>Security updates</p><ul><li>Addressed vulnerabilities identified in dependencies.</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-03-16" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>All systems</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Internationalization</p><ul><li><p>Added support for additional languages in Onboarding and File.1:</p><ul><li>Norwegian</li><li>Danish</li><li>Finnish</li><li>Dutch</li><li>German</li></ul></li></ul></li></ul></td></tr><tr><td>Exact Online</td><td><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Initial support for Exact Online</p><ul><li>Includes connection setup and client portal functionality</li></ul></li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li><p>Branding (Brand Settings)</p><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Introduced Brand Settings for managing branding across Onboarding and File.1</p><ul><li><p>Support for configuring:</p><ul><li><p>Logo</p><ul><li>Company name</li><li>Website URL</li><li>Allowed redirect domains (security safeguard)</li></ul></li></ul></li><li>Support for creating multiple brand settings per client</li><li><p>Added ability to publish brand settings</p><ul><li>Only one customization can be active at a time</li><li>Draft → Publish workflow for controlled rollout</li></ul></li></ul></li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Branding is now consistently applied across Onboarding and File.1</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Updated Branding page in Client Portal with new model</li></ul></li><li><p>System Settings</p><ul><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Introduced Draft → Published → Archive lifecycle</p><ul><li>New settings default to Draft</li><li>Published settings are required for consent creation</li><li>Prevents accidental modification of active integrations</li></ul></li><li><p>[<mark style="color:green;"><strong>New</strong></mark>] Added safeguards when modifying or deleting settings:</p><ul><li>Settings tied to active consents cannot be deleted immediately</li><li>Archive + 30-day waiting period required before deletion</li></ul></li><li>[<mark style="color:green;"><strong>New</strong></mark>] Enhanced validation during consent creation</li><li>[<mark style="color:green;"><strong>New</strong></mark>] Updated System Settings form in Client Portal</li></ul></li><li><p>Invitations &#x26; User Management</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved handling of existing users vs new users</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved handling of user creation from invitation</li><li><p>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Restored user invitation flow after previous security update</p><ul><li>New users can now be invited again</li></ul></li></ul></li><li><p>Client Portal</p><ul><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Improved sign-up flow and general UX</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Multiple small UI improvements and fixes</li></ul></li><li><p>Various bug fixes:</p><ul><li>Fixed 401 error when uploading logo in Client Portal</li><li>Fixed incorrect brandSettings permission casing</li><li>Fixed race condition where default client app ID could be incorrectly used</li><li>Improved stability of Brand Settings</li><li>Reduced severity of credential deletion warnings</li><li>Miscellaneous UI fixes</li></ul></li><li><p>Security updates</p><ul><li><p>Upgraded core stack:</p><ul><li>Next.js 16</li><li>React 19</li><li>Auth0 SDK v4</li><li>tRPC v11</li><li>TanStack Query v5</li></ul></li><li>Addressed vulnerabilities identified in dependencies.</li></ul></li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-02-16" tags="improved" %}

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li>Security updates</li><li>Migrated some services to .NET 10</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-02-11" tags="new,fixed,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Tripletex</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for including <code>vatType</code> when utilizing <code>POST /journals</code></li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with rounding when posting a journal in a different currency than the base currency used in Tripletex</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li>Security updates</li><li>Improved performance when updating status of a consent</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-02-03" tags="fixed,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Spiris</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with <code>POST /journals/attachments</code> causing requests to fail due to incorrect order of operations.</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li>Security updates</li><li>Upgraded AI parsing mechanism</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-01-22" tags="new,fixed,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Björn Lundén</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /incomeStatement</code></li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added full support for systemSettings, allowing client admins to configure your own Björn Lundén application credentials to be used.</li></ul></td></tr><tr><td>Svefaktura</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with rounding in <code>GET /salesInvoices/:id</code></li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with rounding in <code>GET /salesInvoices/:id</code></li></ul></td></tr><tr><td>Visma Dinero</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue in onboarding, causing companies with multiple organization to get stuck.</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li>Security updates</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-01-16" tags="new,fixed,improved" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Procountor</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Updated name to <code>Finago Procountor</code></li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with redirect URI</li></ul></td></tr><tr><td>Visma Dinero</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue in onboarding, causing companies with multiple organization to get stuck.</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li>Security updates</li></ul></td></tr></tbody></table>
{% endupdate %}

{% update date="2026-01-13" tags="new,improved,fixed" %}

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>Björn Lundén</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with setting integration name, preventing client users from creating a complete systemSetting.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with renewing credentials.</li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for rounding when using <code>GET /salesinvoices/:id</code></li></ul></td></tr><tr><td>File.1</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue when creating a new OTC when the user is already signed in</li></ul></td></tr><tr><td>Fortnox</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for invoice lines for GET /supplierinvoices/:id</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with consents not changing status to inactive when using <code>GET /financialDimensions</code> when the connection has been broken.</li></ul></td></tr><tr><td>Spiris</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for invoice lines for <code>GET /supplierinvoices/:id</code></li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for verifying information when using <code>POST /supplierinvoices</code></li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for using customized scopes in combination with Zwapgrids Spiris application client.</li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Added additional verification during onboarding,</li></ul></td></tr><tr><td>Visma e-conomic</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /customers</code></li><li>[<mark style="color:green;"><strong>New</strong></mark>] Added support for <code>GET /customers/:id</code></li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>Consents</td><td><ul><li>[<mark style="color:green;"><strong>New</strong></mark>] Added functionality for deactiavting consents that have not been used for 30 days.</li></ul></td></tr><tr><td>General platform improvements</td><td><ul><li>Security updates</li><li>Upgraded to i18next</li></ul></td></tr></tbody></table>
{% endupdate %}
{% endupdates %}


# 2025-12-11

## Systems

<table><thead><tr><th width="280.25">System</th><th>Functionality</th></tr></thead><tbody><tr><td>File.1</td><td><ul><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Resolved issue with deleting <code>systemSettings</code> without any properties set.</li><li>[<mark style="color:orange;"><strong>Fixed</strong></mark>] Added warning when <code>SubtotalAmount = TotalAmount - TotalTaxAmount - (PayableRoundingAmount =/= 0</code></li><li>[<mark style="color:blue;"><strong>Improved</strong></mark>] Will now show the entire filename on hover over.</li></ul></td></tr></tbody></table>

## Platform

<table><thead><tr><th width="280.25"></th><th>Functionality</th></tr></thead><tbody><tr><td>General platform improvements</td><td><ul><li>Security updates</li><li>Authentication improvements</li><li>Updated UI to latest version</li><li>Migrated to <code>OpenTelemetry Distro</code></li></ul></td></tr><tr><td>Self service</td><td><ul><li>Added "show password icon"</li><li>Added password guidelines when setting password</li><li>Added warning when email already exists when signing up</li><li>Added "way back" if no verification email is received</li><li>Improved client signup with additional information</li></ul></td></tr></tbody></table>




---

[Next Page](https://docs.zwapgrid.com/llms-full.txt/1)