THthredfi
Financial Documents

List financial documents

List all financial documents for a business. Includes documents created via document upload workflow (AR invoices, AP bills, credit notes, and generic documents).

Review Queue: Use needs_review=true to get documents requiring human review.

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

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

Query parameters

created_at_endstring date-time
created_at_startstring date-time
customer_external_idstring
customer_idstring uuid

Filter by customer ID (AR documents)

document_typestring

Filter by document type (comma-separated). Values: sales_invoice, credit_note, bill, vendor_credit_note, statement, contract, other

due_date_endstring date

Documents due on/before this date

due_date_startstring date

Documents due on/after this date

external_idstring
max_amountinteger

Maximum total amount in cents

min_amountinteger

Minimum total amount in cents

min_classification_confidencenumber float

Minimum classification confidence (0.0-1.0)

min_extraction_confidencenumber float

Minimum extraction confidence (0.0-1.0)

needs_reviewboolean

Filter by review status (true = needs review)

pageinteger

Page number (1-indexed, default: 1)

page_sizeinteger

Number of items per page (default: 20, max: 100)

reference_date_endstring date

Documents with reference date on/before this date

reference_date_startstring date

Documents with reference date on/after this date

reference_numberstring
searchstring

Search reference number, external ID, or counterparty name

sortstring

Sort order. Values: created_at, -created_at, reference_date, -reference_date, due_date, -due_date (prefix with - for descending)

statusstring

Filter by status (comma-separated). Values: draft, pending_review, approved, sent, posted, partially_paid, paid, overdue, applied, partially_applied, void, cancelled, processed

vendor_external_idstring
vendor_idstring uuid

Filter by vendor ID (AP documents)

workflow_typestring

Filter by workflow type (comma-separated). Values: ar, ap, generic

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

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