billing
GET /v1/accounting/xero/invoices
Which of this organization's invoices are in its Xero.
Authentication
Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/accounting/xero/invoices \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Every invoice the connection knows about, newest first, with its state and — where it failed or was not sent — the reason. ⭐ States other than synced are listed deliberately. An invoice that is simply absent from a list is indistinguishable from one the sync never saw, so a customer could not tell a deliberate skip from a bug. total is the true count, which may exceed the number of items returned. Requires billing.view.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
items | XeroInvoiceLink[] | Yes | — |
total | integer | Yes | The TRUE count, which may exceed items. ⛔ Never len(items) — a response where those are equal is exactly what a complete answer looks like, so returning the page size would… |
Errors this endpoint can return
401 · 403 · 429