SaqSaq Docs

Reports

The Reports endpoints cover everything involving historical reading of transactions. Use live listing for dashboards and asynchronous CSV generation for BI/audit over large periods.

When to use each one

ScenarioEndpoint
Transactions screen on the dashboardGET /user/transactions
Detail of a specific transactionGET /user/transactions/{id}
Report over a large period (month, year)POST /user/report
List requested reportsGET /user/reports
Check whether the report has finishedGET /user/report/{id}
Download the generated CSVPOST /user/report/{id}/download

Listing vs async report

ScenarioRecommended
Dashboard, < 10k recordsGET /user/transactions paginated
Daily reconciliationGET /user/transactions paginated
Full month or yearPOST /user/report (async CSV)
BI / Data WarehousePOST /user/report scheduled

Examples

Async report flow

Tutorials and best practices

On this page