Creates a Financial document

Create a purchase financial document (invoice, credit note or receipt) together with its file. Sent as multipart/form-data. The document is created in draft (pending review) state; the strict required-field set is only enforced when it is validated in the app.

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

Company identifier, refers to /api/me endpoint.

string
enum
required

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

Allowed:
string

Vendor identifier (Finance contact).

string
string

Document number. Must be unique per vendor for purchases; a duplicate returns a 422 with a machine-readable invoice_number error.

string

Document date.

string

Due date.

string

Document currency (ISO 4217).

integer

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

string

Free-text internal notes about the financial document.

string

For credit notes, the referenced original document by internal id (exposed as parent_financial_document_id to match the read contract). Provide this or original_invoice_number.

string

For credit notes, the referenced original document by invoice number (resolved together with the vendor).

line_items[]
array

Purchase-invoice line items. When present they own the document totals.

line_items[]
file
required

The document file to upload, the binary file. Required for purchase documents.

Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json