Partner - Financial Documents API

Get a financial document.

Returns information about a specific financial document identified by its ID.

Open Swagger Specification

Endpoint

    GET - https://api.travisroadservices.com/partners/v1/financial-documents/{id}
    Copy

Path params

Parameter Type Description
id string Unique identifier of the financial document.

Header params

Parameter Type Description
location string Location ID of the requesting location.

Request body

No request body

Response body

Response 200

FinancialDocumentResource resource

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

Response 401

No response body - No bearer token set verify if your token is added as bearer token

Response 403

No response body - You don't have access to this API resource

Response 404

Not found

Fields

Field Type Description
title string A short, human-readable summary of the problem.
detail string A human-readable explanation specific to this occurrence of the problem.
status integer The HTTP status code applicable to this problem.
instance string A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type string A URI reference that identifies the problem type

Example