Kleer API Integration | Coverage & Setup

Know what you can build.

Read and write support differ by resource. Sales-invoice creation is limited to drafts.

Resource	Read / availability	Write / notes
Onboarding	✓ Available	API token + positive company ID
Sales invoices	✓ List + individual	✓ Create drafts only
Supplier invoices	✓ List + individual	Creation not supported
Customers and suppliers	✓ List + individual records	Read only
Chart of accounts and periods	✓ Supported	Read only
Company information	✓ Supported	Read only
Financial dimensions	✓ Supported	Read only
Printable invoices	✓ Sales + supplier invoices	General attachment endpoints not supported
Supplier invoice payments	✓ Per invoice	Payment creation not supported
Journals and financial reports	Contact us	Not supported in unified endpoints

Check the full API Coverage →

View full endpoint coverage, including attachments and payments

Method	Resource	Support
`GET`	`accountingaccounts`	✓ Supported
`GET`	`accountingperiods`	✓ Supported
`GET`	`balancesheet`	Not supported / contact us
`GET`	`companyinformation`	✓ Supported
`GET`	`customers`	✓ Supported
`GET`	`customers/{customerId}`	✓ Supported
`GET`	`financialdimensions`	✓ Supported
`GET`	`incomestatement`	Not supported / contact us
`GET`	`journals`	Not supported / contact us
`GET`	`journals/{journalId}`	Not supported / contact us
`POST`	`journals`	Not supported / contact us
`GET`	`journals/{journalId}/attachments/{attachmentId}`	Not supported / contact us
`POST`	`journals/{journalId}/attachments`	Not supported / contact us
`GET`	`proxy/{systemUrl}`	✓ Supported
`POST`	`proxy/{systemUrl}`	✓ Supported
`PUT`	`proxy/{systemUrl}`	✓ Supported
`PATCH`	`proxy/{systemUrl}`	Not supported / contact us
`DELETE`	`proxy/{systemUrl}`	✓ Supported
`GET`	`salesinvoices`	✓ Supported
`GET`	`salesinvoices/{salesInvoiceId}`	✓ Supported
`POST`	`salesinvoices`	✓ Drafts only
`GET`	`salesinvoices/{salesInvoiceId}/attachments`	Not supported / contact us
`GET`	`salesinvoices/{salesInvoiceId}/attachments/{attachmentId}`	Not supported / contact us
`GET`	`salesinvoices/{salesInvoiceId}/attachments/printable`	✓ Supported
`POST`	`salesinvoices/{salesInvoiceId}/attachments`	Not supported / contact us
`POST`	`salesinvoices/{salesInvoiceId}/notes`	Not supported / contact us
`GET`	`salesinvoices/payments`	Not supported / contact us
`GET`	`salesinvoices/{salesInvoiceId}/payments`	Not supported / contact us
`POST`	`salesinvoices/{salesInvoiceId}/payments`	Not supported / contact us
`GET`	`supplierinvoices`	✓ Supported
`GET`	`supplierinvoices/{supplierInvoiceId}`	✓ Supported
`POST`	`supplierinvoices`	Not supported / contact us
`GET`	`supplierinvoices/{supplierInvoiceId}/attachments`	Not supported / contact us
`GET`	`supplierinvoices/{supplierInvoiceId}/attachments/{attachmentId}`	Not supported / contact us
`GET`	`supplierinvoices/{supplierInvoiceId}/attachments/printable`	✓ Supported
`POST`	`supplierinvoices/{supplierInvoiceId}/attachments`	Not supported / contact us
`GET`	`supplierinvoices/payments`	Not supported / contact us
`GET`	`supplierinvoices/{supplierInvoiceId}/payments`	✓ Supported
`POST`	`supplierinvoices/{supplierInvoiceId}/payments`	Not supported / contact us
`GET`	`suppliers`	✓ Supported
`GET`	`suppliers/{supplierId}`	✓ Supported
`GET`	`trialbalances (V2)`	Not supported / contact us

Connection options and Proxy.1 availability

Platform capability	Availability
Zwapgrid-managed connection	✓ Supported
Client-managed connection	Not currently available / contact us
Custom scope selection	Not currently available / contact us
Proxy.1	✓ Supported

Kleer is available through the onboarding flow. Sales-invoice creation supports drafts only; Proxy.1 PATCH is not supported.

Read the system setup guide →

“Not supported / contact us” indicates an unavailable unified endpoint. Native API access depends on the separate Proxy.1 availability shown below.

Useful data. Real product workflows.

Invoice workflows

Read sales and supplier invoices, retrieve printable documents and create draft sales invoices from your product.

Connected business records

Read customer and supplier records, chart of accounts and financial dimensions through the same interface as your other supported systems.

Your first Kleer request

Once your customer has authorised the connection, retrieve sales invoices with your API key and consent ID.

curl 'https://apione.zwapgrid.com/accounting/api/v1/consents/{consentId}/salesinvoices?Count=100&CurrentPage=1' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'x-correlation-id: YOUR_UNIQUE_GUID'

Replace the placeholders. Use a unique correlation ID per request and paginate with Count (1–100) and CurrentPage (starting at 1).

Need a native Kleer endpoint?

Proxy.1 supports GET, POST, PUT and DELETE for Kleer, subject to the native API and permissions. PATCH is not supported. Use relative resource paths and set Content-Type: application/json for JSON responses, including GET requests.

Set up, test and go live.

Prepare your credentials. Have your Kleer API token and company ID ready.
Connect the customer. Create or open a consent, select Kleer in the onboarding flow, and enter the API token and positive company ID.
Validate your workflow. Test the API.1 and Proxy.1 operations your product needs before production. We help with test installations and test data.

Read the Kleer setup guide →

Start your 14-day free trial → Connect Kleer in the Client Portal →

Build Your

Kleer

Integration in Days, Not Weeks