Split checkdeprecated
https://core-api.ancon.io/api/v1/Outlets/{outletId}/Checks/{checkId}/SplitWill no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.
Authorization
Access-TokenheaderrequiredTenant- or outlet-level token from the backoffice. See Get started.
Path parameters
outletIdstring (uuid)requiredcheckIdstring (uuid)required
Header parameters
correlationIdstringCorrelation Id for the request
Request body
partsinteger (int32)requiredmin 2, max 100.
Responses
201Created
createdarray<object> | null41 fields in
createdidstring (uuid)createdstring (date-time)modifiedstring (date-time)outletobject | null2 fields in
outletidstring (uuid)namestring | null
orderFormatinteger (int32)Allowed values:
0,1,2,4,8,16,32,64,128,159,191.orderTypeinteger (int32)Allowed values:
0,1,2,3,4,5.saleSourceIdstring (uuid)discountValueobject | null2 fields in
discountValuevaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
discountCodeobject | null2 fields in
discountCodediscountIdstring (uuid) | nulldiscountNamestring | null
currencyobject | null1 field in
currencycodestring | null
salesLocationobject | null2 fields in
salesLocationsalesLocationIdstring (uuid) | nulltypeinteger (int32)Allowed values:
0,1,2,3.
companyInfoobject | null7 fields in
companyInfocompanyIdstring (uuid) | nullcompanyNamestring | nullcompanyBusinessNumberstring | nulladdressobject | null4 fields in
addressstreetstring | nullstreet2string | nullzipCodestring | nullcitystring | null
invoiceEmailobject | null1 field in
invoiceEmailemailstring | null
memberIdstring (uuid) | nullmemberNamestring | null
deletedReasonstring | nullcreatedCheckTenantUserIdstring (uuid)createdCheckTenantUserobject | null3 fields in
createdCheckTenantUseridstring (uuid)nameobject | null2 fields in
namefirstNamestring | nulllastNamestring | null
emailobject | null1 field in
emailemailstring | null
closedCheckTenantUserIdstring (uuid) | nullcreatedCheckClientIdstring (uuid)closedCheckClientIdstring (uuid) | nullorderIdstring (uuid) | nullincrementalNumbersobject | null4 fields in
incrementalNumbersticketNumberinteger (int64) | nullUnique number per outlet per Z-Report, it will reset when a Z-Report is made and start on 1 again. Used alot in the UI to give a simple to read number, will also be printed on tickets.
serialNumberinteger (int64) | nullUnbroken sequence per outlet which statisfies the needs of certain pos system laws, is only used on Checks.
referenceNumberinteger (int64) | nullUnbroken sequence per outlet which is used for all types of sales. Suitable for correlation between systems.
refundSerialNumberinteger (int64) | nullUses same series as SerialNumber and is set on orders which is refunded.
collectionTicketIdstring (uuid) | nullcustomTicketNumberinteger (int64) | nullcustomNamestring | nulldeletedstring (date-time) | nullguestCountinteger (int32) | nullmetaDataarray<object> | nullRename for next version to 'Metadata'
6 fields in
metaDataidstring (uuid)createdstring (date-time)modifiedstring (date-time)checkIdstring (uuid)checkItemIdstring (uuid) | nullRename for next version to string 'Reference'
metaDataany | nullRename for next version to 'Metadata'
checkItemsarray<object> | null43 fields in
checkItemsidstring (uuid)checkIdstring (uuid) | nullcreatedstring (date-time)modifiedstring (date-time)productobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
20 fields in
productglassesPerBottlenumber (double) | nullhasVariantsbooleanisSystemProductbooleanlocalizedProductNamesobject | null1 field in
localizedProductNamestranslationsmap<string, string> | null
localizedVariantNamesobject | null1 field in
localizedVariantNamestranslationsmap<string, string> | null
positionobject | null1 field in
positionpositioninteger (int32)
productGroupIdstring (uuid)productGroupNamestring | nullproductIdstring (uuid)productNamestring | nullproductNumberstring | nullproductTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10.storageInfoobject | null2 fields in
storageInfotemperatureinteger (int32)sizeobject | null3 fields in
sizeheightinteger (int32)widthinteger (int32)lengthinteger (int32)
subProductIdstring (uuid) | nullsubProductQuantityobject | null1 field in
subProductQuantityvaluenumber (double)
useBasePricebooleanvariantIdstring (uuid)variantNamestring | nullvariantNumberstring | nullvariantTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7.
quantityobject | null1 field in
quantityvaluenumber (double)
unitQuantityobject | null1 field in
unitQuantityvaluenumber (double)
unitobject | null2 fields in
unitnamestring | nulltypeinteger (int32)Allowed values:
0,1,2,3.
pricePresetIdstring (uuid) | nullproductPriceInclTaxobject | null2 fields in
productPriceInclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productPriceExclTaxobject | null2 fields in
productPriceExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productMaterialCostExclTaxobject | null2 fields in
productMaterialCostExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
kitchenMessagestring | nulldiscountInfoobject | null2 fields in
discountInfodiscountIdstring (uuid) | nulldiscountNamestring | null
discountobject | null2 fields in
discountvaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
courseNamestring | nullcoursePositioninteger (int32)checkPaymentIdstring (uuid) | nullpaidAtstring (date-time) | nulltagstring | nullstatusinteger (int32)Allowed values:
0,1,2,4,8,16,32.upsellGroupIdstring (uuid) | nullticketedAtstring (date-time) | nullticketedTenantUserIdstring (uuid) | nullmodificationsarray<object> | null5 fields in
modificationsidstring (uuid)createdstring (date-time)modifiedstring (date-time)checkItemIdstring (uuid)modificationobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
9 fields in
modificationaddOnGroupobject | null3 fields in
addOnGroupidstring (uuid)namestring | nulllocalizedCustomerFacingNamesobject | null
costobject | null2 fields in
costamountnumber (double)currencyCodestring | null
freeAmountobject | null1 field in
freeAmountvaluenumber (double)
ingredientobject | null3 fields in
ingredientidstring (uuid)nameobject | nulllocalizedNamesobject | null
materialCostobject | null2 fields in
materialCostamountnumber (double)currencyCodestring | null
modificationstring | nullpositionobject | null1 field in
positionpositioninteger (int32)
quantityobject | null1 field in
quantityvaluenumber (double)
replacementobject | null3 fields in
replacementidstring (uuid)nameobject | nulllocalizedNamesobject | null
isTaxMandatorybooleantaxesarray<object> | null4 fields in
taxesidstring (uuid)createdstring (date-time)modifiedstring (date-time)taxobject | null2 fields in
taxtaxIdstring (uuid)taxValueobject | null2 fields in
taxValuetypeinteger (int32)Allowed values:
1,2.ratenumber (double)
checkItemsarray<object> | nullparentItemIdstring (uuid) | nullisMultiproductbooleanhasOwnPricebooleanpriceInclTaxobject | null2 fields in
priceInclTaxamountnumber (double)currencystring | null
priceExclTaxobject | null2 fields in
priceExclTaxamountnumber (double)currencystring | null
totalPriceInclTaxobject | null2 fields in
totalPriceInclTaxamountnumber (double)currencystring | null
totalPriceExclTaxobject | null2 fields in
totalPriceExclTaxamountnumber (double)currencystring | null
totalMaterialCostExclTaxobject | null2 fields in
totalMaterialCostExclTaxamountnumber (double)currencystring | null
discountAmountInclTaxobject | null2 fields in
discountAmountInclTaxamountnumber (double)currencystring | null
discountAmountExclTaxobject | null2 fields in
discountAmountExclTaxamountnumber (double)currencystring | null
totalDiscountAmountInclTaxobject | null2 fields in
totalDiscountAmountInclTaxamountnumber (double)currencystring | null
totalDiscountAmountExclTaxobject | null2 fields in
totalDiscountAmountExclTaxamountnumber (double)currencystring | null
modificationPriceInclTaxobject | null2 fields in
modificationPriceInclTaxamountnumber (double)currencystring | null
modificationPriceExclTaxobject | null2 fields in
modificationPriceExclTaxamountnumber (double)currencystring | null
isPrepaidboolean
paymentsarray<object> | null21 fields in
paymentsidstring (uuid)createdstring (date-time)modifiedstring (date-time)paymentTypeinteger (int32)Allowed values:
1,2,3.paymentMethodobject | null3 fields in
paymentMethodidstring | nulltypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23.displayNamestring | null
amountobject | null2 fields in
amountamountnumber (double)currencystring | null
cashBackAmountobject | null2 fields in
cashBackAmountamountnumber (double)currencystring | null
roundingAmountobject | null2 fields in
roundingAmountamountnumber (double)currencystring | null
tipAmountobject | null2 fields in
tipAmountamountnumber (double)currencystring | null
tenantUserIdstring (uuid)externalReferencestring | nullexternalIdentifierstring | nullexternalTimeStampstring (date-time) | nullstatusinteger (int32)Allowed values:
0,1,2,3,4,5,-1.errorTypeinteger (int32) | nullAllowed values:
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,-1.terminalobject | null2 fields in
terminalidstring (uuid)namestring | null
clientobject | null2 fields in
clientidstring (uuid)namestring | null
centralControlUnitSerialstring | nullreceiptsarray<object> | null3 fields in
receiptsreceiverTypeinteger (int32)Allowed values:
1,2.needsSignaturebooleanreceiptTextsarray<object> | null3 fields in
receiptTextskeystring | nullvaluestring | nullnamestring | null
invoiceReferenceNotestring | nullisReceiptPrintedboolean
allCheckItemsarray<object> | null43 fields in
allCheckItemsidstring (uuid)checkIdstring (uuid) | nullcreatedstring (date-time)modifiedstring (date-time)productobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
20 fields in
productglassesPerBottlenumber (double) | nullhasVariantsbooleanisSystemProductbooleanlocalizedProductNamesobject | null1 field in
localizedProductNamestranslationsmap<string, string> | null
localizedVariantNamesobject | null1 field in
localizedVariantNamestranslationsmap<string, string> | null
positionobject | null1 field in
positionpositioninteger (int32)
productGroupIdstring (uuid)productGroupNamestring | nullproductIdstring (uuid)productNamestring | nullproductNumberstring | nullproductTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10.storageInfoobject | null2 fields in
storageInfotemperatureinteger (int32)sizeobject | null3 fields in
sizeheightinteger (int32)widthinteger (int32)lengthinteger (int32)
subProductIdstring (uuid) | nullsubProductQuantityobject | null1 field in
subProductQuantityvaluenumber (double)
useBasePricebooleanvariantIdstring (uuid)variantNamestring | nullvariantNumberstring | nullvariantTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7.
quantityobject | null1 field in
quantityvaluenumber (double)
unitQuantityobject | null1 field in
unitQuantityvaluenumber (double)
unitobject | null2 fields in
unitnamestring | nulltypeinteger (int32)Allowed values:
0,1,2,3.
pricePresetIdstring (uuid) | nullproductPriceInclTaxobject | null2 fields in
productPriceInclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productPriceExclTaxobject | null2 fields in
productPriceExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productMaterialCostExclTaxobject | null2 fields in
productMaterialCostExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
kitchenMessagestring | nulldiscountInfoobject | null2 fields in
discountInfodiscountIdstring (uuid) | nulldiscountNamestring | null
discountobject | null2 fields in
discountvaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
courseNamestring | nullcoursePositioninteger (int32)checkPaymentIdstring (uuid) | nullpaidAtstring (date-time) | nulltagstring | nullstatusinteger (int32)Allowed values:
0,1,2,4,8,16,32.upsellGroupIdstring (uuid) | nullticketedAtstring (date-time) | nullticketedTenantUserIdstring (uuid) | nullmodificationsarray<object> | null5 fields in
modificationsidstring (uuid)createdstring (date-time)modifiedstring (date-time)checkItemIdstring (uuid)modificationobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
9 fields in
modificationaddOnGroupobject | null3 fields in
addOnGroupidstring (uuid)namestring | nulllocalizedCustomerFacingNamesobject | null
costobject | null2 fields in
costamountnumber (double)currencyCodestring | null
freeAmountobject | null1 field in
freeAmountvaluenumber (double)
ingredientobject | null3 fields in
ingredientidstring (uuid)nameobject | nulllocalizedNamesobject | null
materialCostobject | null2 fields in
materialCostamountnumber (double)currencyCodestring | null
modificationstring | nullpositionobject | null1 field in
positionpositioninteger (int32)
quantityobject | null1 field in
quantityvaluenumber (double)
replacementobject | null3 fields in
replacementidstring (uuid)nameobject | nulllocalizedNamesobject | null
isTaxMandatorybooleantaxesarray<object> | null4 fields in
taxesidstring (uuid)createdstring (date-time)modifiedstring (date-time)taxobject | null2 fields in
taxtaxIdstring (uuid)taxValueobject | null2 fields in
taxValuetypeinteger (int32)Allowed values:
1,2.ratenumber (double)
checkItemsarray<object> | nullparentItemIdstring (uuid) | nullisMultiproductbooleanhasOwnPricebooleanpriceInclTaxobject | null2 fields in
priceInclTaxamountnumber (double)currencystring | null
priceExclTaxobject | null2 fields in
priceExclTaxamountnumber (double)currencystring | null
totalPriceInclTaxobject | null2 fields in
totalPriceInclTaxamountnumber (double)currencystring | null
totalPriceExclTaxobject | null2 fields in
totalPriceExclTaxamountnumber (double)currencystring | null
totalMaterialCostExclTaxobject | null2 fields in
totalMaterialCostExclTaxamountnumber (double)currencystring | null
discountAmountInclTaxobject | null2 fields in
discountAmountInclTaxamountnumber (double)currencystring | null
discountAmountExclTaxobject | null2 fields in
discountAmountExclTaxamountnumber (double)currencystring | null
totalDiscountAmountInclTaxobject | null2 fields in
totalDiscountAmountInclTaxamountnumber (double)currencystring | null
totalDiscountAmountExclTaxobject | null2 fields in
totalDiscountAmountExclTaxamountnumber (double)currencystring | null
modificationPriceInclTaxobject | null2 fields in
modificationPriceInclTaxamountnumber (double)currencystring | null
modificationPriceExclTaxobject | null2 fields in
modificationPriceExclTaxamountnumber (double)currencystring | null
isPrepaidboolean
itemsExclSystemProductsarray<object> | null43 fields in
itemsExclSystemProductsidstring (uuid)checkIdstring (uuid) | nullcreatedstring (date-time)modifiedstring (date-time)productobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
20 fields in
productglassesPerBottlenumber (double) | nullhasVariantsbooleanisSystemProductbooleanlocalizedProductNamesobject | null1 field in
localizedProductNamestranslationsmap<string, string> | null
localizedVariantNamesobject | null1 field in
localizedVariantNamestranslationsmap<string, string> | null
positionobject | null1 field in
positionpositioninteger (int32)
productGroupIdstring (uuid)productGroupNamestring | nullproductIdstring (uuid)productNamestring | nullproductNumberstring | nullproductTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10.storageInfoobject | null2 fields in
storageInfotemperatureinteger (int32)sizeobject | null3 fields in
sizeheightinteger (int32)widthinteger (int32)lengthinteger (int32)
subProductIdstring (uuid) | nullsubProductQuantityobject | null1 field in
subProductQuantityvaluenumber (double)
useBasePricebooleanvariantIdstring (uuid)variantNamestring | nullvariantNumberstring | nullvariantTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7.
quantityobject | null1 field in
quantityvaluenumber (double)
unitQuantityobject | null1 field in
unitQuantityvaluenumber (double)
unitobject | null2 fields in
unitnamestring | nulltypeinteger (int32)Allowed values:
0,1,2,3.
pricePresetIdstring (uuid) | nullproductPriceInclTaxobject | null2 fields in
productPriceInclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productPriceExclTaxobject | null2 fields in
productPriceExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productMaterialCostExclTaxobject | null2 fields in
productMaterialCostExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
kitchenMessagestring | nulldiscountInfoobject | null2 fields in
discountInfodiscountIdstring (uuid) | nulldiscountNamestring | null
discountobject | null2 fields in
discountvaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
courseNamestring | nullcoursePositioninteger (int32)checkPaymentIdstring (uuid) | nullpaidAtstring (date-time) | nulltagstring | nullstatusinteger (int32)Allowed values:
0,1,2,4,8,16,32.upsellGroupIdstring (uuid) | nullticketedAtstring (date-time) | nullticketedTenantUserIdstring (uuid) | nullmodificationsarray<object> | null5 fields in
modificationsidstring (uuid)createdstring (date-time)modifiedstring (date-time)checkItemIdstring (uuid)modificationobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
9 fields in
modificationaddOnGroupobject | null3 fields in
addOnGroupidstring (uuid)namestring | nulllocalizedCustomerFacingNamesobject | null
costobject | null2 fields in
costamountnumber (double)currencyCodestring | null
freeAmountobject | null1 field in
freeAmountvaluenumber (double)
ingredientobject | null3 fields in
ingredientidstring (uuid)nameobject | nulllocalizedNamesobject | null
materialCostobject | null2 fields in
materialCostamountnumber (double)currencyCodestring | null
modificationstring | nullpositionobject | null1 field in
positionpositioninteger (int32)
quantityobject | null1 field in
quantityvaluenumber (double)
replacementobject | null3 fields in
replacementidstring (uuid)nameobject | nulllocalizedNamesobject | null
isTaxMandatorybooleantaxesarray<object> | null4 fields in
taxesidstring (uuid)createdstring (date-time)modifiedstring (date-time)taxobject | null2 fields in
taxtaxIdstring (uuid)taxValueobject | null2 fields in
taxValuetypeinteger (int32)Allowed values:
1,2.ratenumber (double)
checkItemsarray<object> | nullparentItemIdstring (uuid) | nullisMultiproductbooleanhasOwnPricebooleanpriceInclTaxobject | null2 fields in
priceInclTaxamountnumber (double)currencystring | null
priceExclTaxobject | null2 fields in
priceExclTaxamountnumber (double)currencystring | null
totalPriceInclTaxobject | null2 fields in
totalPriceInclTaxamountnumber (double)currencystring | null
totalPriceExclTaxobject | null2 fields in
totalPriceExclTaxamountnumber (double)currencystring | null
totalMaterialCostExclTaxobject | null2 fields in
totalMaterialCostExclTaxamountnumber (double)currencystring | null
discountAmountInclTaxobject | null2 fields in
discountAmountInclTaxamountnumber (double)currencystring | null
discountAmountExclTaxobject | null2 fields in
discountAmountExclTaxamountnumber (double)currencystring | null
totalDiscountAmountInclTaxobject | null2 fields in
totalDiscountAmountInclTaxamountnumber (double)currencystring | null
totalDiscountAmountExclTaxobject | null2 fields in
totalDiscountAmountExclTaxamountnumber (double)currencystring | null
modificationPriceInclTaxobject | null2 fields in
modificationPriceInclTaxamountnumber (double)currencystring | null
modificationPriceExclTaxobject | null2 fields in
modificationPriceExclTaxamountnumber (double)currencystring | null
isPrepaidboolean
totalAmountobject | null2 fields in
totalAmountamountnumber (double)currencyCodestring | null
totalAmountPlusTipobject | null2 fields in
totalAmountPlusTipamountnumber (double)currencyCodestring | null
taxAmountobject | null2 fields in
taxAmountamountnumber (double)currencyCodestring | null
subtotalInclTaxobject | null2 fields in
subtotalInclTaxamountnumber (double)currencyCodestring | null
subtotalExclTaxobject | null2 fields in
subtotalExclTaxamountnumber (double)currencyCodestring | null
subTotalDiscountInclTaxobject | null2 fields in
subTotalDiscountInclTaxamountnumber (double)currencyCodestring | null
subTotalDiscountExclTaxobject | null2 fields in
subTotalDiscountExclTaxamountnumber (double)currencyCodestring | null
remainingAmountToPayobject | null2 fields in
remainingAmountToPayamountnumber (double)currencyCodestring | null
awaitingConfirmationstring (date-time) | nullcustomerobject | null7 fields in
customeremailobject | null1 field in
emailemailstring | null
fullNamestring | nullcustomerIdstring (uuid) | nullidentityUserIdstring (uuid) | nulladdressobject | null6 fields in
addressstreetstring | nullzipCodestring | nullcitystring | nullstatestring | nullcountrystring | nulllocationobject | null2 fields in
locationlatitudenumber (double)longitudenumber (double)
phonestring | nullsaleSourceIdstring (uuid) | null
guestGroupIdstring (uuid) | null
updatedarray<object> | null41 fields in
updatedidstring (uuid)createdstring (date-time)modifiedstring (date-time)outletobject | null2 fields in
outletidstring (uuid)namestring | null
orderFormatinteger (int32)Allowed values:
0,1,2,4,8,16,32,64,128,159,191.orderTypeinteger (int32)Allowed values:
0,1,2,3,4,5.saleSourceIdstring (uuid)discountValueobject | null2 fields in
discountValuevaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
discountCodeobject | null2 fields in
discountCodediscountIdstring (uuid) | nulldiscountNamestring | null
currencyobject | null1 field in
currencycodestring | null
salesLocationobject | null2 fields in
salesLocationsalesLocationIdstring (uuid) | nulltypeinteger (int32)Allowed values:
0,1,2,3.
companyInfoobject | null7 fields in
companyInfocompanyIdstring (uuid) | nullcompanyNamestring | nullcompanyBusinessNumberstring | nulladdressobject | null4 fields in
addressstreetstring | nullstreet2string | nullzipCodestring | nullcitystring | null
invoiceEmailobject | null1 field in
invoiceEmailemailstring | null
memberIdstring (uuid) | nullmemberNamestring | null
deletedReasonstring | nullcreatedCheckTenantUserIdstring (uuid)createdCheckTenantUserobject | null3 fields in
createdCheckTenantUseridstring (uuid)nameobject | null2 fields in
namefirstNamestring | nulllastNamestring | null
emailobject | null1 field in
emailemailstring | null
closedCheckTenantUserIdstring (uuid) | nullcreatedCheckClientIdstring (uuid)closedCheckClientIdstring (uuid) | nullorderIdstring (uuid) | nullincrementalNumbersobject | null4 fields in
incrementalNumbersticketNumberinteger (int64) | nullUnique number per outlet per Z-Report, it will reset when a Z-Report is made and start on 1 again. Used alot in the UI to give a simple to read number, will also be printed on tickets.
serialNumberinteger (int64) | nullUnbroken sequence per outlet which statisfies the needs of certain pos system laws, is only used on Checks.
referenceNumberinteger (int64) | nullUnbroken sequence per outlet which is used for all types of sales. Suitable for correlation between systems.
refundSerialNumberinteger (int64) | nullUses same series as SerialNumber and is set on orders which is refunded.
collectionTicketIdstring (uuid) | nullcustomTicketNumberinteger (int64) | nullcustomNamestring | nulldeletedstring (date-time) | nullguestCountinteger (int32) | nullmetaDataarray<object> | nullRename for next version to 'Metadata'
6 fields in
metaDataidstring (uuid)createdstring (date-time)modifiedstring (date-time)checkIdstring (uuid)checkItemIdstring (uuid) | nullRename for next version to string 'Reference'
metaDataany | nullRename for next version to 'Metadata'
checkItemsarray<object> | null43 fields in
checkItemsidstring (uuid)checkIdstring (uuid) | nullcreatedstring (date-time)modifiedstring (date-time)productobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
20 fields in
productglassesPerBottlenumber (double) | nullhasVariantsbooleanisSystemProductbooleanlocalizedProductNamesobject | null1 field in
localizedProductNamestranslationsmap<string, string> | null
localizedVariantNamesobject | null1 field in
localizedVariantNamestranslationsmap<string, string> | null
positionobject | null1 field in
positionpositioninteger (int32)
productGroupIdstring (uuid)productGroupNamestring | nullproductIdstring (uuid)productNamestring | nullproductNumberstring | nullproductTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10.storageInfoobject | null2 fields in
storageInfotemperatureinteger (int32)sizeobject | null3 fields in
sizeheightinteger (int32)widthinteger (int32)lengthinteger (int32)
subProductIdstring (uuid) | nullsubProductQuantityobject | null1 field in
subProductQuantityvaluenumber (double)
useBasePricebooleanvariantIdstring (uuid)variantNamestring | nullvariantNumberstring | nullvariantTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7.
quantityobject | null1 field in
quantityvaluenumber (double)
unitQuantityobject | null1 field in
unitQuantityvaluenumber (double)
unitobject | null2 fields in
unitnamestring | nulltypeinteger (int32)Allowed values:
0,1,2,3.
pricePresetIdstring (uuid) | nullproductPriceInclTaxobject | null2 fields in
productPriceInclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productPriceExclTaxobject | null2 fields in
productPriceExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productMaterialCostExclTaxobject | null2 fields in
productMaterialCostExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
kitchenMessagestring | nulldiscountInfoobject | null2 fields in
discountInfodiscountIdstring (uuid) | nulldiscountNamestring | null
discountobject | null2 fields in
discountvaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
courseNamestring | nullcoursePositioninteger (int32)checkPaymentIdstring (uuid) | nullpaidAtstring (date-time) | nulltagstring | nullstatusinteger (int32)Allowed values:
0,1,2,4,8,16,32.upsellGroupIdstring (uuid) | nullticketedAtstring (date-time) | nullticketedTenantUserIdstring (uuid) | nullmodificationsarray<object> | null5 fields in
modificationsidstring (uuid)createdstring (date-time)modifiedstring (date-time)checkItemIdstring (uuid)modificationobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
9 fields in
modificationaddOnGroupobject | null3 fields in
addOnGroupidstring (uuid)namestring | nulllocalizedCustomerFacingNamesobject | null
costobject | null2 fields in
costamountnumber (double)currencyCodestring | null
freeAmountobject | null1 field in
freeAmountvaluenumber (double)
ingredientobject | null3 fields in
ingredientidstring (uuid)nameobject | nulllocalizedNamesobject | null
materialCostobject | null2 fields in
materialCostamountnumber (double)currencyCodestring | null
modificationstring | nullpositionobject | null1 field in
positionpositioninteger (int32)
quantityobject | null1 field in
quantityvaluenumber (double)
replacementobject | null3 fields in
replacementidstring (uuid)nameobject | nulllocalizedNamesobject | null
isTaxMandatorybooleantaxesarray<object> | null4 fields in
taxesidstring (uuid)createdstring (date-time)modifiedstring (date-time)taxobject | null2 fields in
taxtaxIdstring (uuid)taxValueobject | null2 fields in
taxValuetypeinteger (int32)Allowed values:
1,2.ratenumber (double)
checkItemsarray<object> | nullparentItemIdstring (uuid) | nullisMultiproductbooleanhasOwnPricebooleanpriceInclTaxobject | null2 fields in
priceInclTaxamountnumber (double)currencystring | null
priceExclTaxobject | null2 fields in
priceExclTaxamountnumber (double)currencystring | null
totalPriceInclTaxobject | null2 fields in
totalPriceInclTaxamountnumber (double)currencystring | null
totalPriceExclTaxobject | null2 fields in
totalPriceExclTaxamountnumber (double)currencystring | null
totalMaterialCostExclTaxobject | null2 fields in
totalMaterialCostExclTaxamountnumber (double)currencystring | null
discountAmountInclTaxobject | null2 fields in
discountAmountInclTaxamountnumber (double)currencystring | null
discountAmountExclTaxobject | null2 fields in
discountAmountExclTaxamountnumber (double)currencystring | null
totalDiscountAmountInclTaxobject | null2 fields in
totalDiscountAmountInclTaxamountnumber (double)currencystring | null
totalDiscountAmountExclTaxobject | null2 fields in
totalDiscountAmountExclTaxamountnumber (double)currencystring | null
modificationPriceInclTaxobject | null2 fields in
modificationPriceInclTaxamountnumber (double)currencystring | null
modificationPriceExclTaxobject | null2 fields in
modificationPriceExclTaxamountnumber (double)currencystring | null
isPrepaidboolean
paymentsarray<object> | null21 fields in
paymentsidstring (uuid)createdstring (date-time)modifiedstring (date-time)paymentTypeinteger (int32)Allowed values:
1,2,3.paymentMethodobject | null3 fields in
paymentMethodidstring | nulltypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23.displayNamestring | null
amountobject | null2 fields in
amountamountnumber (double)currencystring | null
cashBackAmountobject | null2 fields in
cashBackAmountamountnumber (double)currencystring | null
roundingAmountobject | null2 fields in
roundingAmountamountnumber (double)currencystring | null
tipAmountobject | null2 fields in
tipAmountamountnumber (double)currencystring | null
tenantUserIdstring (uuid)externalReferencestring | nullexternalIdentifierstring | nullexternalTimeStampstring (date-time) | nullstatusinteger (int32)Allowed values:
0,1,2,3,4,5,-1.errorTypeinteger (int32) | nullAllowed values:
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,-1.terminalobject | null2 fields in
terminalidstring (uuid)namestring | null
clientobject | null2 fields in
clientidstring (uuid)namestring | null
centralControlUnitSerialstring | nullreceiptsarray<object> | null3 fields in
receiptsreceiverTypeinteger (int32)Allowed values:
1,2.needsSignaturebooleanreceiptTextsarray<object> | null3 fields in
receiptTextskeystring | nullvaluestring | nullnamestring | null
invoiceReferenceNotestring | nullisReceiptPrintedboolean
allCheckItemsarray<object> | null43 fields in
allCheckItemsidstring (uuid)checkIdstring (uuid) | nullcreatedstring (date-time)modifiedstring (date-time)productobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
20 fields in
productglassesPerBottlenumber (double) | nullhasVariantsbooleanisSystemProductbooleanlocalizedProductNamesobject | null1 field in
localizedProductNamestranslationsmap<string, string> | null
localizedVariantNamesobject | null1 field in
localizedVariantNamestranslationsmap<string, string> | null
positionobject | null1 field in
positionpositioninteger (int32)
productGroupIdstring (uuid)productGroupNamestring | nullproductIdstring (uuid)productNamestring | nullproductNumberstring | nullproductTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10.storageInfoobject | null2 fields in
storageInfotemperatureinteger (int32)sizeobject | null3 fields in
sizeheightinteger (int32)widthinteger (int32)lengthinteger (int32)
subProductIdstring (uuid) | nullsubProductQuantityobject | null1 field in
subProductQuantityvaluenumber (double)
useBasePricebooleanvariantIdstring (uuid)variantNamestring | nullvariantNumberstring | nullvariantTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7.
quantityobject | null1 field in
quantityvaluenumber (double)
unitQuantityobject | null1 field in
unitQuantityvaluenumber (double)
unitobject | null2 fields in
unitnamestring | nulltypeinteger (int32)Allowed values:
0,1,2,3.
pricePresetIdstring (uuid) | nullproductPriceInclTaxobject | null2 fields in
productPriceInclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productPriceExclTaxobject | null2 fields in
productPriceExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productMaterialCostExclTaxobject | null2 fields in
productMaterialCostExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
kitchenMessagestring | nulldiscountInfoobject | null2 fields in
discountInfodiscountIdstring (uuid) | nulldiscountNamestring | null
discountobject | null2 fields in
discountvaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
courseNamestring | nullcoursePositioninteger (int32)checkPaymentIdstring (uuid) | nullpaidAtstring (date-time) | nulltagstring | nullstatusinteger (int32)Allowed values:
0,1,2,4,8,16,32.upsellGroupIdstring (uuid) | nullticketedAtstring (date-time) | nullticketedTenantUserIdstring (uuid) | nullmodificationsarray<object> | null5 fields in
modificationsidstring (uuid)createdstring (date-time)modifiedstring (date-time)checkItemIdstring (uuid)modificationobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
9 fields in
modificationaddOnGroupobject | null3 fields in
addOnGroupidstring (uuid)namestring | nulllocalizedCustomerFacingNamesobject | null
costobject | null2 fields in
costamountnumber (double)currencyCodestring | null
freeAmountobject | null1 field in
freeAmountvaluenumber (double)
ingredientobject | null3 fields in
ingredientidstring (uuid)nameobject | nulllocalizedNamesobject | null
materialCostobject | null2 fields in
materialCostamountnumber (double)currencyCodestring | null
modificationstring | nullpositionobject | null1 field in
positionpositioninteger (int32)
quantityobject | null1 field in
quantityvaluenumber (double)
replacementobject | null3 fields in
replacementidstring (uuid)nameobject | nulllocalizedNamesobject | null
isTaxMandatorybooleantaxesarray<object> | null4 fields in
taxesidstring (uuid)createdstring (date-time)modifiedstring (date-time)taxobject | null2 fields in
taxtaxIdstring (uuid)taxValueobject | null2 fields in
taxValuetypeinteger (int32)Allowed values:
1,2.ratenumber (double)
checkItemsarray<object> | nullparentItemIdstring (uuid) | nullisMultiproductbooleanhasOwnPricebooleanpriceInclTaxobject | null2 fields in
priceInclTaxamountnumber (double)currencystring | null
priceExclTaxobject | null2 fields in
priceExclTaxamountnumber (double)currencystring | null
totalPriceInclTaxobject | null2 fields in
totalPriceInclTaxamountnumber (double)currencystring | null
totalPriceExclTaxobject | null2 fields in
totalPriceExclTaxamountnumber (double)currencystring | null
totalMaterialCostExclTaxobject | null2 fields in
totalMaterialCostExclTaxamountnumber (double)currencystring | null
discountAmountInclTaxobject | null2 fields in
discountAmountInclTaxamountnumber (double)currencystring | null
discountAmountExclTaxobject | null2 fields in
discountAmountExclTaxamountnumber (double)currencystring | null
totalDiscountAmountInclTaxobject | null2 fields in
totalDiscountAmountInclTaxamountnumber (double)currencystring | null
totalDiscountAmountExclTaxobject | null2 fields in
totalDiscountAmountExclTaxamountnumber (double)currencystring | null
modificationPriceInclTaxobject | null2 fields in
modificationPriceInclTaxamountnumber (double)currencystring | null
modificationPriceExclTaxobject | null2 fields in
modificationPriceExclTaxamountnumber (double)currencystring | null
isPrepaidboolean
itemsExclSystemProductsarray<object> | null43 fields in
itemsExclSystemProductsidstring (uuid)checkIdstring (uuid) | nullcreatedstring (date-time)modifiedstring (date-time)productobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the production package (1.0.1200-alpha). The current package marks IsSystemProduct with [JsonIgnore], which would silently drop the field from the legacy payloads, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
20 fields in
productglassesPerBottlenumber (double) | nullhasVariantsbooleanisSystemProductbooleanlocalizedProductNamesobject | null1 field in
localizedProductNamestranslationsmap<string, string> | null
localizedVariantNamesobject | null1 field in
localizedVariantNamestranslationsmap<string, string> | null
positionobject | null1 field in
positionpositioninteger (int32)
productGroupIdstring (uuid)productGroupNamestring | nullproductIdstring (uuid)productNamestring | nullproductNumberstring | nullproductTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7,8,9,10.storageInfoobject | null2 fields in
storageInfotemperatureinteger (int32)sizeobject | null3 fields in
sizeheightinteger (int32)widthinteger (int32)lengthinteger (int32)
subProductIdstring (uuid) | nullsubProductQuantityobject | null1 field in
subProductQuantityvaluenumber (double)
useBasePricebooleanvariantIdstring (uuid)variantNamestring | nullvariantNumberstring | nullvariantTypeinteger (int32)Allowed values:
0,1,2,3,4,5,6,7.
quantityobject | null1 field in
quantityvaluenumber (double)
unitQuantityobject | null1 field in
unitQuantityvaluenumber (double)
unitobject | null2 fields in
unitnamestring | nulltypeinteger (int32)Allowed values:
0,1,2,3.
pricePresetIdstring (uuid) | nullproductPriceInclTaxobject | null2 fields in
productPriceInclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productPriceExclTaxobject | null2 fields in
productPriceExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
productMaterialCostExclTaxobject | null2 fields in
productMaterialCostExclTaxunitPriceobject | null2 fields in
unitPriceamountnumber (double)currencyCodestring | null
additionalPriceobject | null2 fields in
additionalPriceamountnumber (double)currencyCodestring | null
kitchenMessagestring | nulldiscountInfoobject | null2 fields in
discountInfodiscountIdstring (uuid) | nulldiscountNamestring | null
discountobject | null2 fields in
discountvaluenumber (double) | nulltypeinteger (int32) | nullAllowed values:
0,1.
courseNamestring | nullcoursePositioninteger (int32)checkPaymentIdstring (uuid) | nullpaidAtstring (date-time) | nulltagstring | nullstatusinteger (int32)Allowed values:
0,1,2,4,8,16,32.upsellGroupIdstring (uuid) | nullticketedAtstring (date-time) | nullticketedTenantUserIdstring (uuid) | nullmodificationsarray<object> | null5 fields in
modificationsidstring (uuid)createdstring (date-time)modifiedstring (date-time)checkItemIdstring (uuid)modificationobject | nullRestored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the production package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The current package flattened them to decimals, so the raw value object cannot be serialized directly anymore. Frozen - do not change.
9 fields in
modificationaddOnGroupobject | null3 fields in
addOnGroupidstring (uuid)namestring | nulllocalizedCustomerFacingNamesobject | null
costobject | null2 fields in
costamountnumber (double)currencyCodestring | null
freeAmountobject | null1 field in
freeAmountvaluenumber (double)
ingredientobject | null3 fields in
ingredientidstring (uuid)nameobject | nulllocalizedNamesobject | null
materialCostobject | null2 fields in
materialCostamountnumber (double)currencyCodestring | null
modificationstring | nullpositionobject | null1 field in
positionpositioninteger (int32)
quantityobject | null1 field in
quantityvaluenumber (double)
replacementobject | null3 fields in
replacementidstring (uuid)nameobject | nulllocalizedNamesobject | null
isTaxMandatorybooleantaxesarray<object> | null4 fields in
taxesidstring (uuid)createdstring (date-time)modifiedstring (date-time)taxobject | null2 fields in
taxtaxIdstring (uuid)taxValueobject | null2 fields in
taxValuetypeinteger (int32)Allowed values:
1,2.ratenumber (double)
checkItemsarray<object> | nullparentItemIdstring (uuid) | nullisMultiproductbooleanhasOwnPricebooleanpriceInclTaxobject | null2 fields in
priceInclTaxamountnumber (double)currencystring | null
priceExclTaxobject | null2 fields in
priceExclTaxamountnumber (double)currencystring | null
totalPriceInclTaxobject | null2 fields in
totalPriceInclTaxamountnumber (double)currencystring | null
totalPriceExclTaxobject | null2 fields in
totalPriceExclTaxamountnumber (double)currencystring | null
totalMaterialCostExclTaxobject | null2 fields in
totalMaterialCostExclTaxamountnumber (double)currencystring | null
discountAmountInclTaxobject | null2 fields in
discountAmountInclTaxamountnumber (double)currencystring | null
discountAmountExclTaxobject | null2 fields in
discountAmountExclTaxamountnumber (double)currencystring | null
totalDiscountAmountInclTaxobject | null2 fields in
totalDiscountAmountInclTaxamountnumber (double)currencystring | null
totalDiscountAmountExclTaxobject | null2 fields in
totalDiscountAmountExclTaxamountnumber (double)currencystring | null
modificationPriceInclTaxobject | null2 fields in
modificationPriceInclTaxamountnumber (double)currencystring | null
modificationPriceExclTaxobject | null2 fields in
modificationPriceExclTaxamountnumber (double)currencystring | null
isPrepaidboolean
totalAmountobject | null2 fields in
totalAmountamountnumber (double)currencyCodestring | null
totalAmountPlusTipobject | null2 fields in
totalAmountPlusTipamountnumber (double)currencyCodestring | null
taxAmountobject | null2 fields in
taxAmountamountnumber (double)currencyCodestring | null
subtotalInclTaxobject | null2 fields in
subtotalInclTaxamountnumber (double)currencyCodestring | null
subtotalExclTaxobject | null2 fields in
subtotalExclTaxamountnumber (double)currencyCodestring | null
subTotalDiscountInclTaxobject | null2 fields in
subTotalDiscountInclTaxamountnumber (double)currencyCodestring | null
subTotalDiscountExclTaxobject | null2 fields in
subTotalDiscountExclTaxamountnumber (double)currencyCodestring | null
remainingAmountToPayobject | null2 fields in
remainingAmountToPayamountnumber (double)currencyCodestring | null
awaitingConfirmationstring (date-time) | nullcustomerobject | null7 fields in
customeremailobject | null1 field in
emailemailstring | null
fullNamestring | nullcustomerIdstring (uuid) | nullidentityUserIdstring (uuid) | nulladdressobject | null6 fields in
addressstreetstring | nullzipCodestring | nullcitystring | nullstatestring | nullcountrystring | nulllocationobject | null2 fields in
locationlatitudenumber (double)longitudenumber (double)
phonestring | nullsaleSourceIdstring (uuid) | null
guestGroupIdstring (uuid) | null
400Bad Request
messagestring | nullerrorCodestring (uuid)additionalDataany | null
401Unauthorized
messagestring | null
404Not Found
messagestring | nullerrorCodestring (uuid)