For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
          • QUERYcompanyRoles
          • QUERYcompanyRole
          • QUERYcompanyPermissions
          • QUERYaccountSettings
          • QUERYcustomerAccountSettings
          • QUERYinvoices
          • QUERYinvoice
          • QUERYinvoiceStats
          • QUERYinvoiceCustomerInformation
          • QUERYinvoicePaymentModules
          • QUERYinvoiceBcOrderAllowMethods
          • QUERYinvoicePaymentBcCart
          • QUERYinvoicePaymentFees
          • QUERYreceipts
          • QUERYreceipt
          • QUERYallReceiptLines
          • QUERYreceiptLine
          • QUERYreceiptLines
          • QUERYorder
          • QUERYallOrders
          • QUERYorderProducts
          • QUERYorderedProducts
          • QUERYcustomerOrders
          • QUERYcustomerOrder
          • QUERYcreatedByUser
          • QUERYshoppingLists
          • QUERYshoppingList
          • QUERYshoppingListsIdName
          • QUERYcustomerShoppingLists
          • QUERYcustomerShoppingList
          • QUERYcustomerShoppingListsIdName
          • QUERYcompanyExtraFields
          • QUERYuserCompany
          • QUERYcompanyValidateEmail
          • QUERYcompanyUserInfo
          • QUERYaccountFormFields
          • QUERYcompanyCreditConfig
          • QUERYcompanyPaymentTerms
          • QUERYcompanySubsidiaries
          • QUERYsuperAdminCompanies
          • QUERYsuperAdminMasquerading
          • QUERYquotes
          • QUERYcustomerQuotes
          • QUERYquote
          • QUERYquoteUserStoreInfo
          • QUERYquoteConfig
          • QUERYquoteExtraFieldsConfig
          • QUERYusers
          • QUERYuser
          • QUERYuserEmailCheck
          • QUERYcustomerEmailCheck
          • QUERYuserExtraFields
          • QUERYcurrentUser
          • QUERYcustomerInfo
          • QUERYuserLoginState
          • QUERYuserMasqueradingCompany
          • QUERYorderStatuses
          • QUERYbcOrderStatuses
          • QUERYcurrencies
          • QUERYautoLoader
          • QUERYstoreLimitations
          • QUERYstoreBasicInfo
          • QUERYstorefrontScript
          • QUERYstorefrontDefaultLanguage
          • QUERYstorefrontProductSettings
          • QUERYstorefrontSettings
          • QUERYstoreConfigSwitchStatus
          • QUERYstoreCheckoutConfig
          • QUERYstorefrontConfig
          • QUERYstorefrontConfigs
          • QUERYproductVariantsInfo
          • QUERYvariantSku
          • QUERYproductsInventory
          • QUERYproductsLoad
          • QUERYproductsSearch
          • QUERYtaxZoneRates
          • QUERYproductPurchasable
          • QUERYvalidateProduct
          • QUERYvalidateProducts
          • QUERYpriceProducts
          • QUERYaddresses
          • QUERYaddress
          • QUERYcountries
          • QUERYdefaultShippingAddress
          • QUERYdefaultBillingAddress
          • QUERYcustomerAddresses
          • QUERYcustomerAddress
          • QUERYaddressConfig
          • QUERYaddressExtraFields
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLB2BQueries

invoice

Example Query
1query ExampleQuery($invoiceId: Int) {
2  invoice(invoiceId: $invoiceId) {
3    id
4    createdAt
5    updatedAt
6    storeHash
7    customerId
8    externalId
9    externalCustomerId
10    invoiceNumber
11    type
12    dueDate
13  }
14}
Variables
1{
2  "invoiceId": 0
3}
Example response
1{
2  "data": {
3    "invoice": {
4      "id": "example",
5      "createdAt": 0,
6      "updatedAt": 0,
7      "storeHash": "example",
8      "customerId": "example",
9      "externalId": "example",
10      "externalCustomerId": "example",
11      "invoiceNumber": "example",
12      "type": "example",
13      "dueDate": 0
14    }
15  }
16}
Get the details of an invoice. Requires IP authentication.
Was this page helpful?
Previous

invoices

Next

invoiceStats

Built with

Arguments

invoiceIdIntegerRequired
The invoice id. This field is required.

Returns

an optional InvoiceType
idString
createdAtInteger
The created timestamp of the invoice
updatedAtInteger
The updated timestamp of the invoice
storeHashString
The store's store hash
customerIdString
The customer id of the invoice
externalIdString
The external id of the invoice
externalCustomerIdString
The external customer id of the invoice
invoiceNumberString
The invoice number of the invoice
typeString
The type of the invoice
dueDateInteger
The due date of the invoice
statusInteger

The status of the invoice. (0: open, 1: partial paid, 2: completed)

orderNumberString
The order number of the invoice
purchaseOrderNumberString
The purchase order number of the invoice
detailsGenericScalar
The details of the invoice
pendingPaymentCountInteger
The pending payment count of the invoice
sourceInteger
The source of the invoice
originalBalanceInvoiceBalanceType
The original balance of the invoice
openBalanceInvoiceBalanceType
The open balance of the invoice
notAllowedPayInteger
Can this invoice allow payment
bcInformationBCInfomation
The information of the invoice
extraFieldslist of optional InvoiceExtraFieldsType
The extra fields of the invoice
timeOffsetInteger
The time offset
storeInfoInvoiceStoreInfoType
The store information
channelIdInteger
The channel id of the invoice
channelNameString
The channel name of the invoice
companyInfoCompanyInfoType
Company information of invoice
orderUserIdInteger
The order user id