Theme switcher

Debtors Detailed

Financial Data: Extract detailed debtor information and outstanding balances.

Attributes

Attribute

Type

Description

invoice_id

integer

Invoice identifier

instalment_number

integer

Instalment sequence number

date_due

date

Instalment due date

instalment

string

Instalment amount

balance

string

Outstanding balance

rem_1

string

First reminder note

rem_2

string

Second reminder note

rem_3

string

Third reminder note

rem_bad

string

Bad debt reminder note

send_acc_to_third_party

integer

Send account to third party flag

patient_firstname

string

Patient given name

patient_surname

string

Patient surname

third_party_name

string

Third party name

send_acc_to_pat_id

integer

Patient identifier to send account to

days_due

integer

Days overdue

account_payment_plan_id

integer

Payment plan identifier

notes

string

Notes

doctors_list

string

Comma delimited practitioner identifiers

patient_id_list

string

Comma delimited patient identifiers

balance_for_doctor

string

Balance for doctor

patient_head_id

integer

Responsible party patient identifier

bad_debt

string

Bad debt flag as string

printed

integer

Printed flag

reminder_printed

integer

Reminder printed flag

location_id

integer

Practice location identifier

Body Parameters

customer_idstring Required

Unique customer identifier

date_as_atstring Required

The “as at” date for the balances and payment‑cut‑off (YYYY-MM-DD format)

date_for_due_daysstring Required

Reference date for calculating days overdue (YYYY-MM-DD format)

due_date_uptostring Required

Upper bound on invoice due dates to include (YYYY-MM-DD format)

modestring

Execution mode - "auto" (default), "stream", or "job"

output_formatstring

Response format - "ndjson" (default), "json", or "csv"

compressionstring

Compression type - "none" (default), "gzip", or "zip"

encryptedstring

Encryption - "false" (default) or "true"

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1
Was this section helpful?

What made this section unhelpful for you?