Skip to main content

createConsolidatedSalesReceipts

Sends unsent order financials within a date range to the connected QuickBooks integration.

With documentType: SALES_RECEIPT (the default), financials are grouped by sales channel and accounting customer, then by day (DAILY) or calendar month (MONTHLY), and one Sales Receipt is created per group. Only sales channels with consolidated sales receipts enabled are included.

With documentType: INVOICE, one Invoice is sent per order financial, so there is nothing to group and accountingSalesPeriod is rejected. The consolidated sales receipts channel setting does not apply. Dispatch is handed to a background job, so the count returned is what matched at request time.

Already-sent financials are excluded either way, so re-running an overlapping period is safe.

Business Rules​

  • The date range spans at most 31 days and cannot end in the future
  • Omitting salesChannelIds includes all of the company's eligible sales channels
  • accountingSalesPeriod is required for SALES_RECEIPT and rejected for INVOICE
  • DAILY receipts are dated to their day; MONTHLY receipts to their month's end, capped at the selected end date so receipts are never future-dated

Permissions Required​

  • accounting:update_order_financial
createConsolidatedSalesReceipts(
  input: CreateConsolidatedSalesReceiptsInput!
): CreateConsolidatedSalesReceiptsPayload

Arguments​

createConsolidatedSalesReceipts.input ● CreateConsolidatedSalesReceiptsInput! non-null input common​

Parameters for CreateConsolidatedSalesReceipts

Type​

CreateConsolidatedSalesReceiptsPayload object common​

Autogenerated return type of CreateConsolidatedSalesReceipts.