Generate invoice
Generates invoice for the given invoice type such as, shipment, appeasement, and so on.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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.
Body
EventRequest model
Event type
Invoice event detail model
Response
Invoice Model
Unique Id of the invoice
Shipment Id in case of invoice type as Shipment
Current status of the invoice
Required field channel Id
Total amount invoiced
Total tax amount invoiced
Currency type in which amount invoiced
Unique number of the invoice
InvoiceStatus Model
CAPTURED, SETTLED, SETTLE_FAILED, PARTIAL_SETTLED, DRAFT, ISSUED, CREDITED, DELETED InvoiceType Model
RETURN, SHIPPING, APPEASEMENT Date when order invoiced
Shipment Number in case of invoice type as Shipment
Date when order shipped
order details for the invoice
locationNum in case of invoice type as Shipment
Invoice Location
InvoiceRetail Model
Date when invoice created
Date when invoice updated
Date when invoice posted for financial process
Date when invoice acknowledged
InvoiceCustomer Model
Audit log list
OrderShipInfo Model
Was this page helpful?