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

Properties

created

{"created": "2015-10-31"}

String - The date the invoice was created.
id

{"id": 901934}

Integer - The unique ID of the invoice.
total

{"total": 2359.56}

Decimal - The total billed amount of the invoice in USD.
GET
/invoices/{id}
Retrieves an invoice
type The data stream type if you don't want the invoice details and need the actual file. The following options are available:
  • CSV (default)
  • XLS
request
GET /invoices/20008
response

HTTP/1.1 200 OK

{
    "invoice": {
        "created": "2015-10-03",
        "id": 20008,
        "total": 1002.55
    }
}
request
GET /invoices/20008
type=csv
response

HTTP/1.1 200 OK

[blob]