Get Billing Info Records for a Billing Account by invoice period
Returns the complete set of Billing Info Records (BIRs) for the specified Billing Account for a single invoice period.
All records belonging to the invoices of the requested period are returned in one response (not paginated), so the delivery is a single, complete data set that matches the issued invoice totals — records are never split across calendar months.
To retrieve records for a specific account, you must first identify the correct Billing Account ID. Use Get Billing Accounts to list all available accounts and locate the target ID required for this request.
Authorizations
You can get the JWT from the Login endpoint
Path Parameters
Billing account ID
Query Parameters
Filters billing info records (BIRs) by the invoice period — the calendar month in which the invoice was produced and issued (i.e. the invoice date), not the month the costs were incurred. For example, parking from May that is invoiced in June has invoice period '2026-06'.
Validation Constraints:
- Format: YYYY-MM
- Future periods relative to the current calendar month are not allowed and will immediately return a 400 Bad Request error (for example, requesting '2026-07' when the current calendar month is June). The current month is permitted once its invoices have been produced.
Data Availability & Retry Mechanism: The invoices of a given month become accessible only after that month's billing run successfully completes. In a standard scenario, the billrun finishes overnight between the 1st and the 2nd of the month, meaning finalized data is ready to be fetched on the morning of the 2nd. However, weekends or public holidays can delay this process by a few days depending on the specific invoicing provider (potentially pushing generation to the 4th or 5th). If you query the current invoice period before the billrun has finished, the API returns a 409 indicating the data is not yet available; clients must implement a retry mechanism to periodically poll the endpoint until the finalized data is released.
Response
Returns all Billing Info Records for the requested invoice period