Invoice list
This endpoint retrieves the list of invoices associated with your account or a specific business/client.
Endpoint
POST https://canadamotorjobs.com/api/v1/{locale}/invoices/list
# or for a specific business (those issued by the business)
POST https://canadamotorjobs.com/api/v1/{locale}/businesses/{business_id}/invoices
# or for a specific client (those received by the client)
POST https://canadamotorjobs.com/api/v1/{locale}/customers/{customer_id}/invoices
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
business_id | string | Filter by issuing business ID | No |
business_ref_id | string | Filter by client ID | No |
ref_source | string | Filter by client ID source | No |
status | string | Filter by status (e.g.: open, paid, void) | No |
page | number | Page number | No |
limit | number | Number of items per page | No |
sort | string | Sort by date (e.g.: created_at, due_date, updated_at) | No |
from_due_date | string | Due date from (YYYY-MM-DD) | No |
to_due_date | string | Due date to (YYYY-MM-DD) | No |
api_token | string | Your API key | required or bearer token |
Errors
| Code | Message |
|---|---|
| 401 | Unauthorized |
| 500 | Internal Server Error |