Financial Records
The Financial Records API helps sellers reconcile marketplace activity. It covers delivered sales, recorded fees, adjustments, settlements, payout status, and backed exports.
It is not accounting software, tax advice, or a full business ledger. Use these records with your accountant when preparing books.
Financial API Coverage
| Area | What sellers can see |
|---|---|
| Overview | Delivered marketplace sales, recorded marketplace fees, pending payout, completed payout totals |
| Settlement history | Settlement period, gross amount, fees, adjustments, net amount, status, payment reference, and audit metadata |
| Marketplace activity | Period start/end, delivered-order sales total, delivered order count, recorded marketplace-fee total, currency |
| Exports | Settlement CSV, marketplace-activity CSV, and invoice PDFs where invoice records exist |
Important Limits
The platform only reports data it can account for from marketplace activity. These records do not include external supplier invoices, external freight, rent, wages, advertising spend, accountant adjustments, depreciation, or other business costs outside the marketplace.
Supplier cost and richer cost-component analysis remain coverage-gated. If a seller uses suppliers outside the marketplace, the platform does not know those COGS unless they are separately entered or imported through an explicit future feature.
Primary Financial Endpoints
| Endpoint | Purpose |
|---|---|
GET /api/v1/financials/dashboard | Operational financial overview with source and reconciliation-status metadata |
GET /api/v1/financials/metrics | Current operational money metrics |
GET /api/v1/financials/settlements | Seller settlements as a paged envelope |
GET /api/v1/financials/settlements/summary | Settlement totals by status |
GET /api/v1/financials/settlements/export/csv | Settlement CSV export |
GET /api/v1/financials/taxes/bas-summary | Historical path name. Raw marketplace activity for an Australian financial quarter. Not a BAS. |
GET /api/v1/financials/invoices | Seller fee-invoice records |
GET /api/v1/financials/invoices/{invoice_id}/pdf | Invoice PDF where PDF generation is available |
There is no GET /api/v1/financials/taxes/summary. The activity endpoint does
not return GST, BAS labels, or a net-GST figure.
Fee Components
| Component | Notes |
|---|---|
| Platform fee | Marketplace fee applied to seller order activity |
| Loyalty program fund | Marketplace loyalty funding component where applicable |
| Seller order fee | Fixed per-seller order fee where applicable |
| Payment processing | Provider pass-through where captured by the transaction path |
| Adjustments | Refunds, chargebacks, manual adjustments, and settlement corrections where recorded |
Payment processing and provider behavior remain subject to provider/runbook evidence. Live provider settlement matching is an operator gate, not a guarantee made by the API documentation.
Worked Example
For a recorded marketplace order, the records expose:
| Line | Meaning |
|---|---|
| Gross order amount | Customer marketplace sale amount recorded by the platform |
| Marketplace fees | Recorded platform fees and loyalty funding deductions |
| Adjustments | Recorded refunds, chargebacks, or manual corrections |
| Net payout | Amount payable through the settlement workflow |
Use the settlement CSV and marketplace-activity export to reconcile against your accounting system. The values cover marketplace activity only. They are not a GST calculation or a BAS.