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

receipts

Example Query
1query ExampleQuery($paymentStatus: [Int], $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String, $orderBy: String) {
2 receipts(paymentStatus: $paymentStatus, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search, orderBy: $orderBy) {
3 pageInfo {
4 hasNextPage
5 hasPreviousPage
6 startCursor
7 endCursor
8 }
9 edges {
10 node
11 cursor
12 }
13 totalCount
14 }
15}
Variables
1{
2 "paymentStatus": [
3 0
4 ],
5 "offset": 0,
6 "before": "example",
7 "after": "example",
8 "first": 0,
9 "last": 0,
10 "search": "example",
11 "orderBy": "example"
12}
Example response
1{
2 "data": {
3 "receipts": {
4 "pageInfo": {
5 "hasNextPage": true,
6 "hasPreviousPage": true,
7 "startCursor": "example",
8 "endCursor": "example"
9 },
10 "edges": [
11 {
12 "node": {
13 "id": null,
14 "createdAt": null,
15 "updatedAt": null,
16 "storeHash": null,
17 "customerId": null,
18 "externalId": null,
19 "externalCustomerId": null,
20 "totalCode": null,
21 "totalAmount": null,
22 "payerName": null
23 },
24 "cursor": "example"
25 }
26 ],
27 "totalCount": 0
28 }
29 }
30}
A list of receipts. Requires IP authentication.
Was this page helpful?
Previous

invoicePaymentFees

Next

receipt

Built with

Arguments

paymentStatuslist of optional IntegersOptional
The payment status
offsetIntegerOptional
beforeStringOptional
afterStringOptional
firstIntegerOptional
lastIntegerOptional
searchStringOptional
orderByStringOptional
Ordering

Returns

an optional ReceiptTypeCountableConnection
pageInfoPageInfo
Pagination data for this connection.
edgeslist of ReceiptTypeCountableEdges
totalCountInteger
A total count of items in the collection.