GET
/
v1
/
retailers
/
{retailer_pk}
/
invoices
/
{id}
/

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Invoice ID

retailer_pk
number
required

Retailer ID

Response

200 - application/json
invoice_number
string
required

Invoice number

Required string length: 1 - 32
id
integer

Invoice ID

retailer
object
brand
object
connection_id
string

Connection ID

currency
object
terms_type
enum<string> | null

Types of invoice terms

Available options:
End of Month (EOM),
No Charge,
Consignment,
10 Days After End of Month (10 EOM),
Cash Discount Terms Apply,
Basic,
Fixed Date, Late Payment Penalty Applies,
Extended,
Discount Not Applicable,
Fixed Date,
Previously agreed upon
terms_description
string | null

Description of invoice terms

terms_net_days_due
integer | null

Number of days to pay invoice

Required range: -2147483648 < x < 2147483647
terms_date_due
string | null

Payment expected date

terms_discount_percent
string | null

Discount percentage on selected term

order_id
integer

Order ID related to invoice

customer_order_number
string | null

Customer order number (for enduser)

Maximum length: 64
purchase_order_number
string | null

Purchase order number (for retailer)

Maximum length: 64
status
enum<string>

Invoice status

Available options:
closed,
open
remit_to
object
ship_from
object
sold_to
object
ship_to
object
shipping_carrier_name
string | null

Name of shipping carrier

Maximum length: 32
shipping_carrier_code
string | null

Code of shipping carrier

Maximum length: 32
shipping_account_number
string | null

Shipping account number

Maximum length: 32
shipping_method_name
string | null

Name of shipping method

Maximum length: 32
shipping_method_code
string | null

Code of shipping method

Maximum length: 32
shipping_tracking_number
string | null

Shipping tracking number

Maximum length: 32
shipping_weight
string | null

Shipping weight

notes
string | null

Addition info adding to shipping

invoiced_at
string | null

Time of invoice creation (UTC format)

ordered_at
string | null

Time of order finalization (UTC format)

shipped_at
string | null

Time of shipping (UTC format)

acknowledged_at
string | null

Time of retailer acknowledgement (UTC format)

paid_at
string | null

Time of payment (UTC format)

closed_at
string | null

Time of complete invoice payment (UTC format)

canceled_at
string | null

Time of order cancellation (UTC format)

allowances
object[]
charges
object[]
invoice_lines
object[]
net_amount
string | null

Total invoice amount (exluding taxes)

due_amount
string | null

Pending amount

expected_due_amount
string | null

Expected due amount (excluding allowances and charges)

subtotal
string | null

Sub-total

tax
string | null

Total tax on the invoice

invoice_acceptance
object

Was this page helpful?

List invocies from vendorsGet vendor connections