V2 endpoints (/f/v2/...) for retrieving sales and financial data.
Endpoint Mapping
| V1 Endpoint | V2 Endpoint |
|---|---|
getFinancials (/f/finance/{id}/financials/{from}/{to}) |
getSales (/f/v2/business-location/{id}/sales) |
getDailyFinancials (/f/finance/{id}/dailyFinancials) |
getBusinessDaySales (/f/v2/business-location/{id}/sales-daily) |
Response DTOs are nearly identical to V1 with the exceptions noted below
V2 behaviour
- Sorting: Explicitly sorted by
timeClosed - Transitory Accounts / Unsettled Sales: Returns closed transactions and ensures no transitory (unclosed) transactions are included in reporting
- Pagination:
pageSizemax of 100. No HATEOAS_links; usesnextPageTokenstring for pagination instead - Daily endpoints (
getBusinessDaySales): No pagination, no hard cap on results. May have slower response times for larger data sets - Backoffice transactions: Historical dating not currently supported — transactions appear as if created at current time. Transactions can only be found by the date/time they were actually created. Historical dating support is planned for a future release.
- Backoffice modifications (payment method change and canceling): Modifications appear on the date the modification was performed, not the original transaction date
If you need to query transactions by their original business date (e.g. for historical reporting or reconciliation); The V1 endpoints may be more suitable until backwards compatibility is added to V2 for this aspect.