Skip to main content

Update Xero Document Status

PUT 

/api/ledger/connections/:connectionId/xero-document-status

Choose which kinds of document are created in Xero as drafts awaiting approval. Requires the accounting.manage_settings permission.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Body:

  • draft_types (array, required, may be empty) — any of invoice, bill, credit_note, manual_journal, each at most once. An empty array sends everything approved (the default).

Forward-only: documents already in Xero keep their status. Updating a document SKU.io sent as a draft never changes its status in Xero, so a draft stays a draft until someone approves it there, and an approved document is never moved back to draft. Voiding a document that is still a draft deletes it in Xero (Xero only voids approved documents).

Returns the saved setting in the same shape as Get Xero Document Status.

Request​

Responses​

OK

Response Headers
    Content-Type