Skip to main content

accountingPushPreflight

Validates a historical QuickBooks send before anything is pushed. Selects the same documents createConsolidatedSalesReceipts would send and reports every issue that would fail the send or degrade the result, so the user can fix them first.

Each issue carries a stable code for UI remediation flows, a severity (BLOCKER issues fail the send, WARNING issues do not), and the affected products, SKUs, sales channels, orders, and order financials.

Business Rules​

  • The date range spans at most 31 days and cannot end in the future
  • accountingSalesPeriod is required for SALES_RECEIPT and rejected for INVOICE
  • Omitting salesChannelIds includes all of the company's eligible sales channels
  • QuickBooks is queried live for the Shipping and Discount sales form settings; an unreachable QuickBooks is reported as a blocker issue, not an error

Error Scenarios​

  • Invalid date range or accounting sales period arguments
  • One or more sales channels do not belong to the company
  • No active QuickBooks integration is connected for the company

Permissions Required​

  • integration:read_external_data
accountingPushPreflight(
  accountingSalesPeriod: AccountingSalesPeriodEnum
  documentType: OrderFinancialDocumentTypeEnum = SALES_RECEIPT
  endDate: ISO8601Date!
  salesChannelIds: [ID!]
  startDate: ISO8601Date!
): AccountingPushPreflight!

Arguments​

accountingPushPreflight.accountingSalesPeriod ● AccountingSalesPeriodEnum enum common​

One receipt per calendar month, or one per day. Required for SALES_RECEIPT, rejected for INVOICE.

accountingPushPreflight.documentType ● OrderFinancialDocumentTypeEnum enum orders​

Which kind of financial document the send would push.

accountingPushPreflight.endDate ● ISO8601Date! non-null scalar common​

Last document date included in the send.

accountingPushPreflight.salesChannelIds ● [ID!] list scalar common​

Limit the send to these sales channels. Omit for all channels.

accountingPushPreflight.startDate ● ISO8601Date! non-null scalar common​

First document date included in the send.

Type​

AccountingPushPreflight object accounting​

Result of validating a historical QuickBooks send before anything is pushed.