Update document extraction

Updates an inbox document (a supplier invoice or receipt read from a file) before it is converted to a bill: the vendor, dates, currency, number, description and lines. line_items replaces every line: send each line you keep with its id. Each line names its account by account_id (the chart-of-accounts id from the chart of accounts list: use it when the account has no code) or by account_code, and its tax rule by tax_code; when both account fields are sent they must name the same account. An account_id that is not an active expense, cost of sales or asset account of the company, or that is a control account (accounts receivable, accounts payable, VAT, a bank account's ledger), is refused with 422 document_extraction_line_account_unavailable, naming the line in error.fields, and nothing is saved; a line sent with its id may keep the account it already has (its chart_of_account_id). Converting the document (documentExtraction.convertToBill) gives each bill line its inbox line's account. Requires If-Match with the document ETag and an Idempotency-Key. Requires the document-extractions:write OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Fields accepted to update document extraction. The schema identifies required and optional values.

uuid | null
uuid | null
uuid | null
uuid | null
string
enum
Allowed:
string | null
enum
Allowed:
string | null
string | null
date | null
date | null
exchange_rate
object
line_items
array of objects
length ≤ 500
line_items
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*