InterfazPlatino-Version 1 41

download InterfazPlatino-Version 1 41

of 91

description

InterfazPlatino-Version 1 41

Transcript of InterfazPlatino-Version 1 41

  • Point Of Sale

    Interface Specification for Back Office third parties

    Version 1.41

    Last modification: Junio 2015

    Copyright Gilbarco Latin America

    All Rights Reserved

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 2 of 91

    Table of Contents

    1 Version Control.................................................................................................................. 5 2 Introduction ........................................................................................................................ 6 2.A A Brief introduction ............................................................................................................................... 6

    2.A.1 Purpose and scope ..................................................................................................................... 6 2.A.2 XML Background and references ................................................................................................ 6 2.A.3 XML vs. TXT size ........................................................................................................................ 6

    2.B XML Operations ..................................................................................................................................... 8 2.B.1 Data export ................................................................................................................................. 8 2.B.2 Data import ................................................................................................................................. 8 2.B.3 Error manipulation for input files .................................................................................................. 8

    2.B.3.1 Error file ......................................................................................................................... 8 2.B.4 File names .................................................................................................................................. 9 2.B.5 Share folders .............................................................................................................................. 9

    3 XML file specification ..................................................................................................... 12 3.A Data Types ........................................................................................................................................... 14

    4 Output files: POS to BO.................................................................................................. 15 4.A Sales transactions ............................................................................................................................... 15

    4.A.1 Pos_information ........................................................................................................................ 15 4.A.2 trans ......................................................................................................................................... 15

    4.A.2.1 item .............................................................................................................................. 17 4.A.2.1.1 tax.................................................................................................................................. 18

    4.A.2.2 tender ........................................................................................................................... 19 4.A.2.2.1 check ............................................................................................................................. 19 4.A.2.2.2 account .......................................................................................................................... 19 4.A.2.2.3 credit_card..................................................................................................................... 19 4.A.2.2.4 efleet.............................................................................................................................. 20 4.A.2.2.5 axion_card ..................................................................................................................... 20 4.A.2.2.6 delivery_notes ............................................................................................................... 21 4.A.2.2.7 total_tax ......................................................................................................................... 21 4.A.2.2.8 customer_tax_config ..................................................................................................... 21 4.A.2.2.9 additional_data .............................................................................................................. 21

    4.B Cash Drop ............................................................................................................................................ 24 4.B.1 Pos_information ........................................................................................................................ 24 4.B.2 drop .......................................................................................................................................... 24

    4.B.2.1 detail ............................................................................................................................ 24 4.C Filling Detail ......................................................................................................................................... 26

    4.C.1 Pos_information ........................................................................................................................ 26 4.C.2 filling ......................................................................................................................................... 26

    4.C.2.1 tank .............................................................................................................................. 27 4.D Filling Summary................................................................................................................................... 28

    4.D.1 Pos_information ........................................................................................................................ 28 4.D.2 filling ......................................................................................................................................... 28

    4.D.2.1 data .............................................................................................................................. 28 4.E Tank Product Inventory ....................................................................................................................... 30

    4.E.1 Pos_information ........................................................................................................................ 30 4.E.2 tank........................................................................................................................................... 30

    4.F Cashier Statistics ................................................................................................................................ 31 4.F.1 pos_information ........................................................................................................................ 31 4.F.2 cashier ...................................................................................................................................... 31

    4.G Endings ................................................................................................................................................ 33 4.G.1 Pos_information ........................................................................................................................ 33 4.G.2 endings ..................................................................................................................................... 33

    5 Input files: BO to POS ..................................................................................................... 35 5.A Customers ........................................................................................................................................... 35

    5.A.1 update ...................................................................................................................................... 35

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 3 of 91

    5.A.1.1 tax_config ..................................................................................................................... 36 5.A.1.2 patent_config ................................................................................................................ 36

    5.A.2 delete........................................................................................................................................ 37 5.B Products............................................................................................................................................... 38

    5.B.1 single ........................................................................................................................................ 38 5.B.1.1 barcode ........................................................................................................................ 39 5.B.1.2 tax ................................................................................................................................ 39

    5.B.2 combo ....................................................................................................................................... 39 5.B.2.1 barcode ........................................................................................................................ 40 5.B.2.2 item .............................................................................................................................. 41

    5.B.3 grouped .................................................................................................................................... 41 5.B.3.1 item .............................................................................................................................. 42

    5.B.4 fuel ........................................................................................................................................... 42 5.B.4.1 tax ................................................................................................................................ 43 5.B.4.2 Manual Fuels ................................................................................................................ 44

    5.B.5 Telephone_pin .......................................................................................................................... 44 5.B.5.1 tax ................................................................................................................................ 45

    5.B.6 Motorway/Freeway Unique Daily Pass ...................................................................................... 45 5.B.6.1 tax ................................................................................................................................ 47

    5.B.7 enable ....................................................................................................................................... 47 5.B.8 disable ...................................................................................................................................... 47 5.B.9 delete........................................................................................................................................ 47

    5.C Concepts .............................................................................................................................................. 48 5.C.1 paid_in_out ............................................................................................................................... 49 5.C.2 credit_debit ............................................................................................................................... 50

    5.C.2.1 tax ................................................................................................................................ 50 5.C.3 enable ....................................................................................................................................... 51 5.C.4 disable ...................................................................................................................................... 51

    5.D Categories............................................................................................................................................ 52 5.D.1 update ...................................................................................................................................... 52 5.D.2 delete........................................................................................................................................ 52

    5.E Price Changes ..................................................................................................................................... 55 5.E.1 product ..................................................................................................................................... 55

    5.E.1.1 combo_item .................................................................................................................. 55 5.E.1.2 price_level .................................................................................................................... 56

    5.F Special Price List ................................................................................................................................. 57 5.F.1 update ...................................................................................................................................... 57

    5.F.1.1 special_price ................................................................................................................ 57 5.F.1.1.1 product .......................................................................................................................... 59 5.F.1.1.2 category......................................................................................................................... 60

    5.F.2 delete........................................................................................................................................ 60 5.F.2.1 special_price ................................................................................................................ 60

    5.F.2.1.1 product .......................................................................................................................... 60 5.F.2.1.2 category......................................................................................................................... 61

    5.G Bonus Buy Promotions ....................................................................................................................... 64 5.G.1 TransmissionHeader ................................................................................................................. 64 5.G.2 ComboMaintenance .................................................................................................................. 64

    5.G.2.1 CBTDetail ..................................................................................................................... 64 5.G.2.1.1 Promotion ...................................................................................................................... 65 5.G.2.1.2 ComboList ..................................................................................................................... 65

    5.G.2.1.2.1 ComboItemList ................................................................................................ 65 5.G.3 ItemListMaintenance ................................................................................................................. 66

    5.G.3.1 ILTDetail ....................................................................................................................... 66 5.G.3.1.1 ItemListEntry ................................................................................................................. 67

    5.G.3.1.1.1 ItemCode .......................................................................................................... 67 5.G.4 MixMatchMaintenance .............................................................................................................. 67

    5.G.4.1 MMTDetail .................................................................................................................... 68 5.G.4.1.1 Promotion ...................................................................................................................... 68

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 4 of 91

    5.G.4.1.2 MixMatchEntry ............................................................................................................... 68 5.H Special Price List (backward compatibility) ....................................................................................... 69

    5.H.1 update ...................................................................................................................................... 69 5.H.1.1 product ......................................................................................................................... 69

    5.H.2 delete........................................................................................................................................ 71 5.I Tax by Province ................................................................................................................................... 72

    5.I.1 update ...................................................................................................................................... 72 5.I.1.1 data .............................................................................................................................. 72

    5.I.1.1.1 Variant ........................................................................................................................... 72 5.J Account ................................................................................................................................................ 74

    5.J.1 update ...................................................................................................................................... 74 5.J.1.1 subaccount ................................................................................................................... 74

    5.J.2 new_balance............................................................................................................................. 75 5.J.2.1 subaccount ................................................................................................................... 75

    5.J.3 new_balance (backward compatibility with Version 1-16-5)........................................................ 75 5.J.4 disable ...................................................................................................................................... 76

    5.J.4.1 subaccount ................................................................................................................... 76 5.K Transactions ........................................................................................................................................ 77

    5.K.1 update ...................................................................................................................................... 77 5.K.1.1 item .............................................................................................................................. 78

    5.K.1.1.1 tax.................................................................................................................................. 78 5.K.1.2 tender ........................................................................................................................... 79

    5.K.1.2.1 account .......................................................................................................................... 79 5.L Account-Product Restriction .............................................................................................................. 80

    5.L.1 update ...................................................................................................................................... 80 5.L.1.1 product ......................................................................................................................... 80

    5.L.2 delete........................................................................................................................................ 80 5.L.2.1 product ......................................................................................................................... 80

    5.M Currency Rate ...................................................................................................................................... 82 5.M.1 update ...................................................................................................................................... 82

    5.N Banks ................................................................................................................................................... 82 5.N.1 update ...................................................................................................................................... 82

    5.O Payments eFleet .................................................................................................................................. 83 5.O.1 insert......................................................................................................................................... 83

    Apendix A: Table of Constant Values ................................................................................... 84 A.1 Modules ............................................................................................................................................... 84 Apendix B: Combo Examples ................................................................................................ 85 B.1 Saletrans .............................................................................................................................................. 85 B.2 Products............................................................................................................................................... 87 B.3 Price Changes ..................................................................................................................................... 87

    Apendix C: NAXML Promotions Examples .......................................................................... 88 C.1 Combo Promotion ............................................................................................................................... 88 C.2 NAXML Mix & Match Promotion .......................................................................................................... 90

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 5 of 91

    1 Version Control

    Date Document Version Actual Platino Version Version from Platino

    27/03/2014 1.37 6.0.0.3 Corporate 5 18/06/2014 1.38 6.0.7 Corporate 6 01/07/2014 1.39 1.0.3 AXION PY 13/03/2015 1.40 7.0 Axion Main 16/06/2015 1.41 7.0 Axion Main

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 6 of 91

    2 Introduction

    2.AA Brief introduction

    2.A.1 Purpose and scope The goal of this document is to specify the Gilbarco Latin America standard unique interface

    specification between PLatino POS and any Back Office third parties. This document includes the XML file specifications with its corresponding data for the PLatino/Back

    Office interface. This document does not include any program or parser specification to read the XML files.

    2.A.2 XML Background and references XML is the Extensible Markup Language. It is designed to improve the functionality by providing more

    flexible and adaptable information identification. It is called extensible because it is not a fixed format like HTML (a single, predefined markup language). Instead, XML is actually a metalanguage, in other words, a language for describing other languages that lets you design your own customized markup language for limitless different types of documents.

    The following are some advantages by using XML:

    New standard for interfaces Is platform and system independent Easy to understand (it is human-legible and clear) It allows you to define your own data structure Many existing tools and parsers to manage it It is easier to exchange documents among users and applications Supports advanced searching Backward Compatibility New version support XML applications support many document encoding (Unicode)

    For more information about XML you can visit the following sites:

    http://www.xml.org

    http://www.xml.com

    http://www.w3.org

    2.A.3 XML vs. TXT size

    In order to show the different file sizes between these two kinds of formats, many tests have been done using the products file specification with common data.

    It has taken a TXT file format with a fixed length record. The first test has been performed with 100 products for each case:

    The size of the uncompressed TXT file is 21300 bytes

    The size of the uncompressed XML file is 20821 bytes

    In this case the XML size is less than the TXT file, but it could occur the inverse.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 7 of 91

    The XML file compressed with WinZip (normal compression) resulted in 386 bytes. The compression ratio was 98.15 %, i.e. the new zip file occupied 1.85 % of the original XML file.

    The second test has been performed with 50 transactions (the most typical) for each case:

    The size of the uncompressed TXT file is 37898 bytes The size of the uncompressed XML file is 40726 bytes

    In this case the TXT size is less than the XML file, but it could occur the inverse. The XML file compressed with WinZip (normal compression) resulted in 857 bytes. The compression

    ratio was 97.90 %, i.e. the new zip file occupied 2.10 % of the original XML file. The conclusion is that there is not much difference respecting the size between an XML and a TXT file. Besides, the compression ratio is always big enough to reduce considerably the whole file size.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 8 of 91

    2.B XML Operations

    2.B.1 Data export There is an active process to export data that will write the XML files at a predefined moment.

    2.B.2 Data import

    There is an active process to import data that will be checking for new files. Depending on file type, the import process could have different treatment, which allows records to be updated individually. It is possible to create, delete or modify a record depending on the XML file specified. Some files do not allow a delete action, but in some cases they allow data to be enabled or disabled. The import files are not differentiated as master or update files. The actions to be performed are for individual records (or elements) and are described by the element names: update: This action will create a new data record in the database if it does not exist in the system.

    This action will modify a data record in the database if it does exist in the system. delete: This action will delete a data record in the database. enable: This action will enable a data record in the database. disable: This action will disable a data record in the database.

    2.B.3 Error manipulation for input files

    During the import process at the POS, it is possible that some error can occur. When this happen, an error file is generated for each import file that caused an error. When one of the following cases occurred, an XML error file is generated:

    A required attribute does not appear in the XML file. An attribute name does not match the specification. An attribute value is incorrect or does not correspond with the type or size specified.

    It is worth noting that if the first error is encountered for one element in the file, the whole record will be rejected. Therefore, if there exists more than one error for the same element (e.g. two incorrect attributes names), only the first error will be considered.

    2.B.3.1 Error file

    The error file is compound by:

    A root element with the name errores. Elements that are copies of the elements that caused the errors. Each of these elements has added a

    new attribute named error where its content is the error description.

    This is an example of an error file for categories:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 9 of 91

    2.B.4 File names Both input and output files must have unique names. For this purpose, it was defined in the following way: Input File: NNNN_XXXXXXXXCCCYYYYMMDDHHMMSS.xml Output File: XXXXXXXCCCYYYYMMDDHHMMSSVVV.xml

    NN..NNN = Store identifier (variable character length), this must be the Platino Local Store. _ = Seperator XXXXXXXX = Data type name to distinguish the information that will be processed (8 characters) CCC = These 3 characters are for possible recognition of different vendors. YYYYMMDD = Date creation (YYYY = Year, MM = Month, DD = Day) (8 characters) HHMMSS = Time creation (HH=Hour, MM=Minutes, SS=Seconds) (6 characters) VVV = These 3 characters are for possible recognition of different version.

    Note: Creation Date & Time will be used to validate the moment of the importation to Platino. To be imported Creation date & time should be smaller than the current date & time set in Site Master Server.

    2.B.5 Share folders

    PLatino POS will have two folders to receive and transmit files with a Back Office: Input and Output. In \ZeusData\Input\ folder the POS application will be waiting for input files deposited by the Back

    Office. In \ZeusData\Output\ folder the POS application will be writing the output files to be taken by the Back

    Office. These folders must be shared with the Back Office. The structure within the Input directory is depicted in the figure:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 10 of 91

    Input

    Procesados

    Pendientes

    ZIP

    200502

    200503

    Originales

    Errores

    200502

    200503

    200502

    200503

    200502

    200503

    Input

    Procesados

    Pendientes

    ZIP

    200502

    200503

    Originales

    Errores

    200502

    200503

    200502

    200503

    200502

    200503

    In case of using the ZIP file option the mask of the ZIP file will be: XXXXXXXXCCCYYYYMMDDHHMMSS.ZIP

    Where: XXXXXXXX ="ZIPINPUT" CCC = Vendor "SAP" YYYYMMDD = Creation Date HHMMSS = Creation Time Example: ZIPINPUTSAP20050321080912.ZIP

    Platino has the opcion to expect a ZIP file with all the input files. In that case when the ZIP file is left, Platino will detect it automatically and move it to a temporary folder \Input\Pendientes where the xmls should be decompressed in the \Input folder and the zip file should be moved to \Input\Zip in its corresponds YYYYMM folder. If this option is not set, the Back Office should leave all the input xmls files in the \Input folder together.

    Then the xmls are processed with a logical order as it is today. When a xml is processed, any of these possibilities can take place: 1) The xml file has no error The original file is moved to the \Input\Originales

    folder in its corresponds YYYYMM folder A New file is created in \Input\Procesados folder in

    its corresponds YYYYMM folder. 2) The input file has some elements with errors and others without errors The original file is moved to the \Input\Originales

    folder in its corresponds YYYYMM folder A new file is created in \Input\Procesados folder in

    its corresponds YYYYMM folder A new file is created in \Input\Errores It contains the

    original elements that caused an error during the import process, where each element has a new subelement error with a message(added by the interface)

    3) The input file has only elements with errors The original file is moved to the \Input\Originales

    folder in its corresponds YYYYMM folder A new file is created in \Input\Errores It contains the

    original elements that caused an error during the import process, where each element has a new subelement error with a message(added by the interface)

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 11 of 91

    Directories:

    Procesados: It contains files with elements that were processed ok.

    Original: It contains exactly the files that were putted into the Input directory.

    Errores: It contains files with elements that were processed with errors.

    The structure within the output directory is depicted in the figure:

    Output

    XMLS

    200502

    200503

    Output

    XMLS

    200502

    200503

    The ZIP file should be generated in \Output and then the XMLS should be moved \Output\XMLS folder in its corresponds YYYYMM folder The mask of the ZIP file should be:

    XXXXXXXXCCCYYYYMMDDHHMMSS.ZIP Where: XXXXXXXX ="ZIPOUPUT" CCC = Vendor "SAP" YYYYMMDD = Creation Date HHMMSS = Creation Time Example: ZIPOUTPUTSAP20050321080912.ZIP

    Each output interface (sales, cashier statistics, cash drop, so on) is generated through a specific batch process set in Platino. Each process is executed after other in a specific dependence. (i.e. first sale, then cashier statistis, then cash drop and so on). The ZIP process should be a new one which depends on the last interface executed in one moment. It is understood that one moment could be a shift or a day close.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 12 of 91

    3 XML file specification

    The following is a description for an XML file specified in this document. It can be taken like an example. /------------------------------------------------------------ BEGINNING -------------------------------------------------------------------\

    1.C A Subject to understand the data information in the file

    File: name (This word will be replaced in the XXXXXXXX part of the file name.

    See section File names )

    Root element: root_name (This word is the name of the root element of the XML file)

    1.C.1 Element (This word is the tag of an element of the first level)

    Attribute Name Type / Size

    Possible Values Description

    attribute_name1

    attribute_nameN

    Amount of elements: (Indicates how many elements can be repeated)

    Validation: (Indicates that the POS will check the data described in this sentence)

    \----------------------------------------------------------------- END ------------------------------------------------------------------------/ The following is the meaning of each column showed above.

    Attribute Name: Is the name of the attribute in the element. The keys are represented in bold format. A key is the attribute that uniquely identifies data.

    Type/Size: Is the type and size of the attribute value. See section Data Types.

    Possible Values: Values allowed for the attribute. The word Any means that any value for the corresponding attribute type and size is permitted.

    Description: A short description of the attribute meaning.

    Notes:

    There is a column named Required? in each element specification to inform whether the attribute is optional (value No) or mandatory (value Yes). This is only valid for input files.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 13 of 91

    Certainly, some files contain sub-elements for some elements. Therefore, a sub-element is specified in the same way as the element depicted above but incrementing the index level number, which indicates the level it occupies in a tree hierarchy.

    An attribute can appear in any position inside the element. This means that the attributes position is unordered.

    An element without sub-elements can appear in two ways:

    1. The element is closed by one slash at the end (before > sign).

    Example:

    2. The element is closed like an element with sub-elements. Example:

    Therefore, the parser can be prepared to manipulate an element without sub-elements in both ways.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 14 of 91

    3.A Data Types

    To determine the information that can be used in this interface and also to avoid data errors, it has defined the list of data type with its corresponding values to be used.

    Padding of blanks or zeros is not necessary.

    Data Type

    Letter to represent

    data type in the element specification

    Length Type

    Description

    Examples

    Integer I Variable

    An integer number with sign. A type I n mean an integer number with a maximum of n digits.

    I 4: 0 I 4: -1 I 4: 8371

    Real R Variable

    A real number with sign. It has both an integer and decimal part. A type R n,m mean a real number with a maximum of n digits for the integer part and a maximum of m digits for the

    decimal part.

    R 1,2: 0 R 1,2: 1.83 R 8,3: 45.912 R 3,3: -120

    Alphanumeric A Variable

    A chain of alphanumeric characters. The same as String. A type A n mean a string with a maximum of n characters.

    A 11: Hello A 11:Hello world

    Date D Fixed

    (10 characters)

    A date with format DD/MM/YYYY (DD = Day, MM = Month, YYYY = Year)

    D 10: 27/10/2001 D 10: 01/12/2005

    Time T Fixed

    (6 characters)

    A time with format 24 hour HHMMSS (HH=Hour, MM=Minutes, SS=Seconds)

    T 6 : 235959 T 6 : 000001

    Logical L Fixed

    (1 character).

    A logical value. The attribute can be thought as a question. For example an attribute named cancelled, think as Is cancelled ? There are two possible values: Y or N. A value of Y means Yes or True. A value of N means No or False.

    L 1: Y L 1: N

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 15 of 91

    4 Output files: POS to BO

    4.A Sales transactions

    This file contains the sales transactions.

    Each transaction always includes all the hierarchy of products that depends on the main products sold (which are showed in the ticket), i.e. every product with its components, and the components of the component, and so on.

    If the transaction were cancelled (attribute cancelled = Y), then both elements item and tender would not appear in the trans element. Therefore, it will only be compound by trans element attributes. The total_amount attribute will be equal to 0 (zero). File: saletran

    Root element: sales_transactions

    4.A.1 Pos_information

    Attribute Name Type /

    Size Possible Values Description

    Pos_version A 30 Any Platinos version Amount of elements: one

    4.A.2 trans

    These attributes have general transaction information.

    Attribute Name Type /

    Size Possible Values Description

    Node A 15 Any Store identifier

    Id_trans I 18 1 999999999999999999 Transaction identifier. It is unique by POS.

    pos I 5 1 99999 POS identifier

    trans_type A 10 sale refund delivnote paidin paidout debit credit invoicedelivery

    invoicedelivery_flt billingInAdvance refundUnAdvance payments refund_delivnote refund_paidin refund_paidout

    Indicates what type of transaction it is.

    business_date D 10 Any valid date Date for the business

    gen_date D 10 Any valid date Date at the moment of end transaction

    gen_time T 6 Any valid time Time at the moment of end transaction

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 16 of 91

    id_cashier A 15 Any Store operator identifier (system user id) who made the transaction

    cashier_name A 30 Any Store operator name (system user name)

    id_issuer A 10 Any Issuer number. It is the POS identification number issued by the Tax Bureau Agency of the country.

    fiscal_doc_type A 10 See table Fiscal document

    Fiscal document type

    series_num A 15 Any Number Series Fiscal documente Type

    fiscal_doc_num I 18 1 999999999999999999 Fiscal document number. It depends on fiscal_doc_type. It can never be zero, even though the transaction had been cancelled. Important: this number can be repeated for a fiscal_doc_type (certainly, for different fiscal_doc_type too). This is possible if any of the following happen: 1) The printers fiscal memory is filled and

    must be changed. 2) The fiscal printer must be replaced.

    net_amount R 14,4 0,0 99999999999999,9999 = Total_amount Total_tax Exempt_amount

    total_amount R 14,4 0,0 99999999999999,9999 Total amount of the transaction

    total_tax R 14,4 0,0 99999999999999,9999 Total tax for the transaction

    cashier_relative_shift_id I 5 Any Cashier Shift ID relative to the current Business day (Cashier Module Ending)

    cashier_absolute_shift_id I 5 Any Unique shift ID for Cashier (Cashier Module Ending)

    main_group_abs I 5 Any Unique shift ID for Main Group (Shop Module Ending)

    main_group_rel I 5 Any Main Group Shift ID relative to the current Business day (Shop Module Ending)

    id_initial_day I 18 Any Shop DAY period ID relative to the current Month (Shop Module Ending)

    id_initial_day_abs I 18 Any Unique shop DAY period ID (Shop Module Ending)

    voided L 1 Y, N Notifies whether the transaction was voided or not. Values:

    Y = transaction voided N = transaction not voided

    cancel_conc_id I 10 0 9999999999 Cancellation concept identifier, which corresponds to the id attribute in the Concepts file

    cust_num I 18 1 999999999999999999 Unique customer identifier in the whole system. In case of Temporal Customer then value = -1

    cust_comm_name A 50 Any Customer name or commercial name

    tic A 20 Any Tributary identifier code of the customer It is recommended to use customer_tax_config tag instead of.

    tic_type A 5 See Table TIC Type Tributary identifier Type. It is recommended to use customer_tax_config tag instead of.

    tax_payer A 4 See table Tax Payer Tax payer. It is recommended to use customer_tax_config tag instead of.

    origin A 20 pos Indicates who generated the transaction.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 17 of 91

    compl_inv_close auto_invoice_maker

    Values: pos: it was generated by a normal sale at the pos. compl_inv_close: it was generated by a period close. It is a complement invoice. auto_invoice_maker: It was generated by the auto invoice maker.

    manual L 1 Y, N Notifies whether the transaction was manual or automatic

    cash_drawer I 5 1 99999 Cash Drawer Identifier

    rev_trans I 18 1 999999999999999999 Transaction identifier reverse

    rev_pos I 5 1-99999 Pos identifier reverse

    split_category I 1 Any BOS/HOS category to split sales transactions.

    fiscal_auth A 30 Any Depending on the fiscal document type and tax regulations Fiscal authorization code (ARG -> CAI )

    fiscal_auth_expire D 10 Any valid date Depending on the fiscal document type and tax regulations Fiscal authorization code expire date

    cust_address_street A 50 Any Customer address steet

    cust_address_city A 50 Any Customer address city

    exempt_amount R 14,4 0,0 99999999999999,9999 Total Exempt Amount for the transaction, these are the tax free items

    control_code A 20 Any Control Code of transactions, if request by any country. Fiscal code to be printed in the ticket.

    patent A 15 Any Car Number Patent

    nationality_car A 50 Any Nationality of the Car

    Amount of elements: There is no specified limit

    4.A.2.1 item

    This is the information of the product sold. If the product type is combo, there will not be any tax element.

    Attribute Name Type / Size

    Possible Values Description

    id A 16 Any Product (or item) identifier

    type A 1 S, C, G, F, P, O Product type Values:

    S = Single C = Combo G = Grouped F = Fuel Automatic P = PaidIn or PaidOut O = Credit / Debit

    seq_number I 5 Any Sequential number assigned to each item included in the transaction

    parent_seq_number I 5 Any 0 the product belongs to the first level, which are printed in the ticket 0 the product is a component of the

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 18 of 91

    product associated with the parent_seq_number

    quantity R 18,6 Any Quantity of sold products

    price_orig R 18,4 Any Price original per unit of the product with tax included

    price R 18,4 Any Price per unit of the product with tax included

    line_amount R 18,4 Any (price * quantity)

    tax_amount R 18,8 Any It is the sum of all taxes(per unit) applied to the item. It is equal to the sum of the amount attribute of all tax subelements related with this item (through the sequence number).

    barcode A 20 0 - 99999999999999999999 Barcode number used to identify the product. It is empty in case that no barcode was entered to find the product.

    desc A 50 Any Barcode description for the item If the product was selected through a barcode number. Otherwise, it is the product description that is shown on the POS.

    exempt_amount R 18,8 Any Total Exempt Amount for the transaction, these are the tax free items

    total_tax_amount R 18,8 Any It is the sum of all taxes applied to the item. It is equal to the sum of the total_amount attribute of all tax subelements related with this item (through the sequence number).

    net_amount R 18,8 Any = line_amount total_tax_amount exempt_amount

    special_price_list_id I 5 Any Special Price list identifier applied to the item into the transaction. (if any)

    promotion_id A 15 Any One special price list can have more than one promotions This id is the promotion id linked to the special price list id applied to the item into the transaction

    discount_amount R 18,4 Any Value of the discount applied to the item into the transaction

    manual_fuel_selected A 3 YES / NO No => fuel data input was provided by Pump Controller Online output. Yes => fuel data input was provided manually by POS operator. This does not mean that Pump Controller was OFFLINE.

    discount_reason_code A16 Any It is the discount reason code.

    Amount of elements: There is no specified limit

    4.A.2.1.1 tax

    Taxes are only applied to single or fuel products.

    Attribute Name Type /

    Size Possible Values Description

    Id A 5 See table Tax types Tax identifier

    amount R 18,8 Any Tax amount per unit for the item

    taxable_amount R 18,8 Any Taxable amount

    total_amount R 18,4 Any Total amount for the Item rounded to the local

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 19 of 91

    currencys fraction digits.

    Amount of elements: One element per tax identifier.

    Note: If an item is exempt (it has no taxes), the tax element will not be present for the item. In case that the transaction had only exempt items, both net_amount and total_amount attributes will

    be equal.

    4.A.2.2 tender

    Attribute Name Type / Size

    Possible Values Description

    type A 10 See table Tender type Tender type identifier

    currency A 15 See Table Currency Currency.

    amount R 14,4 Any Total amount of the transaction for this tender type

    amount_not_returned R1 Any Amount not returned to type of payment that not accept cash back.

    rate R 14,4 Any Value that corresponds to a unit (one) in the local currency.

    Amount of elements: There is no specified limit

    4.A.2.2.1 check

    This element will only appear if the tender type is a check.

    Attribute Name Type / Size

    Possible Values Description

    number A 16 Any Check number

    bank A 15 See table Banks Bank code

    issue_date D 10 Any valid date Issue date

    payable_date D 10 Any valid date This attribute will come if configured on the POS

    Amount of elements: There is no specified limit

    4.A.2.2.2 account

    This element will only appear if the tender type is a local/global account.

    Attribute Name Type / Size

    Possible Values Description

    subaccount R 4,0 Any Subaccount ID

    Amount of elements: There is no specified limit

    4.A.2.2.3 credit_card

    This element will only appear if the tender type is a credit card.

    Attribute Name Type / Size

    Possible Values Description

    type A 50 Any Type of credit card: VISA, AMEX.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 20 of 91

    This information is provided by the Card Processor

    number A 50 Any number credit card. This information is provided by the Card Processor

    batch_id I 4 1 - 9999 Batch id from where the credit card transaction belongs to. This information is provided by the Card Processor.

    voucher_num I 6 1 999999 Credit card ticket number. This information is provided by the Card Processor.

    terminal_id A 30 Any Terminal id

    card_acceptor_code A 30 Any Card acceptor code code

    Amount of elements: There is no specified limit

    4.A.2.2.4 efleet

    This element will only appear if the tender type is a efleet.

    Attribute Name Type /

    Size Possible Values Description

    id_contract I 5 1 - 99999 Identification number of contract

    id_account I 5 1 -99999 Identification number of account

    device_type A 1 A, T Device Type Values A = Anillo T = Tarjeta

    id_device A 30 Any Device Number

    odometer A10 Any (accept null) Odometer

    license_plate A15 Any (accept null) License Plate

    4.A.2.2.5 axion_card

    This element will only appear if the tender type is an axion card.

    Attribute Name Type /

    Size

    Possible Values Description

    Type A 50 AXIONCARD This description is equal to system description of

    payment in Platino.

    Pan A 50 Any number Axion card. This information is provided

    by the Card Processor, but only itll save the last 4 numbers.

    authorization_code A 50 Any

    (Ex: 123456 B)

    Authorization code where the credit card

    transaction is approved.

    This information is provided by the Card

    Processor.

    Voucher A 30 Any

    (Ex: 638)

    Axion card ticket number.

    This information is provided by the Card

    Processor.

    terminal_id I 18 Any

    (Ex: 2)

    Terminal id

    descripcion_cliente A 50 Any This information is provided by the Card

    Processor.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 21 of 91

    direccion_cliente A 50 Any This information is provided by the Card

    Processor.

    cuit_cliente A 50 Any This information is provided by the Card

    Processor.

    4.A.2.2.6 delivery_notes

    Attribute Name Type / Size

    Possible Values Description

    Node A 15 Any Node identifier. It is unique by HO

    Pos I 5 1 99999 POS identifier

    id_trans I 18 1 999999999999999999

    Transaction identifier. It is unique by POS.

    fiscal_doc_type A 10 See table Fiscal document

    Fiscal document type

    id_issuer A 10 Any Issuer number. It is the POS identification number issued by the Tax Bureau Agency of the country.

    fiscal_doc_num I 18 1 999999999999999999

    Fiscal document number. It depends on fiscal_doc_type.

    Amount of elements: There is no specified limit

    4.A.2.2.7 total_tax

    Transaction Tax Summary

    Attribute Name Type /

    Size Possible Values Description

    Id A 5 See table Tax types Tax identifier

    total_amount R 18,4 Any Total amount for the transaction

    4.A.2.2.8 customer_tax_config

    This is the tax configuration for the customer.

    Attribute Name Type / Size

    Possible Values Description

    fiscal_group A 15 See table Fiscal group Fiscal group

    tax_payer A 4 See table Tax Payer Tax payer identifier

    id_fiscal_number A 30 Any Fiscal identifier number

    tic_type A 5 See Table TIC Type Tributary identifier Type

    Amount of elements: There is no specified limit

    4.A.2.2.9 additional_data

    Attribute Name Type / Size

    Possible Values Description

    Odometer A 50 Any Odometer

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 22 of 91

    license_plate A 50 Any License plate

    Driver A 50 Any Transaction identifier. It is unique by POS.

    Observations A 10 Any Observations

    pago_facil_session_id A 8 Any Session Id sent by Pago Facil

    printer_serie A 10 Any Printer Number Series

    es_dest_propio A 50 Any Destination es_trans_propio A 50 Any Own transport

    es_transporte A 50 Any Buying transport

    nombre_chofer A 30 Any Driver Name

    Patente A 6 Any License plate

    Referencia A 50 Any Reference code

    Reffecha A 50 Any Reference Date

    Reffolio A 15 Any Reference - Folio Number

    Reftipocomp A 50 Any Reference Type of receipt

    rut_conductor A 10 Any Driver rut

    Vehiculo A 50 Any Vehicle type

    Amount of elements: There is no specified limit Examples:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 23 of 91

    fiscal_doc_type="TFB" fiscal_doc_num="136" net_amount="6.01" total_amount="7.27" total_tax="1.26" cashier_relative_shift_id="1" cashier_absolute_shift_id="40" main_group_abs="67" main_group_rel="1" id_initial_day_abs="298" id_initial_day="2" voided="N" cancel_conc_id="" cust_num="50000" cust_comm_name="Cliente Annimo" tic="" tic_type="" tax_payer="CF" origin="pos" manual="N" cash_drawer="10" rev_trans="" rev_pos="" split_category="" fiscal_auth="" fiscal_auth_expire="" cust_address_street="" cust_address_city="" exempt_amount="0.0" >

    See Apendix B for a Combo sale example.

    Example of transaction invoice delivery efleet

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 24 of 91

    4.B Cash Drop

    This file contains the cash drop(safe drop) made by the cashiers.

    File: cashdrop

    Root element: cash_drop

    4.B.1 Pos_information

    Attribute Name Type /

    Size Possible Values Description

    Pos_version A 30 Any Platinos version Amount of elements: one

    4.B.2 drop

    These attributes have general cash drop information.

    Attribute Name Type /

    Size Possible Values Description

    node A 15 Any Store identifier

    id I 18 1 999999999999999999

    Cash drop identifier. It is unique by POS.

    id_shift I 5 Any Unique number to identify the shift This number is by POS.

    pos I 5 1 99999 POS identifier

    cash_drawer I 5 1 99999 Cash Drawer Identifier

    envelope I 10 1 - 9999999999 Envolope identifier where the cash was dropped.

    business_date D 10 Any valid date Date for the business

    date D 10 Any valid date Date at the moment of the cash drop.

    time T 6 Any valid time Time at the moment of the cash drop.

    id_cashier A 15 Any Store operator identifier (system user id) who made the transaction

    cashier_name A 30 Any Store operator name (system user name)

    total_amount R 14,4 0,0 99999999999999,9999

    Total amount of the transaction for this tender type

    cashier_relative_shift_id I 5 Any Cashier Shift ID relative to the current Business day

    Amount of elements: There is no specified limit

    4.B.2.1 detail

    Attribute Name Type / Size

    Possible Values Description

    currency A 15 See Table Currency Currency.

    cashier_value A 15 See Table Cashier_Value

    Cashier_Value, these are different representations of the currency, for example in

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 25 of 91

    Argentina the Peso can be represented as Pesos or as Patacones.

    amount R 14,4 0,0 99999999999999,9999

    Amount dropped.

    rate R 14,4 0,0 99999999999999,9999

    Value that corresponds to a unit (one) in the local currency.

    Amount of elements: There is no specified limit

    Example:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 26 of 91

    4.C Filling Detail This file contains the details about the fillings made by the pumps.

    Data would not have associated one-to-one to a sale transaction in transactions file due to many uncontrolled sale could be a unique sale transaction.

    File: filldeta

    Root element: filling_detail

    4.C.1 Pos_information

    Attribute Name Type / Size

    Possible Values Description

    Pos_version A 30 Any Platinos version Amount of elements: one

    4.C.2 filling

    Attribute Name Type /

    Size Possible Values Description

    node A 15 Any Store identifier

    id I 18 1 999999999999999999

    Sale identifier. This value starts from 1 for each shift

    shift_date D 10 Any valid date Date on which the shift started

    shift_time T 6 Any valid time Time on which the shift started

    business_date D 10 Any valid date Date for the business

    date D 10 Any valid date Date on which the sale occurred

    time T 6 Any valid time Time on which the sale occurred

    pump I 2 1 99 Pump identifier

    hose I 1 0 9 Hose identifier

    product A 9 Any Product identifier

    type A 1 N, U, P Sale type Values:

    N = Normal sale U = Uncontrolled sale R = Pump test with return P = Pump test without return

    ppu R 6,3 0,0 999.999,999 Price per unit of the product. If the type is U, the ppu could be different to the transaction ppu.

    amount R 6,3 0,0 999.999,999 Sale amount

    volume R 6,3 0,0 999.999,999 This value must be equal to the sum of all volumes in each tank sub-element

    ini_vol_totalizer R 6,3 0,0 999.999,999 Total volume initial from dispenser meter

    fin_vol_totalizer R 6,3 0,0 999.999,999 Total volume final from dispenser meter

    ini_amount_totalizer R 6,3 0,0 999.999,999 Total amount initial from dispenser meter

    fin_amount_totalizer R 6,3 0,0 999.999,999 Total amount final from dispenser meter

    prepaid L 1 Y, N Notify whether the sale was prepaid or not

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 27 of 91

    Values: Y = It is prepaid N = It is not prepaid

    id_trans I 18 1 999999999999999999

    Transaction identifier. It is unique by POS.

    id_cashier A 10 Any Id user

    cashier_name A 10 Any Name user

    Amount of elements: There is no specified limit

    4.C.2.1 tank

    Attribute Name Type /

    Size Possible Values Description

    id A 2 1 99 Tank identifier which was used to sell

    volume N 6,3 0,0 999.999,999 Volume pulled from this tank

    product I 15 0 999999999999999 Product identifier

    Example:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 28 of 91

    4.D Filling Summary This file contains the summary about the fillings made by the pumps. File: fillsuma

    Root element: filling_summary

    4.D.1 Pos_information

    Attribute Name Type / Size

    Possible Values Description

    Pos_version A 30 Any Platinos version Amount of elements: one

    4.D.2 filling

    Attribute Name Type / Size

    Possible Values Description

    node A 15 Any Store identifier

    pump I 2 1 99 Pump identifier hose I 1 0 9 Hose identifier main_group_abs I 5 Any Unique shift ID for Main Group

    main_group_rel I 5 Any Main Group Shift ID relative to the current Business day

    shift_date D 10 Any valid date Date on which the shift started

    shift_time T 6 Any valid time Time on which the shift started

    product A 9 Any Fuel product identifier

    business_date D 10 Any valid date Date for the business

    total_volume R 6,3 0,0 999.999,999 Total volume for the shift, pump and hose. It is the sum of all volumes of the data element.

    total_amount R 6,3 0,0 999.999,999 Total amount for the shift, pump and hose. It is the sum of all amounts of the data element.

    ini_vol_totalizer R 6,3 0,0 999.999,999 Total volume initial from dispenser meter

    fin_vol_totalizer R 6,3 0,0 999.999,999 Total volume final from dispenser meter

    ini_amount_totalizer R 6,3 0,0 999.999,999 Total amount initial from dispenser meter

    fin_amount_totalizer R 6,3 0,0 999.999,999 Total amount final from dispenser meter

    Amount of elements: There is no specified limit.

    4.D.2.1 data

    Attribute Name Type / Size

    Possible Values Description

    type A 1 N, U, P Sale type. Values:

    N = Normal sale U = Uncontrolled sale R = Pump test with return P = Pump test without return

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 29 of 91

    amount R 6,3 0,0 999.999,999 Sale amount

    volume R 6,3 0,0 999.999,999 Sale volume

    Amount of elements: No more than three with different types.

    Example:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 30 of 91

    4.E Tank Product Inventory This file contains the tank product inventory. File: tankinvt

    Root element: tank_product_inventory

    4.E.1 Pos_information

    Attribute Name Type /

    Size Possible Values Description

    Pos_version A 30 Any Platinos version Amount of elements: one

    4.E.2 tank

    Attribute Name Type / Size

    Possible Values Description

    node A 15 Any Store identifier

    id A 2 1 99 Tank identifier

    product A 9 Any Fuel product identifier

    shift_date D 10 Any valid date Date on which the shift started

    shift_time T 6 Any valid time Time on which the shift started

    business_date D 10 Any valid date Date for the business

    fuel_volume R 6,3 0,0 999.999,999 Measured volume of fuel (in liters/gallons) calculated by the system depending on the tank calibration

    water_volume R 6,3 0,0 999.999,999 Measured volume of water (in liters/gallons) calculated by the system depending on the tank calibration

    date D 10 Any valid date Date of volume calculation

    time T 6 Any valid time Time of volume calculation

    reading_date D 10 Any valid date Date of measures readings

    reading_time T 6 Any valid time Time of measures readings

    Amount of elements: There is no specified limit.

    Example:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 31 of 91

    4.F Cashier Statistics This file contains the information about cashier statistics. File: cashstat

    Root element: cashier_statics

    4.F.1 pos_information

    Attribute Name Type / Size

    Possible Values Description

    Pos_version A 30 Any Platinos version Amount of elements: one

    4.F.2 cashier

    Attribute Name Type /

    Size Possible Values Description

    node A 15 Any Store identifier

    id A 15 Any Store operator identifier (system user id)

    cashier_name A 30 Any Store operator name (system user name)

    business_date D 10 Any valid date Date for the business

    shift_date D 10 Any valid date Date of the shift closed. Zeros if it is generated at the day end

    shift_time T 6 Any valid time Time of the shift closed. Zeros if it is generated at the day end

    sale_cancellation_qty I 18 0 999999999999999999 Number of cancellations before ends

    sale_cancellation_amount R 14,4 0,0 99999999999999,9999 Amount in cancellations before ends

    voided_qty I 18 0 999999999999999999 Number of sales transactions cancelled

    voided_amount R 14,4 0,0 99999999999999,9999 Amount of sales cancelled

    refund_qty I 18 0 999999999999999999 Number of refunds transactions

    refund_amount R 14,4 0,0 99999999999999,9999 Amount of refunds transactions

    items_deteled_qty I 18 0 999999999999999999 Number of items deleted before transaction ending

    items_deleted_amount R 14,4 0,0 99999999999999,9999 Amount of items deleted before transaction ending

    trans_qty I 18 0 999999999999999999 Total quantity of sales transactions

    trans_amount R 14,4 0,0 99999999999999,9999

    Total amount of sales transactions

    manual_discounts_qty I 18 0 999999999999999999 Times the cashier granted

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 32 of 91

    a discount manually from the POS

    manual_discounts_amount R 14,4 0,0 99999999999999,9999 Amount of discount granted manually from POS

    drawer_open I 18 0 999999999999999999 Times that drawer was opened and it was not a sale

    drawer_open_amount R 14,4 0,0 99999999999999,9999 Amount of drawer was opened and it was not a sale

    manual_overprice_qty I 18 0 999999999999999999 Times the cashier rised the price manually from the POS

    manual_overprice_amount R 14,4 0,0 99999999999999,9999 Amount of manual overprice collected from POS

    safe_drop_qty I 18 0 999999999999999999 Safe drop quantity

    safe_drop_amount R 14,4 0,0 99999999999999,9999 Safe drop amount

    cash_short_qty I 18 0 999999999999999999 Times of cash sort

    cash_short R 14,4 0,0 99999999999999,9999 Cash_short To get this functionality a login by transaction is required but it will work if only one generic user is used and it is loged during the whole period Last cash drop functionality should be used if not this values will be always ceros

    authorize_duplicate_safe_drop_qty I 18 0 999999999999999999 Times of authorize duplicate safe dropeleted before transaction ending

    authorize_duplicate_safe_drop_amount R 14,4 0,0 99999999999999,9999 Amount of authorize duplicate safe dropeleted before transaction ending

    cash_over_qty I 18 0 999999999999999999 Times of cash over

    cash_over R 14,4 0,0 99999999999999,9999 Cash over. To get this functionality a login by transaction is required but it will work if only one generic user is used and it is loged during the whole period Last cash drop functionality should be used if not this values will be always ceros

    Amount of elements: There is no specified limit

    Example:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 33 of 91

    trans_amount="0" manual_discounts_qty="0" manual_discounts_amount="0" drawer_open="0" drawer_open_amount="0" manual_overprice_qty="0" manual_overprice_amount="0" safe_drop_qty="0" safe_drop_amount="0" cash_short_qty="0" cash_short="0" authorize_duplicate_safe_drop_qty="0" authorize_duplicate_safe_drop_amount="0" cash_over_qty="0" cash_over="0" />

    4.G Endings

    This file contains the information about shift, day, month and year endings. Only the SHOP module will inform Day, Month and Year endings. Other modules will refer to independent

    terminal shift endings. A Shop module shift ending refers to the event of a terminal group ending.

    File: endingss

    Root element: endings

    4.G.1 Pos_information

    Attribute Name Type / Size

    Possible Values Description

    Pos_version A 30 Any Platinos version Amount of elements: one

    4.G.2 endings

    Attribute Name Type /

    Size Possible Values Description

    node A 15 Any Store identifier

    type A 1 S, D, M o Y Operator (S)hift, (D)ay end, (M)onth end, (Y)ear end

    module A15 Any valid Modules

    terminal I 5 1 99999 Terminal ID

    id I 5 1 99999 End ID

    number I 5 1 99999 Turn counter in the current period

    day_id I 5 1 99999 Corresponding day period counter id, present for type=SHIFT

    month_id I 5 1 99999 Corresponding Month period counter id, present for type=SHIFT or DAY

    year_id I 5 1 99999 Corresponding Year period counter id, present for typeYEAR

    depending_id I 5 1 99999 End ID of the super period

    business_date D 10 Any valid date Business Date

    open_date D 10 Any valid date End opening date

    open_time T 6 Any valid time End opening time

    end_date D 10 Any valid date End close date

    end_time T 6 Any valid time End close time

    operator A15 Any valid operator Present for Module CAJA in the case of a Billetera

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 34 of 91

    Amount of elements: There is no specified limit

    Example:

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 35 of 91

    5 Input files: BO to POS

    5.A Customers This file contains the customers to be created, deleted or modified at the store. File: customer

    Root element: customers

    5.A.1 update This is the customer information. If the customer doesnt exist in the POS system, it will be created. Otherwise, it will be modified.

    Attribute Name Type / Size

    Possible Values Required? Description

    cust_number E 18 1 999999999999999999

    Yes Customer identifier

    category A 15 See table Customer Category

    Yes Customer category

    last_name A 50 Any Yes Customer last name or commercial name

    first_name A 50 Any No Customer first name

    nationality A 15 See table Country Yes Country on which the customer was born.

    activity_code A 15 See table Activity Code

    No Customer commercial activity

    doc_type A 50 See table Document Type

    No Document type. If the field doc_type sent, should sent the field doc_number also.

    doc_number A 50 Any No Document number

    birth_date D 10 Any valid date No Birth date

    phone I 18 0 999999999999999999

    No Telephone number

    fax I 18 0 999999999999999999

    No Fax number

    address_type A 1 C, P No Address type. Values: C = Commercial address P = Particular address Default value: P

    street A 50 Any No Street name. See note.

    number I 5 0 99999 No Street number. See note.

    floor I 3 0 999 No Apartment floor. See note.

    department A 5 Any No Department. See note.

    zipcode A 10 Any No Zip code. See note.

    division3 A 20 Any No Division name for level 3. Example of division3 can be Locality.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 36 of 91

    division2 A 20 Any No Division name for level 2. Example of division2 can be City .

    division1 A 15 See Table Province No Division name for level 1. Examples of division1 can be Province or State.

    country A 15 See table Country Yes Country on which the customer belongs to

    observation A 200 Any No Observations

    special_price_list I 5 0 99999 No Price list identifier. Each customer may have one special price list. Values:

    0 = Its a General list for any customer.

    1 99999 = Its a Special list. enable L 1 Y, N No Enable customer

    Amount of elements: There is no specified limit Validation:

    The price list special_price_list must exist in the system Both doc_type and doc_number must be empty or not empty toghether. If the attributes doc_type and doc_number are not empty, the nationality must not be empty.

    Note:

    Both division1 and country attributes are not required, but if one of them has value and the other has not value, then an error will be informed. This means that both attributes must appear together with valid values. Besides, only when both division1 and country attributes have values, anyone of street, number, floor, department, city and zipcode will be considered.

    5.A.1.1 tax_config

    This is the tax configuration for the customer.

    Attribute Name Type / Size

    Possible Values Required? Description

    fiscal_group A 15 See table Fiscal group Yes Fiscal group

    tax_payer A 4 See table Tax Payer Yes Tax payer identifier

    id_fiscal_number A 30 Any No Fiscal identifier number

    Amount of elements: At least one Validation:

    The attributes values of fiscal_group and tax_payer must be consistent with the table Tax Payer

    5.A.1.2 patent_config

    Attribute Name Type / Size Possible Values Description

    cust_number E 18 1 999999999999999999 Any

    Customer identifier

    patent A 15 Any Patent of the Car

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 37 of 91

    nationality_car A 50 Any Nationality of the Car

    5.A.2 delete This customer will be deleted from the database.

    Attribute Name Type /

    Size Possible Values Required? Description

    cust_number I 18 1 999999999999999999

    Yes Customer identifier to be disabled.

    country A 15 See table Country Yes Country on which the customer belongs to

    Amount of elements: There is no specified limit

    Validation:

    In eliminating customer will validate if exits patent and nationality associated. If exists one or more patents and nationalities will eliminate all the registers.

    Example:

    |

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 38 of 91

    5.B Products This file contains the products to be created, deleted or modified at the store. File: products

    Root element: products

    5.B.1 single This element defines the product to be updated. If the product does not exist in the POS system, it will be created. Otherwise, it will be modified.

    Attribute Name Type /

    Size Possible Values Required? Description

    id A 16 0 999999999999999 Yes Product identifier

    desc A 50 Any Yes Product description to be shown on the POS

    ticket_desc A 15 Any Yes Product description to be shown on the ticket

    id_tax A 15 See table Tax Configuration

    No Tax identifier that represents a group of taxes.

    price R 14,4 0,0 99999999999999,9999

    Yes Product price per unit

    cost R 14,4 0,0 99999999999999,9999

    No Product Cost

    sale_enable L 1 Y, N Yes Enable or disable the product so that it can be sold or not at the POS. Values:

    Y = enable N = disable (it cannot be sold like a single product) For example, this option can be used for ingredients)

    consig_indic I 18 0 999999999999999999

    No Consignment indicator

    eft_code I 15 0 999999999999999 No EFT or ATOS code Applies only to EssoCard module, otherwise, do not send Tag.

    id_categ1 A 15 Any Yes First level category. This level is used to represent general groups of products. Every product must be associated to one category at least.

    id_categ2 A 15 Any No Second level category. Subcategory of id_categ1.

    id_categ3 A 15 Any No Third level category. Subcategory of id_categ2.

    id_categ4 A 15 Any No Fourth level category. Subcategory of id_categ3. This level is used to represent specific groups of products.

    unit_measure A 15 See Table Measurement Unit

    Yes Unit measure valid.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 39 of 91

    icon A 30 Any No Icon file name. This icon will be showed in the POS for this product. If this attribute does not appear or is empty, a default icon will be used.

    id_department A 20 See table Department Yes It is the place where the product can be sold.

    doc_category A 15 See table Document Category

    Yes Document category

    quantifiable L 1 Y, N Yes Indicates if the product can be considered in the stock

    manual_price L 1 Y, N Yes Indicates if the price can be entered manually by the cashier

    activity I 10 0 - 999999999 No Activity Id Number Only when the article requires individually Activity ID Number.

    Amount of elements: There is no specified limit

    5.B.1.1 barcode

    It is a barcode assigned to a product, which is used to recognize the product with a scanner.

    Attribute Name Type /

    Size Possible Values Required? Description

    number A 20 0 - 99999999999999999999

    Yes Barcode number to identify the product

    desc A 50 Any No Specific description for the product with this barcode.

    Amount of elements: There is no specified limit

    5.B.1.2 tax

    Special taxes assigned directly to the product that are not included in the TAX GROUP. This subelement is optional.

    Attribute Name Type /

    Size Possible Values Required? Description

    id_tax A 5 0 - 99999999999999999999

    Yes A valid TAX_TYPE available in Platinos RTL_TIPO_IMPUESTO table

    value R 16,8 Any No Value to be applied

    Amount of elements: There is no specified limit

    5.B.2 combo This element defines the product to be updated. If the product does not exist in the POS system, it will be created. Otherwise, it will be modified.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 40 of 91

    Attribute Name Type /

    Size Possible Values Required? Description

    id A 16 0 999999999999999 Yes Product identifier

    desc A 50 Any Yes Product description to be shown on the POS

    ticket_desc A 15 Any Yes Product description to be shown on the ticket

    sale_enable L 1 Y, N Yes Enable or disable the product so that it can be sold or not at the POS. Values:

    Y = enable N = disable (it cannot be sold like a single product) For example, this option can be used for ingredients)

    consig_indic I 18 0 999999999999999999

    No Consignment indicator

    eft_code I 15 0 999999999999999 No EFT or ATOS code

    id_categ1 A 15 Any Yes First level category. This level is used to represent general groups of products. Every product must be associated to one category at least.

    id_categ2 A 15 Any No Second level category. Subcategory of id_categ1.

    id_categ3 A 15 Any No Third level category. Subcategory of id_categ2.

    id_categ4 A 15 Any No Fourth level category. Subcategory of id_categ3. This level is used to represent specific groups of products.

    unit_measure A 15 Any Yes Unit measure valid

    icon A 30 Any No Icon file name. This icon will be showed in the POS for this product. If this attribute does not appear or is empty, a default icon will be used.

    id_department A 20 See table Department Yes It is the place where the product can be sold.

    doc_category A 15 See table Document Category

    Yes Document category

    quantifiable L 1 Y, N Yes Indicates if the product can be considered in the stock

    manual_price L 1 Y, N Yes Indicates if the price can be entered manually by the cashier

    Amount of elements: There is no specified limit

    5.B.2.1 barcode

    It is a barcode assigned to a product, which is used to recognize the product with a scanner.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 41 of 91

    Attribute Name Type /

    Size Possible Values Required? Description

    number A 20 0 - 99999999999999999999

    Yes Barcode number to identify the product

    desc A 50 Any No Specific description for the product with this barcode.

    Amount of elements: There is no specified limit

    5.B.2.2 item

    This is a product that is part of the combo product.

    Attribute Name Type / Size

    Possible Values Required?

    Description

    id A 16 0 - 999999999999999 Yes Product identifier that is part of the combo product

    qty R 14,5 0 - 99999999999999,99999

    Yes Units quantity of this product component inside the combo

    price R 14,4 0 - 99999999999999,9999 Yes Price per unit. Replaces the price that comes with the product. If specified, "total_price" shall not.

    total_price R 14,4 0 - 99999999999999,9999 No qty per price. If not present, Platino will use the qty and price attributes to manually calculate the total price of the item in the combo.

    type A 15 F, A, O Yes Price type. Values:

    F = Fix A = Additional O = Optional

    Amount of elements: There is no specified limit

    5.B.3 grouped This element defines the product to be updated. If the product does not exist in the POS system, it will be created. Otherwise, it will be modified.

    Attribute Name Type /

    Size Possible Values Required? Description

    id A 16 0 999999999999999 Yes Product identifier

    desc A 50 Any Yes Product description to be shown on the POS

    ticket_desc A 15 Any Yes Product description to be shown on the ticket

    sale_enable L 1 Y, N Yes Enable or disable the product so that it can be sold or not at the POS. Values:

    Y = enable N = disable (it cannot be sold like a single product) For example, this option can be used for

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 42 of 91

    ingredients)

    consig_indic I 18 0 999999999999999999

    No Consignment indicator

    eft_code I 15 0 999999999999999 No EFT or ATOS code

    id_categ1 A 15 Any Yes First level category. This level is used to represent general groups of products. Every product must be associated to one category at least.

    id_categ2 A 15 Any No Second level category. Subcategory of id_categ1.

    id_categ3 A 15 Any No Third level category. Subcategory of id_categ2.

    id_categ4 A 15 Any No Fourth level category. Subcategory of id_categ3. This level is used to represent specific groups of products.

    unit_measure A 15 Any Yes Unit measure valid.

    icon A 30 Any No Icon file name. This icon will be showed in the POS for this product. If this attribute does not appear or is empty, a default icon will be used.

    id_department A 20 See table Department Yes It is the place where the product can be sold.

    Amount of elements: There is no specified limit

    5.B.3.1 item

    This is a product that is part of the grouped product.

    Attribute Name Type / Size

    Possible Values Required? Description

    id A 16 0 - 999999999999999 Yes Product identifier that is part of the grouped product

    Amount of elements: There is no specified limit

    5.B.4 fuel This element defines the product to be updated. If the product does not exist in the POS system, it will be created. Otherwise, it will be modified.

    Attribute Name Type /

    Size Possible Values Required? Description

    id A 16 0 999999999999999 Yes Product identifier

    desc A 50 Any Yes Product description to be shown on the POS

    ticket_desc A 15 Any Yes Product description to be shown on the ticket

    grade R 18,0 0 - 999999999999999999

    Yes CEM product ID, if present the fuel is Automatic, if not the fuel is manual.

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 43 of 91

    id_tax I 5 See table Tax configuration

    No Tax identifier that represent a group of taxes.

    sale_enable L 1 Y, N Yes Enable or disable the product so that it can be sold or not at the POS. Values:

    Y = enable N = disable (it cannot be sold like a single product) For example, this option can be used for ingredients)

    Note: this attribute must only appear when the type attribute has value M.

    consig_indic I 18 0 999999999999999999

    No Consignment indicator

    eft_code I 15 0 999999999999999

    No EFT or ATOS code

    id_categ1 A 15 Any Yes First level category. This level is used to represent general groups of products. Every product must be associated to one category at least.

    id_categ2 A 15 Any No Second level category. Subcategory of id_categ1.

    id_categ3 A 15 Any No Third level category. Subcategory of id_categ2.

    id_categ4 A 15 Any No Fourth level category. Subcategory of id_categ3. This level is used to represent specific groups of products.

    unit_measure A 15 Any Yes Unit measure valid.

    icon A 30 Any No Icon file name. This icon will be showed in the POS for this product. If this attribute does not appear or is empty, a default icon will be used.

    id_department A 20 See table Department Yes It is the place where the product can be sold.

    cost R 14,4 0,0 99999999999999,9999

    No Product Cost

    doc_category A 15 See table Document Category

    Yes Document category

    Amount of elements: There is no specified limit

    5.B.4.1 tax

    Special taxes assigned directly to the product that are not included in the TAX GROUP. This subelement is optional.

    Attribute Name Type /

    Size Possible Values Required? Description

    id_tax A 5 0 - 99999999999999999999

    Yes A valid TAX_TYPE available in Platinos RTL_TIPO_IMPUESTO table

    value R 16,8 Any No Value to be applied

  • PLatino POS

    Interface Specification PLatino and Back Office third parties

    Version 1.41

    Page 44 of 91

    Amount of elements: There is no specified limit

    5.B.4.2 Manual Fuels

    The BO does not specify Manual Fuel products but they must exist in Platino for use when CEM is not operational for a fuel pump.

    When the BO sends the Price Change file for the automatic fuel, Platino will create and update a Manual Fuel product for each price level and the manual fuel shall be mapped to the grade and level of the price. The Platino interface can be configured to create automatically the Manual Fuel ID