Get Xero Document Status
GET/api/ledger/connections/:connectionId/xero-document-status
Which kinds of document are created in Xero as drafts awaiting approval instead of approved.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
By default draft_types is empty: invoices, bills and credit notes are created AUTHORISED and manual journals POSTED. Each kind listed in draft_types is created as DRAFT instead, for an accountant to approve in Xero. A draft posts nothing to Xero's ledger and takes no payments or allocations until it is approved; payments against it are pushed once Xero reports it approved.
kinds lists the document kinds that can be drafts. Bank transactions (spend money, prepayments) and allocations have no draft state in Xero and are always approved.
awaiting_approval counts documents currently in Xero as DRAFT or SUBMITTED, whatever the setting is now, and awaiting_statuses lists which of those two statuses they actually have (empty when none are waiting).
Returns 404 when the connection id does not name the configured Xero connection (including a QuickBooks connection).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.