Table of Contents
Namespace: http://pos.whentomanage.com/updx/transactions
Table 1. Element: UPDX_TRANSACTIONS
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
top level of the Universal POS DataXchange format: Transactional preferred date format is YYYY-MM-DD. Impossible dates, such as 2000-02-34, will not validate. preferred dateTime format is YYYY-MM-DDThh:mm:ss Year,month,dayThour,minute,second for dateTime datatypes. Impossible values, such as 2000-02-34T66:32:19, will not validate. Date Times/Times should all be in store local time. They do not include a timezone. Dates and times that are all zeros will cause an odd validation error "Code: 12, Description: Extra element [parent_element_name] in interleave" Preferred boolean values are 1 and 0, but acceptable boolean values are 1, 0, true, false |
Content Model |
VERSION ( ORDER )* , ( TIMESLIP )* , ( PAYMENT )* , ( DEPOSIT )* |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="UPDX_TRANSACTIONS"> <element name="VERSION"> <choice> <value>1.1</value> </choice> </element> <a:documentation>top level of the Universal POS DataXchange format: Transactional</a:documentation> <a:documentation>preferred date format is YYYY-MM-DD. Impossible dates, such as 2000-02-34, will not validate.</a:documentation> <a:documentation>preferred dateTime format is YYYY-MM-DDThh:mm:ss Year,month,dayThour,minute,second for dateTime datatypes. Impossible values, such as 2000-02-34T66:32:19, will not validate.</a:documentation> <a:documentation>Date Times/Times should all be in store local time. They do not include a timezone.</a:documentation> <a:documentation>Dates and times that are all zeros will cause an odd validation error "Code: 12, Description: Extra element [parent_element_name] in interleave"</a:documentation> <a:documentation>Preferred boolean values are 1 and 0, but acceptable boolean values are 1, 0, true, false</a:documentation> <interleave> <zeroOrMore> <element name="ORDER"> <a:documentation>A single party of one or more customers ordering and dining together</a:documentation> <a:documentation>ORDER ID is the POS assigned, unique ID for the order</a:documentation> <interleave> <element name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID is the employee responsible for the order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="START_TIME"> <a:documentation>date and time the order was opened in local time</a:documentation> <data type="dateTime"/> </element> <element name="END_TIME"> <a:documentation>date and time the order was closed in local time</a:documentation> <data type="dateTime"/> </element> <element name="REVENUE_CENTER_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TABLE_NUM"> <a:documentation>Human-meaningful number/name of table, not necessarily auto-generated by POS</a:documentation> <data type="string"/> </element> <element name="GUEST_COUNT"> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> <optional> <element name="REOPEN_TIME"> <a:documentation>Last date and time the order was reopened</a:documentation> <data type="dateTime"/> </element> <element name="REOPENED_BY"> <a:documentation>REOPENED_BY is the manager responsible for reopening the order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <oneOrMore> <element name="CHECK"> <a:documentation>A single division of an order, paid, most likely, by one part, but with possbily multiple payments</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>CHECK NUMBER is the POS assigned, unique counter for the order's checks, not necessarily starting at 1 for each order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">16777215</param> </data> </element> <element name="TOTAL"> <a:documentation>Total as would be listed for customer to pay on check. Includes auto-gratuity, exclusive tax, price paid for items. Does not include promo/comp amounts or regular TIPs paid. If there are multiple checks on an order, then the TOTAL only includes the portion paid on this check, which in general is less than the order total.</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_INCL_TOTAL"> <a:documentation>Tax totals of taxes included in items' prices</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCL_TOTAL"> <a:documentation>Tax totals of taxes not included in items' prices</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="AUTO_GRATUITY"> <a:documentation>Amount added to check for auto/forced gratuity</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="PROMO_TOTAL"> <a:documentation>Total promos/coupons applied to the check, should total up to amounts in items, if ITEM_PROMOs are present</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <optional> <element name="MODIFIED_TIME"> <a:documentation>Last date and time the check was edited</a:documentation> <data type="dateTime"/> </element> </optional> <oneOrMore> <element name="TRANSACTION"> <a:documentation>A single payment made towards amount due on a check</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>TRANSACTION NUMBER is the POS assigned, unique counter for the check's transactions, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="RECEIVED"> <a:documentation>Total amount given by customer not including TIPs. This is generally amount applied to check + change returned, and change will be calculated based on the difference between RECEIVED and APPLIED</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="APPLIED"> <a:documentation>Amount of payment applied to pay for order. Total recieved may be more than applied due to change returned</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TENDER_TYPE_ID"> <a:documentation>Type used in transaction</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <optional> <element name="ACCOUNT_ID"> <a:documentation>House account transaction was charged to</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <optional> <element name="TIP"> <a:documentation>Total tips paid</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> </optional> <optional> <element name="CC_TIP_FEE"> <a:documentation>Amount of service fee charged to tip recipient for credit card fees</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> </optional> <optional> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="PROMO_MANAGER_ID"> <a:documentation>EMPLOYEE ID of user who approved the promo/coupon</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <optional> <element name="VOUCHER_TYPE_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="VOUCHER_NUMBER"> <a:documentation>Store or POS assigned voucher number</a:documentation> <text/> </element> </optional> <optional> <element name="MODIFIED_TIME"> <a:documentation>Last date and time the transaction was edited</a:documentation> <data type="dateTime"/> </element> </optional> </interleave> </element> </oneOrMore> <zeroOrMore> <element name="ITEM"> <a:documentation>A primary item on the check/order. It does not modify any other items</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter per check, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="QUANTITY"> <a:documentation>Number of this item ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TAX_INCLUSIVE"> <a:documentation>Amount of price which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <optional> <element name="VOID_STATUS"> <a:documentation>Was the item voided?</a:documentation> <data type="boolean"/> </element> <element name="VOID_REASON_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="VOID_MANAGER_ID"> <a:documentation>who authorized the void</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <zeroOrMore> <element name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="MODIFIER"> <a:documentation>A modifying item on the check/order. It must be modifying an ITEM.</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>MODIFIER NUMBER is the POS assigned, unique counter per item's modifiers, not necessarily starting at 1 for each item</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ITEM_NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter of this modifier's parent item. It matches the NUMBER element from the proper ITEM.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="QUANTITY"> <a:documentation>Number of this modifier ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TAX_INCLUSIVE"> <a:documentation>Amount of PRICE which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <zeroOrMore> <element name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> </interleave> </element> </zeroOrMore> </interleave> </element> </oneOrMore> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="TIMESLIP"> <a:documentation>Unique ID of the timeslip. Generated by POS</a:documentation> <interleave> <element name="TIMESLIP_ID"> <a:documentation>Unique ID of the timeslip. Generated by POS</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">18446744073709551615</param> </data> </element> <element name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID who clocked in/out for timeslip.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="JOB_ID"> <a:documentation>JOB ID employee clocked in/out for.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="START_TIME"> <a:documentation>Date and time of clock in.</a:documentation> <data type="dateTime"/> </element> <element name="END_TIME"> <a:documentation>Date and time of clock out.</a:documentation> <data type="dateTime"/> </element> <element name="TOTAL_PAY"> <a:documentation>Total pay earned during shift, includes overtime pay</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> <element name="OVERTIME_MINS"> <a:documentation>Total overtime minutes worked during shift</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> <element name="OVERTIME_PAY"> <a:documentation>Overtime pay earned during shift</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> <element name="PAID_BREAKS_SECS"> <a:documentation>seconds of paid break taken during shift</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> <element name="UNPAID_BREAKS_SECS"> <a:documentation>seconds of unpaid break taken during shift</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> <element name="DECLARED_TIPS"> <a:documentation>cash tips declared upon clock out</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="PAYMENT"> <a:documentation>A single Paid In/Out</a:documentation> <a:documentation>PAYMENT ID is the POS assigned, unique ID for the payment</a:documentation> <interleave> <element name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID is the employee responsible for the payment</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="REASON_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="PAYMENT_DATE"> <a:documentation>PAYMENT date is actually a date + time. Be sure to include the full time stamp so that payments appear on the correct business day.</a:documentation> <data type="dateTime"/> </element> <element name="TENDER_TYPE_ID"> <a:documentation>Type used in payment</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="IN_OUT"> <a:documentation>IN = money into cash. OUT = money out of cash.</a:documentation> <choice> <value>IN</value> <value>OUT</value> </choice> </element> <optional> <element name="ACCOUNT_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="DEPOSIT"> <a:documentation>Bank Deposits made with cash. POS must assign a unique ID to each deposit.</a:documentation> <interleave> <element name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="DEPOSIT_DATE"> <a:documentation>date and time the deposit was made</a:documentation> <data type="dateTime"/> </element> </interleave> </element> </zeroOrMore> </interleave> </element> |
Table 2. Element: VERSION
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
( "1.1" ) |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="VERSION"> <choice> <value>1.1</value> </choice> </element> |
Table 3. Element: ORDER
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
A single party of one or more customers ordering and dining together ORDER ID is the POS assigned, unique ID for the order |
Content Model |
ID, EMPLOYEE_ID, START_TIME, END_TIME, REVENUE_CENTER_ID, TABLE_NUM, GUEST_COUNT, REOPEN_TIME, REOPENED_BY ? , ( CHECK )+ |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ORDER"> <a:documentation>A single party of one or more customers ordering and dining together</a:documentation> <a:documentation>ORDER ID is the POS assigned, unique ID for the order</a:documentation> <interleave> <element name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID is the employee responsible for the order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="START_TIME"> <a:documentation>date and time the order was opened in local time</a:documentation> <data type="dateTime"/> </element> <element name="END_TIME"> <a:documentation>date and time the order was closed in local time</a:documentation> <data type="dateTime"/> </element> <element name="REVENUE_CENTER_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TABLE_NUM"> <a:documentation>Human-meaningful number/name of table, not necessarily auto-generated by POS</a:documentation> <data type="string"/> </element> <element name="GUEST_COUNT"> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> <optional> <element name="REOPEN_TIME"> <a:documentation>Last date and time the order was reopened</a:documentation> <data type="dateTime"/> </element> <element name="REOPENED_BY"> <a:documentation>REOPENED_BY is the manager responsible for reopening the order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <oneOrMore> <element name="CHECK"> <a:documentation>A single division of an order, paid, most likely, by one part, but with possbily multiple payments</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>CHECK NUMBER is the POS assigned, unique counter for the order's checks, not necessarily starting at 1 for each order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">16777215</param> </data> </element> <element name="TOTAL"> <a:documentation>Total as would be listed for customer to pay on check. Includes auto-gratuity, exclusive tax, price paid for items. Does not include promo/comp amounts or regular TIPs paid. If there are multiple checks on an order, then the TOTAL only includes the portion paid on this check, which in general is less than the order total.</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_INCL_TOTAL"> <a:documentation>Tax totals of taxes included in items' prices</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCL_TOTAL"> <a:documentation>Tax totals of taxes not included in items' prices</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="AUTO_GRATUITY"> <a:documentation>Amount added to check for auto/forced gratuity</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="PROMO_TOTAL"> <a:documentation>Total promos/coupons applied to the check, should total up to amounts in items, if ITEM_PROMOs are present</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <optional> <element name="MODIFIED_TIME"> <a:documentation>Last date and time the check was edited</a:documentation> <data type="dateTime"/> </element> </optional> <oneOrMore> <element name="TRANSACTION"> <a:documentation>A single payment made towards amount due on a check</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>TRANSACTION NUMBER is the POS assigned, unique counter for the check's transactions, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="RECEIVED"> <a:documentation>Total amount given by customer not including TIPs. This is generally amount applied to check + change returned, and change will be calculated based on the difference between RECEIVED and APPLIED</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="APPLIED"> <a:documentation>Amount of payment applied to pay for order. Total recieved may be more than applied due to change returned</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TENDER_TYPE_ID"> <a:documentation>Type used in transaction</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <optional> <element name="ACCOUNT_ID"> <a:documentation>House account transaction was charged to</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <optional> <element name="TIP"> <a:documentation>Total tips paid</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> </optional> <optional> <element name="CC_TIP_FEE"> <a:documentation>Amount of service fee charged to tip recipient for credit card fees</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> </optional> <optional> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="PROMO_MANAGER_ID"> <a:documentation>EMPLOYEE ID of user who approved the promo/coupon</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <optional> <element name="VOUCHER_TYPE_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="VOUCHER_NUMBER"> <a:documentation>Store or POS assigned voucher number</a:documentation> <text/> </element> </optional> <optional> <element name="MODIFIED_TIME"> <a:documentation>Last date and time the transaction was edited</a:documentation> <data type="dateTime"/> </element> </optional> </interleave> </element> </oneOrMore> <zeroOrMore> <element name="ITEM"> <a:documentation>A primary item on the check/order. It does not modify any other items</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter per check, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="QUANTITY"> <a:documentation>Number of this item ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TAX_INCLUSIVE"> <a:documentation>Amount of price which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <optional> <element name="VOID_STATUS"> <a:documentation>Was the item voided?</a:documentation> <data type="boolean"/> </element> <element name="VOID_REASON_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="VOID_MANAGER_ID"> <a:documentation>who authorized the void</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <zeroOrMore> <element name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="MODIFIER"> <a:documentation>A modifying item on the check/order. It must be modifying an ITEM.</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>MODIFIER NUMBER is the POS assigned, unique counter per item's modifiers, not necessarily starting at 1 for each item</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ITEM_NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter of this modifier's parent item. It matches the NUMBER element from the proper ITEM.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="QUANTITY"> <a:documentation>Number of this modifier ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TAX_INCLUSIVE"> <a:documentation>Amount of PRICE which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <zeroOrMore> <element name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> </interleave> </element> </zeroOrMore> </interleave> </element> </oneOrMore> </interleave> </element> |
Table 4. Element: ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Unique ID |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 5. Element: EMPLOYEE_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
EMPLOYEE ID is the employee responsible for the order |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID is the employee responsible for the order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 6. Element: START_TIME
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
date and time the order was opened in local time |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="START_TIME"> <a:documentation>date and time the order was opened in local time</a:documentation> <data type="dateTime"/> </element> |
Table 7. Element: END_TIME
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
date and time the order was closed in local time |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="END_TIME"> <a:documentation>date and time the order was closed in local time</a:documentation> <data type="dateTime"/> </element> |
Table 8. Element: REVENUE_CENTER_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="REVENUE_CENTER_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 9. Element: TABLE_NUM
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Human-meaningful number/name of table, not necessarily auto-generated by POS |
Content Model |
xsd:string |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TABLE_NUM"> <a:documentation>Human-meaningful number/name of table, not necessarily auto-generated by POS</a:documentation> <data type="string"/> </element> |
Table 10. Element: GUEST_COUNT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="GUEST_COUNT"> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> |
Table 11. Element: REOPEN_TIME
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Last date and time the order was reopened |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="REOPEN_TIME"> <a:documentation>Last date and time the order was reopened</a:documentation> <data type="dateTime"/> </element> |
Table 12. Element: REOPENED_BY
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
REOPENED_BY is the manager responsible for reopening the order |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="REOPENED_BY"> <a:documentation>REOPENED_BY is the manager responsible for reopening the order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 13. Element: CHECK
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
A single division of an order, paid, most likely, by one part, but with possbily multiple payments |
Content Model |
NUMBER, TOTAL, TAX_INCL_TOTAL, TAX_EXCL_TOTAL, AUTO_GRATUITY, PROMO_TOTAL, MODIFIED_TIME ? , ( TRANSACTION )+ , ( ITEM )* , ( MODIFIER )* |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="CHECK"> <a:documentation>A single division of an order, paid, most likely, by one part, but with possbily multiple payments</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>CHECK NUMBER is the POS assigned, unique counter for the order's checks, not necessarily starting at 1 for each order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">16777215</param> </data> </element> <element name="TOTAL"> <a:documentation>Total as would be listed for customer to pay on check. Includes auto-gratuity, exclusive tax, price paid for items. Does not include promo/comp amounts or regular TIPs paid. If there are multiple checks on an order, then the TOTAL only includes the portion paid on this check, which in general is less than the order total.</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_INCL_TOTAL"> <a:documentation>Tax totals of taxes included in items' prices</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCL_TOTAL"> <a:documentation>Tax totals of taxes not included in items' prices</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="AUTO_GRATUITY"> <a:documentation>Amount added to check for auto/forced gratuity</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="PROMO_TOTAL"> <a:documentation>Total promos/coupons applied to the check, should total up to amounts in items, if ITEM_PROMOs are present</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <optional> <element name="MODIFIED_TIME"> <a:documentation>Last date and time the check was edited</a:documentation> <data type="dateTime"/> </element> </optional> <oneOrMore> <element name="TRANSACTION"> <a:documentation>A single payment made towards amount due on a check</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>TRANSACTION NUMBER is the POS assigned, unique counter for the check's transactions, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="RECEIVED"> <a:documentation>Total amount given by customer not including TIPs. This is generally amount applied to check + change returned, and change will be calculated based on the difference between RECEIVED and APPLIED</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="APPLIED"> <a:documentation>Amount of payment applied to pay for order. Total recieved may be more than applied due to change returned</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TENDER_TYPE_ID"> <a:documentation>Type used in transaction</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <optional> <element name="ACCOUNT_ID"> <a:documentation>House account transaction was charged to</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <optional> <element name="TIP"> <a:documentation>Total tips paid</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> </optional> <optional> <element name="CC_TIP_FEE"> <a:documentation>Amount of service fee charged to tip recipient for credit card fees</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> </optional> <optional> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="PROMO_MANAGER_ID"> <a:documentation>EMPLOYEE ID of user who approved the promo/coupon</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <optional> <element name="VOUCHER_TYPE_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="VOUCHER_NUMBER"> <a:documentation>Store or POS assigned voucher number</a:documentation> <text/> </element> </optional> <optional> <element name="MODIFIED_TIME"> <a:documentation>Last date and time the transaction was edited</a:documentation> <data type="dateTime"/> </element> </optional> </interleave> </element> </oneOrMore> <zeroOrMore> <element name="ITEM"> <a:documentation>A primary item on the check/order. It does not modify any other items</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter per check, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="QUANTITY"> <a:documentation>Number of this item ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TAX_INCLUSIVE"> <a:documentation>Amount of price which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <optional> <element name="VOID_STATUS"> <a:documentation>Was the item voided?</a:documentation> <data type="boolean"/> </element> <element name="VOID_REASON_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="VOID_MANAGER_ID"> <a:documentation>who authorized the void</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <zeroOrMore> <element name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="MODIFIER"> <a:documentation>A modifying item on the check/order. It must be modifying an ITEM.</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>MODIFIER NUMBER is the POS assigned, unique counter per item's modifiers, not necessarily starting at 1 for each item</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ITEM_NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter of this modifier's parent item. It matches the NUMBER element from the proper ITEM.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="QUANTITY"> <a:documentation>Number of this modifier ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TAX_INCLUSIVE"> <a:documentation>Amount of PRICE which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <zeroOrMore> <element name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> </interleave> </element> </zeroOrMore> </interleave> </element> |
Table 14. Element: NUMBER
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
CHECK NUMBER is the POS assigned, unique counter for the order's checks, not necessarily starting at 1 for each order |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="NUMBER"> <a:documentation>CHECK NUMBER is the POS assigned, unique counter for the order's checks, not necessarily starting at 1 for each order</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">16777215</param> </data> </element> |
Table 15. Element: TOTAL
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total as would be listed for customer to pay on check. Includes auto-gratuity, exclusive tax, price paid for items. Does not include promo/comp amounts or regular TIPs paid. If there are multiple checks on an order, then the TOTAL only includes the portion paid on this check, which in general is less than the order total. |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TOTAL"> <a:documentation>Total as would be listed for customer to pay on check. Includes auto-gratuity, exclusive tax, price paid for items. Does not include promo/comp amounts or regular TIPs paid. If there are multiple checks on an order, then the TOTAL only includes the portion paid on this check, which in general is less than the order total.</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 16. Element: TAX_INCL_TOTAL
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Tax totals of taxes included in items' prices |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TAX_INCL_TOTAL"> <a:documentation>Tax totals of taxes included in items' prices</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 17. Element: TAX_EXCL_TOTAL
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Tax totals of taxes not included in items' prices |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TAX_EXCL_TOTAL"> <a:documentation>Tax totals of taxes not included in items' prices</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 18. Element: AUTO_GRATUITY
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Amount added to check for auto/forced gratuity |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="AUTO_GRATUITY"> <a:documentation>Amount added to check for auto/forced gratuity</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 19. Element: PROMO_TOTAL
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total promos/coupons applied to the check, should total up to amounts in items, if ITEM_PROMOs are present |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="PROMO_TOTAL"> <a:documentation>Total promos/coupons applied to the check, should total up to amounts in items, if ITEM_PROMOs are present</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 20. Element: MODIFIED_TIME
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Last date and time the check was edited |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MODIFIED_TIME"> <a:documentation>Last date and time the check was edited</a:documentation> <data type="dateTime"/> </element> |
Table 21. Element: TRANSACTION
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
A single payment made towards amount due on a check |
Content Model |
NUMBER, RECEIVED, APPLIED, TENDER_TYPE_ID, ACCOUNT_ID ? , TIP ? , CC_TIP_FEE ? , PROMO_ID, PROMO_MANAGER_ID ? , VOUCHER_TYPE_ID, VOUCHER_NUMBER ? , MODIFIED_TIME ? |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TRANSACTION"> <a:documentation>A single payment made towards amount due on a check</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>TRANSACTION NUMBER is the POS assigned, unique counter for the check's transactions, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="RECEIVED"> <a:documentation>Total amount given by customer not including TIPs. This is generally amount applied to check + change returned, and change will be calculated based on the difference between RECEIVED and APPLIED</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="APPLIED"> <a:documentation>Amount of payment applied to pay for order. Total recieved may be more than applied due to change returned</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TENDER_TYPE_ID"> <a:documentation>Type used in transaction</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <optional> <element name="ACCOUNT_ID"> <a:documentation>House account transaction was charged to</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <optional> <element name="TIP"> <a:documentation>Total tips paid</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> </optional> <optional> <element name="CC_TIP_FEE"> <a:documentation>Amount of service fee charged to tip recipient for credit card fees</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> </optional> <optional> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="PROMO_MANAGER_ID"> <a:documentation>EMPLOYEE ID of user who approved the promo/coupon</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <optional> <element name="VOUCHER_TYPE_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="VOUCHER_NUMBER"> <a:documentation>Store or POS assigned voucher number</a:documentation> <text/> </element> </optional> <optional> <element name="MODIFIED_TIME"> <a:documentation>Last date and time the transaction was edited</a:documentation> <data type="dateTime"/> </element> </optional> </interleave> </element> |
Table 22. Element: NUMBER
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
TRANSACTION NUMBER is the POS assigned, unique counter for the check's transactions, not necessarily starting at 1 for each check |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="NUMBER"> <a:documentation>TRANSACTION NUMBER is the POS assigned, unique counter for the check's transactions, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> |
Table 23. Element: RECEIVED
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total amount given by customer not including TIPs. This is generally amount applied to check + change returned, and change will be calculated based on the difference between RECEIVED and APPLIED |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="RECEIVED"> <a:documentation>Total amount given by customer not including TIPs. This is generally amount applied to check + change returned, and change will be calculated based on the difference between RECEIVED and APPLIED</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 24. Element: APPLIED
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Amount of payment applied to pay for order. Total recieved may be more than applied due to change returned |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="APPLIED"> <a:documentation>Amount of payment applied to pay for order. Total recieved may be more than applied due to change returned</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 25. Element: TENDER_TYPE_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Type used in transaction |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TENDER_TYPE_ID"> <a:documentation>Type used in transaction</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 26. Element: ACCOUNT_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
House account transaction was charged to |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ACCOUNT_ID"> <a:documentation>House account transaction was charged to</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 27. Element: TIP
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total tips paid |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TIP"> <a:documentation>Total tips paid</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 28. Element: CC_TIP_FEE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Amount of service fee charged to tip recipient for credit card fees |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="CC_TIP_FEE"> <a:documentation>Amount of service fee charged to tip recipient for credit card fees</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 29. Element: PROMO_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 30. Element: PROMO_MANAGER_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
EMPLOYEE ID of user who approved the promo/coupon |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="PROMO_MANAGER_ID"> <a:documentation>EMPLOYEE ID of user who approved the promo/coupon</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 31. Element: VOUCHER_TYPE_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="VOUCHER_TYPE_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 32. Element: VOUCHER_NUMBER
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Store or POS assigned voucher number |
Content Model |
TEXT |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="VOUCHER_NUMBER"> <a:documentation>Store or POS assigned voucher number</a:documentation> <text/> </element> |
Table 33. Element: MODIFIED_TIME
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Last date and time the transaction was edited |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MODIFIED_TIME"> <a:documentation>Last date and time the transaction was edited</a:documentation> <data type="dateTime"/> </element> |
Table 34. Element: ITEM
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
A primary item on the check/order. It does not modify any other items |
Content Model |
NUMBER, ADJUSTED_PRICE, QUANTITY, MENU_ITEM_ID, TAX_INCLUSIVE, TAX_EXCLUSIVE, VOID_STATUS, VOID_REASON_ID, VOID_MANAGER_ID ? , ( ITEM_PROMO )* , ( ITEM_COMP )* |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ITEM"> <a:documentation>A primary item on the check/order. It does not modify any other items</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter per check, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="QUANTITY"> <a:documentation>Number of this item ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TAX_INCLUSIVE"> <a:documentation>Amount of price which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <optional> <element name="VOID_STATUS"> <a:documentation>Was the item voided?</a:documentation> <data type="boolean"/> </element> <element name="VOID_REASON_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="VOID_MANAGER_ID"> <a:documentation>who authorized the void</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> <zeroOrMore> <element name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> </interleave> </element> |
Table 35. Element: NUMBER
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
ITEM NUMBER is the POS assigned, unique counter per check, not necessarily starting at 1 for each check |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter per check, not necessarily starting at 1 for each check</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> |
Table 36. Element: ADJUSTED_PRICE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax). |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 37. Element: QUANTITY
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Number of this item ordered on the check |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="QUANTITY"> <a:documentation>Number of this item ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 38. Element: MENU_ITEM_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 39. Element: TAX_INCLUSIVE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Amount of price which is inclusive tax |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TAX_INCLUSIVE"> <a:documentation>Amount of price which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 40. Element: TAX_EXCLUSIVE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Tax above and beyond the price |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 41. Element: VOID_STATUS
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Was the item voided? |
Content Model |
xsd:boolean |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="VOID_STATUS"> <a:documentation>Was the item voided?</a:documentation> <data type="boolean"/> </element> |
Table 42. Element: VOID_REASON_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="VOID_REASON_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 43. Element: VOID_MANAGER_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
who authorized the void |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="VOID_MANAGER_ID"> <a:documentation>who authorized the void</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 44. Element: ITEM_PROMO
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Discount/Promo applied to one ITEM or MODIFIER |
Content Model | |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> |
Table 45. Element: PROMO_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 46. Element: AMOUNT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total amount of the coupon/promo on this item |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 47. Element: MANAGER_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
who authorized the promo |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 48. Element: ITEM_COMP
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Comp applied to one ITEM or MODIFIER |
Content Model | |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> |
Table 49. Element: COMP_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 50. Element: AMOUNT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total amount of the comp on this item |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 51. Element: MANAGER_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
who authorized the comp |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 52. Element: MODIFIER
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
A modifying item on the check/order. It must be modifying an ITEM. |
Content Model |
NUMBER, ITEM_NUMBER, ADJUSTED_PRICE, QUANTITY, MENU_ITEM_ID, TAX_INCLUSIVE, TAX_EXCLUSIVE, ( ITEM_PROMO )* , ( ITEM_COMP )* |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MODIFIER"> <a:documentation>A modifying item on the check/order. It must be modifying an ITEM.</a:documentation> <interleave> <element name="NUMBER"> <a:documentation>MODIFIER NUMBER is the POS assigned, unique counter per item's modifiers, not necessarily starting at 1 for each item</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ITEM_NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter of this modifier's parent item. It matches the NUMBER element from the proper ITEM.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> <element name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="QUANTITY"> <a:documentation>Number of this modifier ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="TAX_INCLUSIVE"> <a:documentation>Amount of PRICE which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <zeroOrMore> <element name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> <zeroOrMore> <element name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> </zeroOrMore> </interleave> </element> |
Table 53. Element: NUMBER
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
MODIFIER NUMBER is the POS assigned, unique counter per item's modifiers, not necessarily starting at 1 for each item |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="NUMBER"> <a:documentation>MODIFIER NUMBER is the POS assigned, unique counter per item's modifiers, not necessarily starting at 1 for each item</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> |
Table 54. Element: ITEM_NUMBER
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
ITEM NUMBER is the POS assigned, unique counter of this modifier's parent item. It matches the NUMBER element from the proper ITEM. |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ITEM_NUMBER"> <a:documentation>ITEM NUMBER is the POS assigned, unique counter of this modifier's parent item. It matches the NUMBER element from the proper ITEM.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">65535</param> </data> </element> |
Table 55. Element: ADJUSTED_PRICE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax). |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ADJUSTED_PRICE"> <a:documentation>The store's take of the value of the sale. In most cases this is (menu price - comps - promos - inclusive tax).</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 56. Element: QUANTITY
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Number of this modifier ordered on the check |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="QUANTITY"> <a:documentation>Number of this modifier ordered on the check</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 57. Element: MENU_ITEM_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MENU_ITEM_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 58. Element: TAX_INCLUSIVE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Amount of PRICE which is inclusive tax |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TAX_INCLUSIVE"> <a:documentation>Amount of PRICE which is inclusive tax</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 59. Element: TAX_EXCLUSIVE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Tax above and beyond the price |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TAX_EXCLUSIVE"> <a:documentation>Tax above and beyond the price</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 60. Element: ITEM_PROMO
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Discount/Promo applied to one ITEM or MODIFIER |
Content Model | |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ITEM_PROMO"> <a:documentation>Discount/Promo applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> |
Table 61. Element: PROMO_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="PROMO_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 62. Element: AMOUNT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total amount of the coupon/promo on this item |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="AMOUNT"> <a:documentation>Total amount of the coupon/promo on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 63. Element: MANAGER_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
who authorized the promo |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MANAGER_ID"> <a:documentation>who authorized the promo</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 64. Element: ITEM_COMP
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Comp applied to one ITEM or MODIFIER |
Content Model | |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ITEM_COMP"> <a:documentation>Comp applied to one ITEM or MODIFIER</a:documentation> <interleave> <element name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </interleave> </element> |
Table 65. Element: COMP_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="COMP_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 66. Element: AMOUNT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total amount of the comp on this item |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="AMOUNT"> <a:documentation>Total amount of the comp on this item</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 67. Element: MANAGER_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
who authorized the comp |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="MANAGER_ID"> <a:documentation>who authorized the comp</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 68. Element: TIMESLIP
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Unique ID of the timeslip. Generated by POS |
Content Model |
TIMESLIP_ID, EMPLOYEE_ID, JOB_ID, START_TIME, END_TIME, TOTAL_PAY, OVERTIME_MINS, OVERTIME_PAY, PAID_BREAKS_SECS, UNPAID_BREAKS_SECS, DECLARED_TIPS |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TIMESLIP"> <a:documentation>Unique ID of the timeslip. Generated by POS</a:documentation> <interleave> <element name="TIMESLIP_ID"> <a:documentation>Unique ID of the timeslip. Generated by POS</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">18446744073709551615</param> </data> </element> <element name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID who clocked in/out for timeslip.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="JOB_ID"> <a:documentation>JOB ID employee clocked in/out for.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="START_TIME"> <a:documentation>Date and time of clock in.</a:documentation> <data type="dateTime"/> </element> <element name="END_TIME"> <a:documentation>Date and time of clock out.</a:documentation> <data type="dateTime"/> </element> <element name="TOTAL_PAY"> <a:documentation>Total pay earned during shift, includes overtime pay</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> <element name="OVERTIME_MINS"> <a:documentation>Total overtime minutes worked during shift</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> <element name="OVERTIME_PAY"> <a:documentation>Overtime pay earned during shift</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> <element name="PAID_BREAKS_SECS"> <a:documentation>seconds of paid break taken during shift</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> <element name="UNPAID_BREAKS_SECS"> <a:documentation>seconds of unpaid break taken during shift</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> <element name="DECLARED_TIPS"> <a:documentation>cash tips declared upon clock out</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> </interleave> </element> |
Table 69. Element: TIMESLIP_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Unique ID of the timeslip. Generated by POS |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TIMESLIP_ID"> <a:documentation>Unique ID of the timeslip. Generated by POS</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">18446744073709551615</param> </data> </element> |
Table 70. Element: EMPLOYEE_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
EMPLOYEE ID who clocked in/out for timeslip. |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID who clocked in/out for timeslip.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 71. Element: JOB_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
JOB ID employee clocked in/out for. |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="JOB_ID"> <a:documentation>JOB ID employee clocked in/out for.</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 72. Element: START_TIME
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Date and time of clock in. |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="START_TIME"> <a:documentation>Date and time of clock in.</a:documentation> <data type="dateTime"/> </element> |
Table 73. Element: END_TIME
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Date and time of clock out. |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="END_TIME"> <a:documentation>Date and time of clock out.</a:documentation> <data type="dateTime"/> </element> |
Table 74. Element: TOTAL_PAY
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total pay earned during shift, includes overtime pay |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TOTAL_PAY"> <a:documentation>Total pay earned during shift, includes overtime pay</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> |
Table 75. Element: OVERTIME_MINS
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Total overtime minutes worked during shift |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="OVERTIME_MINS"> <a:documentation>Total overtime minutes worked during shift</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> |
Table 76. Element: OVERTIME_PAY
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Overtime pay earned during shift |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="OVERTIME_PAY"> <a:documentation>Overtime pay earned during shift</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> |
Table 77. Element: PAID_BREAKS_SECS
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
seconds of paid break taken during shift |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="PAID_BREAKS_SECS"> <a:documentation>seconds of paid break taken during shift</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> |
Table 78. Element: UNPAID_BREAKS_SECS
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
seconds of unpaid break taken during shift |
Content Model |
xsd:nonNegativeInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="UNPAID_BREAKS_SECS"> <a:documentation>seconds of unpaid break taken during shift</a:documentation> <data type="nonNegativeInteger"> <param name="maxInclusive">16777215</param> </data> </element> |
Table 79. Element: DECLARED_TIPS
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
cash tips declared upon clock out |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="DECLARED_TIPS"> <a:documentation>cash tips declared upon clock out</a:documentation> <data type="decimal"> <param name="fractionDigits">2</param> <param name="minInclusive">0</param> </data> </element> |
Table 80. Element: PAYMENT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
A single Paid In/Out PAYMENT ID is the POS assigned, unique ID for the payment |
Content Model |
ID, EMPLOYEE_ID, REASON_ID, AMOUNT, PAYMENT_DATE, TENDER_TYPE_ID, IN_OUT, ACCOUNT_ID ? |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="PAYMENT"> <a:documentation>A single Paid In/Out</a:documentation> <a:documentation>PAYMENT ID is the POS assigned, unique ID for the payment</a:documentation> <interleave> <element name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID is the employee responsible for the payment</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="REASON_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="PAYMENT_DATE"> <a:documentation>PAYMENT date is actually a date + time. Be sure to include the full time stamp so that payments appear on the correct business day.</a:documentation> <data type="dateTime"/> </element> <element name="TENDER_TYPE_ID"> <a:documentation>Type used in payment</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="IN_OUT"> <a:documentation>IN = money into cash. OUT = money out of cash.</a:documentation> <choice> <value>IN</value> <value>OUT</value> </choice> </element> <optional> <element name="ACCOUNT_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> </optional> </interleave> </element> |
Table 81. Element: ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Unique ID |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 82. Element: EMPLOYEE_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
EMPLOYEE ID is the employee responsible for the payment |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="EMPLOYEE_ID"> <a:documentation>EMPLOYEE ID is the employee responsible for the payment</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 83. Element: REASON_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="REASON_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 84. Element: AMOUNT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="AMOUNT"> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 85. Element: PAYMENT_DATE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
PAYMENT date is actually a date + time. Be sure to include the full time stamp so that payments appear on the correct business day. |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="PAYMENT_DATE"> <a:documentation>PAYMENT date is actually a date + time. Be sure to include the full time stamp so that payments appear on the correct business day.</a:documentation> <data type="dateTime"/> </element> |
Table 86. Element: TENDER_TYPE_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Type used in payment |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="TENDER_TYPE_ID"> <a:documentation>Type used in payment</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 87. Element: IN_OUT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
IN = money into cash. OUT = money out of cash. |
Content Model |
( "IN" | "OUT" ) |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="IN_OUT"> <a:documentation>IN = money into cash. OUT = money out of cash.</a:documentation> <choice> <value>IN</value> <value>OUT</value> </choice> </element> |
Table 88. Element: ACCOUNT_ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ACCOUNT_ID"> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 89. Element: DEPOSIT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Bank Deposits made with cash. POS must assign a unique ID to each deposit. |
Content Model | |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="DEPOSIT"> <a:documentation>Bank Deposits made with cash. POS must assign a unique ID to each deposit.</a:documentation> <interleave> <element name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> <element name="AMOUNT"> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> <element name="DEPOSIT_DATE"> <a:documentation>date and time the deposit was made</a:documentation> <data type="dateTime"/> </element> </interleave> </element> |
Table 90. Element: ID
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
Unique ID |
Content Model |
xsd:positiveInteger |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="ID"> <a:documentation>Unique ID</a:documentation> <data type="positiveInteger"> <param name="maxInclusive">4294967295</param> </data> </element> |
Table 91. Element: AMOUNT
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
None |
Content Model |
xsd:decimal |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="AMOUNT"> <data type="decimal"> <param name="fractionDigits">2</param> </data> </element> |
Table 92. Element: DEPOSIT_DATE
Namespace |
http://pos.whentomanage.com/updx/transactions |
Documentation |
date and time the deposit was made |
Content Model |
xsd:dateTime |
Source |
<element xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" name="DEPOSIT_DATE"> <a:documentation>date and time the deposit was made</a:documentation> <data type="dateTime"/> </element> |