Retrieve a list of invoices

Retrieves the collection of Invoice resources.

Authorizations:Token, JWT

Query Parameters

order_id required	stringInvoice identifier
page	integerDefault: 1The collection page number
itemsPerPage	integer[0 .. 100]Default: 30The number of items per page
pagination	booleanEnable or disable pagination
filter.createdAt.range	object (Range filter for "createdAt" field)Range filter for "createdAt" field
begin string or null end string or null

Query Parameters

order_id required	stringInvoice identifier
page	integerDefault: 1The collection page number
itemsPerPage	integer[0 .. 100]Default: 30The number of items per page
pagination	booleanEnable or disable pagination
filter.createdAt.range	object (Range filter for "createdAt" field)Range filter for "createdAt" field
begin string or null end string or null

Responses

200Invoice collection

Response schema: application/jsonapplication/ld+json

Invoice collection

Array

invoiceNumber	string
profile	object
id integer or null email string membershipId integer>= 0 addresses Array of objects Array is_billing boolean is_shipping boolean is_work boolean type stringDefault: "R"Enum: "R""C" title string firstname string lastname string phone string address1 string address2 string address3 string zipcode string<= 32 characters city string country_code string2 characters state integer>= 0 state_name string custom_fields Array of objects Array name string value string id integer>= 1 isBilling boolean isShipping boolean isWork boolean countryCode string stateName string customFields Array of objects Array name string value string
createdAt	string
updatedAt	string
status	string
customerNotes	string
adminNotes	string
items	Array of objects
Array id integer productId integer>= 1 sku string name string amount number price number surcharges Array of objects Array id integer type stringEnum: "tax""discount""shipping""handling""error" family string code string name string include boolean available booleanDefault: true value number attribute_values Array of objects Array id integer type stringEnum: "checkbox""select""text" name string value string attributeId integer subtotal number total number attributeValues Array of objects Array id integer type stringEnum: "checkbox""select""text" name string value string attributeId integer
surcharges	Array of objects
Array id integer type stringEnum: "tax""discount""shipping""handling""error" family string code string name string include boolean available booleanDefault: true value number
paymentTransactions	Array of objects
Array id integer createdAt string publicTxnId string method_name string status string value number note string type string<= 16 characters publicId string currency string3 characters methodName string
currency	string3 characters
subtotal	number
total	number
id	integer>= 1

401Unauthorized

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Unauthorized

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null

500Internal error

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Internal error

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null