GET
/
invoice
/
{invoiceId}

Authorizations

Authorization
string
headerrequired

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

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

invoiceId
string
required

Response

200 - application/json

Invoice Model

invoiceId
string
required

Unique Id of the invoice

shipmentId
string
required

Shipment Id in case of invoice type as Shipment

statusCode
string
required

Current status of the invoice

channelId
string
required

Required field channel Id

invoiceTotal
number
required

Total amount invoiced

totalTaxAmount
number
required

Total tax amount invoiced

currency
string
required

Currency type in which amount invoiced

invoiceNumber
string

Unique number of the invoice

invoiceStatus
enum<string>

InvoiceStatus Model

Available options:
CAPTURED,
SETTLED,
SETTLE_FAILED,
PARTIAL_SETTLED,
DRAFT,
ISSUED,
CREDITED,
DELETED
invoiceType
enum<string>

InvoiceType Model

Available options:
RETURN,
SHIPPING,
APPEASEMENT
invoiceDate
string

Date when order invoiced

shipmentNumber
string

Shipment Number in case of invoice type as Shipment

shippedOn
string

Date when order shipped

orders
object[]

order details for the invoice

locationNum
number

locationNum in case of invoice type as Shipment

location
object

Invoice Location

retail
object

InvoiceRetail Model

createdAt
string

Date when invoice created

updatedAt
string

Date when invoice updated

postedAt
string

Date when invoice posted for financial process

acknowledgedAt
string

Date when invoice acknowledged

customer
object

InvoiceCustomer Model

auditLogs
object[]

Audit log list

shipInfo
object

OrderShipInfo Model

attributes
object