THthredfi
v1

POST /v1/platform/businesses/{business_id}/financial-documents/

Block document creation via API.

POST /financial-documents/ is not allowed. Documents are created via the document upload workflow, not directly via API.

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring required

Response

typestring required

Always 'FinancialDocumentData' for type discrimination

idstring uuid required
business_idstring uuid required
external_idstring nullable required
workflow_typestring required

Workflow type: AR, AP, or GENERIC

document_typestring required

Document type: sales_invoice, bill, credit_note, etc.

statusstring required

Document status

reference_numberstring nullable required
reference_datestring date nullable required
due_datestring date nullable required
payment_termsstring nullable required
currencystring nullable required
subtotalinteger required

Subtotal in cents

tax_amountinteger required

Tax amount in cents

total_amountinteger required

Total amount in cents

amount_paidinteger required

Amount paid in cents

amount_dueinteger required

Amount due in cents

is_overdueboolean required
is_fully_paidboolean required
needs_reviewboolean required
review_reasonsunknown required
reviewed_atstring date-time nullable required
extraction_confidencenumber double nullable required
classification_confidencenumber double nullable required
summaryunknown required
source_document_idstring uuid nullable required
journal_entry_idstring uuid nullable required
posted_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.