# API.1 Documentation

## Documentation

- [Overview](https://docs.zwapgrid.com/readme.md): 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.
- [Systems in the grid](https://docs.zwapgrid.com/systems-in-the-grid.md)
- [Terminology](https://docs.zwapgrid.com/key-concepts/terminology.md): This is the terminology you will find throughout the documentation and in your communication with us.
- [Fair-usage Policy](https://docs.zwapgrid.com/key-concepts/fair-usage-policy.md)
- [Overview](https://docs.zwapgrid.com/get-started/get-started.md)
- [How the platform works](https://docs.zwapgrid.com/get-started/how-the-platform-works.md)
- [Onboard Your Customer](https://docs.zwapgrid.com/get-started/onboard-your-customer.md)
- [Access Your Customer Data](https://docs.zwapgrid.com/get-started/access-your-customer-data.md)
- [Overview](https://docs.zwapgrid.com/client-portal/client-portal.md)
- [Environments](https://docs.zwapgrid.com/client-portal/environments.md)
- [Development](https://docs.zwapgrid.com/client-portal/environments/development.md)
- [Production](https://docs.zwapgrid.com/client-portal/environments/production.md)
- [Consents](https://docs.zwapgrid.com/client-portal/consents.md)
- [Consent Lifecycle](https://docs.zwapgrid.com/client-portal/consents/consent-lifecycle.md)
- [Create Consent](https://docs.zwapgrid.com/client-portal/consents/create-consent.md)
- [Grant Consent](https://docs.zwapgrid.com/client-portal/consents/grant-consent.md)
- [Consent Status](https://docs.zwapgrid.com/client-portal/consents/consent-status.md)
- [API Keys](https://docs.zwapgrid.com/client-portal/api-keys.md)
- [Usage](https://docs.zwapgrid.com/client-portal/api-keys/usage.md)
- [Security](https://docs.zwapgrid.com/client-portal/api-keys/security.md)
- [API Key Lifecycle](https://docs.zwapgrid.com/client-portal/api-keys/api-key-lifecycle.md)
- [Users](https://docs.zwapgrid.com/client-portal/users.md)
- [Onboarding](https://docs.zwapgrid.com/client-portal/onboarding.md)
- [Systems](https://docs.zwapgrid.com/client-portal/systems.md)
- [Connection Management](https://docs.zwapgrid.com/client-portal/systems/connection-management.md)
- [Zwapgrid-managed Connection](https://docs.zwapgrid.com/client-portal/systems/zwapgrid-managed-connection.md)
- [Client-managed Connection](https://docs.zwapgrid.com/client-portal/systems/client-managed-connection.md)
- [Overview](https://docs.zwapgrid.com/onboarding-flow/onboarding-flow.md)
- [Inviting Your Customer](https://docs.zwapgrid.com/onboarding-flow/inviting-your-customer.md)
- [URL and parameters](https://docs.zwapgrid.com/onboarding-flow/url-and-parameters.md)
- [One-Time Code](https://docs.zwapgrid.com/onboarding-flow/one-time-code.md)
- [Accounting Systems](https://docs.zwapgrid.com/onboarding-flow/accounting-systems.md)
- [Overview](https://docs.zwapgrid.com/api.1/api.1.md)
- [Use Cases](https://docs.zwapgrid.com/api.1/use-cases.md)
- [Invoicing](https://docs.zwapgrid.com/api.1/use-cases/invoicing.md)
- [Bookkeeping](https://docs.zwapgrid.com/api.1/use-cases/bookkeeping.md)
- [Financial Reporting](https://docs.zwapgrid.com/api.1/use-cases/financial-reporting.md)
- [Overview](https://docs.zwapgrid.com/file-1/file-1.md)
- [How does File.1 work?](https://docs.zwapgrid.com/file-1/how-does-file.1-work.md)
- [Overview](https://docs.zwapgrid.com/proxy.1/proxy.1.md)
- [Company Security](https://docs.zwapgrid.com/security/company-security.md): Overview of how the security/encryption setup is within Zwapgrid.
- [Platform Security](https://docs.zwapgrid.com/security/platform-security.md)
- [API Security](https://docs.zwapgrid.com/security/api-security.md)
- [Data Residency and Compliance](https://docs.zwapgrid.com/security/data-residency-and-compliance.md)
- [Data Retention Periods](https://docs.zwapgrid.com/security/data-residency-and-compliance/data-retention-periods.md)
- [Compliance](https://docs.zwapgrid.com/security/compliance.md)
- [Postman](https://docs.zwapgrid.com/resources/postman.md): We have our APIs hosted in Postman so you can pull the collections and you can get started by visiting our collection
- [Demos](https://docs.zwapgrid.com/resources/demos.md)

## API Guide

- [Consents](https://docs.zwapgrid.com/api-guide/consents-api-guide/consents.md)
- [Models](https://docs.zwapgrid.com/api-guide/consents-api-guide/models.md)
- [Accounting Accounts](https://docs.zwapgrid.com/api-guide/accounting-api-guide/accounting-accounts.md)
- [Accounting Periods](https://docs.zwapgrid.com/api-guide/accounting-api-guide/accounting-periods.md)
- [Balance Sheet](https://docs.zwapgrid.com/api-guide/accounting-api-guide/balance-sheet.md)
- [Company Information](https://docs.zwapgrid.com/api-guide/accounting-api-guide/company-information.md)
- [Customers](https://docs.zwapgrid.com/api-guide/accounting-api-guide/customers.md)
- [Financial Dimensions](https://docs.zwapgrid.com/api-guide/accounting-api-guide/financial-dimensions.md)
- [Income Statement](https://docs.zwapgrid.com/api-guide/accounting-api-guide/income-statement.md)
- [Journals](https://docs.zwapgrid.com/api-guide/accounting-api-guide/journals.md)
- [Journals Attachments](https://docs.zwapgrid.com/api-guide/accounting-api-guide/journals-attachments.md)
- [Proxy.1](https://docs.zwapgrid.com/api-guide/accounting-api-guide/proxy.1.md)
- [Sales Invoices](https://docs.zwapgrid.com/api-guide/accounting-api-guide/sales-invoices.md)
- [Sales Invoices Attachments](https://docs.zwapgrid.com/api-guide/accounting-api-guide/sales-invoices-attachments.md)
- [Sales Invoices Notes](https://docs.zwapgrid.com/api-guide/accounting-api-guide/sales-invoices-notes.md)
- [Sales Invoices Payments](https://docs.zwapgrid.com/api-guide/accounting-api-guide/sales-invoices-payments.md)
- [Supplier Invoices](https://docs.zwapgrid.com/api-guide/accounting-api-guide/supplier-invoices.md)
- [Supplier Invoices Attachments](https://docs.zwapgrid.com/api-guide/accounting-api-guide/supplier-invoices-attachments.md)
- [Supplier Invoices Payments](https://docs.zwapgrid.com/api-guide/accounting-api-guide/supplier-invoices-payments.md)
- [Suppliers](https://docs.zwapgrid.com/api-guide/accounting-api-guide/suppliers.md)
- [Trial Balances](https://docs.zwapgrid.com/api-guide/accounting-api-guide/trial-balances.md)
- [Models](https://docs.zwapgrid.com/api-guide/accounting-api-guide/models.md)

## Changelog

- [2026](https://docs.zwapgrid.com/changelog/2026.md)
- [2025-12-11](https://docs.zwapgrid.com/changelog/december-2025/readme-7.md)
- [2025-12-08](https://docs.zwapgrid.com/changelog/december-2025/readme-7-1.md)
- [2025-12-01](https://docs.zwapgrid.com/changelog/december-2025/2025-12-01.md)
- [2025-11-26](https://docs.zwapgrid.com/changelog/november-2025/2025-11-26.md)
- [2025-11-20](https://docs.zwapgrid.com/changelog/november-2025/2025-11-20.md)
- [2025-11-13](https://docs.zwapgrid.com/changelog/november-2025/readme-6.md)
- [2025-11-07](https://docs.zwapgrid.com/changelog/november-2025/readme-5.md)
- [2025-10-24](https://docs.zwapgrid.com/changelog/october-2025/readme-4.md)
- [2025-10-08](https://docs.zwapgrid.com/changelog/october-2025/readme-3.md)
- [2025-10-03](https://docs.zwapgrid.com/changelog/october-2025/2025-10-03.md)
- [2025-09-30](https://docs.zwapgrid.com/changelog/september-2025/readme-2.md)
- [2025-09-22](https://docs.zwapgrid.com/changelog/september-2025/2025-09-22.md)
- [2025-09-08](https://docs.zwapgrid.com/changelog/september-2025/2025-09-08.md)
- [2025-09-05](https://docs.zwapgrid.com/changelog/september-2025/2025-09-05.md)
- [2025-09-04](https://docs.zwapgrid.com/changelog/september-2025/2025-09-04.md)
- [2025-09-02](https://docs.zwapgrid.com/changelog/september-2025/2025-09-02.md)
- [2025-08-28](https://docs.zwapgrid.com/changelog/august-2025/2025-08-28.md)
- [2025-08-25](https://docs.zwapgrid.com/changelog/august-2025/2025-08-25.md)
- [2025-08-19](https://docs.zwapgrid.com/changelog/august-2025/readme-1.md)
- [2025-08-12](https://docs.zwapgrid.com/changelog/august-2025/2025-08-12.md)
- [2025-08-07](https://docs.zwapgrid.com/changelog/august-2025/2025-08-07.md)
- [2025-07-16](https://docs.zwapgrid.com/changelog/july-2025/2025-07-16.md)
- [2025-07-15](https://docs.zwapgrid.com/changelog/july-2025/2025-07-15.md)
- [2025-07-10](https://docs.zwapgrid.com/changelog/2025-07-10.md)
- [2025-07-01](https://docs.zwapgrid.com/changelog/2025-07-01.md)
- [2025-06-24](https://docs.zwapgrid.com/changelog/june-2025/2025-06-24.md)
- [2025-06-18](https://docs.zwapgrid.com/changelog/june-2025/2025-06-18.md)
- [2025-06-16](https://docs.zwapgrid.com/changelog/june-2025/2025-06-16.md)
- [2025-06-11](https://docs.zwapgrid.com/changelog/june-2025/2025-06-11.md)
- [2025-05-26](https://docs.zwapgrid.com/changelog/may-2025/2025-05-26.md)
- [2025-05-15](https://docs.zwapgrid.com/changelog/may-2025/2025-05-15.md)
- [2025-04-29](https://docs.zwapgrid.com/changelog/april-2025/2025-04-29.md)
- [2025-04-24](https://docs.zwapgrid.com/changelog/april-2025/2025-04-24.md)
- [2025-04-22](https://docs.zwapgrid.com/changelog/april-2025/2025-04-22.md)
- [2025-04-10](https://docs.zwapgrid.com/changelog/april-2025/2025-04-10.md)
- [2025-04-08](https://docs.zwapgrid.com/changelog/april-2025/2025-04-08.md)
- [2025-04-02](https://docs.zwapgrid.com/changelog/april-2025/2025-04-02.md)
- [2025-03-31](https://docs.zwapgrid.com/changelog/march-2025/2025-03-31.md)
- [2025-03-28](https://docs.zwapgrid.com/changelog/march-2025/2025-03-28.md)
- [2025-03-24](https://docs.zwapgrid.com/changelog/march-2025/2025-03-24.md)
- [2025-03-20](https://docs.zwapgrid.com/changelog/march-2025/2025-03-20.md)
- [2025-03-17](https://docs.zwapgrid.com/changelog/march-2025/2025-03-17.md)
- [2025-03-13](https://docs.zwapgrid.com/changelog/march-2025/2025-03-13.md)
- [2025-03-04](https://docs.zwapgrid.com/changelog/march-2025/2025-03-04.md)
- [2025-02-19](https://docs.zwapgrid.com/changelog/february-2025/2025-02-19.md)
- [2025-02-11](https://docs.zwapgrid.com/changelog/february-2025/2025-02-11.md)
- [2025-01-28](https://docs.zwapgrid.com/changelog/january-2025/2025-01-28.md)
- [2025-01-20](https://docs.zwapgrid.com/changelog/january-2025/2025-01-20.md)
- [2024-12-18](https://docs.zwapgrid.com/changelog/december-2024/2024-12-18.md)
- [2024-12-12](https://docs.zwapgrid.com/changelog/december-2024/2024-12-12.md)
- [2024-12-03](https://docs.zwapgrid.com/changelog/december-2024/3rd-december.md)
- [2024-11-28](https://docs.zwapgrid.com/changelog/november-2024/28th-november.md)
- [2024-11-20](https://docs.zwapgrid.com/changelog/november-2024/20th-november.md)
- [2024-11-07](https://docs.zwapgrid.com/changelog/november-2024/7th-november.md)
- [2024-10-15](https://docs.zwapgrid.com/changelog/october-2024/15th-october.md)
- [2024-10-08](https://docs.zwapgrid.com/changelog/october-2024/8th-october.md)
- [2024-10-04](https://docs.zwapgrid.com/changelog/october-2024/4th-october.md)
- [2024-09-19](https://docs.zwapgrid.com/changelog/september-2024/19th-september.md)
- [2024-09-10](https://docs.zwapgrid.com/changelog/september-2024/10th-september.md)
- [2024-09-06](https://docs.zwapgrid.com/changelog/september-2024/6th-september.md)
- [2024-08-26](https://docs.zwapgrid.com/changelog/august-2024/26th-august.md)
- [2024-08-01](https://docs.zwapgrid.com/changelog/august-2024/1st-august.md)
- [2024-07-04](https://docs.zwapgrid.com/changelog/july-2024/4th-july.md)

## Deprecation Schedule

- [Removel of creditAmount, debitAmount, paymentId from payments](https://docs.zwapgrid.com/deprecation-schedule/2026-10/removel-of-creditamount-debitamount-paymentid-from-payments.md)
- [Removal of accountingAccountId & description from accountingAccount](https://docs.zwapgrid.com/deprecation-schedule/2026-06/readme.md)
- [Removal of trialBalances V1](https://docs.zwapgrid.com/deprecation-schedule/2026-06/removal-of-trialbalances-v1.md)
- [Removal of accountBalances endpoint](https://docs.zwapgrid.com/deprecation-schedule/2026-06/removal-of-accountbalances-endpoint.md)
- [Removal of financialDimensionId from invoice data model](https://docs.zwapgrid.com/deprecation-schedule/2026-03/readme-2.md)
- [Removal of unused status](https://docs.zwapgrid.com/deprecation-schedule/2026-03/readme-2-1.md)
- [Remove "payeeFinancialAccounts" from Suppliers data model](https://docs.zwapgrid.com/deprecation-schedule/2026-03/remove-payeefinancialaccounts-from-suppliers-data-model.md)
- [Rounding Amount Standardisation](https://docs.zwapgrid.com/deprecation-schedule/2025-12/readme-1.md)
- [Changes to Sales Invoice](https://docs.zwapgrid.com/deprecation-schedule/2025-06/changes-to-sales-invoice.md)
- [Deprecation of accountbalances endpoint](https://docs.zwapgrid.com/deprecation-schedule/2025-01/deprecation-of-accountbalances-endpoint.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.zwapgrid.com/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.