Get documents

GET/v1/operations/documents.get

Synced documents by id: one, or several separated by commas (up to 50). Each comes with its supplier, number, dates, currency and totals; its coded lines (the account, tax, class and customer each line was published with); and its invoice line items (what the supplier's invoice itself listed: product code, quantity, unit, unit price, tax and amount). The ids are the document ids ledger.account_transactions returns. An id that is not one of this organisation's documents is listed under notFound.

Scope: synced.read · reads only
Roles: Super admin, Admin (by default; an admin can change this per operation)
MCP tool: documents_get

Request

Send the token as Authorization: Bearer. A token approved for several organisations also sends Synced-Organisation: {id} (see Organisations).

Query parameters

Name	Type	Description
`ids`required	string	Document idsOne or more Synced document ids, comma separated (up to 50).

Response

200 with a JSON body. 401 without a valid token, 403 when the scope, role or organisation does not allow it, 429 when rate limited (see Errors and limits).

Name	Type	Description
`documents`	object[]
`id`	string
`number`	string
`type`	string
`supplier`	string
`date`	string
`dueDate`	string
`currency`	string
`subtotal`	number
`tax`	number
`total`	number
`accountingId`	string
`publishedAt`	string
`link`	string
`codedLines`	object[]
`id`	string
`description`	string
`quantity`	number
`subtotal`	number
`tax`	number
`total`	number
`account`	string
`accountId`	string
`taxCodeId`	string
`class`	string
`customer`	string
`invoiceLines`	object[]
`id`	string
`description`	string
`productCode`	string
`quantity`	number
`unit`	string
`unitPrice`	number
`tax`	number
`amount`	number
`notFound`	string[]

Example

curl -X GET 'https://api.syncedhq.com/v1/operations/documents.get' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Try it

Sign in to send this request as yourself. You choose the organisations on Synced's consent screen; the token stays in this tab and expires within an hour.

idsrequiredstring

One or more Synced document ids, comma separated (up to 50).

Required: ids

Request

curl -X GET 'https://api.syncedhq.com/v1/operations/documents.get' \
  -H 'Accept: application/json'

Response

Sign in, then send the request.