Updates a Financial document

put

https://api.factorialhr.com/api/2026-10-01/resources/finance/financial_documents/{id}

Update a purchase financial document with PUT semantics: read the document, modify it, and send the complete resource back — the fields are replaced as sent. Status transitions are accepted and have their real side effects. Fields required on a validated document are only enforced when the document is validated (validated_at present in the payload), not before.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Identifier of the financial document to update.

Body Params

company_id

string

required

Company identifier, as returned by the credentials endpoint (/resources/api_public/credentials).

string

required

Identifier of the financial document to update.

currency

string

Document currency (ISO 4217).

total_amount_cents

integer

Total amount in cents. Ignored when line_items are provided, since the line items own the totals.

document_number

string

Document number. Must be unique per vendor for purchases; a duplicate returns a 409 with the same machine-readable invoice_number error key as the create endpoint.

document_date

string

Document date.

due_date

string

Due date.

status

string

enum

required

Status of the document. Transitions have real side effects: sent_to_pay enqueues a payment request in Factorial, and paid marks the document as paid (manual payment). Once a document is sent_to_pay, its payment lifecycle is owned by the payment flow in Factorial — do not set paid manually on it; the payment reconciliation does.

Allowed:

validated_at

string

Validation timestamp, as returned by the read endpoint (e.g. 2020-01-01T00:00:00.000Z). Setting it on a not-yet-validated document validates it: the strict required-field set (currency, amounts, document number, dates, vendor, legal entity) is enforced on that transition, not before.

taxes

array

required

Tax breakdown, as returned by the read endpoint — send back what you read (adjusted to your changes). Replaced as sent; ignored when line_items are provided, since the line items own the totals.

taxes*

line_items

array

Purchase-invoice line items. Rows are addressed by id, never by position: rows carrying an id update the matching line item, rows without an id create new ones, and persisted rows missing from the set are deleted. Send an empty array to remove all line items, or omit the field entirely to leave them untouched. When present they own the document totals.

line_items

legal_entity_id

string

Legal entity identifier of the financial document.

vendor_id

string

Vendor identifier (Finance contact).

document_type

string

enum

Type of the financial document. One of invoice, credit_note, receipt.

Allowed:

parent_financial_document_id

string

For credit notes, the referenced original document by internal id (e.g. 135).

additional_information

string

Free-text internal notes about the financial document. Kept unchanged when the field is absent.

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK