Invoices
Billing records and downloadable PDFs.
/api/v1/invoicesAuthorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Query Parameters
Page size. Defaults to a server-chosen value; maximum 100.
1 <= value <= 100Cursor: return records after this id.
Cursor: return records before this id.
Filter by customer.
0 <= valueResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/invoices"{ "object": "list", "data": [ { "object": "invoice", "id": 0, "invoice_number": "string", "status": "string", "amount_due_cents": 0, "amount_paid_cents": 0, "due_date": "string", "created_at": "string" } ], "has_more": true, "url": "/api/v1/invoices"}/api/v1/invoices/{id}Authorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Path Parameters
Resource identifier.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/invoices/string"{ "object": "invoice", "id": 0, "invoice_number": "string", "status": "string", "amount_due_cents": 0, "amount_paid_cents": 0, "due_date": "string", "created_at": "string"}/api/v1/invoices/{id}/pdfAuthorization
ApiKeyAuth Authenticate with your secret API key in the Authorization header: Authorization: Bearer fk_live_.... Use an fk_test_ key to operate against test mode, which never contacts a carrier or moves real freight.
In: header
Path Parameters
Resource identifier.
Response Body
application/pdf
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/invoices/string/pdf""string"