Download OpenAPI specification:Download
Sorted file for browsing the dictionary with swagger-ui or similar tools.
details for accountIDElement
| accountID required | string (accountIDType) [ 1 .. 40 ] characters The identification of the account related to the tender type. |
{- "accountID": "string"
}details for accountNameElement
| accountName required | string (accountNameType) <= 40 characters The name of the account related to the tender type. |
{- "accountName": "string"
}details for alarmDurationElement
| alarmDuration required | string (alarmDurationType) <= 20 characters ^P([0-9]+Y)?([0-9]+M)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$ The number of seconds that the drawer alarm sounded in a Drawer Alarm event. Since the designation is in seconds, the duration should be limited to expressing seconds, i.e. PxS, where 'x' is the number of seconds. |
{- "alarmDuration": "string"
}details for approvalCodeElement
| approvalCode required | string (approvalCodeType) [ 1 .. 40 ] characters Common approval code for payment or other POS operations. |
{- "approvalCode": "string"
}details for approvalReferenceCodeElement
| approvalReferenceCode required | string (approvalCodeType) [ 1 .. 40 ] characters Common approval code for payment or other POS operations. |
{- "approvalReferenceCode": "string"
}details for approverIDElement
| approverID required | string (approverIDType) [ 1 .. 40 ] characters An identifier for the cashier or manager that approved the SaleEvent, RefundEvent, VoidEvent or TransactionLine. |
{- "approverID": "string"
}details for automaticDiscountIDElement
| automaticDiscountID required | integer (automaticDiscountIDType) [ 0 .. 10000000000000000 ] AutomaticDiscountID is a pointer to a discount in a discount table to be applied to an item any time it is sold |
{- "automaticDiscountID": 0
}details for bankAccountNumberElement
| bankAccountNumber required | integer (bankAccountNumberType) [ 0 .. 10000000000000000 ] The bank account number of the check being processed. |
{- "bankAccountNumber": 0
}details for bankIDElement
| bankID required | integer (bankIDType) [ 0 .. 10000000000000000 ] The identification of the bank for the check being processed. |
{- "bankID": 0
}details for batchNumberElement
| batchNumber required | integer (batchNumberType) [ 0 .. 10000000000000000 ] A unique identifier for the batch that has been created. |
{- "batchNumber": 0
}details for batchSequenceNumberElement
| batchSequenceNumber | string (batchSequenceNumberType) [ 1 .. 4 ] characters ^[0-9]{1,4}$ Short batch sequence number. |
{- "batchSequenceNumber": "stri"
}details for biometricIdentifierElement
| biometricIdentifier required | string (biometricIdentifierType) <= 40 characters Free-form text from a reading device. |
{- "biometricIdentifier": "string"
}details for breakDurationElement
| breakDuration required | string (breakDurationType) <= 20 characters ^P([0-9]+Y)?([0-9]+M)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$ The duration of a break, expressed in minutes and seconds. PxMyS is the normal expression, where x = minutes and y = seconds |
{- "breakDuration": "string"
}details for businessDateElement
| businessDate required | string <date> (dateType) <= 10 characters ISO 8601 Date Type to align with XML Schema. |
{- "businessDate": "2020-06-23"
}details for cardCategoryElement
| cardCategory required | string (cardCategoryType) [ 1 .. 2 ] characters Short card category |
{- "cardCategory": "st"
}details for cardCircuitElement
| cardCircuit required | string (cardCircuitType) [ 1 .. 20 ] characters The CardCircuit dentifies the card type. This element is intended to align with the requirements of the EPS 2.7 (and later) standard |
{- "cardCircuit": "string"
}details for cardDescriptionElement
| cardDescription required | string (cardDescriptionType) <= 40 characters Description of card |
{- "cardDescription": "string"
}details for cardTypeIDElement
| cardTypeID required | string (cardTypeIDType) [ 1 .. 16 ] characters Card identifier |
{- "cardTypeID": "string"
}details for cashierIDElement
| cashierID required | string (cashierIDType) [ 1 .. 40 ] characters Identifies the cashier conducting the transaction(s) in the reporting period |
{- "cashierID": "string"
}details for checkNumberElement
| checkNumber required | integer (checkNumberType) [ 0 .. 10000000000000000 ] The sequential number assigned to the check, which is generally pre-printed in the upper right hand corner of the check |
{- "checkNumber": 0
}details for cityElement
| city required | string (cityType) <= 40 characters The city portion of the address |
{- "city": "string"
}details for comboDescriptionElement
| comboDescription required | string (comboDescriptionType) <= 40 characters A free form description of the combination offered for sale - "combo", i.e., "Manager's Special", "Sandwich Combo", etc. |
{- "comboDescription": "string"
}details for commissionRateElement
| commissionRate required | string (commissionRateType) <= 18 characters ^\-?[0-9]{0,12}(\.[0-9]{1,5})?$ Rate paid for commission, expressed as a decimal number (left of decimal). |
{- "commissionRate": "string"
}details for conceptIDElement
| conceptID required | string (conceptIDType) [ 1 .. 40 ] characters This identifies a particular branding within a RevenueCenterID. For example, Subway within a QSR RevenueCenterID. |
{- "conceptID": "string"
}details for condimentIDElement
| condimentID required | object (condimentIDObject) |
{- "condimentID": {
- "value": "string",
- "componentAction": "string"
}
}details for condimentNameElement
| condimentName required | string (condimentNameType) <= 40 characters The name of the item that is being sold as optional extra alongside some other item. |
{- "condimentName": "string"
}details for countElement
| count required | integer (countType) [ 0 .. 9999999999 ] A 'number of times' or 'number of objects'. |
{- "count": 0
}details for countrySettingsElement
| countrySettings | object (countrySettingsObject) |
{- "countrySettings": {
- "volumeUnit": "str",
- "levelUnit": "str",
- "temperatureUnit": "str",
- "countryCode": "AF",
- "language": "abk",
- "localCurrencies": [
- "AED"
], - "foreignCurrencies": [
- "AED"
]
}
}details for couponRedeemedElement
| couponRedeemed | object (couponRedeemedObject) |
{- "couponRedeemed": {
- "redeemedCouponID": "string",
- "primaryCompanyPrefix": "string",
- "offerCode": 0,
- "couponExpirationDate": "2020-06-23"
}
}details for currencyExchangeRateElement
| currencyExchangeRate required | number (currencyExchangeRateType) [ 0 .. 999999999999 ] For currency exchange, 6,6 decimal. |
{- "currencyExchangeRate": 0
}details for customerPONumberElement
| customerPONumber required | string (customerPONumberType) [ 1 .. 16 ] characters PO number |
{- "customerPONumber": "string"
}details for descriptionIDElement
| descriptionID required | string (descriptionIDType) [ 1 .. 8 ] characters A reference string for description lookup. |
{- "descriptionID": "string"
}details for deviceIDElement
| deviceID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
{- "deviceID": "string"
}details for discountElement
| discount required | object (discountObject) |
{- "discount": {
- "discountVolume": {
- "value": "string",
- "uom": "MLT"
}, - "discountQuantity": {
- "value": "string",
- "uom": "GRM"
}, - "discountAmount": {
- "value": "string",
- "currency": "AED"
}, - "discountReason": "storeCouponOffer",
- "discountID": "string",
- "itemTaxes": [
- {
- "taxLevelID": "stri",
- "taxableSalesAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxCollectedAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxableSalesRefundedAmount": null,
- "taxRefundedAmount": null,
- "taxExemptSalesAmount": null,
- "taxExemptAmount": null,
- "taxExemptSalesRefundedAmount": null,
- "taxExemptReason": null,
- "taxForgivenSalesAmount": null,
- "taxForgivenSalesRefundedAmount": null,
- "taxForgivenAmount": null,
- "taxForgivenReason": null
}
], - "transactionTaxes": [
- {
- "taxLevelID": "stri",
- "taxableSalesAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxCollectedAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxableSalesRefundedAmount": null,
- "taxRefundedAmount": null,
- "taxExemptSalesAmount": null,
- "taxExemptAmount": null,
- "taxExemptSalesRefundedAmount": null,
- "taxExemptReason": null,
- "taxForgivenSalesAmount": null,
- "taxForgivenSalesRefundedAmount": null,
- "taxForgivenAmount": null,
- "taxForgivenReason": null
}
]
}
}details for discountIDElement
| discountID required | string (discountIDType) [ 1 .. 40 ] characters A reference string for identifying a discount. |
{- "discountID": "string"
}details for discountReasonElement
| discountReason required | string or string (discountReasonEENUMType) A reason code indicating why the item/merchandise was discounted defined by Conexxus (base type). |
{- "discountReason": "storeCouponOffer"
}details for dispenserIDElement
| dispenserID | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
{- "dispenserID": "string"
}details for dispensersConfigurationElement
| dispensersConfiguration | Array of objects (dispenserConfigurationObject) <= 20 items dispensers configuration is the array which includes the dispenser configuration definition |
{- "dispensersConfiguration": [
- {
- "dispenserID": "string",
- "fuelProducts": [
- {
- "productNo": 0,
- "productCategory": 0,
- "productID": {
- "productName": "string",
- "description": "string"
}, - "productCode": 0,
- "merchandiseCode": "string",
- "prices": [
- {
- "fuelUnitPrice": {
- "value": "string",
- "currency": "AED"
}, - "priceTier": "cash",
- "modeNo": 0
}
], - "taxID": "string"
}
], - "limits": [
- {
- "productNo": 0,
- "modeNo": 0,
- "maxTrxAmount": {
- "value": "string",
- "currency": "AED"
}, - "maxTrxVolume": {
- "value": "string",
- "uom": "GRM"
}
}
], - "pumpTimeout": 1,
- "fuelingPoints": [
- {
- "fuelingPointID": "string",
- "pumpNo": 0,
- "defaultFuelingMode": 0,
- "maxTrxAmount": {
- "value": "string",
- "currency": "AED"
}, - "maxTrxVolume": {
- "value": "string",
- "uom": "GRM"
}, - "serviceLevel": "F",
- "nozzles": [
- {
- "nozzleNo": 0,
- "nozzleName": "string",
- "productNo": 0,
- "tankNo1": 0,
- "tankNo2": 0,
- "blendRatio": 0
}
]
}
]
}
]
}details for driverIDElement
| driverID required | string (driverIDType) [ 1 .. 40 ] characters The type of identification used to verify the identification of the driver. |
{- "driverID": "string"
}details for dropNumberElement
| dropNumber required | string (dropNumberType) [ 1 .. 8 ] characters A unique identifer for the safe drop that was performed. |
{- "dropNumber": "string"
}details for electronicSignatureElement
| electronicSignature required | string (electronicSignatureType) <= 40 characters Used to give the electronic signature value where signature capture device is present for additional verification. |
{- "electronicSignature": "string"
}details for emailAddressElement
| emailAddress required | string (emailAddressType) <= 320 characters email address (valid according RFC 3696). |
{- "emailAddress": "string"
}details for employeeIDElement
| employeeID required | string (employeeIDType) [ 1 .. 16 ] characters Identifier for an employee. Use caution not to disclose PII. |
{- "employeeID": "string"
}details for employeeNumberElement
| employeeNumber required | string (employeeNumberType) [ 1 .. 16 ] characters A unique identifer for the employee that is referred to in a TimeClock event. |
{- "employeeNumber": "string"
}details for employeeRoleElement
| employeeRole required | string (employeeRoleType) <= 40 characters Role of the employee for a given task. |
{- "employeeRole": "string"
}details for envelopeIDElement
| envelopeID required | string (envelopeIDType) [ 1 .. 40 ] characters The unique identifier that was on the envelope, that the money was placed in during the safe drop event. |
{- "envelopeID": "string"
}details for epsNameElement
| epsName required | string (epsNameType) <= 40 characters Unique name of the EPS with in a given site. A site can have one or more EPS. |
{- "epsName": "string"
}details for eventIDElement
| eventID required | string (eventIDType) [ 1 .. 40 ] characters The identification of a specific event responsible for the reward. |
{- "eventID": "string"
}details for eventSequenceIDElement
| eventSequenceID required | integer (eventSequenceIDType) [ 0 .. 10000000000000000 ] A unique identifer for the FinancialEvent. |
{- "eventSequenceID": 0
}details for feeIDElement
| feeID required | string (feeIDType) [ 1 .. 16 ] characters An ID for a fee applied to a transaction. |
{- "feeID": "string"
}details for fieldNameElement
| fieldName required | string (fieldNameType) <= 16 characters For audit events, what table/field changed? |
{- "fieldName": "string"
}details for fuelGradeIDElement
| fuelGradeID required | object (fuelGradeIDObject) |
{- "fuelGradeID": {
- "value": "string",
- "paymentSystemsProductCode": "strin"
}
}details for fuelGradeSequenceIDElement
| fuelGradeID | integer (fuelGradeSequenceIDType) [ 0 .. 9999 ] The sequence number to which the FuelGradeID is assigned. Normally hose ID. |
{- "fuelGradeID": 0
}details for fuelModesElement
| fuelModes | Array of objects (fuelModesObject) <= 100 items fuelModes is the array which includes the modes definition |
{- "fuelModes": [
- {
- "modeNo": 0,
- "modeName": "string"
}
]
}details for fuelPositionIDElement
| fuelPositionID required | integer (fuelPositionIDType) [ 0 .. 9999 ] ID for Fuel Position. |
{- "fuelPositionID": 0
}details for fuelPositionStatusElement
| fuelPositionStatus required | string (fuelPositionStatusType) <= 16 characters The status of a fuel position that causes a PumpStatus event to occur. |
{- "fuelPositionStatus": "string"
}details for fuelPriceChangeIDElement
| fuelPriceChangeID required | string (fuelPriceChangeIDType) [ 1 .. 40 ] characters The system dependent identifier for a fuel price change event. |
{- "fuelPriceChangeID": "string"
}details for fuelProductBlendPercentElement
| fuelProductBlendPercent required | string (fuelProductBlendPercentType) <= 18 characters ^\-?[0-9]{0,12}(\.[0-9]{1,5})?$ This is the percentage of FuelProductID used in a blending of two fuel products to create a fuel grade. The blend percentage of FuelProductIDHigh is 100 less FuelProductBlendPercent. If not a blended fuel grade then put 100 as the FuelProductBlendPercent. |
{- "fuelProductBlendPercent": "string"
}details for fuelProductElement
| fuelProducts | Array of objects (fuelProductObject) <= 1000 items fuel product is the array which includes the fuel product definition |
{- "fuelProducts": [
- {
- "productNo": 0,
- "productCategory": 0,
- "productID": {
- "productName": "string",
- "description": "string"
}, - "productCode": 0,
- "merchandiseCode": "string",
- "prices": [
- {
- "fuelUnitPrice": {
- "value": "string",
- "currency": "AED"
}, - "priceTier": "cash",
- "modeNo": 0
}
], - "taxID": "string"
}
]
}details for fuelProductStatusElement
| fuelProductStatus required | string (fuelProductStatusType) <= 16 characters The status of the fuel product at the time of the tank reading. |
{- "fuelProductStatus": "string"
}details for fuelingPointIDElement
| fuelingPointID | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
{- "fuelingPointID": "string"
}details for ipv4AddressElement
| ipv4Address | string <= 100 characters ((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?) Internet Protocol version 4 (IPv4) is the fourth version of the Internet Protocol (IP) |
{- "ipv4Address": "string"
}details for ipv6AddressElement
| ipv6Address | string <= 100 characters '((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)
(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)
(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})
?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4})
{1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:)
{2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))
{3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)
(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)
(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*'
Internet Protocol version 6 (IPv6) is a new version of the Internet Protocol (IP) |
{- "ipv6Address": "string"
}details for itemCodeElement
| itemCode required | object (itemCodeObject) |
{- "itemCode": {
- "posCodeFormat": {
- "format": "upcA",
- "checkDigit": "present"
}, - "posCode": "string",
- "posCodeModifier": {
- "value": "stri",
- "name": "string"
}, - "inventoryItemID": "string"
}
}details for itemIDElement
| itemID required | string (itemIDType) [ 1 .. 40 ] characters Generic ID for items and links to them. |
{- "itemID": "string"
}details for itemListIDElement
| itemListID required | string (itemListIDType) [ 1 .. 40 ] characters A pointer to the Item List look-up table. A "null" or "no value" for ItemListIDType may be allowed. |
{- "itemListID": "string"
}details for jobCodeElement
| jobCode required | string (jobCodeType) [ 1 .. 40 ] characters A code denoting the job that the employee was linked to during a TimeClock event. |
{- "jobCode": "string"
}details for jobIDElement
| jobID required | string (jobIDType) [ 1 .. 40 ] characters The identification of the job associated with the fleet card purchase. |
{- "jobID": "string"
}details for keyboardElement
| keyboard required | string (keyboardType) <= 40 characters Type of keyboard involved in the transaction. |
{- "keyboard": "string"
}details for levelElement
| level | integer (levelType) [ 0 .. 99999999 ] level value as used for level readings by tank level gauges. Level is an unsigned integer from "0" to "99999999" |
{- "level": 0
}details for licenseNumberElement
| licenseNumber required | string (licenseNumberType) <= 16 characters The license number of the vehicle that drove off. |
{- "licenseNumber": "string"
}details for licensePlateIDElement
| licensePlateID required | string (licensePlateIDType) <= 16 characters The license plate number of the vehicle recorded in a DriveOff event. |
{- "licensePlateID": "string"
}details for limitElement
| limit | Array of objects (limitObject) <= 8 items limit is the array which includes the limit definition |
{- "limit": [
- {
- "productNo": 0,
- "modeNo": 0,
- "maxTrxAmount": {
- "value": "string",
- "currency": "AED"
}, - "maxTrxVolume": {
- "value": "string",
- "uom": "GRM"
}
}
]
}details for lineSequenceNumberElement
| lineSequenceNumber required | integer (lineSequenceNumberType) [ 0 .. 10000000000000000 ] A unique sequence number for the subItemLine within the ItemLine it is attached to. |
{- "lineSequenceNumber": 0
}details for linkedItemListIDElement
| linkedItemListID required | string (linkedItemListIDType) [ 1 .. 40 ] characters A pointer to the Item List look-up table. A 'null' or 'no value' for ItemListIDType may be allowed. |
{- "linkedItemListID": "string"
}details for loyaltyProgramNameElement
| loyaltyProgramName required | string (loyaltyProgramNameType) <= 40 characters The name of the loyalty program to which the reduction is attributed. |
{- "loyaltyProgramName": "string"
}details for loyaltyTransactionIDElement
| loyaltyTransactionID required | string (loyaltyTransactionIDType) [ 1 .. 40 ] characters The ID of the loyalty program to which the reduction is attributed. |
{- "loyaltyTransactionID": "string"
}details for macAddressElement
| macAddress | string <= 100 characters [0-9a-fA-F]{2}-[0-9a-fA-F]{2}-[0-9a-fA-F]{2}-[0-9a-fA-F]{2}-[0-9a-fA-F]{2}-[0-9a-fA-F]{2} A media access control address (MAC address) of a device is a unique identifier assigned to a network interface controller (NIC) |
{- "macAddress": "string"
}details for managerIDElement
| managerID required | string (managerIDType) [ 1 .. 8 ] characters Identifier for a manager, unique to a given site. |
{- "managerID": "string"
}details for manualActionIDElement
| manualActionID required | string (manualActionIDType) [ 1 .. 40 ] characters The identification of the action used to trigger the promotion. |
{- "manualActionID": "string"
}details for manufacturerCouponElement
| manufacturerCoupon required | object (manufacturerCouponObject) |
{- "manufacturerCoupon": {
- "primaryLabelID": "string",
- "extendedLabelID": "string",
- "manufacturerID": "string",
- "familyCode": "str",
- "couponExpirationDate": "2020-06-23",
- "promotionCode": "string"
}
}details for memoDetailElement
| memoDetail required | string (memoDetailType) <= 40 characters A descriptive piece of text that is placed into the journal as a Memo event. |
{- "memoDetail": "string"
}details for merchandiseCodeDescriptionElement
| merchandiseCodeDescription required | string (merchandiseCodeDescriptionType) <= 40 characters Native language description of the merchandise code normally printed on the register tape. |
{- "merchandiseCodeDescription": "string"
}details for merchandiseCodeElement
| merchandiseCode required | object (merchandiseCodeObject) |
{- "merchandiseCode": {
- "level": "stri",
- "value": "string"
}
}details for mimeTypeElement
| mimeType required | string (mimeTypeType) [ 1 .. 40 ] characters MIME type for binary data. |
{- "mimeType": "string"
}details for miscellaneousSummaryCodeElement
| miscellaneousSummaryCode required | string or string (miscellaneousSummaryCodeEENUMType) MiscellaneousSummaryCodes defined by Conexxus (base type). |
{- "miscellaneousSummaryCode": "safeDrop"
}details for miscellaneousSummarySubCodeElement
| miscellaneousSummarySubCode required | string or string (miscellaneousSummarySubCodeEENUMType) MiscellaneousSummarySubCodes defined by Conexxus (base type). |
{- "miscellaneousSummarySubCode": "total"
}details for mixMatchCodeElement
| mixMatchCode required | string (mixMatchCodeType) [ 1 .. 8 ] characters A code identifying the MixMatch. |
{- "mixMatchCode": "string"
}details for modeNoElement
| modeNo | integer (modeNoType) [ 0 .. 99 ] mode No is an unsigned integer used to identify the different modes to dispatch fuel products, like self service of full |
{- "modeNo": 0
}details for moneyOrderNumberElement
| moneyOrderNumber required | string (moneyOrderNumberType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ The sequential number issued by the money order company to the individual money order being sold. |
{- "moneyOrderNumber": "string"
}details for moneyOrderTypeIndicatorElement
| moneyOrderTypeIndicator required | string (moneyOrderTypeIndicatorType) [ 1 .. 4 ] characters ^[0-9]{1,4}$ An indicator as to the type of money order, I.e., vendor payment, payroll, customer, etc. |
{- "moneyOrderTypeIndicator": "stri"
}details for networkIDElement
| networkID required | string (networkIDType) [ 1 .. 16 ] characters An identifier for the batch on the network. |
{- "networkID": "string"
}details for networkProductCodeElement
| networkProductCode required | string (networkProductCodeType) [ 1 .. 4 ] characters A code reported to the credit card processing host, to indicate types of products being sold in the transaction. Provided for use of non-Conexxus codes if needed. |
{- "networkProductCode": "stri"
}details for newSecurityIDElement
| newSecurityID required | string (newSecurityIDType) [ 1 .. 16 ] characters A code denoting the new security that was in place after the security bypass event was performed. |
{- "newSecurityID": "string"
}details for newValueElement
| newValue required | string (newValueType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ For use in NAXML-POSJournal (mainly) in MaintenanceAuditEvent to declare a new (audited) value |
{- "newValue": "string"
}details for nozzleNoElement
| nozzleNo | integer (nozzleNoType) [ 0 .. 99 ] nozzle No is the unique identifier of a nozzle |
{- "nozzleNo": 0
}details for odometerReadingElement
| odometerReading required | integer (odometerReadingType) [ 0 .. 10000000000000000 ] The odometer reading of the vehicle being filled. |
{- "odometerReading": 0
}details for oldSecurityLevelElement
| oldSecurityLevel required | string (oldSecurityLevelType) [ 1 .. 16 ] characters A code denoting the security level that was in place before the security bypass event was performed. |
{- "oldSecurityLevel": "string"
}details for oldValueElement
| oldValue required | string (oldValueType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ For use in NAXML-POSJournal (mainly) in MaintenanceAuditEvent to declare an old (unaudited) value. |
{- "oldValue": "string"
}details for overridingCashierIDElement
| overridingCashierID required | string (overridingCashierIDType) [ 1 .. 40 ] characters A unique identifier for the cashier or manager that performed the security override event. |
{- "overridingCashierID": "string"
}details for partDescriptionElement
| partDescription required | string (partDescriptionType) <= 40 characters A long and complex description for a vehicle part number that is being sold. |
{- "partDescription": "string"
}details for passwordElement
| password required | string (passwordType) <= 40 characters Security password |
{- "password": "string"
}details for paymentSystemsProductCodeElement
| paymentSystemsProductCode required | string (paymentSystemsProductCodeType) [ 2 .. 5 ] characters ^[0-9]{2,5}$ Conexxus Payment System Product Codes and/or the underlying standard (X9.104) for which Conexxus is the Registration Authority, published by ACS X9, Inc. |
{- "paymentSystemsProductCode": "strin"
}details for percentageElement
| percentage required | number (percentageType) <= 999999 3,3 decimal valid percentage, may range over 100 (i.e. 300% increase, etc.) |
{- "percentage": 0
}details for phoneNumberStringElement
| phoneNumberString required | string (phoneNumberStringType) <= 14 characters ^[0-9\-\(\)\B]{,14}$ String roughly constrained to handle phone numbers and common delimiting characters. |
{- "phoneNumberString": "string"
}details for posCodeElement
| posCode required | string (posCodeType) <= 24 characters ^[0-9]{1,24}$ |
{- "posCode": "string"
}details for posCodeFormatElement
| posCodeFormat required | object (posCodeFormatObject) |
{- "posCodeFormat": {
- "format": "upcA",
- "checkDigit": "present"
}
}details for posCodeModiferElement
| posCodeModifier required | object (posCodeModifierObject) |
{- "posCodeModifier": {
- "value": "stri",
- "name": "string"
}
}details for postalCodeElement
| postalCode required | string (postalCodeType) <= 16 characters The postal code in the address (zip code in the US). |
{- "postalCode": "string"
}details for preAuthorizationElement
| preAuthorization required | integer (preAuthorizationType) [ 0 .. 9999 ] Indicates pre-authorization was obtained |
{- "preAuthorization": 0
}details for preparationModElement
| preparationMod required | string (preparationModType) <= 40 characters Description of a preparation modification that must occur when the item is sold as a component within another item |
{- "preparationMod": "string"
}details for priceOverrideApproverIDElement
| priceOverrideApproverID required | string (priceOverrideApproverIDType) [ 1 .. 40 ] characters Identifies the individual athorizing the price overrider. |
{- "priceOverrideApproverID": "string"
}details for priceOverrideElement
| priceOverride required | object (priceOverrideObject) |
{- "priceOverride": {
- "priceOverridePrice": {
- "value": "string",
- "currency": "AED"
}, - "priceOverrideApproverID": "string",
- "priceOverrideReason": "emp"
}
}details for pricePoleConfigurationElement
| pricePoleConfiguration | object (pricePoleConfigurationObject) |
{- "pricePoleConfiguration": {
- "pricePoleID": "string",
- "pricePolePoint": {
- "pricePolePointID": "string",
- "signNo": 0,
- "manualMode": true,
- "segments": [
- {
- "segmentNo": 0,
- "productNo": 0,
- "productName": "string",
- "productPrice": {
- "value": "string",
- "currency": "AED"
}, - "modeNo": 0
}
]
}
}
}details for pricePoleIDElement
| pricePoleID | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
{- "pricePoleID": "string"
}details for pricePolePointIDElement
| pricePolePointID | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
{- "pricePolePointID": "string"
}details for priceTierCodeElement
| priceTierCode required | string (priceTierCodeType) [ 1 .. 4 ] characters ^[0-9]{1,4}$ A pointer to the Price Tier Table. The values indicate the type of pricing level by which the customer purchased or may purchase the fuel grade. This is typically used for cash/credit pricing. |
{- "priceTierCode": "stri"
}details for productCategoryElement
| productCategory | integer (productCategoryType) [ 0 .. 99999999 ] the product category value determine how the POS treats the data coming from the dispenser |
{- "productCategory": 0
}details for productCodeElement
| productCode | integer (productCodeType) [ 0 .. 99999999 ] product code provides a classification of the fuel product |
{- "productCode": 0
}details for productNameElement
| productName | string (productNameType) <= 16 characters fuel product name is the unique identification of fuel sold at Service stations and C-Stores |
{- "productName": "string"
}details for productNoElement
| productNo | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
{- "productNo": 0
}details for promotionElement
| promotion required | object (promotionObject) |
{- "promotion": {
- "promotionID": "string",
- "promotionReason": "combinationOffer",
- "promotionAmount": {
- "value": "string",
- "currency": "AED"
}
}
}details for pumpNoElement
| pumpNo | integer (pumpNoType) [ 0 .. 9999 ] pump No is the unique identifier of a pump. |
{- "pumpNo": 0
}details for pumpTestReasonElement
| pumpTestReason required | string (pumpTestReasonType) [ 1 .. 16 ] characters A reason code for the pump test defined by Conexxus (base type). |
{- "pumpTestReason": "string"
}details for pumpTesterIDElement
| pumpTesterID required | string (pumpTesterIDType) [ 1 .. 40 ] characters A unique identifer for the person (or organization) that conducted the pump test. |
{- "pumpTesterID": "string"
}details for quantityUNElement
| quantity required | object (quantityUNObject) |
{- "quantity": {
- "value": "string",
- "uom": "GRM"
}
}details for redeemedCouponIDElement
| redeemedCouponID required | string (redeemedCouponIDType) [ 1 .. 80 ] characters The identification of the redeemed coupon. |
{- "redeemedCouponID": "string"
}details for redeemedPointsTypeIDElement
| redeemedPointsTypeID required | string (redeemedPointsTypeIDType) [ 1 .. 40 ] characters The identification of the type of points redeemed. |
{- "redeemedPointsTypeID": "string"
}details for refundReasonElement
| refundReason required | string or string (refundReasonEENUMType) A reason code indicating why the item/merchandise was refunded defined by Conexxus (base type). |
{- "refundReason": "damaged"
}details for registerIDElement
| registerID required | string (registerIDType) [ 1 .. 4 ] characters ^[0-9]{1,4}$ The identification of the register that finalized the sales being reported. This is typically the register number. |
{- "registerID": "stri"
}details for reportPeriodElement
| reportPeriod required | object (reportPeriodObject) |
{- "reportPeriod": {
- "value": "2020-06-23",
- "interval": "cashier"
}
}details for reportSequenceNumberElement
| reportSequenceNumber required | integer (reportSequenceNumberType) [ 0 .. 99999999 ] A unique sequential report control number |
{- "reportSequenceNumber": 0
}details for revenueCenterIDElement
| revenueCenterID required | string (revenueCenterIDType) [ 1 .. 40 ] characters The identification of the revenue or profit center within the store. |
{- "revenueCenterID": "string"
}details for safeLoanReasonElement
| safeLoanReason required | string (safeLoanReasonType) [ 1 .. 16 ] characters Safe loan reasons defined by Conexxus (base type). |
{- "safeLoanReason": "string"
}details for salesRestrictCodeElement
| salesRestrictCode required | string or string (salesRestrictCodeEENUMType) A pointer to a value in the SalesRestrict table. The values indicate the restrictions that apply to the item/merchandise code. defined by Conexxus (base type). |
{- "salesRestrictCode": "allowWIC"
}details for securityLevelElement
| securityLevel required | integer (securityLevelType) [ 0 .. 9999 ] Four digit security level designation. |
{- "securityLevel": 0
}details for segmentNoElement
| segmentNo | integer (segmentNoType) [ 0 .. 9999 ] segment No is the unique identification of a segment within a price pole |
{- "segmentNo": 0
}details for serialNumberElement
| serialNumber required | string (serialNumberType) <= 40 characters The serial number |
{- "serialNumber": "string"
}details for severityIndicatorElement
| severityIndicator required | string (severityIndicatorType) [ 1 .. 16 ] characters The severity of an alert event that has been raised. |
{- "severityIndicator": "string"
}details for shiftIDElement
| shiftID required | string (shiftIDType) [ 1 .. 4 ] characters For use in task scheduling, along with TaskID, description, begin time, etc. |
{- "shiftID": "stri"
}details for siteIDElement
| siteID required | string (siteIDType) [ 1 .. 40 ] characters An alphanumeric value by which the site is identified, assumed to be unique across an organization. |
{- "siteID": "string"
}details for siteTraitElement
| siteTrait required | object (siteTraitObject) |
{- "siteTrait": {
- "value": "string",
- "siteTraitName": "string"
}
}details for softwareComponentElement
| softwareComponent | object (softwareComponentObject) |
{- "softwareComponent": {
- "itemID": "string",
- "name": "string",
- "manufacturerID": "string",
- "manufacturerName": "string",
- "applicationName": "string",
- "applicationSoftwareVersion": "string",
- "applicationType": "chp",
- "protocol": "string",
- "protocolVersion": "string",
- "checksum": "string",
- "build": "string",
- "buildDate": "2020-06-23T16:37:35Z"
}
}details for stanElement
| stan required | string (stanType) <= 40 characters System Trace Audit Number (STAN) is a unique identifier generated by the FEP when a transaction is processed. It is unique to the FEP. |
{- "stan": "string"
}details for stateOrProvinceElement
| stateOrProvince required | provinceCAENUMType (string) or stateUSENUMType (string) (stateOrProvinceENUMType) Combination of US States and Canadian Provinces for convenience. |
{- "stateOrProvince": "AB"
}details for storeConceptIDElement
| storeConceptID required | string (storeConceptIDType) [ 1 .. 40 ] characters The identification of the concept within the RevenueCenterID, I.e. Subway within a QSR RevenueCenterID. |
{- "storeConceptID": "string"
}details for storeHierarchyIDElement
| storeHierarchyID required | string (storeHierarchyIDType) [ 1 .. 40 ] characters The lowest level of the store structure where the item was sold from |
{- "storeHierarchyID": "string"
}details for storeLocationIDElement
| storeLocationID required | string (storeLocationIDType) [ 1 .. 40 ] characters The store/location/site identifier assigned by the company to this physical location. It is typically the store number. |
{- "storeLocationID": "string"
}details for tableNameElement
| tableName required | string (tableNameType) <= 40 characters For audit events, what table/field changed? |
{- "tableName": "string"
}details for tankChartIDElement
| tankChartID required | string (tankChartIDType) [ 1 .. 4 ] characters ^[0-9]{1,4}$ A pointer to a tank capacity chart not defined in this document. |
{- "tankChartID": "stri"
}details for tankGroupNoElement
| tankGroupNo | integer (tankGroupNoType) [ 0 .. 9999 ] tank group number is the unique identifier of the tank group on a retail store |
{- "tankGroupNo": 0
}details for tankIDElement
| tankID required | string (tankIDType) [ 1 .. 40 ] characters The assigned identification for a fuel product tank. |
{- "tankID": "string"
}details for tankLevelGaugeConfigurationElement
| tankLevelGaugesConfiguration | Array of objects (tankLevelGaugeConfigurationObject) <= 100 items tankLevelGaugeConfiguration is the array which includes the tankLevelGaugeConfiguration definition |
{- "tankLevelGaugesConfiguration": [
- {
- "tankLevelGaugeID": "string",
- "tankProbes": [
- {
- "tankProbeID": "string",
- "tankNo": 0,
- "tankName": "string",
- "productNo": 0,
- "productName": "string",
- "manualMode": true,
- "shellCapacity": "string",
- "maxSafeFillCap": "string",
- "lowCapacity": "string",
- "minOperatingCapacity": "string",
- "tankManifoldPartners": [
- {
- "tankNo": 0
}
], - "setPoints": {
- "hiHiLevel": 0,
- "hiLevel": 0,
- "loLevel": 0,
- "loLoLevel": 0,
- "hiWater": 0
}
}
]
}
]
}details for tankLevelGaugeIDElement
| tankLevelGaugeID | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
{- "tankLevelGaugeID": "string"
}details for tankManifoldIDElement
| tankManifoldID required | string (tankManifoldIDType) [ 1 .. 40 ] characters The identification of the fuel product tank manifold. Usage is implementation specific. |
{- "tankManifoldID": "string"
}details for tankManufacturerElement
| tankManufacturer required | string (tankManufacturerType) <= 40 characters The name of the manufacturer of the fuel product tank. |
{- "tankManufacturer": "string"
}details for tankModelNumberElement
| tankModelNumber required | string (tankModelNumberType) <= 40 characters The model number of the fuel product tank. |
{- "tankModelNumber": "string"
}details for tankNoElement
| tankNo | integer (tankNoType) [ 0 .. 9999 ] tankNo is used to identify a fuel container at a service station. The tank number in a TP (Tank Probe) structure is used to number TPs consecutively |
{- "tankNo": 0
}details for tankProbeIDElement
| tankProbeID | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
{- "tankProbeID": "string"
}details for tankSerialNumberElement
| tankSerialNumber required | string (tankSerialNumberType) <= 40 characters A description of the serial number of the fuel product tank. |
{- "tankSerialNumber": "string"
}details for taskDurationElement
| taskDuration required | string (taskDurationType) <= 20 characters ^P([0-9]+Y)?([0-9]+M)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$ Length of time allocated to a task. Duration expression should be limited to hours, minutes, and seconds, i.e. PxHyMzS, where x = hours, y = minutes, and z = seconds |
{- "taskDuration": "string"
}details for taskIDElement
| taskID required | string (taskIDType) [ 1 .. 4 ] characters An ID for the task to which the timeclock event applies. |
{- "taskID": "stri"
}details for taxElement
| tax required | object (taxObject) |
{- "tax": {
- "taxLevelID": "stri",
- "taxableSalesAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxCollectedAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxableSalesRefundedAmount": null,
- "taxRefundedAmount": null,
- "taxExemptSalesAmount": null,
- "taxExemptAmount": null,
- "taxExemptSalesRefundedAmount": null,
- "taxExemptReason": null,
- "taxForgivenSalesAmount": null,
- "taxForgivenSalesRefundedAmount": null,
- "taxForgivenAmount": null,
- "taxForgivenReason": null
}
}details for taxExemptCertificateIDElement
| taxExemptCertificateID required | string (taxExemptCertificateIDType) [ 1 .. 40 ] characters The tax exempt number issued by the tax authority to the customer who is tax exempt. |
{- "taxExemptCertificateID": "string"
}details for taxLevelIDElement
| taxLevelID required | string (taxLevelIDType) [ 1 .. 4 ] characters A pointer to the Tax Level Table or Rate. The values of the table specify the tax level being reported. It usually defines a tax rate or table. |
{- "taxLevelID": "stri"
}details for taxPayerIDElement
| taxPayerID required | string (taxPayerIDType) [ 1 .. 40 ] characters Identifier assigned to the payer by the tax authority. |
{- "taxPayerID": "string"
}details for taxRateElement
| taxRate required | number (taxRateType) <= 999999 Percentage applicable to the ActualSellPrice of an item unless breakpoint matrix is used. |
{- "taxRate": 0
}details for taxReceiptDescriptionElement
| taxReceiptDescription required | string (taxReceiptDescriptionType) <= 16 characters Describes the tax authority in an abbreviated format. |
{- "taxReceiptDescription": "string"
}details for taxRegistrationNumberElement
| taxRegistrationNumber required | integer (taxRegistrationNumberType) [ 0 .. 10000000000000000 ] Number assigned by taxing authority that must appear on the register receipt or reports. |
{- "taxRegistrationNumber": 0
}details for taxSequenceNumberElement
| taxSequenceNumber required | integer (taxSequenceNumberType) [ 0 .. 9999 ] Identifies the sequence that the included TaxLevelId should be followed to calculate the TaxLevelIDs taxes. |
{- "taxSequenceNumber": 0
}details for taxStrategyIDElement
| taxStrategyID required | string (taxStrategyIDType) [ 1 .. 4 ] characters ^[0-9]{1,4}$ It is a pointer to the Tax Strategy Maintenance Table that includes sufficient methods and/or algorithms to compute the tax relative to or required by that item/department. A TaxStrategyID = 0 indicates the item is non-taxable. |
{- "taxStrategyID": "stri"
}details for taxSymbolElement
| taxSymbolNumber required | string (taxSymbolType) <= 4 characters Single or dual character that prints on the register receipt to indicate the TaxLevelID. |
{- "taxSymbolNumber": "stri"
}details for taxTableIDElement
| taxTableID required | string (taxTableIDType) [ 1 .. 4 ] characters A pointer to a matrix of tax breakpoints for taxes that are not a straight percentage. |
{- "taxTableID": "stri"
}details for temperatureUNElement
| temperature required | object (temperatureUNObject) |
{- "temperature": {
- "value": -9999,
- "temperatureUOM": "CEL"
}
}details for tenderIDElement
| tenderID required | object (tenderIDObject) |
{- "tenderID": {
- "tenderCode": "cash",
- "tenderSubCode": "cash"
}
}details for tentIDElement
| tentID required | string (tentIDType) [ 1 .. 8 ] characters The number on the little tent given to the customer in a food service environment. The customer places the tent on their table, and the staff uses it to locate the correct table to delivery the food to after preparation |
{- "tentID": "string"
}details for terminalStatusCodeElement
| terminalStatusCode required | string or string (terminalStatusCodeEENUMType) terminalStatusCode values defined by Conexxus (base type) |
{- "terminalStatusCode": "startup"
}details for tillIDElement
| tillID required | string (tillIDType) [ 1 .. 4 ] characters Identifies the till in a multiple till per register scenario. |
{- "tillID": "stri"
}details for timeClockSequenceNumberElement
| timeClockSequenceNumber required | integer (timeClockSequenceNumberType) [ 0 .. 99999999 ] Identifier for a TimeClockDetail entry. |
{- "timeClockSequenceNumber": 0
}details for timeElement
| time required | string <time> (timeType) [ 8 .. 14 ] characters ISO 8601 time designation aligning with XML Schema. |
{- "time": "stringst"
}details for timeTierCodeElement
| timeTierCode required | string (timeTierCodeType) [ 1 .. 16 ] characters A pointer to the Time Tier Table. The values indicate the type of time tier by which the customer purchased or may purchase a fuel grade. This is typically used for day segment pricing. |
{- "timeTierCode": "string"
}details for timeUNUOMElement
| timeUOM required | string (timeUNUOMENUMType) <= 3 characters Enum: "SEC" "MIN" "HUR" "DAY" "WEE" "MON" "ANN" Common time units of measure |
{- "timeUOM": "SEC"
}details for timeZoneElement
| timeZone required | string (timeZoneType) <= 24 characters 24 character timezone description. |
{- "timeZone": "string"
}details for timestampElement
| timestamp | string <date-time> (dateTimeType) [ 10 .. 30 ] characters |
{- "timestamp": "2020-06-23T16:37:36Z"
}details for transactionIDElement
| transactionID required | string (transactionIDType) [ 1 .. 16 ] characters Identifier for the transaction within a given period. |
{- "transactionID": "string"
}details for transactionLineSequenceNumberElement
| transactionLineSequenceNumber required | integer (transactionLineSequenceNumberType) [ 0 .. 99999999 ] The sequence number assigned to the transaction line by the register. |
{- "transactionLineSequenceNumber": 0
}details for transactionSeqNoElement
| transactionSeqNo | integer (transactionSeqNoType) [ 0 .. 99999999 ] transactionSeqNo is the unique identifier of a transaction |
{- "transactionSeqNo": 0
}details for transmissionIDElement
| transmissionID required | integer (transmissionIDType) [ 0 .. 99999999 ] An unique identifier for a particular report. |
{- "transmissionID": 0
}details for transponderIDElement
| transponderID required | string (transponderIDType) [ 1 .. 40 ] characters Electronic ID of the transponder. |
{- "transponderID": "string"
}details for trayIDElement
| trayID required | string (trayIDType) [ 1 .. 16 ] characters A unique identifier denoting the tray that was used within a food service environment. |
{- "trayID": "string"
}details for userIDElement
| userID | string (userIDType) <= 16 characters userID is used to identify the ID of the user who performs certain operation |
{- "userID": "string"
}details for userNameElement
| userName | string (userNameType) <= 40 characters userName is used to identify the name of the user who performs certain operation |
{- "userName": "string"
}details for vehicleColorElement
| vehicleColor required | string (vehicleColorType) <= 24 characters The color of the vehicle. |
{- "vehicleColor": "string"
}details for vehicleIDElement
| vehicleID required | string (vehicleIDType) [ 1 .. 40 ] characters The identification of the vehicle in the fleet card purchase. |
{- "vehicleID": "string"
}details for vehicleTypeElement
| vehicleType required | string (vehicleTypeType) <= 24 characters Type of vehicle. |
{- "vehicleType": "string"
}details for vendorModelVersionElement
| vendorModelVersion required | string (vendorModelVersionType) <= 40 characters A description of the POS or Back Office model/version. The use of this element is an implementation choice. Some may prefer to set up a general table containing this information |
{- "vendorModelVersion": "string"
}details for vendorNameElement
| vendorName required | string (vendorNameType) <= 40 characters The POS or Back Office vendor name. The use of this element is an implementation choice. Some may prefer to set up a general table containing this information |
{- "vendorName": "string"
}details for voidReasonElement
| voidReason required | string (voidReasonType) [ 1 .. 16 ] characters A reason code indicating why the item/merchandise was voided defined by Conexxus (base type). |
{- "voidReason": "string"
}details for volumeUNElement
| volume required | object (volumeUNObject) |
{- "volume": {
- "value": "string",
- "uom": "MLT"
}
}details for washCodeElement
| washCode required | integer (washCodeType) [ 0 .. 10000000000000000 ] The code assigned to the purchased wash, needed for redemption at the pedestal. |
{- "washCode": 0
}details for yesNoElement
| yesNo required | string (yesNoENUMType) <= 4 characters Enum: "yes" "no" Yes or no value, used as a more flexible option to true/false. |
{- "yesNo": "yes"
}details for accountIDType
The identification of the account related to the tender type.
"string"details for accountNameType
The name of the account related to the tender type.
"string"details for alarmDurationType
The number of seconds that the drawer alarm sounded in a Drawer Alarm event. Since the designation is in seconds, the duration should be limited to expressing seconds, i.e. PxS, where 'x' is the number of seconds.
"string"details for approvalCodeType
Common approval code for payment or other POS operations.
"string"details for approvalReferenceCodeType
The code given by the authorizing host.
"string"details for approverIDType
An identifier for the cashier or manager that approved the SaleEvent, RefundEvent, VoidEvent or TransactionLine.
"string"details for auditStatusENUMType
Status of a till or a period for an audit record (ne).
"open"details for automaticDiscountIDType
AutomaticDiscountID is a pointer to a discount in a discount table to be applied to an item any time it is sold
0details for bankAccountNumberType
The bank account number of the check being processed.
0details for bankIDType
The identification of the bank for the check being processed.
0details for batchCloseReasonEENUMType
Reason for Batch Close.
"string"details for batchEENUMType
Indicates batch type.
"string"details for batchNumberType
A unique identifier for the batch that has been created.
0details for batchSequenceNumberType
Short batch sequence number.
"stri"details for batchStatusEENUMType
Indicates batch status
"string"details for biometricIdentifierType
Free-form text from a reading device.
"string"details for breakDurationType
The duration of a break, expressed in minutes and seconds. PxMyS is the normal expression, where x = minutes and y = seconds
"string"details for calculationENUMType
Indicates whether a value was read (actual) or calculated somehow
"actual"details for cardCircuitType
The CardCircuit dentifies the card type. This element is intended to align with the requirements of the EPS 2.7 (and later) standard
"string"details for cardDescriptionType
Description of card
"string"details for cashierIDType
Identifies the cashier conducting the transaction(s) in the reporting period
"string"details for checkNumberType
The sequential number assigned to the check, which is generally pre-printed in the upper right hand corner of the check
0details for clockEntryEENUMType
Entry method for time-clock events.
"string"details for comboDescriptionType
A free form description of the combination offered for sale - "combo", i.e., "Manager's Special", "Sandwich Combo", etc.
"string"details for commissionRateType
Rate paid for commission, expressed as a decimal number (left of decimal).
"string"details for componentActionENUMType
An identifer for how the component item is attached to the main item in the sale
"isMemberOf"details for conceptIDType
This identifies a particular branding within a RevenueCenterID. For example, Subway within a QSR RevenueCenterID.
"string"details for condimentNameType
The name of the item that is being sold as optional extra alongside some other item.
"string"details for countryEENUMType
ISO-3166 / UN/ECE REC 09 Codes
"st"details for currencyEENUMType
ISO-4217 / UN/ECE REC 09 Codes
"str"details for currencyExchangeRateType
For currency exchange, 6,6 decimal.
0details for customerPONumberType
PO number
"string"details for dataReadEventTypeCodeENUMType
Indicates why a value (usually a fuel meter) was read.
"periodClose"details for dayOfWeekENUMType
Day of the week.
"Sunday"details for deliveryReasonEENUMType
the reason for the tank movement
"string"details for deliveryTypeENUMType
delivery type identifies whether the movement adds or removes product from the tank contents
"Fill"details for descriptionIDType
A reference string for description lookup.
"string"details for deviceIDType
The identifier for a device which has raised an alert event.
"string"details for discountIDType
A reference string for identifying a discount.
"string"details for discountReasonEENUMType
A reason code indicating why the item/merchandise was discounted defined by Conexxus (base type).
"string"details for dispPromptMethodEENUMType
display or prompt (base type)
"string"details for displayType
Open reference to a display device, used for things like how to present help, etc.
"string"details for driverIDType
The type of identification used to verify the identification of the driver.
"string"details for dropNumberType
A unique identifer for the safe drop that was performed.
"string"details for earlyPunchType
How early is the employee allowed to punch. Duration expression should be limited to hours, minutes, and seconds, i.e. PxHyMzS, where x = hours, y = minutes, and z = seconds.
"string"details for electronicSignatureType
Used to give the electronic signature value where signature capture device is present for additional verification.
"string"details for emailAddressType
email address (valid according RFC 3696).
"string"details for employeeIDType
Identifier for an employee. Use caution not to disclose PII.
"string"details for employeeNumberType
A unique identifer for the employee that is referred to in a TimeClock event.
"string"details for employeeRoleType
Role of the employee for a given task.
"string"details for entryMethodENUMType
Entry method use for the associated data value.
"scan"details for envelopeIDType
The unique identifier that was on the envelope, that the money was placed in during the safe drop event.
"string"details for epsNameType
Unique name of the EPS with in a given site. A site can have one or more EPS.
"string"details for eventIDType
The identification of a specific event responsible for the reward.
"string"details for eventSequenceIDType
A unique identifer for the FinancialEvent.
0details for eventTypeType
Used mainly in MaintenanceAuditEvent (Journal) to designate the type of event that triggered the audit.
"string"details for extendedLabelIDType
An extra label from a coupon.
"string"details for familyCodeType
That portion of a U.P.C. on a manufacturer's coupon used to identify an item's grouping for discount purposes.
"str"details for fieldNameType
For audit events, what table/field changed?
"string"details for fuelEventENUMType
Indicates the reason for the fuel reading
"periodClose"details for fuelGradeSequenceIDType
The sequence number to which the FuelGradeID is assigned. Normally hose ID.
0details for fuelPositionStatusType
The status of a fuel position that causes a PumpStatus event to occur.
"string"details for fuelPriceChangeIDType
The system dependent identifier for a fuel price change event.
"string"details for fuelProductBlendPercentType
This is the percentage of FuelProductID used in a blending of two fuel products to create a fuel grade. The blend percentage of FuelProductIDHigh is 100 less FuelProductBlendPercent. If not a blended fuel grade then put 100 as the FuelProductBlendPercent.
"string"details for fuelProductStatusType
The status of the fuel product at the time of the tank reading.
"string"details for fuelingPointStateEENUMType
fueling point state is a string of characters used to identify the state of a fueling point
"string"details for giskeAlgorithmEENUMType
GISKE Specification 2.3a - Key Block header byte 7
"string"details for giskeExportabilityEENUMType
GISKE Specification 2.3a - Key Block header byte 27. Exportability refers to transfer outside the system in which the key is found. Secure backup of a key may be allowed, depending on local rules. Flags in this field indicate special types of keys that require unusual handling. Any key that does not follow normal security assumptions should have a notation in this field. This may mean that the key should be less trusted, like a CAPI key, or that the key assumes a high degree of trust, such as a CA key. In general, a letter in this column means that future developers should check the definition of this type of key carefully.
"string"details for giskeKeyUsageEENUMType
GISKE Specification 2.3a - Key Block header bytes 5 and 6. Note that these usages may work for both symmetric and asymmetric keys. This list of usages is not intended to be exhaustive. Future versions may include other key usages types.
"string"details for giskeModeOfUseEENUMType
GISKE Specification 2.3a - Key Block header byte 8
"string"details for gtinType
AI for GTIN-14 is '01', GTIN is 14 digits, optional AI for serial number is '21', followed by 0-20 characters as defined.
"string"details for idEENUMType
Identification types (driver's license, social security number, etc.) defined by Conexxus.
"string"details for intervalENUMType
Sometimes refered to as 'day part' values, refers to the scoped period of a report.
"cashier"details for itemListIDType
A pointer to the Item List look-up table. A "null" or "no value" for ItemListIDType may be allowed.
"string"details for itemTypeCodeEENUMType
A pointer to the Item Type Look-up table. A "null" or "no value" for ItemTypeCode should be allowed.
"string"details for jobCodeType
A code denoting the job that the employee was linked to during a TimeClock event.
"string"details for jobIDType
The identification of the job associated with the fleet card purchase.
"string"details for keyboardType
Type of keyboard involved in the transaction.
"string"details for languageENUMType
The following SGML-encoded summary of the language codes of ISO 639 was prepared by Harry Gaylord. The two-letter codes are from the present ISO 639 standard. The three letter-codes are the current proposals in ISO CD 639/2 Draft dated 10/15/92 of the working group revising 639 for TC 3 and TC 46 of ISO and may be revised, amended, or changed before the new ISO standard is issued.
"abk"details for latePunchType
How late is the employee allowed to punch. Duration expression should be limited to hours, minutes, and seconds, i.e. PxHyMzS, where x = hours, y = minutes, and z = seconds.
"string"details for lengthUNUOMENUMType
uom designation for lengths (widths, depths, etc.).
"MMT"details for levelType
level value as used for level readings by tank level gauges. Level is an unsigned integer from "0" to "99999999"
0details for licenseNumberType
The license number of the vehicle that drove off.
"string"details for licensePlateIDType
The license plate number of the vehicle recorded in a DriveOff event.
"string"details for lineSequenceNumberType
A unique sequence number for the subItemLine within the ItemLine it is attached to.
0details for linkCodeEENUMType
Specific additions to posCodeFormat required for linkCode, OR the type of coding scheme used in POSCode.
"item"details for linkedItemListIDType
A pointer to the Item List look-up table. A 'null' or 'no value' for ItemListIDType may be allowed.
"string"details for loanTypeENUMType
An identifer for the type of DrawerLoan event that was performed.
"in"details for loyaltyProgramNameType
The name of the loyalty program to which the reduction is attributed.
"string"details for loyaltyTransactionIDType
The ID of the loyalty program to which the reduction is attributed.
"string"details for managerIDType
Identifier for a manager, unique to a given site.
"string"details for manualActionIDType
The identification of the action used to trigger the promotion.
"string"details for manufacturerIDType
An identifier for the manufacturer that issued the coupon.
"string"details for massUNUOMENUMType
Unit of measure indicating weight (mass).
"GRM"details for memoDetailType
A descriptive piece of text that is placed into the journal as a Memo event.
"string"details for merchandiseCodeDescriptionType
Native language description of the merchandise code normally printed on the register tape.
"string"details for merchandiseCodeType
Enhanced MerchandiseCode type to support hierarchical MerchandiseCodes.
"string"details for meterENUMType
Indicates whether the meter is mechanical or electronic.
"mechanical"details for miscellaneousSummaryCodeEENUMType
MiscellaneousSummaryCodes defined by Conexxus (base type).
"string"details for miscellaneousSummarySubCodeEENUMType
MiscellaneousSummarySubCodes defined by Conexxus (base type).
"string"details for mixMatchCodeType
A code identifying the MixMatch.
"string"details for modeNoType
mode No is an unsigned integer used to identify the different modes to dispatch fuel products, like self service of full
0details for moneyOrderNumberType
The sequential number issued by the money order company to the individual money order being sold.
"string"details for moneyOrderTypeIndicatorType
An indicator as to the type of money order, I.e., vendor payment, payroll, customer, etc.
"stri"details for networkIDType
An identifier for the batch on the network.
"string"details for networkProductCodeType
A code reported to the credit card processing host, to indicate types of products being sold in the transaction. Provided for use of non-Conexxus codes if needed.
"stri"details for newSecurityIDType
A code denoting the new security that was in place after the security bypass event was performed.
"string"details for newValueType
For use in NAXML-POSJournal (mainly) in MaintenanceAuditEvent to declare a new (audited) value
"string"details for odometerReadingType
The odometer reading of the vehicle being filled.
0details for offerCodeType
Offer code for a coupon, should be a GS1 'GCN' - 13 digits.
0details for oldSecurityLevelType
A code denoting the security level that was in place before the security bypass event was performed.
"string"details for oldValueType
For use in NAXML-POSJournal (mainly) in MaintenanceAuditEvent to declare an old (unaudited) value.
"string"details for originalTransactionENUMType
Identifies whether a transaction was a sale or refund for reference.
"sale"details for outdoorPaymentTerminalStateEENUMType
outdoor payment terminal state is a string of characters used to identify the state of an outdoor payment terminal
"string"details for overridingCashierIDType
A unique identifier for the cashier or manager that performed the security override event.
"string"details for partDescriptionType
A long and complex description for a vehicle part number that is being sold.
"string"details for payInReasonType
Pay in reason value defined by Conexxus (base type)
"string"details for payOutReasonType
Pay out reason value defined by Conexxus (base type)
"string"details for paymentMethodEENUMType
payment method is an string with a list of possible enum values; this list is same as IFSF_BasicTypesCards from EPS
"string"details for paymentSystemsProductCodeType
Conexxus Payment System Product Codes and/or the underlying standard (X9.104) for which Conexxus is the Registration Authority, published by ACS X9, Inc.
"strin"details for percentageType
3,3 decimal valid percentage, may range over 100 (i.e. 300% increase, etc.)
0details for phoneLineTypeEENUMType
The type of phone line (extendable).
"string"details for phoneNumberStringType
String roughly constrained to handle phone numbers and common delimiting characters.
"string"details for posCodeFormatEENUMType
"string"details for postalCodeType
The postal code in the address (zip code in the US).
"string"details for preAuthorizationType
Indicates pre-authorization was obtained
0details for preparationModType
Description of a preparation modification that must occur when the item is sold as a component within another item
"string"details for priceOverrideApproverIDType
Identifies the individual athorizing the price overrider.
"string"details for priceOverrideReasonEENUMType
A reason code indicating why the item/merchandise code/fuel grade was sold at a price different from the RegularSellPrice. Values - ( EMP | EXP | FCW | FRS | FSH | GOW | MGR | POL | RPC | SCD | TPC ) defined by Conexxus (base type).
"string"details for pricePoleStateEENUMType
price pole state is a string of characters used to identify the state of a price pole
"string"details for priceTierCodeType
A pointer to the Price Tier Table. The values indicate the type of pricing level by which the customer purchased or may purchase the fuel grade. This is typically used for cash/credit pricing.
"stri"details for priceTierEENUMType
price tier is a string of characters used to identify the payment method
"s"details for primaryCompanyPrefixType
Prefix for identifying Coupons, variable portion (6-12 digits) of the GS1 'GLN' - 13 digits including check digit.
"string"details for primaryLabelIDType
The primary label from a coupon.
"string"details for priorityEENUMType
The priority of an alert event that has been raised.
"string"details for productCategoryType
the product category value determine how the POS treats the data coming from the dispenser
0details for productCodeType
product code provides a classification of the fuel product
0details for productNameType
fuel product name is the unique identification of fuel sold at Service stations and C-Stores
"string"details for productNoType
product No is the unique identification of the product at the service station
0details for promotionCodeType
The kind of promotion the coupon is part of.
"string"details for promotionReasonEENUMType
A reason code indicating why the item/merchandise was promo'ed defined by Conexxus (base type).
"string"details for providerIDType
Identifies the authorizing agency, bank or clearinghouse.
"string"details for provinceCAENUMType
Provinces and territories of Canada, ref http://www.iso.ch/iso/en/prods-services/iso3166ma/04background-on-iso-3166/iso3166-2.html.
"AB"details for pumpTestReasonType
A reason code for the pump test defined by Conexxus (base type).
"string"details for pumpTesterIDType
A unique identifer for the person (or organization) that conducted the pump test.
"string"details for punchEENUMType
Source of punch in/out entry.
"string"details for punchModReasonType
Punch modification reason value defined by Conexxus (base type).
"string"details for punchReasonEENUMType
Punch reason value defined by Conexxus (base type).
"string"details for quantityUNUOMEENUMType
Unit of measure indicating weight (mass).
"GRM"details for readingTypeEENUMType
reading type is an string of characters used to indicate how the reading of a tank was obtained
"string"details for reasonCodeEENUMType
Identifier for the type of reason code; this enumeration is not extendable
"string"details for redeemedCouponIDType
The identification of the redeemed coupon.
"string"details for redeemedPointsTypeIDType
The identification of the type of points redeemed.
"string"details for refundReasonEENUMType
A reason code indicating why the item/merchandise was refunded defined by Conexxus (base type).
"string"details for registerIDType
The identification of the register that finalized the sales being reported. This is typically the register number.
"stri"details for reportPeriodType
ISO 8601 Date Type to align with XML Schema.
"2020-06-23"details for reportRangeENUMType
Range of the values represented in the report.
"cumulative"details for reportSequenceNumberType
A unique sequential report control number
0details for repriceReasonCodeEENUMType
(remove?)
"string"details for repriceReasonEENUMType
(remove?)
"string"details for revenueCenterIDType
The identification of the revenue or profit center within the store.
"string"details for safeLoanReasonType
Safe loan reasons defined by Conexxus (base type).
"string"details for salesRestrictCodeEENUMType
A pointer to a value in the SalesRestrict table. The values indicate the restrictions that apply to the item/merchandise code. defined by Conexxus (base type).
"string"details for securityLevelType
Four digit security level designation.
0details for segmentNoType
segment No is the unique identification of a segment within a price pole
0details for serviceLevelCodeEENUMType
Fuel selling service levels defined by Conexxus (base type).
"string"details for severityEENUMType
severity is the standard for message logging criticality levels
"string"details for severityIndicatorType
The severity of an alert event that has been raised.
"string"details for shiftIDType
For use in task scheduling, along with TaskID, description, begin time, etc.
"stri"details for siteIDType
An alphanumeric value by which the site is identified, assumed to be unique across an organization.
"string"details for stanType
System Trace Audit Number (STAN) is a unique identifier generated by the FEP when a transaction is processed. It is unique to the FEP.
"string"details for stateOrProvinceENUMType
Provinces and territories of Canada, ref http://www.iso.ch/iso/en/prods-services/iso3166ma/04background-on-iso-3166/iso3166-2.html.
"AB"details for stateUSENUMType
States of the US.
"AL"details for storeConceptIDType
The identification of the concept within the RevenueCenterID, I.e. Subway within a QSR RevenueCenterID.
"string"details for storeHierarchyIDType
The lowest level of the store structure where the item was sold from
"string"details for storeLocationIDType
The store/location/site identifier assigned by the company to this physical location. It is typically the store number.
"string"details for systemOfMeasurementENUMType
enum values excerpted from IFSF TG Standard
"metric"details for tableNameType
For audit events, what table/field changed?
"string"details for tankChartIDType
A pointer to a tank capacity chart not defined in this document.
"stri"details for tankGroupNoType
tank group number is the unique identifier of the tank group on a retail store
0details for tankGroupTypeENUMType
The tank group type
"TankSyphon"details for tankIDType
The assigned identification for a fuel product tank.
"string"details for tankLogicalStateENUMType
A LogicalState which can be locked or unlocked
"locked"details for tankManifoldIDType
The identification of the fuel product tank manifold. Usage is implementation specific.
"string"details for tankManufacturerType
The name of the manufacturer of the fuel product tank.
"string"details for tankModelNumberType
The model number of the fuel product tank.
"string"details for tankNoType
tankNo is used to identify a fuel container at a service station. The tank number in a TP (Tank Probe) structure is used to number TPs consecutively
0details for tankProbeStateEENUMType
tankProbeState is a string of characters used to identify the state of a tank probe
"string"details for tankSerialNumberType
A description of the serial number of the fuel product tank.
"string"details for taskDurationType
Length of time allocated to a task. Duration expression should be limited to hours, minutes, and seconds, i.e. PxHyMzS, where x = hours, y = minutes, and z = seconds
"string"details for taskIDType
An ID for the task to which the timeclock event applies.
"stri"details for taxExemptCertificateIDType
The tax exempt number issued by the tax authority to the customer who is tax exempt.
"string"details for taxExemptReasonEENUMType
Tax exemption reasons defined by Conexxus (base type).
"string"details for taxForgivenReasonType
Tax forgiven (normally for payment with government benefits) reasons defined by Conexxus (base type).
"string"details for taxLevelIDType
A pointer to the Tax Level Table or Rate. The values of the table specify the tax level being reported. It usually defines a tax rate or table.
"stri"details for taxPayerIDType
Identifier assigned to the payer by the tax authority.
"string"details for taxRateType
Percentage applicable to the ActualSellPrice of an item unless breakpoint matrix is used.
0details for taxReceiptDescriptionType
Describes the tax authority in an abbreviated format.
"string"details for taxRegistrationNumberType
Number assigned by taxing authority that must appear on the register receipt or reports.
0details for taxSequenceNumberType
Identifies the sequence that the included TaxLevelId should be followed to calculate the TaxLevelIDs taxes.
0details for taxStrategyIDType
It is a pointer to the Tax Strategy Maintenance Table that includes sufficient methods and/or algorithms to compute the tax relative to or required by that item/department. A TaxStrategyID = 0 indicates the item is non-taxable.
"stri"details for taxSymbolType
Single or dual character that prints on the register receipt to indicate the TaxLevelID.
"stri"details for taxTableIDType
A pointer to a matrix of tax breakpoints for taxes that are not a straight percentage.
"stri"details for temperatureUNUOMENUMType
Temperature units of measure, following UN/ECE Rec 20.
"CEL"details for temperatureValueType
A numeric value that ranges over the common temperature scales.
-9999details for tenderCodeEENUMType
TenderCodes defined by Conexxus (base type).
"string"details for tenderSubCodeEENUMType
TenderSubCodes defined by Conexxus (base type).
"string"details for tentIDType
The number on the little tent given to the customer in a food service environment. The customer places the tent on their table, and the staff uses it to locate the correct table to delivery the food to after preparation
"string"details for terminalStatusCodeEENUMType
terminalStatusCode values defined by Conexxus (base type)
"string"details for tillIDType
Identifies the till in a multiple till per register scenario.
"stri"details for timeClockSequenceNumberType
Identifier for a TimeClockDetail entry.
0details for timeTierCodeType
A pointer to the Time Tier Table. The values indicate the type of time tier by which the customer purchased or may purchase a fuel grade. This is typically used for day segment pricing.
"string"details for timeType
ISO 8601 time designation aligning with XML Schema.
"stringst"details for timeUNUOMENUMType
Common time units of measure
"SEC"details for transactionAvailableStateENUMType
transactionAvailableState is used in fdc to identify the different states of an available transaction
"locked"details for transactionIDType
Identifier for the transaction within a given period.
"string"details for transactionLineSequenceNumberType
The sequence number assigned to the transaction line by the register.
0details for transactionLineStatusENUMType
Normal indicates anormally completed, unmodified transaction line. Cancel indicatges a transaction line that was rung and then reversed, and is therfore not included in the transation total and does not impact store inventory. Return indicate a transaction line for a product returned by the customer for credit as part of a sale transaction. Refund transactions would not use this status. This status could also be used to record foodservice orders that were cancelled after the order was prepared. Return aquantity is assumed to be a positive number. Retun is not applicable to Tender, PromotionTrigger, PromotionReward, TransactionTax, or CustomerID transaction lines. Other indicates transaction line whose status is user-defined and qulified by the element TransactionLineStatusDescription.
"normal"details for transactionLinkReasonType
A reason code indicating why the item/merchandise was linked defined by Conexxus (base type).
"string"details for transactionSeqNoType
transactionSeqNo is the unique identifier of a transaction
0details for transactionStatusEENUMType
transactionStatus is a string of characters used to identify the state of a transaction
"string"details for transmissionIDType
An unique identifier for a particular report.
0details for transponderIDType
Electronic ID of the transponder.
"string"details for trayIDType
A unique identifier denoting the tray that was used within a food service environment.
"string"details for unitOfMeasurementEENUMType
enum values excerpted from IFSF Engineering Bulletin 14 (UN/ECE Rec 20)
"ANN"details for upcFamilyCodeType
(remove?)
"str"details for userIDType
userID is used to identify the ID of the user who performs certain operation
"string"details for userNameType
userName is used to identify the name of the user who performs certain operation
"string"details for vehicleColorType
The color of the vehicle.
"string"details for vehicleIDType
The identification of the vehicle in the fleet card purchase.
"string"details for vendorModelVersionType
A description of the POS or Back Office model/version. The use of this element is an implementation choice. Some may prefer to set up a general table containing this information
"string"details for vendorNameType
The POS or Back Office vendor name. The use of this element is an implementation choice. Some may prefer to set up a general table containing this information
"string"details for voidReasonType
A reason code indicating why the item/merchandise was voided defined by Conexxus (base type).
"string"details for volumeUNUOMENUMType
Unit of measure indicating volume.
"MLT"details for washCodeType
The code assigned to the purchased wash, needed for redemption at the pedestal.
0details for yesNoEENUMType
boolean definition
"string"details for yesNoENUMType
Yes or no value, used as a more flexible option to true/false.
"yes"details for alarmMsgObject
| number required | integer (integerUnsigned2BaseType) [ 0 .. 99 ] 2 digit numeric value |
| text required | string (description40BaseType) <= 40 characters 40 character description. |
[- {
- "number": 0,
- "text": "string"
}
]details for amountObject
| value required | string (decimal12BaseType) <= 18 characters ^\-?[0-9]{0,12}(\.[0-9]{1,5})?$ 12,5 decimal value |
| currency | string or string (currencyEENUMType) ISO-4217 / UN/ECE REC 09 Codes |
{- "value": "string",
- "currency": "AED"
}details for comboDiscountAllocationObject
| value required | string (decimal12BaseType) <= 18 characters ^\-?[0-9]{0,12}(\.[0-9]{1,5})?$ 12,5 decimal value |
| percent required | string <= 8 characters Enum: "percent" "amount" ComboDiscountAllocation permits the BOS to designate how promotion discounts are to be allocated to the items in a promotion. To allocate no discount, one would use an amount or percent of zero. |
{- "value": "string",
- "percent": "percent"
}details for componentItemIDObject
| value required | string (id40BaseType) [ 1 .. 40 ] characters 40 character ID |
| componentAction required | string <= 16 characters Enum: "isMemberOf" "isAddedTo" "isRemovedFrom" A unique identifier for an item which is a component of some other item. Attributes componentAction ( isAddedTo | isMemberOf | isRemovedFrom ). |
{- "value": "string",
- "componentAction": "isMemberOf"
}details for condimentIDObject
| value required | string (id40BaseType) [ 1 .. 40 ] characters 40 character ID |
| componentAction | string (id16BaseType) [ 1 .. 16 ] characters 16 character ID |
{- "value": "string",
- "componentAction": "string"
}details for countrySettingsObject
| volumeUnit | string or string (unitOfMeasurementEENUMType) enum values excerpted from IFSF Engineering Bulletin 14 (UN/ECE Rec 20) |
| levelUnit | string or string (unitOfMeasurementEENUMType) enum values excerpted from IFSF Engineering Bulletin 14 (UN/ECE Rec 20) |
| temperatureUnit | string or string (unitOfMeasurementEENUMType) enum values excerpted from IFSF Engineering Bulletin 14 (UN/ECE Rec 20) |
| countryCode | string or string (countryEENUMType) <= 2 characters ^[A-Z][A-Z] ISO-3166 / UN/ECE REC 09 Codes |
| language | string (languageENUMType) <= 8 characters Enum: "abk" "ace" "ach" "ada" "aar" "afh" "afr" "afa" "aka" "akk" "alb/sqi" "ale" "alg" "tut" "amh" "apa" "ara" "arc" "arp" "arn" "arw" "arm/hye" "art" "asm" "ath" "map" "ava" "ave" "awa" "aym" "aze" "nah" "ban" "bat" "bal" "bam" "bai" "bad" "bnt" "bas" "bak" "baq/eus" "bej" "bem" "ben" "ber" "bho" "bih" "bik" "bin" "bis" "bra" "bre" "bug" "bul" "bua" "bur/mya" "bel" "cad" "car" "cat" "cau" "ceb" "cel" "cai" "chg" "cha" "che" "chr" "chy" "chb" "chi/zho" "chn" "cho" "chu" "chv" "cop" "cor" "cos" "cre" "mus" "crp" "cpe" "cpf" "cpp" "cus" "ces/cze" "dak" "dan" "del" "din" "div" "doi" "dra" "dua" "dut/nla" "dum" "dyu" "dzo" "efi" "egy" "eka" "elx" "eng" "enm" "ang" "esk" "epo" "est" "ewe" "ewo" "fan" "fat" "fao" "fij" "fin" "fiu" "fon" "fra/f" "frm" "fro" "fry" "ful" "gaa" "gae/gdh" "glg" "lug" "gay" "gez" "geo/kat" "deu/ger" "gmh" "goh" "gem" "gil" "gon" "got" "grb" "grc" "ell/gre" "kal" "grn" "guj" "hai" "hau" "haw" "heb" "her" "hil" "him" "hin" "hmo" "hun" "hup" "iba" "ice/isl" "ibo" "ijo" "ilo" "inc" "ine" "ind" "ina" "iku" "ipk" "ira" "gai/iri" "sga" "mga" "iro" "ita" "jpn" "jav/jaw" "jrb" "jpr" "kab" "kac" "kam" "kan" "kau" "kaa" "kar" "kas" "kaw" "kaz" "kha" "khm" "khi" "kho" "kik" "kin" "kir" "kom" "kon" "kok" "kor" "kpe" "kro" "kua" "kum" "kur" "kru" "kus" "kut" "lad" "lah" "lam" "oci" "lao" "lat" "lav" "ltz" "lez" "lin" "lit" "loz" "lub" "lui" "lun" "luo" "mac/mak" "mad" "mag" "mai" "mak" "mlg" "may/msa" "mal" "mlt" "man" "mni" "mno" "max" "mao/mri" "mar" "chm" "mah" "mwr" "mas" "myn" "men" "mic" "min" "mis" "moh" "mol" "mkh" "lol" "mon" "mos" "mul" "mun" "nau" "nav" "nde" "nbl" "ndo" "nep" "new" "nic" "ssa" "niu" "non" "nai" "nor" "nno" "nub" "nym" "nya" "nyn" "nyo" "nzi" "oji" "ori" "orm" "osa" "oss" "oto" "pal" "pau" "pli" "pam" "pag" "pan" "pap" "paa" "fas/per" "peo" "phn" "pol" "pon" "por" "pra" "pro" "pus" "que" "roh" "raj" "rar" "roa" "ron/rum" "rom" "run" "rus" "sal" "sam" "smi" "smo" "sad" "sag" "san" "srd" "sco" "sel" "sem" "scr" "srr" "shn" "sna" "sid" "bla" "snd" "sin" "sit" "sio" "sla" "ssw" "slk/slo" "slv" "sog" "som" "son" "wen" "nso" "sot" "sai" "esl/spa" "suk" "sux" "sun" "sus" "swa" "sve/swe" "syr" "tgl" "tah" "tgk" "tmh" "tam" "tat" "tel" "ter" "tha" "bod/tib" "tig" "tir" "tem" "tiv" "tli" "tog" "ton" "tru" "tsi" "tso" "tsn" "tum" "tur" "ota" "tuk" "tyv" "twi" "uga" "uig" "ukr" "umb" "und" "urd" "uzb" "vai" "ven" "vie" "vol" "vot" "wak" "wal" "war" "was" "cym/wel" "wol" "xho" "sah" "yao" "yap" "yid" "yor" "zap" "zen" "zha" "zul" "zun" The following SGML-encoded summary of the language codes of ISO 639 was prepared by Harry Gaylord. The two-letter codes are from the present ISO 639 standard. The three letter-codes are the current proposals in ISO CD 639/2 Draft dated 10/15/92 of the working group revising 639 for TC 3 and TC 46 of ISO and may be revised, amended, or changed before the new ISO standard is issued. |
| localCurrencies | Array of strings or strings (local currencies array) <= 5 items country settings includes relevant information specifically related to a country and common to all its sites |
| foreignCurrencies | Array of strings or strings (foreign currencies array) <= 5 items country settings includes relevant information specifically related to a country and common to all its sites |
{- "volumeUnit": "str",
- "levelUnit": "str",
- "temperatureUnit": "str",
- "countryCode": "AF",
- "language": "abk",
- "localCurrencies": [
- "AED"
], - "foreignCurrencies": [
- "AED"
]
}details for couponRedeemedObject
| redeemedCouponID required | string (redeemedCouponIDType) [ 1 .. 80 ] characters The identification of the redeemed coupon. |
| primaryCompanyPrefix | string (primaryCompanyPrefixType) <= 40 characters Prefix for identifying Coupons, variable portion (6-12 digits) of the GS1 'GLN' - 13 digits including check digit. |
| offerCode | integer (offerCodeType) [ 0 .. 10000000000000000 ] Offer code for a coupon, should be a GS1 'GCN' - 13 digits. |
| couponExpirationDate | string <date> (dateType) <= 10 characters ISO 8601 Date Type to align with XML Schema. |
{- "redeemedCouponID": "string",
- "primaryCompanyPrefix": "string",
- "offerCode": 0,
- "couponExpirationDate": "2020-06-23"
}details for depthObject
| value required | string (decimal16BaseType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ 16,5 decimal value |
| unit | string or string (unitOfMeasurementEENUMType) enum values excerpted from IFSF Engineering Bulletin 14 (UN/ECE Rec 20) |
{- "value": "string",
- "unit": "str"
}details for discountObject
| discountVolume | object (volumeUNObject) |
| discountQuantity | object (quantityUNObject) |
| discountAmount required | object (amountObject) |
| discountReason | string or string (discountReasonEENUMType) A reason code indicating why the item/merchandise was discounted defined by Conexxus (base type). |
| discountID | string (discountIDType) [ 1 .. 40 ] characters A reference string for identifying a discount. |
| itemTaxes | Array of objects (taxObject) Description of the specific discount recorded. Choice of DiscountVolume or DiscountQuantity. |
| transactionTaxes | Array of objects (taxObject) Description of the specific discount recorded. Choice of DiscountVolume or DiscountQuantity. |
{- "discountVolume": {
- "value": "string",
- "uom": "MLT"
}, - "discountQuantity": {
- "value": "string",
- "uom": "GRM"
}, - "discountAmount": {
- "value": "string",
- "currency": "AED"
}, - "discountReason": "storeCouponOffer",
- "discountID": "string",
- "itemTaxes": [
- {
- "taxLevelID": "stri",
- "taxableSalesAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxCollectedAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxableSalesRefundedAmount": null,
- "taxRefundedAmount": null,
- "taxExemptSalesAmount": null,
- "taxExemptAmount": null,
- "taxExemptSalesRefundedAmount": null,
- "taxExemptReason": null,
- "taxForgivenSalesAmount": null,
- "taxForgivenSalesRefundedAmount": null,
- "taxForgivenAmount": null,
- "taxForgivenReason": null
}
], - "transactionTaxes": [
- {
- "taxLevelID": "stri",
- "taxableSalesAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxCollectedAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxableSalesRefundedAmount": null,
- "taxRefundedAmount": null,
- "taxExemptSalesAmount": null,
- "taxExemptAmount": null,
- "taxExemptSalesRefundedAmount": null,
- "taxExemptReason": null,
- "taxForgivenSalesAmount": null,
- "taxForgivenSalesRefundedAmount": null,
- "taxForgivenAmount": null,
- "taxForgivenReason": null
}
]
}details for dispenserConfigurationObject
| dispenserID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| fuelProducts | Array of objects (fuelProductObject) <= 8 items |
| limits | Array of objects (limitObject) <= 8 items |
| pumpTimeout | integer [ 1 .. 60 ] Timeout for a pump auth, in seconds |
| fuelingPoints | Array of objects (fuelingPointConfigurationObject) <= 4 items |
{- "dispenserID": "string",
- "fuelProducts": [
- {
- "productNo": 0,
- "productCategory": 0,
- "productID": {
- "productName": "string",
- "description": "string"
}, - "productCode": 0,
- "merchandiseCode": "string",
- "prices": [
- {
- "fuelUnitPrice": {
- "value": "string",
- "currency": "AED"
}, - "priceTier": "cash",
- "modeNo": 0
}
], - "taxID": "string"
}
], - "limits": [
- {
- "productNo": 0,
- "modeNo": 0,
- "maxTrxAmount": {
- "value": "string",
- "currency": "AED"
}, - "maxTrxVolume": {
- "value": "string",
- "uom": "GRM"
}
}
], - "pumpTimeout": 1,
- "fuelingPoints": [
- {
- "fuelingPointID": "string",
- "pumpNo": 0,
- "defaultFuelingMode": 0,
- "maxTrxAmount": {
- "value": "string",
- "currency": "AED"
}, - "maxTrxVolume": {
- "value": "string",
- "uom": "GRM"
}, - "serviceLevel": "F",
- "nozzles": [
- {
- "nozzleNo": 0,
- "nozzleName": "string",
- "productNo": 0,
- "tankNo1": 0,
- "tankNo2": 0,
- "blendRatio": 0
}
]
}
]
}details for fuelGradeIDObject
| value required | string (id40BaseType) [ 1 .. 40 ] characters 40 character ID |
| paymentSystemsProductCode | string (paymentSystemsProductCodeType) [ 2 .. 5 ] characters ^[0-9]{2,5}$ Conexxus Payment System Product Codes and/or the underlying standard (X9.104) for which Conexxus is the Registration Authority, published by ACS X9, Inc. |
{- "value": "string",
- "paymentSystemsProductCode": "strin"
}details for fuelModesObject
| modeNo | integer (modeNoType) [ 0 .. 99 ] mode No is an unsigned integer used to identify the different modes to dispatch fuel products, like self service of full |
| modeName | string (description16BaseType) <= 16 characters 16 character description. |
{- "modeNo": 0,
- "modeName": "string"
}details for fuelProductObject
| productNo required | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| productCategory | integer (productCategoryType) [ 0 .. 99999999 ] the product category value determine how the POS treats the data coming from the dispenser |
| productID | object |
| productCode required | integer (productCodeType) [ 0 .. 99999999 ] product code provides a classification of the fuel product |
| merchandiseCode | string (description40BaseType) <= 40 characters 40 character description. |
| prices | Array of objects <= 100 items |
| taxID | string |
{- "productNo": 0,
- "productCategory": 0,
- "productID": {
- "productName": "string",
- "description": "string"
}, - "productCode": 0,
- "merchandiseCode": "string",
- "prices": [
- {
- "fuelUnitPrice": {
- "value": "string",
- "currency": "AED"
}, - "priceTier": "cash",
- "modeNo": 0
}
], - "taxID": "string"
}details for fuelStockIDObject
| value | string (id40BaseType) [ 1 .. 40 ] characters 40 character ID |
| paymentSystemsProductCode | string (paymentSystemsProductCodeType) [ 2 .. 5 ] characters ^[0-9]{2,5}$ Conexxus Payment System Product Codes and/or the underlying standard (X9.104) for which Conexxus is the Registration Authority, published by ACS X9, Inc. |
{- "value": "string",
- "paymentSystemsProductCode": "strin"
}details for fuelingPointAuthorizeObject
| fuelingPointID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| maxTrxAmount | object (monetaryAmount20Object) |
| maxTrxVolume | object (quantityUNObject) |
| modeNo | integer (modeNoType) [ 0 .. 99 ] mode No is an unsigned integer used to identify the different modes to dispatch fuel products, like self service of full |
| releasedProducts | Array of objects <= 8 items data structure which defines the fueling point authorization request |
| releaseToken | string <= 8 characters data structure which defines the fueling point authorization request |
| lockFuelSaleTrx | string <= 8 characters Enum: true false data structure which defines the fueling point authorization request |
| consentNeeded | string <= 5 characters Default: "false" Enum: true false |
{- "fuelingPointID": "string",
- "maxTrxAmount": {
- "value": "string",
- "currency": "AED"
}, - "maxTrxVolume": {
- "value": "string",
- "uom": "GRM"
}, - "modeNo": 0,
- "releasedProducts": [
- {
- "productNo": 0,
- "customerActionNeedsConsent": "false"
}
], - "releaseToken": "string",
- "lockFuelSaleTrx": true,
- "consentNeeded": "false"
}details for fuelingPointConfigurationObject
| fuelingPointID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| pumpNo required | integer (pumpNoType) [ 0 .. 9999 ] pump No is the unique identifier of a pump. |
| defaultFuelingMode | integer (modeNoType) [ 0 .. 99 ] mode No is an unsigned integer used to identify the different modes to dispatch fuel products, like self service of full |
| maxTrxAmount | object (monetaryAmount20Object) |
| maxTrxVolume | object (quantityUNObject) |
| serviceLevel | string Enum: "F" "S" Service Level (F or S). Full or Self |
| nozzles | Array of objects (nozzleObject) <= 8 items |
{- "fuelingPointID": "string",
- "pumpNo": 0,
- "defaultFuelingMode": 0,
- "maxTrxAmount": {
- "value": "string",
- "currency": "AED"
}, - "maxTrxVolume": {
- "value": "string",
- "uom": "GRM"
}, - "serviceLevel": "F",
- "nozzles": [
- {
- "nozzleNo": 0,
- "nozzleName": "string",
- "productNo": 0,
- "tankNo1": 0,
- "tankNo2": 0,
- "blendRatio": 0
}
]
}details for fuelingPointConsentAuthorizeObject
| fuelingPointID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| releasedProducts | Array of objects <= 8 items data structure which defines the fueling point authorization request |
| consentGiven | string <= 5 characters Default: "true" Enum: true false |
{- "fuelingPointID": "string",
- "releasedProducts": [
- {
- "productNo": 0,
- "customerConsentGiven": "false"
}
], - "consentGiven": "true"
}details for fuelingPointTotalsObject
| fuelingPointID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| pumpNo required | integer (pumpNoType) [ 0 .. 9999 ] pump No is the unique identifier of a pump. |
| nozzleNo required | integer (nozzleNoType) [ 0 .. 99 ] nozzle No is the unique identifier of a nozzle |
| amount | object (monetaryAmount20Object) |
| volume | object (quantityUNObject) |
| volumeProduct1 | object (quantityUNObject) |
| volumeProduct2 | object (quantityUNObject) |
| productNo1 | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| productNo2 | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| errorCode | string or string <= 40 characters error code is an string of characters used to identify specific errors of a transaction |
{- "fuelingPointID": "string",
- "pumpNo": 0,
- "nozzleNo": 0,
- "amount": {
- "value": "string",
- "currency": "AED"
}, - "volume": {
- "value": "string",
- "uom": "GRM"
}, - "volumeProduct1": {
- "value": "string",
- "uom": "GRM"
}, - "volumeProduct2": {
- "value": "string",
- "uom": "GRM"
}, - "productNo1": 0,
- "productNo2": 0,
- "errorCode": "ERRCD_OK"
}details for fuelingStatusObject
| fuelingPointID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| pumpNo required | integer (pumpNoType) [ 0 .. 9999 ] pump No is the unique identifier of a pump. |
| transactionSeqNo required | integer (transactionSeqNoType) [ 0 .. 99999999 ] transactionSeqNo is the unique identifier of a transaction |
| currentAmount | object (monetaryAmount20Object) |
| currentVolume | object (quantityUNObject) |
| currentUnitPrice | object (price10Object) |
| currentNozzleNo | integer (nozzleNoType) [ 0 .. 99 ] nozzle No is the unique identifier of a nozzle |
| releaseToken | string <= 8 characters It is taken from Dispenser Standard Release Token, which is Bin 8 pattern "[0-9A-F][0-9A-F]" |
| authorizationApplicationSender | string (description100BaseType) <= 100 characters 100 character description. |
| errorCode | string or string <= 40 characters error code is an string of characters used to identify specific errors of a transaction |
{- "fuelingPointID": "string",
- "pumpNo": 0,
- "transactionSeqNo": 0,
- "currentAmount": {
- "value": "string",
- "currency": "AED"
}, - "currentVolume": {
- "value": "string",
- "uom": "GRM"
}, - "currentUnitPrice": {
- "value": "string",
- "currency": "AED"
}, - "currentNozzleNo": 0,
- "releaseToken": "string",
- "authorizationApplicationSender": "string",
- "errorCode": "ERRCD_OK"
}details for geoCoordinatesObject
| latitude required | number <double> [ -90 .. 90 ] the geoCoordinates are a unique identifier of a precise geographic location on the earth |
| longitude required | number <double> [ -180 .. 180 ] the geoCoordinates are a unique identifier of a precise geographic location on the earth |
| angleUOM | string <= 25 characters Enum: "radians" "decimal degrees" "decimal dd.mm.ss" the geoCoordinates are a unique identifier of a precise geographic location on the earth |
| datum | string <= 8 characters the geoCoordinates are a unique identifier of a precise geographic location on the earth |
{- "latitude": -90,
- "longitude": -180,
- "angleUOM": "radians",
- "datum": "string"
}details for giskeKeyHeaderObject
| keyUsage required | (giskeKeyUsageEENUMType (string or string)) or string Global Interoperable Secure Key Exchange Key Block Specification V2.3a Key Header. Before a key in the Key Block format is used in a Tamper Resistant Security Module (TRSM), the content of the header block must be validated to ensure the correct usage is enforced. The Key Usage byte is typically checked first followed by the Algorithm byte. The other header bytes may or may not be checked depending on the key usage and the algorithm used. |
| algorithm required | (giskeAlgorithmEENUMType (string or string)) or string Global Interoperable Secure Key Exchange Key Block Specification V2.3a Key Header. Before a key in the Key Block format is used in a Tamper Resistant Security Module (TRSM), the content of the header block must be validated to ensure the correct usage is enforced. The Key Usage byte is typically checked first followed by the Algorithm byte. The other header bytes may or may not be checked depending on the key usage and the algorithm used. |
| modeOfUse required | (giskeModeOfUseEENUMType (string or string)) or string Global Interoperable Secure Key Exchange Key Block Specification V2.3a Key Header. Before a key in the Key Block format is used in a Tamper Resistant Security Module (TRSM), the content of the header block must be validated to ensure the correct usage is enforced. The Key Usage byte is typically checked first followed by the Algorithm byte. The other header bytes may or may not be checked depending on the key usage and the algorithm used. |
| exportability required | (giskeExportabilityEENUMType (string or string)) or string Global Interoperable Secure Key Exchange Key Block Specification V2.3a Key Header. Before a key in the Key Block format is used in a Tamper Resistant Security Module (TRSM), the content of the header block must be validated to ensure the correct usage is enforced. The Key Usage byte is typically checked first followed by the Algorithm byte. The other header bytes may or may not be checked depending on the key usage and the algorithm used. |
{- "keyUsage": "dataEncryption",
- "algorithm": "3des",
- "modeOfUse": "noSpecialRestrictions",
- "exportability": "sensitive"
}details for groupCodeObject
| value required | string (id16BaseType) [ 1 .. 16 ] characters 16 character ID |
| index | string (id4BaseType) [ 1 .. 4 ] characters 4 character ID |
| type | string <= 8 characters Enum: "pointer" "text" GroupCode is a mechanism for grouping items independently of merchandise code or other hierarchy. |
{- "value": "string",
- "index": "stri",
- "type": "pointer"
}details for itemCodeObject
| posCodeFormat required | object (posCodeFormatObject) |
| posCode required | string (posCodeType) <= 24 characters ^[0-9]{1,24}$ |
| posCodeModifier required | object (posCodeModifierObject) |
| inventoryItemID | string (itemIDType) [ 1 .. 40 ] characters Generic ID for items and links to them. |
{- "posCodeFormat": {
- "format": "upcA",
- "checkDigit": "present"
}, - "posCode": "string",
- "posCodeModifier": {
- "value": "stri",
- "name": "string"
}, - "inventoryItemID": "string"
}details for lengthUNObject
| value | string (decimal12BaseType) <= 18 characters ^\-?[0-9]{0,12}(\.[0-9]{1,5})?$ 12,5 decimal value |
| uom | string (lengthUNUOMENUMType) <= 3 characters Enum: "MMT" "CMT" "MTR" "KMT" "INH" "FOT" "YRD" "SMI" uom designation for lengths (widths, depths, etc.). |
{- "value": "string",
- "uom": "MMT"
}details for limitObject
| productNo required | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| modeNo required | integer (modeNoType) [ 0 .. 99 ] mode No is an unsigned integer used to identify the different modes to dispatch fuel products, like self service of full |
| maxTrxAmount | object (monetaryAmount20Object) |
| maxTrxVolume | object (quantityUNObject) |
{- "productNo": 0,
- "modeNo": 0,
- "maxTrxAmount": {
- "value": "string",
- "currency": "AED"
}, - "maxTrxVolume": {
- "value": "string",
- "uom": "GRM"
}
}details for manufacturerCouponObject
| primaryLabelID | string (primaryLabelIDType) [ 1 .. 16 ] characters ^[0-9]{1,16}$ The primary label from a coupon. |
| extendedLabelID | string (extendedLabelIDType) [ 1 .. 16 ] characters ^[0-9]{1,16}$ An extra label from a coupon. |
| manufacturerID required | string (manufacturerIDType) [ 1 .. 8 ] characters An identifier for the manufacturer that issued the coupon. |
| familyCode required | string (familyCodeType) [ 1 .. 3 ] characters ^[0-9]{1,3}$ That portion of a U.P.C. on a manufacturer's coupon used to identify an item's grouping for discount purposes. |
| couponExpirationDate required | string <date> (dateType) <= 10 characters ISO 8601 Date Type to align with XML Schema. |
| promotionCode | string (promotionCodeType) [ 1 .. 8 ] characters The kind of promotion the coupon is part of. |
{- "primaryLabelID": "string",
- "extendedLabelID": "string",
- "manufacturerID": "string",
- "familyCode": "str",
- "couponExpirationDate": "2020-06-23",
- "promotionCode": "string"
}details for massUNObject
| value required | string (decimal12BaseType) <= 18 characters ^\-?[0-9]{0,12}(\.[0-9]{1,5})?$ 12,5 decimal value |
| uom | string (massUNUOMENUMType) <= 3 characters Enum: "GRM" "KGM" "ONZ" "LBR" Unit of measure indicating weight (mass). |
{- "value": "string",
- "uom": "GRM"
}details for merchandiseCodeObject
| level | string (id4NBaseType) [ 1 .. 4 ] characters ^[0-9]{1,4}$ 4 digit numeric ID |
| value required | string (merchandiseCodeType) <= 40 characters ^([0-9]{1,16}(\.[0-9]{1,16}){0,6})$ Enhanced MerchandiseCode type to support hierarchical MerchandiseCodes. |
{- "level": "stri",
- "value": "string"
}details for mimeEncodedDataObject
| mimeType | string (mimeTypeType) [ 1 .. 40 ] characters MIME type for binary data. |
| data | string $((([A-Za-z0-9+/] ?){4})*(([A-Za-z0-9+/] ?){3}[A-Za-z0-9+/]|([A-Za-z0-9+/] ?){2}[AEIMQUYcgkosw048] ?=|[A-Za-z0-9+/] ?[AQgw] ?= ?=))? Base 64 binary encoded data (per XML Schema Part 2), with accompanying MIME-type. |
{- "mimeType": "string",
- "data": "string"
}details for monetaryAmount20Object
| value required | string (decimal16BaseType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ 16,5 decimal value |
| currency | string or string (currencyEENUMType) ISO-4217 / UN/ECE REC 09 Codes |
{- "value": "string",
- "currency": "AED"
}details for nozzleObject
| nozzleNo required | integer (nozzleNoType) [ 0 .. 99 ] nozzle No is the unique identifier of a nozzle |
| nozzleName | string (description40BaseType) <= 40 characters 40 character description. |
| productNo required | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| tankNo1 required | integer (tankNoType) [ 0 .. 9999 ] tankNo is used to identify a fuel container at a service station. The tank number in a TP (Tank Probe) structure is used to number TPs consecutively |
| tankNo2 | integer (tankNoType) [ 0 .. 9999 ] tankNo is used to identify a fuel container at a service station. The tank number in a TP (Tank Probe) structure is used to number TPs consecutively |
| blendRatio required | integer (integerUnsigned2BaseType) [ 0 .. 99 ] 2 digit numeric value |
{- "nozzleNo": 0,
- "nozzleName": "string",
- "productNo": 0,
- "tankNo1": 0,
- "tankNo2": 0,
- "blendRatio": 0
}details for nozzleStateObject
| nozzleNo required | integer (nozzleNoType) [ 0 .. 99 ] nozzle No is the unique identifier of a nozzle |
| logicalNozzle | string <= 16 characters Enum: "nozzleUp" "nozzleDown" state of a specific nozzle to get (used in FDC to get fueling point status) |
| logicalState | string <= 16 characters Enum: "locked" "unlocked" state of a specific nozzle to get (used in FDC to get fueling point status) |
| tankLogicalState | string <= 16 characters Enum: "locked" "unlocked" state of a specific nozzle to get (used in FDC to get fueling point status) |
{- "nozzleNo": 0,
- "logicalNozzle": "nozzleUp",
- "logicalState": "locked",
- "tankLogicalState": "locked"
}details for periodObject
| type required | string period is used in the day end process to identify the period to be closed |
| id required | integer <int64> >= 1 period is used in the day end process to identify the period to be closed |
| beginDateTime required | string <date-time> (dateTimeType) [ 10 .. 30 ] characters |
{- "type": "string",
- "id": 1,
- "beginDateTime": "2020-06-23T16:37:36Z"
}details for phoneNumberObject
| type required | string or string (phoneLineTypeEENUMType) The type of phone line (extendable). |
| number required | string (phoneNumberStringType) <= 14 characters ^[0-9\-\(\)\B]{,14}$ String roughly constrained to handle phone numbers and common delimiting characters. |
{- "type": "mobile",
- "number": "string"
}details for posCodeFormatObject
| format required | string or string (posCodeFormatEENUMType) |
| checkDigit | string <= 10 characters Enum: "present" "absent" Indicates whether checkdigit is present or absent. |
{- "format": "upcA",
- "checkDigit": "present"
}details for posCodeModifierObject
| value required | string (id4NBaseType) [ 1 .. 4 ] characters ^[0-9]{1,4}$ 4 digit numeric ID |
| name | string (description16BaseType) <= 16 characters 16 character description. |
{- "value": "stri",
- "name": "string"
}details for posTerminalObject
| terminalID required | integer (integerUnsigned2BaseType) [ 0 .. 99 ] 2 digit numeric value |
| terminalType | string (description24BaseType) <= 24 characters 24 character description. |
| description | string (description100BaseType) <= 100 characters 100 character description. |
{- "terminalID": 0,
- "terminalType": "string",
- "description": "string"
}details for price10Object
| value required | string <= 10 characters [0-9]*[.][0-9][0-9]* a price is a positive decimal so its value is equivalent to a decimal type except for the sign |
| currency | string or string (currencyEENUMType) ISO-4217 / UN/ECE REC 09 Codes |
{- "value": "string",
- "currency": "AED"
}details for priceOverrideObject
| priceOverridePrice required | object (amountObject) |
| priceOverrideApproverID required | string (approverIDType) [ 1 .. 40 ] characters An identifier for the cashier or manager that approved the SaleEvent, RefundEvent, VoidEvent or TransactionLine. |
| priceOverrideReason required | string or string (repriceReasonEENUMType) (remove?) |
{- "priceOverridePrice": {
- "value": "string",
- "currency": "AED"
}, - "priceOverrideApproverID": "string",
- "priceOverrideReason": "emp"
}details for pricePoleConfigurationObject
| pricePoleID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| pricePolePoint | object |
{- "pricePoleID": "string",
- "pricePolePoint": {
- "pricePolePointID": "string",
- "signNo": 0,
- "manualMode": true,
- "segments": [
- {
- "segmentNo": 0,
- "productNo": 0,
- "productName": "string",
- "productPrice": {
- "value": "string",
- "currency": "AED"
}, - "modeNo": 0
}
]
}
}details for promotionObject
| promotionID required | string (id40BaseType) [ 1 .. 40 ] characters 40 character ID |
| promotionReason | string or string (promotionReasonEENUMType) A reason code indicating why the item/merchandise was promo'ed defined by Conexxus (base type). |
| promotionAmount | object (amountObject) |
{- "promotionID": "string",
- "promotionReason": "combinationOffer",
- "promotionAmount": {
- "value": "string",
- "currency": "AED"
}
}details for quantityUNObject
| value required | string (decimal12BaseType) <= 18 characters ^\-?[0-9]{0,12}(\.[0-9]{1,5})?$ 12,5 decimal value |
| uom | massUNUOMENUMType (string) or volumeUNUOMENUMType (string) or lengthUNUOMENUMType (string) or string or string (quantityUNUOMEENUMType) Quanity UOM made of massUOM, volumeUOM, lengthUOM, adding 'each'. |
{- "value": "string",
- "uom": "GRM"
}details for reportPeriodObject
| value required | dateType (string) or dateTimeType (string) or string (reportPeriodType) Label for a report, one of a date, a dateTime, or a string of 12 characters. |
| interval | string (intervalENUMType) <= 16 characters Enum: "cashier" "day" "week" "month" "year" "daypart" "shift" "transaction" "sBatch" "hostBatch" "other" Sometimes refered to as 'day part' values, refers to the scoped period of a report. |
{- "value": "2020-06-23",
- "interval": "cashier"
}details for segmentObject
| segmentNo required | integer (segmentNoType) [ 0 .. 9999 ] segment No is the unique identification of a segment within a price pole |
| productNo required | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| productName required | string (productNameType) <= 16 characters fuel product name is the unique identification of fuel sold at Service stations and C-Stores |
| productPrice required | object (price10Object) |
| modeNo required | integer (modeNoType) [ 0 .. 99 ] mode No is an unsigned integer used to identify the different modes to dispatch fuel products, like self service of full |
{- "segmentNo": 0,
- "productNo": 0,
- "productName": "string",
- "productPrice": {
- "value": "string",
- "currency": "AED"
}, - "modeNo": 0
}details for siteIDObject
| type required | string (description16BaseType) <= 16 characters 16 character description. |
| ID required | string (description8BaseType) <= 8 characters 8 character description. |
{- "type": "string",
- "ID": "string"
}details for siteTraitObject
| value | string (description255BaseType) <= 255 characters 255 character description. |
| siteTraitName | string (description24BaseType) <= 24 characters 24 character description. |
{- "value": "string",
- "siteTraitName": "string"
}details for softwareComponentObject
| itemID required | string (description40BaseType) <= 40 characters 40 character description. |
| name required | string (description100BaseType) <= 100 characters 100 character description. |
| manufacturerID required | string (description40BaseType) <= 40 characters 40 character description. |
| manufacturerName required | string (description100BaseType) <= 100 characters 100 character description. |
| applicationName required | string (description100BaseType) <= 100 characters 100 character description. |
| applicationSoftwareVersion required | string (description8BaseType) <= 8 characters 8 character description. |
| applicationType required | string <= 5 characters Enum: "chp" "agent" An individual software component is a software package, a web service, a web resource, or a module that encapsulates a set of related functions (or data) |
| protocol required | string (description16BaseType) <= 16 characters 16 character description. |
| protocolVersion required | string (description8BaseType) <= 8 characters 8 character description. |
| checksum required | string (description100BaseType) <= 100 characters 100 character description. |
| build required | string (description40BaseType) <= 40 characters 40 character description. |
| buildDate required | string <date-time> (dateTimeType) [ 10 .. 30 ] characters |
{- "itemID": "string",
- "name": "string",
- "manufacturerID": "string",
- "manufacturerName": "string",
- "applicationName": "string",
- "applicationSoftwareVersion": "string",
- "applicationType": "chp",
- "protocol": "string",
- "protocolVersion": "string",
- "checksum": "string",
- "build": "string",
- "buildDate": "2020-06-23T16:37:37Z"
}details for tankLevelGaugeConfigurationObject
| tankLevelGaugeID | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| tankProbes | Array of objects (tankProbeObject) <= 31 items |
{- "tankLevelGaugeID": "string",
- "tankProbes": [
- {
- "tankProbeID": "string",
- "tankNo": 0,
- "tankName": "string",
- "productNo": 0,
- "productName": "string",
- "manualMode": true,
- "shellCapacity": "string",
- "maxSafeFillCap": "string",
- "lowCapacity": "string",
- "minOperatingCapacity": "string",
- "tankManifoldPartners": [
- {
- "tankNo": 0
}
], - "setPoints": {
- "hiHiLevel": 0,
- "hiLevel": 0,
- "loLevel": 0,
- "loLoLevel": 0,
- "hiWater": 0
}
}
]
}details for tankObject
| tankNo required | integer (tankNoType) [ 0 .. 9999 ] tankNo is used to identify a fuel container at a service station. The tank number in a TP (Tank Probe) structure is used to number TPs consecutively |
| tankName required | string (description40BaseType) <= 40 characters 40 character description. |
| description | string (description40BaseType) <= 40 characters 40 character description. |
| tankGroupNo | integer (tankGroupNoType) [ 0 .. 9999 ] tank group number is the unique identifier of the tank group on a retail store |
| label | string (description40BaseType) <= 40 characters 40 character description. |
| productNo required | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| productID required | object |
{- "tankNo": 0,
- "tankName": "string",
- "description": "string",
- "tankGroupNo": 0,
- "label": "string",
- "productNo": 0,
- "productID": {
- "productName": "string",
- "description": "string"
}
}details for tankProbeMeasurementDataObject
| tankProbeID required | object (tankProbeIDElement) |
| tank required | object (tankObject) |
| timestamp | string <date-time> (dateTimeType) [ 10 .. 30 ] characters |
| readingType | string or string (readingTypeEENUMType) <= 15 characters ^[A-Z][A-Za-z]{2,14} reading type is an string of characters used to indicate how the reading of a tank was obtained |
| deliveryInProgress | string or string (yesNoEENUMType) <= 6 characters boolean definition |
| grossObservedVolumes | Array of objects (quantityUNObject) <= 10 items data structure which describes the details of the stock within a tank |
| observedVolume required | object (quantityUNObject) |
| productLevel | object (quantityUNObject) |
| averageTemp | object (temperatureUNObject) |
| fuelTemperatures | Array of objects <= 10 items data structure which describes the details of the stock within a tank |
| ullage | object (quantityUNObject) |
| operatingUllage | object (quantityUNObject) |
| waterDepths | Array of objects (quantityUNObject) <= 10 items data structure which describes the details of the stock within a tank |
| waterLevel | integer (levelType) [ 0 .. 99999999 ] level value as used for level readings by tank level gauges. Level is an unsigned integer from "0" to "99999999" |
| observedDensity | string (decimal16BaseType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ 16,5 decimal value |
| temperatureCompensated | string (yesNoENUMType) <= 4 characters Enum: "yes" "no" Yes or no value, used as a more flexible option to true/false. |
| userID | object (userIDElement) |
| userName | object (userNameElement) |
{- "tankProbeID": {
- "tankProbeID": "string"
}, - "tank": {
- "tankNo": 0,
- "tankName": "string",
- "description": "string",
- "tankGroupNo": 0,
- "label": "string",
- "productNo": 0,
- "productID": {
- "productName": "string",
- "description": "string"
}
}, - "timestamp": "2020-06-23T16:37:37Z",
- "readingType": "Auto",
- "deliveryInProgress": "yes",
- "grossObservedVolumes": [
- {
- "value": "string",
- "uom": "GRM"
}
], - "observedVolume": {
- "value": "string",
- "uom": "GRM"
}, - "productLevel": {
- "value": "string",
- "uom": "GRM"
}, - "averageTemp": {
- "value": -9999,
- "temperatureUOM": "CEL"
}, - "fuelTemperatures": [
- {
- "value": -9999,
- "temperatureUOM": "CEL"
}
], - "ullage": {
- "value": "string",
- "uom": "GRM"
}, - "operatingUllage": {
- "value": "string",
- "uom": "GRM"
}, - "waterDepths": [
- {
- "value": "string",
- "uom": "GRM"
}
], - "waterLevel": 0,
- "observedDensity": "string",
- "temperatureCompensated": "yes",
- "userID": {
- "userID": "string"
}, - "userName": {
- "userName": "string"
}
}details for tankProbeObject
| tankProbeID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| tankNo required | integer (tankNoType) [ 0 .. 9999 ] tankNo is used to identify a fuel container at a service station. The tank number in a TP (Tank Probe) structure is used to number TPs consecutively |
| tankName | string (description40BaseType) <= 40 characters 40 character description. |
| productNo required | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| productName required | string (productNameType) <= 16 characters fuel product name is the unique identification of fuel sold at Service stations and C-Stores |
| manualMode required | string <= 8 characters Enum: true false manual mode true or false |
| shellCapacity | string (decimal16BaseType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ 16,5 decimal value |
| maxSafeFillCap | string (decimal16BaseType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ 16,5 decimal value |
| lowCapacity | string (decimal16BaseType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ 16,5 decimal value |
| minOperatingCapacity | string (decimal16BaseType) <= 22 characters ^\-?[0-9]{0,16}(\.[0-9]{1,5})?$ 16,5 decimal value |
| tankManifoldPartners | Array of objects <= 8 items |
| setPoints | object See Engineering Bulletin No 11. BCD 8 |
{- "tankProbeID": "string",
- "tankNo": 0,
- "tankName": "string",
- "productNo": 0,
- "productName": "string",
- "manualMode": true,
- "shellCapacity": "string",
- "maxSafeFillCap": "string",
- "lowCapacity": "string",
- "minOperatingCapacity": "string",
- "tankManifoldPartners": [
- {
- "tankNo": 0
}
], - "setPoints": {
- "hiHiLevel": 0,
- "hiLevel": 0,
- "loLevel": 0,
- "loLoLevel": 0,
- "hiWater": 0
}
}details for taxObject
| taxLevelID required | string (taxLevelIDType) [ 1 .. 4 ] characters A pointer to the Tax Level Table or Rate. The values of the table specify the tax level being reported. It usually defines a tax rate or table. |
| taxableSalesAmount required | object (amountObject) |
| taxCollectedAmount required | object (amountObject) |
| taxableSalesRefundedAmount | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxRefundedAmount | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxExemptSalesAmount | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxExemptAmount | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxExemptSalesRefundedAmount | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxExemptReason | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxForgivenSalesAmount | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxForgivenSalesRefundedAmount | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxForgivenAmount | any Complete set of tax fields to describe taxes applied in a given situation. |
| taxForgivenReason | any Complete set of tax fields to describe taxes applied in a given situation. |
{- "taxLevelID": "stri",
- "taxableSalesAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxCollectedAmount": {
- "value": "string",
- "currency": "AED"
}, - "taxableSalesRefundedAmount": null,
- "taxRefundedAmount": null,
- "taxExemptSalesAmount": null,
- "taxExemptAmount": null,
- "taxExemptSalesRefundedAmount": null,
- "taxExemptReason": null,
- "taxForgivenSalesAmount": null,
- "taxForgivenSalesRefundedAmount": null,
- "taxForgivenAmount": null,
- "taxForgivenReason": null
}details for temperatureUNObject
| value | number (temperatureValueType) [ -9999 .. 9999 ] A numeric value that ranges over the common temperature scales. |
| temperatureUOM | string (temperatureUNUOMENUMType) <= 3 characters Enum: "CEL" "FAH" Temperature units of measure, following UN/ECE Rec 20. |
{- "value": -9999,
- "temperatureUOM": "CEL"
}details for tenderIDObject
| tenderCode | string or string (tenderCodeEENUMType) TenderCodes defined by Conexxus (base type). |
| tenderSubCode | string or string (tenderSubCodeEENUMType) TenderSubCodes defined by Conexxus (base type). |
{- "tenderCode": "cash",
- "tenderSubCode": "cash"
}details for transactionDetailsObject
| fuelingPointID required | string (deviceIDType) [ 1 .. 16 ] characters The identifier for a device which has raised an alert event. |
| pumpNo required | integer (pumpNoType) [ 0 .. 9999 ] pump No is the unique identifier of a pump. |
| nozzleNo required | integer (nozzleNoType) [ 0 .. 99 ] nozzle No is the unique identifier of a nozzle |
| transactionSeqNo required | integer (transactionSeqNoType) [ 0 .. 99999999 ] transactionSeqNo is the unique identifier of a transaction |
| transactionDate | string <date-time> (dateTimeType) [ 10 .. 30 ] characters |
| state | string (transactionAvailableStateENUMType) <= 7 characters ^[a-z]{6,7} Enum: "locked" "payable" "cleared" transactionAvailableState is used in fdc to identify the different states of an available transaction |
| releaseToken | string <= 8 characters It is taken from Dispenser Standard Release Token, which is Bin 8 pattern "[0-9A-F][0-9A-F]" |
| modeNo | integer (modeNoType) [ 0 .. 99 ] mode No is an unsigned integer used to identify the different modes to dispatch fuel products, like self service of full |
| productNo | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| amount | object (monetaryAmount20Object) |
| volume | object (quantityUNObject) |
| unitPrice | object (price10Object) |
| volumeProduct1 | object (quantityUNObject) |
| volumeProduct2 | object (quantityUNObject) |
| productNo1 | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| productNo2 | integer (productNoType) [ 0 .. 99999999 ] product No is the unique identification of the product at the service station |
| blendRatio | integer (integerUnsigned2BaseType) [ 0 .. 99 ] 2 digit numeric value |
| averageTemperature | object (quantityUNObject) |
| lockingApplicationSender | string (description100BaseType) <= 100 characters 100 character description. |
| authorisationApplicationSender | string (description100BaseType) <= 100 characters 100 character description. |
| DSPFields | string (description100BaseType) <= 100 characters 100 character description. |
| CRCMode | string (description100BaseType) <= 100 characters 100 character description. |
| errorCode | string or string <= 40 characters error code is an string of characters used to identify specific errors of a transaction |
{- "fuelingPointID": "string",
- "pumpNo": 0,
- "nozzleNo": 0,
- "transactionSeqNo": 0,
- "transactionDate": "2020-06-23T16:37:37Z",
- "state": "locked",
- "releaseToken": "string",
- "modeNo": 0,
- "productNo": 0,
- "amount": {
- "value": "string",
- "currency": "AED"
}, - "volume": {
- "value": "string",
- "uom": "GRM"
}, - "unitPrice": {
- "value": "string",
- "currency": "AED"
}, - "volumeProduct1": {
- "value": "string",
- "uom": "GRM"
}, - "volumeProduct2": {
- "value": "string",
- "uom": "GRM"
}, - "productNo1": 0,
- "productNo2": 0,
- "blendRatio": 0,
- "averageTemperature": {
- "value": "string",
- "uom": "GRM"
}, - "lockingApplicationSender": "string",
- "authorisationApplicationSender": "string",
- "DSPFields": "string",
- "CRCMode": "string",
- "errorCode": "ERRCD_OK"
}details for volumeUNObject
| value required | string (decimal12BaseType) <= 18 characters ^\-?[0-9]{0,12}(\.[0-9]{1,5})?$ 12,5 decimal value |
| uom | string (volumeUNUOMENUMType) <= 3 characters Enum: "MLT" "CMQ" "LTR" "OZA" "OZI" "PT" "PTI" "QT" "QTI" "GLL" "GLI" Unit of measure indicating volume. |
{- "value": "string",
- "uom": "MLT"
}details for decimal12BaseType
12,5 decimal value
"string"details for decimal16BaseType
16,5 decimal value
"string"details for description100BaseType
100 character description.
"string"details for description16BaseType
16 character description.
"string"details for description24BaseType
24 character description.
"string"details for description255BaseType
255 character description.
"string"details for description40BaseType
40 character description.
"string"details for description4BaseType
4 character description.
"stri"details for description8BaseType
8 character description.
"string"details for durationBaseType
"string"details for id16NBaseType
16 digit numeric ID
"string"details for integerUnsigned16BaseType
16 digit numeric value
0details for integerUnsigned2BaseType
2 digit numeric value
0details for integerUnsigned3BaseType
3 digit numeric value
0details for integerUnsigned4BaseType
4 digit numeric value
0details for integerUnsigned8BaseType
8 digit numeric value
0