Theme switcher

Financials

Attributes

Attribute

Type

Description

fin_key

string

Unique financial transaction key

date_effective

date

Transaction effective date (YYYY-MM-DD)

surname

string

Patient surname

title

string

Patient title

first_name

string

Patient first name

transaction_id

integer

Unique transaction identifier

invoice_total

string

Total invoice amount (fixed-point, e.g. "560.0000")

invoice_discount

string

Applied discount amount (fixed-point)

invoice_involvement

string

Invoice involvement percentage (fixed-point)

payment_total

string, nullable

Total payment amount (fixed-point)

payment_involvement

string, nullable

Payment involvement percentage (fixed-point)

lab_fees

string, nullable

Laboratory fees amount (fixed-point)

lab_fees_involvement

string, nullable

Lab fees involvement percentage (fixed-point)

transaction_type_1

string

Primary transaction type code

practitioner_id

integer

Associated practitioner identifier

practitioner_code

string

Practitioner code

main_practitioner

integer, nullable

Main practitioner ID (if applicable)

allocation_id

integer, nullable

Allocation identifier (if applicable)

gst_amount

string

GST amount (fixed-point)

gst_discount

string, nullable

GST discount amount (fixed-point)

commission_percent

string

Commission percentage (fixed-point)

location_id_invoice

integer

Invoice location identifier

location_id_payment

integer

Payment location identifier

transaction_type_2

string

Secondary transaction type code

commission_expenses

string, nullable

Commission expenses amount (fixed-point)

PPA_Status

string, nullable

PPA status

payment_id

integer, nullable

Payment identifier

date_processing

date-time

Transaction processing timestamp (YYYY-MM-DD HH:MM:SS)

updated_date

date-time

Record update timestamp (YYYY-MM-DD HH:MM:SS)

payment_type

string, nullable

Payment method/type

health_fund_id

integer, nullable

Health fund identifier

payment_amount

string, nullable

Individual payment amount (fixed-point)

chequename

string

Cheque payer name (if applicable)

chequebank

string

Cheque bank (if applicable)

chequebranch

string

Cheque branch (if applicable)

Processing Features:

  • High-Volume Processing: Efficiently handles millions of financial records
  • Detailed Breakdown: Includes invoice, payment, and discount components
  • Multi-Currency Support: Handles different currency formats
  • Audit Trail: Complete transaction history with timestamps

Use Cases:

  • Financial reporting and analysis
  • Revenue tracking and forecasting
  • Accounting system integration
  • Business intelligence dashboards
  • Tax reporting and compliance
  • Practice performance analysis
  • Patient billing reconciliation
  • Insurance claim processing

Header Parameters

Content-Typestring

Body Parameters

customer_idstring Required

Unique customer identifier

from_datestring

Start date for filtering (YYYY-MM-DD format)

to_datestring

End date for filtering (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"

date_modifierstring

Filter mode - "All" (default), "Created", or "Updated

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?