v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Sales Mix Service

getAllSalesMix

Retrieve summarized sales mix data by GL by location.

get/salesmix/v1/getAllSalesMix

Query parameters

includeDetailsboolean

Use true to retrieve detailed information for one Sales Mix at a time.

locationCodestring required

The Code that identifies the Location in Crunchtime.

posNumberstring

The Register Number configured in Crunchtime for each location. Often configured as "1" or "POS" by default. Required to retrieve detailed records if 'includeDetails' param set to 'true'

transactionDatestring required

Transaction date to retrieve in format DD-MMM-YY.

includeNullboolean

Specify 'true' to output null data elements.

typestring

Numeric type of Sales Mix detail to filter relevant segments of data (e.g., 0=Sales, 1=Sales Tax, 3=Paid Outs, 5=Media Types, 6=Comps & Discounts, 7=Bank Deposits)

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

Example response

[
  {
    "salesMixDetailDetails": [
      {
        "daypartCode": 33,
        "glValue": 99999999.9999,
        "memo": "memo",
        "type": 7
      }
    ],
    "salesMixHeaderDetails": {
      "bankDeposits": 906,
      "bookCash": -375.6,
      "chargedTips": 99999999.9999,
      "complimentary": 160.98,
      "endingCount": 999999,
      "grossSales": 8685.03,
      "middayCount": 999999,
      "morningCount": 999999,
      "numberOfVoids": 999999,
      "overShort": 1281.6,
      "paidOuts": 12.76,
      "paymentMedia1": 8283.21,
      "paymentMedia2": 82,
      "paymentMedia3": 682.66,
      "salesTax": 568.21,
      "taxExemptAmount": 99999999.9999,
      "taxableSales": 8136.82,
      "totalNetSales": 8116.82,
      "totalOverrings": 99999999.9999,
      "totalVoidedAmount": 99999999.9999,
      "transactionDate": "MM/dd/yyyy"
    }
  }
]