Requests & Responses
Common conventions used across all Business API v1 resources.
Route pattern
GET /api/v1/companies/{companyId}/resourcecompanyId is a positive integer assigned to the API client.
Date format
Date parameters use ISO format yyyy-MM-dd, for example 2026-09-30. For date-based transaction/history resources, both fromDate and toDate are required and toDate cannot be earlier than fromDate.
Pagination
Paged endpoints accept page and pageSize. Defaults are page=1 and pageSize=200. The maximum page size is 1000.
| Field | Meaning |
|---|---|
page | Current 1-based page number. |
pageSize | Requested rows per page. |
count | Rows returned in this page. |
totalCount | Total rows matching the request. |
totalPages | Total page count for the current page size. |
data | Response rows. |
Null and decimal values
Optional source values are returned as JSON null. Financial, quantity and price fields are JSON numbers and may contain decimal precision appropriate to the underlying business value.
Filtering
Filters are supplied as query-string parameters. Omitted optional filters do not restrict the result. Multiple supplied filters are combined to narrow the result.
Large extracts
Use bounded date ranges and page through results sequentially. Do not request the same large page repeatedly. Respect the client rate limits returned by the service.