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

Authorizations

Authorization
string
headerrequired

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

Path Parameters

retailer_pk
number
required

Retailer ID

Query Parameters

search
string

Search by invoice or purchase order number

is_acknowledged
number

1: Acknowledged invoices <br /> 0: Unacknowledged invoices

is_paid
number

1: Paid invoices <br /> 0: Unpaid invoices

invoiced_at_lt
number

Invoice date is lesser than specified Time (Unix epoch format)

invoiced_at_lte
number

Invoice date is lesser than or equal to specified Time (Unix epoch format)

invoiced_at_gt
number

Invoice date is greater than specified Time (Unix epoch format)

invoiced_at_gte
number

Invoice date is greater than or equal to specified unix Time

terms_date_due_lt
number

Invoice due date is less than specified Time(Unix epoch format)

terms_date_due_lte
number

Invoice due date is less than or equal to specified Time (Unix epoch format)

terms_date_due_gt
number

Invoice due date is greater than specified Time (Unix epoch format)

terms_date_due_gte
number

Invoice due date is greater than or equal to specified Time (Unix epoch format)

connection_id
number[]

Connection ID. Multiple values may be separated by commas.

brand_id
number[]

Vendor IDs. Multiple values may be separated by commas.

retailer_id
number[]

Retailer IDs. Multiple values may be separated by commas.

payment_id
number[]

Payment IDs. Multiple values may be separated by commas.

has_payment
number

1: Invoice is paid <br /> 0: Invoice is unpaid

purchase_order_number
string

Purchase order number

total_due_lt
number

Total due amount is less than the specified amount

total_due_lte
number

Total due amount is less than or equal to the specified amount

total_due_gt
number

Total due amount is greater than the specified amount

total_due_gte
number

Total due amount is greater than or equal to the specified amount

paid_at_lt
number

Paid on date is less than specified Time (Unix epoch format)

paid_at_lte
number

Paid on date is less than or equal to specified Time (Unix epoch format)

paid_at_gt
number

Paid on date is greater than specified Time (Unix epoch format)

paid_at_gte
number

Paid on date is greater than or equal to specified Time (Unix epoch format)

order_closed_at_lt
number

Order closure date is less than specified Time (Unix epoch format).

order_closed_at_lte
number

Order closure date is less than or equal to specified Time (Unix epoch format).

order_closed_at_gt
number

Order close date is greater than specified Time (Unix epoch format)

order_closed_at_gte
number

Order closure date is greater than or equal to specified Time (Unix epoch format)

order_by
string

Sorting preference

page
integer

Page number within the paginated response

limit
integer

Number of records per page

Response

200 - application/json
count
integer
required

Total number of records

results
object[]
required
next
string | null

Next page (applicable in a paginated response)

previous
string | null

Previous page (applicable in a paginated response)

Was this page helpful?

Acknowledge receipt of an invoice.Get details of a single invoice