Partner - Financial Documents API
List financial documents.
Returns financial documents, such as self-billing invoices, for a location. The collection is ordered by creation date in descending order by default.
Endpoint
GET - https://api.travisroadservices.com/partners/v1/financial-documents
Copy
Header params
| Parameter | Type | Description |
|---|---|---|
location
|
string | Location ID for which to retrieve financial documents. |
Query params
| Parameter | Type | Description |
|---|---|---|
created[from]
|
string | Filters by creation date (from). Format: YYYY-MM-DD. |
created[to]
|
string | Filters by creation date (to). Format: YYYY-MM-DD. |
documentNumber
|
string | Filters by document number (e.g. C00090-2601-EU). Must be an exact match. |
order[invoiceDate]
|
string | Sorts results by document date. Possible values: asc, desc. |
order[invoiceNumber]
|
string | Sorts results by document number. Possible values: asc, desc. |
page
|
string | The collection page number |
itemsPerPage
|
string | The number of items per page |
Request body
No request bodyResponse body
Response 200
FinancialDocumentResource collection
Fields
| Field | Type | Description |
|---|---|---|
id
|
integer | ID of the financial document issued. |
documentDate
|
string (date-time) | Date the financial document was issued. |
status
|
string | Current status of the financial document. |
documentNumber
|
string | The number of the financial document. |
periodFrom
|
string (date-time) | Start date of the document period. |
periodTo
|
string (date-time) | End date of the document period. |
files
|
object | Download links for the financial document. |
document
|
string | URL to the PDF of the financial document. |
csvSpecifications
|
string | URL to the CSV specification of the financial document. |
Example