Financials
Attributes
Attribute | Type | Description |
| string | Unique financial transaction key |
| date | Transaction effective date (YYYY-MM-DD) |
| string | Patient surname |
| string | Patient title |
| string | Patient first name |
| integer | Unique transaction identifier |
| string | Total invoice amount (fixed-point, e.g. |
| string | Applied discount amount (fixed-point) |
| string | Invoice involvement percentage (fixed-point) |
| string, nullable | Total payment amount (fixed-point) |
| string, nullable | Payment involvement percentage (fixed-point) |
| string, nullable | Laboratory fees amount (fixed-point) |
| string, nullable | Lab fees involvement percentage (fixed-point) |
| string | Primary transaction type code |
| integer | Associated practitioner identifier |
| string | Practitioner code |
| integer, nullable | Main practitioner ID (if applicable) |
| integer, nullable | Allocation identifier (if applicable) |
| string | GST amount (fixed-point) |
| string, nullable | GST discount amount (fixed-point) |
| string | Commission percentage (fixed-point) |
| integer | Invoice location identifier |
| integer | Payment location identifier |
| string | Secondary transaction type code |
| string, nullable | Commission expenses amount (fixed-point) |
| string, nullable | PPA status |
| integer, nullable | Payment identifier |
| date-time | Transaction processing timestamp (YYYY-MM-DD HH:MM:SS) |
| date-time | Record update timestamp (YYYY-MM-DD HH:MM:SS) |
| string, nullable | Payment method/type |
| integer, nullable | Health fund identifier |
| string, nullable | Individual payment amount (fixed-point) |
| string | Cheque payer name (if applicable) |
| string | Cheque bank (if applicable) |
| 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
Body Parameters
Unique customer identifier
Start date for filtering (YYYY-MM-DD format)
End date for filtering (YYYY-MM-DD format)
Execution mode - "auto" (default), "stream", or "job"
Response format - "ndjson" (default), "json", or "csv"
Compression type - "none" (default), "gzip", or "zip"
Encryption - "false" (default) or "true"
Filter mode - "All" (default), "Created", or "Updated