openapi: 3.2.0 info: description: Swagger documentation supporting mobile development of Crunchtime. version: '2.99' title: Inventory & Labor Sales Mix Service API termsOfService: http://springfox.io contact: name: Crunchtime Development Team url: http://www.crunchtime.com email: apiquestions@crunchtime.com license: name: Apache License Version 2.0 url: https://github.com/springfox/springfox/blob/master/LICENSE servers: - url: //webservices-test.net-chef.com tags: - name: Sales Mix Service description: 'The Sales Mix Service is used to align Crunchtime with Daily Sales Information generated in a PointofSale system. The data includes: Sales, Sales Tax, Paid Outs, Non Cash Media, Comps and Discounts and Bank Deposits.' paths: /salesmix/v1/getAllSalesMix: get: tags: - Sales Mix Service summary: getAllSalesMix description: Retrieve summarized sales mix data by GL by location. operationId: getAllSalesMixRecordsV1UsingGET parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: includeDetails in: query description: Use `true` to retrieve detailed information for one Sales Mix at a time. required: false example: false schema: type: boolean default: false - name: locationCode in: query description: 'The Code that identifies the Location in Crunchtime. ' required: true schema: type: string - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: posNumber in: query description: 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' required: false schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: transactionDate in: query description: Transaction date to retrieve in format DD-MMM-YY. required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string - name: includeNull in: query description: Specify 'true' to output null data elements. required: false allowEmptyValue: true schema: type: boolean - name: type in: query description: 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) required: false schema: type: string responses: '200': description: Success content: '*/*': schema: type: array items: $ref: '#/components/schemas/SalesMixDetailsGet' application/json: schema: type: array items: $ref: '#/components/schemas/SalesMixDetailsGet' '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '404': description: sales mix not found content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string /salesmix/v1/getSalesMixByPage: get: tags: - Sales Mix Service summary: getSalesMixByPage description: Retrieve summarized sales mix data by GL by location by page number. operationId: getSalesMixRecordsByPageV1UsingGET parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: includeDetails in: query description: Use `true` to retrieve detailed information for one Sales Mix at a time. required: false example: false schema: type: boolean default: false - name: locationCode in: query description: The Code that identifies the Location in Crunchtime. required: true schema: type: string - name: pageNumber in: query description: "Retrieve one or more records by `pageNumber`. \n Use to retrieve data in smaller chunks. \n If left blank, the default is `1`." required: false schema: type: integer format: int32 default: 1 - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: posNumber in: query description: 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' required: false schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: transactionDate in: query description: Transaction date to retrieve in format DD-MMM-YY. required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string - name: pageSize in: query description: Number of items to display per page. required: false schema: type: integer format: int32 - name: includeNull in: query description: Specify 'true' to output null data elements. required: false allowEmptyValue: true schema: type: boolean - name: type in: query description: 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) required: false schema: type: string responses: '200': description: Success content: '*/*': schema: $ref: '#/components/schemas/SalesMixBatchResponseDto' application/json: schema: $ref: '#/components/schemas/SalesMixBatchResponseDto' '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '404': description: sales mix not found content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string /salesmix/v1/saveSalesMix: post: tags: - Sales Mix Service summary: saveSalesMix description: 'Create a new sales mix entry. Update a sales mix entry.' operationId: saveSalesMixRecordUsingPOST parameters: - name: authenticationtoken in: header description: Secure token for API authentication. required: true schema: type: string - name: password in: header description: Password for the Crunchtime Application User. required: true schema: type: string - name: sitename in: header description: Crunchtime site identifier. (test or production) required: true schema: type: string - name: userid in: header description: User ID for the Crunchtime Application User. required: true schema: type: string - name: X-B3-TraceId in: header description: Optional trace identifier for troubleshooting. required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SalesMixDetailsList' description: salesMixDetails required: true responses: '200': description: Success content: '*/*': schema: type: object application/json: schema: type: object '400': description: Validation Error content: '*/*': schema: type: array items: $ref: '#/components/schemas/ObjectError' application/json: schema: type: array items: $ref: '#/components/schemas/ObjectError' '401': description: Authorization content: '*/*': schema: type: string application/json: schema: type: string '429': description: Too Many Requests content: '*/*': schema: type: string application/json: schema: type: string '500': description: Unexpected Error content: '*/*': schema: type: string application/json: schema: type: string '503': description: System under maintenance content: '*/*': schema: type: string application/json: schema: type: string '504': description: Timeout content: '*/*': schema: type: string application/json: schema: type: string components: schemas: SalesMixDetailsGet: type: object properties: salesMixDetailDetails: type: array items: $ref: '#/components/schemas/SalesMixDetailsDto' salesMixHeaderDetails: $ref: '#/components/schemas/SalesMixHeaderDtoGet' title: SalesMixDetailsGet description: SalesMixDetailsGet description SalesMixHeaderDtoGet: type: object required: - registerNumber - transactionDate properties: bankDeposits: type: number example: 906 description: '"bankDeposits" from Sales Mix' bookCash: type: number example: -375.6 description: '"bookCash" from Sales Mix' cateringAccounts: type: number example: 0 description: '"cateringAccounts" from Sales Mix' cateringSales: type: number example: 0 description: '"cateringSales" from Sales Mix' chargedTips: type: number example: 99999999.9999 description: '"chargedTips" from Sales Mix' complimentary: type: number example: 160.98 description: '"complimentary" from Sales Mix' endingCount: type: integer format: int64 example: 999999 description: '"endingCount" from Sales Mix' grossSales: type: number example: 8685.03 description: '"grossSales" from Sales Mix' middayCount: type: integer format: int64 example: 999999 description: '"middayCount" from Sales Mix' morningCount: type: integer format: int64 example: 999999 description: '"morningCount" from Sales Mix' numberOfVoids: type: integer format: int64 example: 999999 description: '"numberOfVoids" from Sales Mix' overShort: type: number example: 1281.6 description: '"overShort" from Sales Mix' paidOuts: type: number example: 12.76 description: '"paidOuts" from Sales Mix' paymentMedia1: type: number example: 8283.21 description: '"paymentMedia1" from Sales Mix' paymentMedia2: type: number example: 82 description: '"paymentMedia2" from Sales Mix' paymentMedia3: type: number example: 682.66 description: '"paymentMedia3" from Sales Mix' registerNumber: type: string example: 2 description: '"registerNumber" from Sales Mix' salesTax: type: number example: 568.21 description: '"salesTax" from Sales Mix' taxExemptAmount: type: number example: 99999999.9999 description: '"taxExemptAmount" from Sales Mix' taxableSales: type: number example: 8136.82 description: '"taxableSales" from Sales Mix' totalNetSales: type: number example: 8116.82 description: '"totalNetSales" from Sales Mix' totalOverrings: type: number example: 99999999.9999 description: '"totalOverrings" from Sales Mix' totalVoidedAmount: type: number example: 99999999.9999 description: '"totalVoidedAmount" from Sales Mix' transactionDate: type: string example: MM/dd/yyyy description: '"transactionDate" from Sales Mix' zReadingNumber: type: string example: 1 description: '"zReadingNumber" from Sales Mix' title: SalesMixHeaderDtoGet description: SalesMixHeaderDtoGet description SalesMixDetailsDto: type: object required: - daypartCode - glNumber - glValue - type properties: daypartCode: type: integer format: int64 example: 33 description: '"daypartCode" from salesmix. Required for "Sales" and "Sales Tax" rows only. (Not used for other record types.)' glNumber: type: string example: 400001 description: '"glNumber" from salesmix. GL Number is not required (or) stored for Bank Deposits.' glValue: type: number example: 99999999.9999 description: '"glValue" from salesmix' memo: type: string example: memo description: '"memo" from salesmix' type: type: integer format: int64 example: 7 description: '"type" from salesmix' title: SalesMixDetailsDto description: SalesMixDetailsDto description SalesMixDetailsList: type: object required: - locationCode properties: locationCode: type: string example: '000000' description: '"Code" from Company setup screen' salesMixDetails: type: array items: $ref: '#/components/schemas/SalesMixDetails' title: SalesMixDetailsList description: SalesMixDetailsList description ObjectError: type: object properties: arguments: type: array items: type: object code: type: string codes: type: array items: type: string defaultMessage: type: string objectName: type: string title: ObjectError SalesMixHeaderDto: type: object required: - registerNumber - transactionDate properties: chargedTips: type: number example: 99999999.9999 description: The tips charged to a credit card. endingCount: type: integer format: int64 example: 999999 description: '"endingCount" from salesmix' middayCount: type: integer format: int64 example: 999999 description: '"middayCount" from salesmix' morningCount: type: integer format: int64 example: 999999 description: '"morningCount" from salesmix' numberOfVoids: type: integer format: int64 example: 999999 description: '"numberOfVoids" from salesmix' registerNumber: type: string example: 2 description: '"registerNumber" from salesmix' taxExemptAmount: type: number example: 99999999.9999 description: '"taxExemptAmount" from salesmix' totalOverrings: type: number example: 99999999.9999 description: '"totalOverrings" from salesmix' totalVoidedAmount: type: number example: 99999999.9999 description: '"totalVoidedAmount" from salesmix' transactionDate: type: string example: MM/dd/yyyy description: '"transactionDate" from salesmix' zReadingNumber: type: string example: 1 description: '"zReadingNumber" from salesmix' title: SalesMixHeaderDto description: SalesMixHeaderDto description SalesMixBatchResponseDto: type: object properties: hasNext: type: boolean salesMixDetails: type: array items: $ref: '#/components/schemas/SalesMixDetailsGet' totalPages: type: integer format: int32 title: SalesMixBatchResponseDto description: SalesMixBatchResponseDto description SalesMixDetails: type: object properties: salesMixDetailDetails: type: array items: $ref: '#/components/schemas/SalesMixDetailsDto' salesMixHeaderDetails: $ref: '#/components/schemas/SalesMixHeaderDto' title: SalesMixDetails description: SalesMixDetails description externalDocs: description: Crunchtime Developer Hub url: https://developer.crunchtime.com/ x-provenance: method: searched source: https://developer.crunchtime.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://developer.crunchtime.com/reference/downloadscheduledexportsv1usingget.md - https://developer.crunchtime.com/reference/downloadscheduledexportsv2usingget.md - https://developer.crunchtime.com/reference/get15minutessalesforecastbypagev1usingget.md - https://developer.crunchtime.com/reference/get15minutessalesforecastv1usingget.md - https://developer.crunchtime.com/reference/get_commissaryorder-v1-getcommissaryordersbypage.md - https://developer.crunchtime.com/reference/get_customerorderenhanced-v1-getcustomerorderenhancedbypage.md - https://developer.crunchtime.com/reference/getallapplicationusersv1usingget.md - https://developer.crunchtime.com/reference/getallbudgetv1usingget.md - https://developer.crunchtime.com/reference/getallcategoryv1usingget.md - https://developer.crunchtime.com/reference/getallcheckmenumixrecordsv1usingget.md - https://developer.crunchtime.com/reference/getallcommissaryordersv1usingget.md - https://developer.crunchtime.com/reference/getallcompanyproductsenhancedv1usingget.md - https://developer.crunchtime.com/reference/getallconfirmreceiptstandardv1usingget.md - https://developer.crunchtime.com/reference/getallcurrencyratiov1usingget.md - https://developer.crunchtime.com/reference/getallcustomerorderenhancedv1usingget.md - https://developer.crunchtime.com/reference/getallcustomerrecordsv1usingget.md - https://developer.crunchtime.com/reference/getalldailyprepsv1usingget.md - https://developer.crunchtime.com/reference/getallgeneralledgersv1usingget.md - https://developer.crunchtime.com/reference/getallinventoryadjustmentv1usingget.md - https://developer.crunchtime.com/reference/getallinventorylocationtransfersv1usingget.md - https://developer.crunchtime.com/reference/getallinventoryvalueadjustmentv1usingget.md - https://developer.crunchtime.com/reference/getalllocationproductpricingv1usingget.md - https://developer.crunchtime.com/reference/getalllocationsv1usingget.md - https://developer.crunchtime.com/reference/getallnutritionv1usingget.md - https://developer.crunchtime.com/reference/getallpackagetypesv2usingget.md - https://developer.crunchtime.com/reference/getallpbisbypagev2usingget.md - https://developer.crunchtime.com/reference/getallpbisv2usingget.md - https://developer.crunchtime.com/reference/getallphysicalinventorystandardusingget.md - https://developer.crunchtime.com/reference/getallprojectedconsumptionv1usingget.md - https://developer.crunchtime.com/reference/getallpurchaseordersv1usingget.md - https://developer.crunchtime.com/reference/getallrecipelocationv1usingget.md - https://developer.crunchtime.com/reference/getallrecipesenhancedv2usingget.md - https://developer.crunchtime.com/reference/getallsalesmixrecordsv1usingget.md - https://developer.crunchtime.com/reference/getallscheduledexportsv1usingget.md - https://developer.crunchtime.com/reference/getallstoragelocationv1usingget.md - https://developer.crunchtime.com/reference/getallsupplementalwagerecordsv1usingget.md - https://developer.crunchtime.com/reference/getalltimeclockenhancedrecordsv1usingget.md - https://developer.crunchtime.com/reference/getallvendorlocationv1usingget.md - https://developer.crunchtime.com/reference/getallvendorpaymentv1usingget.md - https://developer.crunchtime.com/reference/getallvendorproductpricingv1usingget.md - https://developer.crunchtime.com/reference/getallvendorsv1usingget.md - https://developer.crunchtime.com/reference/getapplicationusersbypagev1usingget.md - https://developer.crunchtime.com/reference/getattachmentsbypagev1usingget.md - https://developer.crunchtime.com/reference/getattachmentsbypagev2.md - https://developer.crunchtime.com/reference/getbudgetbypagev1usingget.md - https://developer.crunchtime.com/reference/getcategorybypagev1usingget.md - https://developer.crunchtime.com/reference/getcheckmenumixrecordsbypagev1usingget.md - https://developer.crunchtime.com/reference/getcompanyproductsenhancedbypagev1usingget.md - https://developer.crunchtime.com/reference/getconfirmreceiptstandardbypagev1usingget.md - https://developer.crunchtime.com/reference/getcurrencyratiobypagev1usingget.md - https://developer.crunchtime.com/reference/getcurrentinventorybypagev1usingget.md - https://developer.crunchtime.com/reference/getcustomerrecordsbypagev1usingget.md - https://developer.crunchtime.com/reference/getdailyprepsbypagev1usingget.md - https://developer.crunchtime.com/reference/getdailysalesforecastbypagev1usingget.md - https://developer.crunchtime.com/reference/getdailysalesforecastv1usingget.md - https://developer.crunchtime.com/reference/getemployeenumbersv1usingget.md - https://developer.crunchtime.com/reference/getemployeesbypagev1usingget.md - https://developer.crunchtime.com/reference/getemployeev1usingget.md - https://developer.crunchtime.com/reference/gethierarchiesv2usingget.md - https://developer.crunchtime.com/reference/gethierarchydetailsv2usingget.md - https://developer.crunchtime.com/reference/gethourlysalesforecastbypagev1usingget.md - https://developer.crunchtime.com/reference/gethourlysalesforecastv1usingget.md - https://developer.crunchtime.com/reference/getinventoryadjustmentbypagev1usingget.md - https://developer.crunchtime.com/reference/getinventorylocationtransfersbypagev1usingget.md - https://developer.crunchtime.com/reference/getinventoryvalueadjustmentbypagev1usingget.md - https://developer.crunchtime.com/reference/getlocationproductpricingbypagev1usingget.md - https://developer.crunchtime.com/reference/getlocationsbypagev1usingget.md - https://developer.crunchtime.com/reference/getnutritionbypagev1usingget.md - https://developer.crunchtime.com/reference/getpackagetypesbypagev2usingget.md - https://developer.crunchtime.com/reference/getphysicalinventorystandardbypagev1usingget.md - https://developer.crunchtime.com/reference/getprojectedconsumptionbypagev1usingget.md - https://developer.crunchtime.com/reference/getpurchaseordersbypagev1usingget.md - https://developer.crunchtime.com/reference/getrecipelocationbypagev1usingget.md - https://developer.crunchtime.com/reference/getrecipesenhancedbypagev2usingget.md - https://developer.crunchtime.com/reference/getsalesmixrecordsbypagev1usingget.md - https://developer.crunchtime.com/reference/getschedulesv1usingget.md - https://developer.crunchtime.com/reference/getstoragelocationbypagev1usingget.md - https://developer.crunchtime.com/reference/getsupplementalwagerecordsbypageusingget.md - https://developer.crunchtime.com/reference/gettimeclockenhancedrecordsbypagev1usingget.md - https://developer.crunchtime.com/reference/getudalocationsusingget.md - https://developer.crunchtime.com/reference/getudavendorsusingget.md - https://developer.crunchtime.com/reference/getvendorlocationbypagev1usingget.md - https://developer.crunchtime.com/reference/getvendorpaymentbypagev1usingget.md - https://developer.crunchtime.com/reference/getvendorproductpricingbypagev1usingget.md - https://developer.crunchtime.com/reference/markscheduledexportsv1usingput.md - https://developer.crunchtime.com/reference/save15minutessalesforecastusingpost.md - https://developer.crunchtime.com/reference/saveapplicationusersv1usingpost.md - https://developer.crunchtime.com/reference/savebudgetusingpost.md - https://developer.crunchtime.com/reference/savecategoryusingpost.md - https://developer.crunchtime.com/reference/savecheckmenumixrecordsv1usingpost.md - https://developer.crunchtime.com/reference/savecompanyproductenhancedv1usingpost.md - https://developer.crunchtime.com/reference/saveconfirmreceiptstandardusingpost.md - https://developer.crunchtime.com/reference/savecurrencyratiousingpost.md - https://developer.crunchtime.com/reference/savecustomerorderenhancedusingpost.md - https://developer.crunchtime.com/reference/savecustomerrecordsusingpost.md - https://developer.crunchtime.com/reference/savedailyprepsusingpost.md - https://developer.crunchtime.com/reference/savedailysalesforecastusingpost.md - https://developer.crunchtime.com/reference/saveelectronicinvoiceusingpost.md - https://developer.crunchtime.com/reference/saveemployeev1usingpost.md - https://developer.crunchtime.com/reference/savegeneralledgerv1usingpost.md - https://developer.crunchtime.com/reference/savehierarchyv2usingpost.md - https://developer.crunchtime.com/reference/savehourlysalesforecastusingpost.md - https://developer.crunchtime.com/reference/saveinventoryadjustmentusingpost.md - https://developer.crunchtime.com/reference/saveinventoryvalueadjustmentusingpost.md - https://developer.crunchtime.com/reference/savelocationproductpricingusingpost.md - https://developer.crunchtime.com/reference/savelocationv1usingpost.md - https://developer.crunchtime.com/reference/savenutritionusingpost.md - https://developer.crunchtime.com/reference/savepackagetypesv2usingpost.md - https://developer.crunchtime.com/reference/savepbiv2usingpost.md - https://developer.crunchtime.com/reference/savephysicalinventorystandardusingpost.md - https://developer.crunchtime.com/reference/saveprojectedconsumptionusingpost.md - https://developer.crunchtime.com/reference/savepurchaseordersusingpost.md - https://developer.crunchtime.com/reference/saverecipelocationusingpost.md - https://developer.crunchtime.com/reference/saverecipesv2usingpost.md - https://developer.crunchtime.com/reference/savesalesmixrecordusingpost.md - https://developer.crunchtime.com/reference/savestoragelocationusingpost.md - https://developer.crunchtime.com/reference/savesupplementalwagerecordsusingpost.md - https://developer.crunchtime.com/reference/savetimeclockenhancedrecordsusingpost.md - https://developer.crunchtime.com/reference/savevendorlocationv1usingpost.md - https://developer.crunchtime.com/reference/savevendorpaymentusingpost.md - https://developer.crunchtime.com/reference/savevendorv1usingpost.md - https://developer.crunchtime.com/reference/validateuserusingpost.md merge: pages: 122 deduped: 334 conflicts_kept_first: 0