For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
B2B
Queries
invoice
Copy page
Get the details of an invoice. Requires IP authentication.
Arguments
invoiceId
Integer
Required
The invoice id. This field is required.
Returns
an optional
InvoiceType
id
String
createdAt
Integer
Optional
The created timestamp of the invoice
updatedAt
Integer
Optional
The updated timestamp of the invoice
storeHash
String
Optional
The store's store hash
customerId
String
Optional
The customer id of the invoice
externalId
String
Optional
The external id of the invoice
externalCustomerId
String
Optional
The external customer id of the invoice
invoiceNumber
String
Optional
The invoice number of the invoice
type
String
Optional
The type of the invoice
dueDate
Integer
Optional
The due date of the invoice
status
Integer
Optional
The status of the invoice. (0: open, 1: partial paid, 2: completed)
orderNumber
String
Optional
The order number of the invoice
purchaseOrderNumber
String
Optional
The purchase order number of the invoice
details
String
Optional
The details of the invoice
pendingPaymentCount
Integer
Optional
The pending payment count of the invoice
source
Integer
Optional
The source of the invoice
originalBalance
InvoiceBalanceType
Optional
The original balance of the invoice
openBalance
InvoiceBalanceType
Optional
The open balance of the invoice
notAllowedPay
Integer
Optional
Can this invoice allow payment
bcInformation
BCInfomation
Optional
The information of the invoice
extraFields
list of optional
InvoiceExtraFieldsType
Optional
The extra fields of the invoice
timeOffset
Integer
Optional
The time offset
storeInfo
InvoiceStoreInfoType
Optional
The store information
channelId
Integer
Optional
The channel id of the invoice
channelName
String
Optional
The channel name of the invoice
companyInfo
CompanyInfoType
Optional
Company information of invoice
orderUserId
Integer
Optional
The order user id
