Job listing invoices
This endpoint retrieves the list of invoices linked to a specific job listing.
Endpoint
POST https://canadamotorjobs.com/api/v1/{locale}/job-listings/invoices
Authentication
The API requires Bearer authentication. Include the token in the request header:
Authorization: Bearer <your_token>
Query parameters
| Parameter | Type | Description | Required | Default |
|---|---|---|---|---|
| job_listing_id | string | The unique job listing identifier | No | |
| page | number | Page number | No | 1 |
| per_page | number | Number of invoices per page | No | 10 |
| status | string: paid, pending, failed | Invoice status | No | all |
| from | date: YYYY-MM-DD | Start date | No | null |
| to | date: YYYY-MM-DD | End date | No | today |
| sort_by | string | Sort criterion | No | created_at |
| sort_direction | string: asc, desc | Sort direction | No | desc |
Errors
| Code | Message | Description |
|---|---|---|
| 200 | OK | The invoice list was retrieved successfully |
| 404 | Not Found | The specified job listing does not exist |
| 403 | Forbidden | You are not authorized to access this job listing |
| 401 | Unauthorized | Authentication is required |
Notes
- Invoices are sorted by creation date (descending) by default.
- You can change the sort criterion and direction using the
sort_byandsort_directionparameters. - Invoices are linked to a specific job listing.