Invoices

The Invoices resource allows a user to retrieve an itemized list of credits and debits for all of their processed shipments and overpacks. Invoices can be generated every day if necessary. When searching for invoices the results will include all invoices where created is within the date_start and date_end search parameters inclusive.

Actions

GET /invoices Retrieves a paginated list of invoices
GET /invoices/{id} Retrieves an invoice or PDF

Properties

created

{"created": "2021-09-03 13:57:13"}

String - The date and time the invoice was created in UTC. Set by the system.
currency

{"currency": "USD"}

String - The 3-letter currency code for the amount in this invoice. Set by the system.
end_date

{"end_date": "2021-08-29"}

String - The end date of the invoice in UTC. Set by the system.
id

{"id": 901934}

Integer - The unique ID of the invoice.
name

{"name": "2021-W34"}

String - The name of the invoice for grouping multiple invoices in different currencies together. Set by the system.
start_date

{"start_date": "2021-08-23"}

String - The start date of the invoice in UTC. Set by the system.
total

{"total": 2359.56}

Decimal - The total billed amount of the invoice.
GET
/invoices/{id}
Retrieves an invoice or download the PDF if type=PDF. Invoices before 2021-10-31 will not have a PDF.
type "PDF" is the only option.
request
GET /invoices/123790
response

HTTP/1.1 200 OK

{
    "created": "2021-09-03 13:57:13",
    "currency": "USD",
    "end_date": "2021-08-29",
    "id": 123790,
    "name": "2021-W34",
    "start_date": "2021-08-23",
    "total": 450.86
}
request
GET /invoices/123790 
type=pdf
response

HTTP/1.1 200 OK

[blob]