 |
Command:
CASH REGISTER REPORTS
 |
Node: cash_register_reports |
|
Mandatory: |
no |
|
max. Occurrence: |
unbounded |
|
Description: This tag is used as container for commands regarding cash register reports.
|
|
 |
|
|
 |
Node: cash_register_report |
|
Mandatory: |
yes |
|
max. Occurrence: |
unbounded |
|
Supported modes: |
delete Delete the named item. read Read the named item.
|
|
Description: This command is used for reading and deleting cash register reports.
|
|
Notes:
The cumulated values returned by this command including information from the operations performed
and processed until the moment when this command is executed.
For the mode ''delete'' the device-number must indicate an individual cash register.
|
|
 |
|
|
|
 |
Tag: device_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 999
|
|
Nillable: |
no |
|
Description: The number of the device the cash register reports is desired.
|
|
Notes: For further information see the paragraph about Distribution of data Device number 0 indicates all devices.
|
|
 |
|
|
|
 |
Node: cash_register_report_header |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: This node contains general information about a requested cash register report.
|
|
 |
|
|
|
|
 |
Tag: cash_register_report_counter |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
0 - maxInclusive of the datatype.
|
|
Nillable: |
no |
|
Description: The counter indicates how many times the cash register data have been deleted.
|
|
 |
|
|
|
|
 |
Tag: last_deletion_date |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
dateTime |
|
Range: |
- |
|
Nillable: |
yes |
|
Description: Date and time when this report has been deleted last time. CCYY-MM-DDThh:mm:ss The format is as following: C = Century Y = Year M = Month D = Day T = Separator between date and time h = hour m = month s = second
|
|
 |
|
|
|
|
 |
Tag: report_status |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
flagType |
|
Range: |
(0/1)
|
|
Nillable: |
no |
|
Description: Indicates the report data status:
Value |
Description |
0
|
Data are complete |
1
|
Data are incomplete because there are still registrations in the local TAF that must be processed |
|
|
 |
|
|
|
|
 |
Tag: sequence_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
0 - maxInclusive of the datatype.
|
|
Nillable: |
no |
|
Description: The number of the last TAF entry processed for cumulating cash register report’s data.
|
|
 |
|
|
|
 |
Node: operator_total_values |
|
Mandatory: |
no |
|
max. Occurrence: |
unbounded |
|
Description: This node contains cash register report data regarding one operator.
|
|
 |
|
|
|
|
 |
Tag: operator_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
1 - 999 999.
|
|
Nillable: |
no |
|
Description: Number of the operator the total values are belonging to.
|
|
 |
|
|
|
|
 |
Tag: name |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 20 chars
|
|
Nillable: |
no |
|
Description: The name of the operator.
|
|
 |
|
|
|
|
 |
Tag: number_of_customers |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of customers that have been served by this operator.
|
|
 |
|
|
|
|
 |
Tag: amount |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The amount from all sale transactions performed by this operator.
The value is always stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: number_of_linevoids |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of linevoids done by this operator.
|
|
 |
|
|
|
|
 |
Tag: amount_linevoid |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The accumulated amount of line voids listed in <number_of_linevoids>.
|
|
 |
|
|
|
|
 |
Tag: number_of_voids |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of voided receipts or labels done by this operator.
|
|
 |
|
|
|
|
 |
Tag: amount_void |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The accumulated amount of voided receipts listed in <number_of_voids>.
|
|
 |
|
|
|
|
 |
Tag: number_of_zero_receipts |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of zero receipts created by this operator.
|
|
Notes: A zero receipt doesn't contain a registration and has a total amount of 0.
|
|
 |
|
|
|
|
 |
Tag: number_of_items |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of the accumulated items of all receipts that have been generated by this operator.
|
|
 |
|
|
|
|
 |
Tag: weight |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The accumulated weight of the articles/items of all receipts that have been generated by this operator.
|
|
 |
|
|
|
 |
Node: cash_register_totals |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: This node contains cash register report data regarding totals for all operators.
|
|
 |
|
|
|
|
 |
Tag: number_of_customers |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of customers that has been served on this cash register.
|
|
 |
|
|
|
|
 |
Tag: amount |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The amount from all sale transactions performed by all operators.
The value is always stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: number_of_linevoids |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of linevoids done on this cash register.
|
|
 |
|
|
|
|
 |
Tag: amount_linevoid |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The accumulated amount of line voids listed in <number_of_linevoids>.
|
|
 |
|
|
|
|
 |
Tag: number_of_voids |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of voided receipts or labels done on this cash register.
|
|
 |
|
|
|
|
 |
Tag: amount_void |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The accumulated amount of voided receipts listed in <number_of_voids>.
|
|
 |
|
|
|
|
 |
Tag: number_of_zero_receipts |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of zero receipts created by the operator.
|
|
Notes: A zero receipt doesn't contain a registration and has a total amount of 0.
|
|
 |
|
|
|
|
 |
Tag: number_of_items |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of the accumulated items of all receipts that have been generated by this operator.
|
|
 |
|
|
|
|
 |
Tag: weight |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The accumulated weight of the articles/items of all receipts that have been generated by this operator.
|
|
 |
|
|
|
 |
Node: local_currency_totals |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: This node contains cash register report data regarding totals for operations involving local currency.
|
|
 |
|
|
|
|
 |
Tag: number_of_customers |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of customers having payment in primary currency.
|
|
 |
|
|
|
|
 |
Tag: amount |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
The total amount of payments using primary currency made for all sale transactions performed on this cash register.
The value is always stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: number_of_changes |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of receipts having non-zero value for change returned to customer.
|
|
 |
|
|
|
|
 |
Tag: amount_changes |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Amount of change returned to customers:
The accumulated amount of change returned to customers.
The value is always stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: amount_paid_in |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Amount of all 'paid in' operations.
The accumulated amount of 'paid in' operations made on this cash register.
The value is always stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: number_of_paid_ins |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: Number of “Paid in” operations.
|
|
 |
|
|
|
|
 |
Tag: amount_paid_out |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Amount of all 'paid out' operations.
The accumulated amount of 'paid out' operations made on this cash register.
The value is always stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: number_of_paid_outs |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: Number of “Paid out” operations.
|
|
 |
|
|
|
|
 |
Tag: amount_loan |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Amount of all 'loan (float)' operations.
The accumulated amount of 'loan (float)' operations made on this cash register.
The value is always stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: number_of_loans |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: Number of “Loan (float)” operations.
|
|
 |
|
|
|
|
 |
Tag: amount_pickup |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Amount of all 'pickup (withdrawal)' operations.
The accumulated amount of 'pickup (withdrawal)' operations made on this cash register.
The value is always stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: number_of_pickups |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: Number of “Pickup (withdrawal)” operations.
|
|
 |
|
|
|
|
 |
Tag: amount_total_expected |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Expected total amount of all operations involving primary currency.
The expected amount resulting from accumulation of all operations where primary currency is used.
The value is always stored in the primary currency.
|
|
 |
|
|
|
 |
Node: tender_totals |
|
Mandatory: |
no |
|
max. Occurrence: |
unbounded |
|
Description: This node contains cash register report data regarding totals for operations involving a tender different from primary currency.
|
|
 |
|
|
|
|
 |
Tag: tender_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 99
|
|
Nillable: |
no |
|
Description: The number of the tender. For more information see command <tenders>.
|
|
 |
|
|
|
|
 |
Tag: shortname |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 3 chars
|
|
Nillable: |
no |
|
Description: Short name of the tender (e.g. USD, CHF).
|
|
 |
|
|
|
|
 |
Tag: number_of_customers |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of customers having payment with this tender.
|
|
 |
|
|
|
|
 |
Tag: amount_tender_customers |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Amount of payments with tender in receipts.
The total amount of payments using this tender made for all sale transactions performed on this cash register.
The value is stored in the current tender.
|
|
 |
|
|
|
|
 |
Tag: amount |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Equivalent in primary currency for the <amount_tender_customers> of payments using this tender
made for all sale transactions performed on this cash register.
The value is stored in the primary currency.
|
|
 |
|
|
|
|
 |
Tag: tender_pickup |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Amount of all 'pickup (withdrawal)' operations with tender.
The accumulated amount of 'pickup (withdrawal)' operations made on this cash register with this tender.
The value is always stored in this tender.
|
|
 |
|
|
|
|
 |
Tag: number_of_tender_pickups |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Number of tender “Pickup (withdrawal)” operations.
|
|
 |
|
|
|
|
 |
Tag: local_currency_equivalent_pickup |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Local currency equivalent amount of 'pickup (withdrawal)' operation made with tender.
The accumulated equivalent amount in local currency of 'pickup (withdrawal)' operations made
on this cash register with this tender.
The value is stored in the primary (local) currency.
|
|
 |
|
|
|
|
 |
Tag: tender_total_expected |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
Expected total amount of operations involving tender.
The expected amount resulting from accumulation from all operations where this tender is used.
The value is stored in this tender.
|
|
 |
|
|
|
|
 |
Tag: amount_total_expected |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description:
The local currency equivalent expected total amount of operations involving tender.
The equivalent in local currency of the expected amount resulting from accumulation from all operations where this tender
is used.
The value is stored in the primary currency.
|
|
 |
|
|
|
 |
Node: vat_values |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: This node contains cash register report data regarding VAT's for all operators.
|
|
 |
|
|
|
|
 |
Tag: vat_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 9 999
|
|
Nillable: |
no |
|
Description: The value added tax (VAT) number. For more information see <vat>
|
|
 |
|
|
|
|
 |
Tag: vat_value |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 9 999
|
|
Nillable: |
no |
|
Description: The value of the VAT. The VAT value is always stored with 2 decimal places 5% = 500, 5,5% = 550).
|
|
 |
|
|
|
|
 |
Tag: amount |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The amount accumulated for this the VAT number.
|
|
 |
|
|
|
|
 |
Tag: vat_total_amount |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The amount calculated by applying VAT value to VAT Turnover accumulated for this VAT number.
|
|
 |
|
|
|
 |
Node: markup_discount_values |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Description: This node contains cash register report data regarding markups and discounts for all operators.
|
|
 |
|
|
|
|
 |
Tag: markup_discount_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The markup/discount number. For more information see <markup_discount_no>>
|
|
 |
|
|
|
|
 |
Tag: markup_discount_num_registrations |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of registrations a markup or discount has been assigned to.
|
|
 |
|
|
|
|
 |
Tag: markup_discount_amount_registrations |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The accumulated amount of all registrations listed in <markup_discount_num_registrations>.
|
|
 |
|
|
|
|
 |
Tag: markup_discount_num_totals |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The number of totals a markup or discount has been assigned to.
|
|
 |
|
|
|
|
 |
Tag: markup_discount_amount_totals |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
int |
|
Range: |
See the range of the datatype.
|
|
Nillable: |
no |
|
Description: The accumulated amount of all totals listed in <markup_discount_num_totals>.
|
|
 |
|
|