Check Summary

get

http://{{apiurl}}/api/v1/sales/checks/summaries

Check Summary

Represents a POS check including line items, category rollups, taxes, payments, and computed totals.

When calling this endpont, you must provide either a businessDate or an id.

Provide businessDate to obtain a list of Check Summaries for the given business date.
Provide id to obtain a specific Check Summary

All monetary amounts are expressed in minor units (e.g., cents).

In all arrays, metaId is the identifier of the record instance itself, and id is a reference back to the configuration record (e.g., in items the id is the Menu Item ID; in payments the id is the Tender ID).

CheckSummary Object

Field	Type	Description
`id`	string	Check identifier. Often equals `checkId` in the sample payloads.
`checkId`	string	Check identifier as generated by the POS.
`name` / `checkName`	string	Human label or ticket name (e.g., table label). Both appear in payloads.
`checkNumber`	number	Sequential check number.
`status`	string	Check lifecycle status (e.g., `CLOSED`).
`type`	string	Check type (e.g., `ORDER`).
`businessDate`	string (YYYY-MM-DD)	Business date for the revenue day.
`closedAt`	string (ISO 8601)	Timestamp when the check was closed (if available).
`updatedAt`	string (ISO 8601)	Timestamp when the summary was last updated.
`venueId`	string	Venue identifier.
`revenueCenterId` / `revenueCenterName`	string	Revenue center reference and name.
`areaId` / `areaName`	string	Service area reference and name (e.g., “Dine In”).
`guestCount`	number	Guests on the check.
`seatCount`	number	Number of seats.
`ownerEmployeeId` / `ownerEmployeeName`	string	Employee who owns the check.
`accountableEmployeeId` / `accountableEmployeeName`	string	Employee recorded as accountable for the check.
`accountableTimeCardId`	string	Related time card identifier.
`missingBeverageCount`	number	Operational counter for beverage controls.
`tags`	string[]	Tags applied to the check (e.g., `["POS"]`).
`source` / `sourceStatus`	string	Ingestion source (e.g., `POS`) and optional source status.
`_entityName`	string	Internal entity label (e.g., `CHECK_SUMMARY`).
`_entityVersion`	number	Internal schema/version indicator.
`_createdAt` / `_updatedAt`	string	Internal create/update timestamps.
`_updatedBy`	string	Internal updater (e.g., `API`).
`_stage`	string	Environment indicator (e.g., `prod`).
`version`	number	Record version.
`customerTenants`	array	Present in payloads; empty in examples.
`payments`	Payment[]	Payment summary lines associated with the check.
`items`	Item[]	Sold items and modifiers (zero-priced modifiers appear with parent linkage).
`salesCategories`	SalesCategory[]	Roll-ups by sales category including nested tax summaries.
`taxes`	TaxTotal[]	Aggregated tax totals across the check.
`discounts`	array	Present (often empty) for check-level discounts.
`paidIns` / `paidOuts`	array	Present (empty in samples) for cash movements.
`giftCards`	array	Present (empty in samples) for gift card movements.
`fees`	array	Present (empty in samples) for additional fee lines.
`voids`	array	Present (empty in samples) for voided lines.
`gratuities`	array	Present (empty in samples) for auto-grat lines.
`checkTotals`	CheckTotals	Computed totals (subtotal, taxes, payments, balance, etc.).

Nested Objects

CheckTotals

Totals are in minor units.

Field	Type	Notes
`subtotal`	number	Pre-tax, pre-fees merchandise total.
`exclusiveTaxAmount` / `inclusiveTaxAmount`	number	Split of tax calculation modes. Examples show exclusive taxes populated.
`feeTotal` / `paymentFeeTotal` / `alternatePricingFeeTotal`	number	Additional fee totals (0 in samples).
`discountAmount`	number	Check-level discounts. (0 in samples.)
`gratuityTotal`	number	Auto-gratuity total (0 in samples).
`voidTotal`	number	Voids affecting totals (0 in samples).
`paidInTotal` / `paidOutTotal`	number	Cash drawer adjustments (0 in samples).
`giftCardTotal`	number	Gift card activity (0 in samples).
`tipTotal`	number	Tips recorded on the check (often > 0).
`paymentsAppliedTotal`	number	Total of payments applied.
`changeDueTotal`	number	Change given (0 in samples).
`creditBalanceDue`	number	Remaining amount due (can be negative if over-paid).
`remainingBalance`	number	Remaining balance at close (0 in samples).
`total`	number	Final total (generally equals merchandise + taxes + fees − discounts).

Payment

A tender application (e.g., credit). metaId identifies the payment record; id references the Tender configuration. Totals in minor units.

Field	Type	Description
`metaId`	string	Payment record ID.
`id`	string	Tender ID (configuration reference).
`type`	string	Tender family (e.g., `CREDIT`).
`detailType`	string	Always `PAYMENT` in samples.
`name`	string	Friendly tender label (e.g., “Visa ~ 9466”).
`employeeId`	string	Employee who processed the payment.
`disbursement`	string	e.g., `RETAINED`.
`status`	string	e.g., `TIP_ADJUSTED`.
`account`	string	Masked PAN/account string.
`count`	number	Count of applied payments in this line (samples show `1`).
`total`	number	Amount charged.
`tipTotal`	number	Tip amount.
`tipRetainedTotal`	number	Portion of tip retained.
`tipFeeTotal`	number	Tip fee total (0 in samples).
`refundTotal`	number	Refund amount (0 in samples).
`changeDueTotal`	number	Change due from payment (0 in samples).
`_createdAt`	string	Creation time of the payment record.

Item

Represents a sold menu line or a zero-priced modifier/ingredient. id references the Menu Item (or modifier item) configuration; metaId is the sold-line instance. Monetary amounts in minor units.

Field	Type	Description
`metaId`	string	Line instance ID.
`id`	string	Menu Item (configuration) ID.
`name`	string	Item name at time of sale.
`type`	string	Product class (e.g., `FOOD`).
`detailType`	string	Always `ITEM` in samples.
`salesCategoryId`	string	Category reference.
`employeeId`	string	Employee who rang the item.
`status`	string	e.g., `COMMITTED` or `RANG` (modifiers often `RANG`).
`count`	number	Quantity (integer).
`total`	number	Extended price for this line (minor units).
`pricePointId` / `pricePointName`	string	Price point reference & label (e.g., `HH`, `RH`, `Single`).
`parentMetaId`	string	null
`discountId` / `discountName` / `discountTotal`	—	If item-level discounts applied.
`taxes[]`	ItemTax[]	Taxes applied to this line (see below).
`approvedByEmployeeId` / `discountedByEmployeeId` / `discountedAt`	—	Audit fields for approvals/discounts.
`_createdAt`	string	null

ItemTax

id (Tax config ID), name, type (EXCLUSIVE in samples), total (minor units).

SalesCategory

Roll-up per sales category with nested tax roll-ups.

Field	Type	Description
`id`	string	Sales category ID (configuration).
`name`	string	Category name (e.g., `Food`, `Liquor`, `NA Bev`).
`type`	string	Always `SALES` in samples.
`detailType`	string	`SALES_CATEGORY`.
`count`	number	Number of lines contributing.
`grossSalesTotal` / `netSalesTotal` / `discountTotal`	number	Category roll-up totals (minor units).
`inclusiveTaxTotal`	number	Included tax roll-up (0 in samples).
`total`	number	Category total (equals net in samples).
`taxes[]`	CategoryTax[]	Roll-up of taxes within the category.
`_createdAt`	string	null

CategoryTax

id, name, type (EXCLUSIVE), rate (decimal), taxableTotal, total, count, exemptTotal, exemptReason, exemptMeta.

TaxTotal

Top-level aggregation of taxes for the check.

Field	Type	Description
`id`	string	Tax configuration ID.
`name`	string	Tax name (e.g., “AZ Sales Tax”).
`type`	string	Tax calculation mode (`EXCLUSIVE` in samples).
`total`	number	Total amount of this tax (minor units).

Example (abridged)

{
  "records": [
    {
      "id": "30fbf1b1-720a-4ca4-b3f5-0322a0cd278b",
      "checkId": "30fbf1b1-720a-4ca4-b3f5-0322a0cd278b",
      "status": "CLOSED",
      "type": "ORDER",
      "businessDate": "2025-10-31",
      "closedAt": "2025-11-01T01:35:02.844971Z",
      "venueId": "73ef8a9b-df4f-4149-9e2a-f0b119c9e219",
      "revenueCenterId": "385f0c9c-f997-4040-b4cc-6df9106112a1",
      "areaId": "267cd8fc-7ced-4d5d-834d-408fd58c2ff9",
      "guestCount": 1,
      "checkTotals": {
        "subtotal": 4100,
        "exclusiveTaxAmount": 381,
        "paymentsAppliedTotal": 4481,
        "tipTotal": 500,
        "total": 4481,
        "creditBalanceDue": 2733,
        "remainingBalance": 0
      },
      "items": [
        { "metaId": "95d4...", "id": "59c3...", "name": "Loaded Nachos RH", "total": 1600, "taxes": [/*...*/] },
        { "metaId": "cae8...", "id": "6c4b...", "name": "House Marg RH", "total": 900, "taxes": [/*...*/] }
      ],
      "payments": [
        { "metaId": "c3ba...", "id": "7b42...", "type": "CREDIT", "name": "Visa ~ 9466", "total": 4481, "tipTotal": 500 }
      ],
      "taxes": [
        { "id": "78c2...", "name": "AZ Sales Tax", "type": "EXCLUSIVE", "total": 229.6 }
      ]
    }
  ]
}

Integrator Notes

Cents vs. Dollars: All amounts are in minor units (e.g., $44.81 → 4481). Convert as needed for display.
Parent/Child Items: Zero-priced modifiers appear with parentMetaId pointing to a parent item line. Do not treat them as separate checks; they are part of the parent line.
Configuration References: In arrays, use id to join back to configuration catalogs (Menu Items, Tenders, Taxes, Categories). Use metaId to reference the specific transactional record.
Requesting Check Summaries: When calling this endpont, you must provide either a businessDate or an id.
- Provide businessDate to obtain a list of Check Summaries for the given business date.
- Provide id to obtain a specific Check Summary