USusesecuro
invoices

List Invoices

Changed on
get/api/invoices

Request

Query parameters

statestring nullable

Filter by derived state

yearinteger nullable

Filter by issue year

direction'receivable' | 'payable'

Which side of the ledger to read

payee_idstring uuid nullable
schedule_idstring uuid nullable

Only invoices of this agreement

qstring nullable
limitinteger
offsetinteger

Headers

X-Workspace-Idstring nullable

Response

Successful Response

idstring uuid required
payee_idstring uuid nullable required
document_typestring required
direction'receivable' | 'payable' required
originstring required
external_sourcestring nullable
external_idstring nullable
numberinteger nullable required
seriesstring nullable required
external_numberstring nullable
status'draft' | 'open' | 'void' | 'uncollectible' required
state'draft' | 'open' | 'partial' | 'paid' | 'overdue' | 'void' | 'uncollectible'
issue_datestring date required
due_datestring date required
competence_datestring date nullable required
sent_atstring date-time nullable required
currencystring required
subtotalstring required
discountstring required
tax_totalstring required
totalstring required
amount_paidstring
amount_deductedstring
balancestring
days_overdueinteger
next_due_datestring date nullable
notesstring nullable required
internal_notesstring nullable required
custom_fieldsobject nullable required
snapshotobject nullable required
share_tokenstring nullable
schedule_idstring uuid nullable
sequenceinteger nullable
period_startstring date nullable
period_endstring date nullable
created_atstring date-time required

Changes