SAP POS 2.3 SDK Technical Reference

Transcription

1 SDK Technical Reference Guide SAP Point-of-Sale 2.3 Document Version:

2 Typographic Conventions Type Style Example Description Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Textual cross-references to other documents. Example EXAMPLE Example Example <Example> EXAMPLE Emphasized words or expressions. Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE. Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools. Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system. Keys on the keyboard, for example, F2 or ENTER SAP SE or an SAP affiliate company. All rights reserved. Typographic Conventions

3 Document History Version Date Change Initial version for the SAP POS 2.3 release Updated document version to match POS 2.3 SP Updated template. Document History 2015 SAP SE or an SAP affiliate company. All rights reserved. 3

4 Contents 1 Introduction Glossary PtBatch ASCII Line Formats for POS Comma Separated Field Format Line Formats Field Formats Update Flag Not Supported Records Header Record (Sequence Number 1) Summary Record (Sequence Number 2) Admin Record (Sequence Number 3) Total Record (Sequence Number 4) Merchandise Item Record Non-Merchandise Item Record Item Discount Record Transaction Discount Record SAP SE or an SAP affiliate company. All rights reserved. Contents

5 1 Introduction This document describes the Pending Transactions ASCII line formats that are used to import new or outstanding pending transactions. The primary intended audience for this document is developers. Introduction 2015 SAP SE or an SAP affiliate company. All rights reserved. 5

6 2 Glossary Term SDK Description Software Development Kit SAP SE or an SAP affiliate company. All rights reserved. Glossary

7 3 PtBatch ASCII Line Formats for POS 10.3 These formats are used to import new or outstanding pending transactions. Multiple pending transactions can be put in one file. 3.1 Comma Separated Field Format A comma separated field format file is converted to XML by PtBatch and then submitted to the Pending Transaction object. Each pending transaction is comprised of multiple lines in the file. Each line begins with a one or two character string that identifies the contents of that line (as it maps to the entries comprising the pending transaction request in XML format). 3.2 Line Formats Optional fields in each line are surrounded by square brackets ([ ]). If any single optional field is provided, values for all preceding fields must also be supplied. Field names are shown in angle brackets (< >). Where a record sequence number is indicated, the record must appear at the indicated position within the group of records that define a single transaction. That is, a transaction must always begin with a Header record, Summary record, Admin record, and Total record, in that sequence. Record types without a sequence number can appear any number of times following the header (for example, sequenced) records. 3.3 Field Formats Yes/No fields must be entered as 0 for No or 1 for Yes Date fields must use a 4 digit year Do not use the characters or around character or string data Do not leave a field empty. If needed use 0 for numeric fields and a space for character fields. 3.4 Update Flag If using the update option in PtBatch, or with the interface, any records previously saved will be replaced. Records cannot be deleted. PtBatch ASCII Line Formats for POS SAP SE or an SAP affiliate company. All rights reserved. 7

8 4 Not Supported Some fields are described as obsolete as they are not supported or require other internal data to also be populated which is not provided by this interface. Note This format does not support all features of pending transactions SAP SE or an SAP affiliate company. All rights reserved. Not Supported

9 5 Records 5.1 Header Record (Sequence Number 1) This line marks the start of a pending transaction definition (and the end of the previous transaction). The end of file also indicates the end of the current pending transaction definition. LH, transaction number LH Identifier for the Header record String Mandatory Transaction number This number is the register s transaction number. It is also used as an internal number (transnum) as the linking key between all 1-6 digits Mandatory This number must be unique. Check the transnum field in the ptd_admin table. the records of a pending transaction in the set of ptd_* tables. 5.2 Summary Record (Sequence Number 2) LS, <totalpaymentamount>, <updatedate> [, <lastpaymentdate>, <originaldate>, <tax1>, <tax2>, <tax3>, <tax4>, usemanualtaxpercent1, usemanualtaxpercent2, usemanualtaxpercent3, usemanualtaxpercent4, manualtaxpercent1, manualtaxpercent2, manualtaxpercent3, manualtaxpercent4>] LS Identifier for Summary record totalpaymentamount Total payment amount paid to-date Ex: updatedate Date of last update Date time Example Formats: 9/22/ :15 or 25 January 1996 or January :30 Records 2015 SAP SE or an SAP affiliate company. All rights reserved. 9

10 Do not use a comma within the field. lastpaymentdate Date of last payment Date time Defaults to updatedate if not provided. Example Formats: 9/22/ :15 or 25 January 1996 or January :30 Do not use a comma within the originaldate Original date Date time Defaults to updatedate if not provided. field. Example Formats: 9/22/ :15 or 25 January 1996 or January :30 Do not use comma within the field. Tax1 Tax 1 amount charged in Ex: 1.52 transaction. Tax may be recalculated by the POS according to the items tax flags. Tax2 Tax 2 amount charged in transaction. EX: 1.52 Tax may be recalculated by the POS according to the items tax flags. Tax3 Tax 3 amount charged in transaction. Tax may be recalculated by the POS according to the items tax flags. Tax4 Tax 4 amount charged in transaction. Tax may be recalculated by the POS according to the items tax flags. usemanualtaxpercen Use Manual Tax Percent This indicates that manual tax t1 on Tax 1. 1 (Yes) or 0 (No) percentage is to be used in the tax calculation. This is equivalent to using manager code 108. usemanualtaxpercen Use Manual Tax Percent This indicates that manual tax t2 on Tax 2. 1 (Yes) percentage is to be used in the tax calculation. This is equivalent to using manager code SAP SE or an SAP affiliate company. All rights reserved. Records

11 usemanualtaxpercen t3 Use Manual Tax Percent on Tax 3. 1 (Yes) This indicates that manual tax percentage is to be used in the tax calculation. This is equivalent to using manager code 108. usemanualtaxpercen t4 Use Manual Tax Percent on Tax 4. 1 (Yes) This indicates that manual tax percentage is to be used in the tax calculation. This is equivalent to using manager code 108. manualtaxpercent1 Manual Tax Percent for Tax 1. Up to 3 decimals Ex: 2.25 This indicates that manual tax percentage is to be used in the tax calculation. manualtaxpercent2 Manual Tax Percent for Tax 2. Up to 3 decimals This indicates that manual tax percentage is to be used in the tax calculation. manualtaxpercent3 Manual Tax Percent for Tax 3. Up to 3 decimals This indicates that manual tax percentage is to be used in the tax calculation. manualtaxpercent4 Manual Tax Percent for This indicates that manual tax Tax 4. Up to 3 decimals percentage is to be used in the tax calculation. 5.3 Admin Record (Sequence Number 3) LA, <cashiernumber>, <itemdatetime>, <ptid>, <ptnumber>, <registergroupnumber>, <registernumber>, <storenumber> [, <bindescription1>, <bindescription2>, <bindescription3>, <bindescription4>, <customername>, <customernumber>, <phonenumber1>] LA Identifier for the Admin record cashiernumber Cashier number 1-8 digits itemdatetime Date and time of sale Date time Example Formats: 9/22/ :15 or 25 January 1996 or Records 2015 SAP SE or an SAP affiliate company. All rights reserved. 11

12 January :30 Do not use a comma within the field. ptdid ptnumber Pending Transaction ID corresponding to a valid Configurator Pending Transaction ID. Identifies the pending transaction number, which is the unique number assigned to each pending transaction created. 1-2 digits 1-8 digits registergroupnumbe r Obsolete Use 0 registernumber storenumber Register number recorded for the pending transaction. Must be current store number where pending transactions are being loaded. 1-8 digits bindescription1 Bin 1 Description. String If not using, enter 1 space. 1-5 characters bindescription2 Bin 1 Description. String If not using, enter 1 space. 1-5 characters bindescription 3 Bin 1 Description. String If not using, enter 1 space. 1-5 characters bindescription4 Bin 1 Description. String If not using, enter 1 space. 1-5 characters customername Customer last name and first name. String 1-20 characters Do not use a comma between last name and first name. customernumber Customer number String 1-14 characters phonenumber1 Phone number 1-16 digits This number must already exist in the POS database (table pa_customer). Do not use any formatting characters or spaces SAP SE or an SAP affiliate company. All rights reserved. Records

13 5.4 Total Record (Sequence Number 4) LT, <schedulenumber>, <servicecharge>, <totalsale> [, <cancelfee>, <cancelfeetax>, <servicechargetax>] LT Identifier for the Total record schedulenumber Schedule Number used for the configured Pending Transaction ID. Use same schedule number defined for the configured Pending Transaction ID. servicecharge totalsale cancelfee cancelfeetax Service Charge. Obsolete. Total cost of pending transaction. This includes discount amounts. This does not include tax amounts. This amount does not include any service charge or deposit amounts automatically charged by the configured Pending Transaction. Cancel Fee. Obsolete. Tax Flags Bit Format. Obsolete. Use 0 Use 0 Use 0 The service charge used in the configuration will be used. If the transaction is subsequently cancelled the cancel fee is taken from the Pending Transaction configuration. servicechargetax Tax Flags Bit Format. Use 0 Obsolete. 1 digit Records 2015 SAP SE or an SAP affiliate company. All rights reserved. 13

14 5.5 Merchandise Item Record I, <skunumber>, <extendedsellprice>, [, <istaxable1>, istaxable2>, <istaxable3>, <istaxable3>, <istaxable4>, <quantity>, <extendedoriginalprice>, <extendedundiscountprice>, <discounted>, <activemixmatch>, <clusterquantity>, <linkeditem>, <pricelevel>, <standardunitprice>] I Identifier for the Merchandise record skunumber PLU number String 1-18 characters extendedsellprice Extended selling price (for example, quantity * retail price). This price is after the discount. If the extended original price is greater than this value and the merchandise does not have a discount, the difference in price is considered a price override. istaxable1 Was taxed? Required if the item is taxed. 1 (Yes) or 0 (No) istaxable2 Was taxed? Required if the item is taxed. 1 (Yes) or 0 (No) istaxable3 Was taxed? Required if the item is taxed. 1 (Yes) or 0 (No) istaxable4 Was taxed? Required if the item is taxed. 1 (Yes) or 0 (No) Quantity Quantity purchased. Defaults to 1 if not provided. Up to 3 decimals extendedoriginal Extended Original Price. Defaults to Price extendedsellprice if not provided. extendedundiscount Extended Price before Defaults to Price discounts. extendedoriginalprice if not provided. Discounted Indicates whether or not there is a discount on this item. The discount 1 (Yes) or 0 (No) Must be 1 if the item is followed by a DI or DT record. must follow this row. activemixmatch Obsolete Use 0 clusterquantity Obsolete Up to 3 decimals Use SAP SE or an SAP affiliate company. All rights reserved. Records

15 linkeditem Is a linked item (item in a package)? 1 (Yes) or 0 (No) Use 0 pricelevel Obsolete Use 0 standardunitprice Standard Unit Price 5.6 Non-Merchandise Item Record N, <nonmerchandiseid>, <extendedsellprice> [,<quantity>, <extendedoriginalprice>, <discounted>,<referencenumber>] N Identifier for the Non- Merchandise nonmerchandiseid Non-Merchandise ID from configurations. extendedsellprice Extended selling price If the extended original price is (for example, quantity * retail price). This price is after discount. greater than this value and the merchandise does not have a discount, the difference in price is considered a price override. quantity Quantity purchased Defaults to 1 if not provided. Up to 3 decimals ExtendedOriginalPr Extended Original Price Defaults to extendedsellprice ice if not provided. discounted Indicates whether or not Must be 1 if the item is followed by there is a discount on this item. 1 (Yes) or 0 (No) a DI or DT record. referencenumber Reference Number. String 1-20 characters Records 2015 SAP SE or an SAP affiliate company. All rights reserved. 15

16 5.7 Item Discount Record An Item Discount record must immediately follow the Merchandise Item or Non-Merchandise record to which the discount applies. DI, <discounttypecode>,<discountdefinitionnumber>, <extendeddiscountamount> [, <taxflags>, <discountpercent>, <discountquantity>, <affectnetsales>, <referencenumber>, <autopreset>, <usingpreset>, <employeesale>] DI Identifier for the Item Discount record discounttypecode Type of discount. This type must correspond to the configured Discount Type in the Discount Configuration. Valid numeric values for Item Discounts are: 1 - PERCENT 2 - DOLLAR 3 - MARKDOWN PRICE 11 - ITEM EMPLOYEE PERCENT 12 - SURCHARGE PERCENT 13 - SURCHARGE DOLLAR discountdefinition Number Must correspond to a configured discount ID. 1-3 digits extendeddiscountam ount Extended Discount Amount: For discount enter negative sign. Unit discount * quantity. Ex: taxflags This indicates which taxes are to be applied to the discount amount. 1-2 digits Value = binary values for each tax applicable from right to left (tax 1, 2, 3, 4) This is a binary representation of the 4 Tax Flags. To calculate the value add: 1 if tax 1 is applicable 2 if tax 2 is applicable 4 if tax 3 is applicable 8 if tax 4 is applicable Example: if tax 1, 2 and 4 are applicable the binary representation is 1011 which is the numeric value 11. discountpercent Percent used to calculate the discount. This field is Up to 3 decimals For example, 2.5 for 2.5 percent SAP SE or an SAP affiliate company. All rights reserved. Records

17 informational. It is not used to calculate a percent. Expected if discounts are calculated by percent. The percent is available in the discount TLOG when the pending transaction is picked up. discountquantity Quantity discounted Up to 3 decimals affectnetsales Indicates whether or not the discount affects net sales. 0 Does not affect net sales 1 Affects net sales referencenumber Reference number String 1-20 characters autopreset Indicates whether or not the discount amount or percent was automatically set. 0 discount not automatically set 1 sets the autopreset field of the discount TLOG to 1 usingpreset Indicates whether or not the discount used the Preset dollar discount or percentage amount. 0 discount used preset amount 1 sets the usingpreset field of the discount TLOG to 1 employeesale Indicates whether or not 0 discount is not an employee the discount is an Employee Sale. The indication is saved in the discount TLOG record when the pending transaction is picked up. sale 1 sets the employeesale field of the discount TLOG record to 1. Setting this option does not make the pending transaction an Employee Sale. 5.8 Transaction Discount Record DT, <discounttypecode>,<discountdefinitionnumber>, <extendeddiscountamount> [, <taxflags>, <discountpercent>, <discountquantity>, <affectnetsales>, <referencenumber>, <autopreset>, <usingpreset>, <employeesale>] This record type does not create prorated records that are required for proper handling of returns, therefore the use of this type of record is not recommended. The alternative approach is to use Item Discount records instead of Transaction Discount records. Records 2015 SAP SE or an SAP affiliate company. All rights reserved. 17

18 The format of this record is the same as for DI (the Item Discount record above) only the discounttypecode has different values. Valid numeric discounttypecode numbers are: 4 - PERCENT 5 - DOLLAR 6 - KEYED COUPON 9 - MATCHED COUPON 10 - SCANNED MFG COUPON 15 - SURCHARGE PERCENT 16 - SURCHARGE DOLLAR 17 - AUTO TRANSACTION PERCENT 18 - AUTO TRANSACTION DOLLAR 19 - AUTO TENDER PERCENT 20 - AUTO TENDER DOLLAR Example Below is an example of a complete pending transaction record: LH,90143 LS,0.00,9/22/ :05,9/22/ :05,9/22/ :05,1.33,.13,0,0,1,1,0,0,0,0 LA,7777,9/22/ :05,1,10143,0,22,1,,BIN2,BIN3,BIN4,STEVE, , LT,1,0,7.72,1.50 I,42,10.98,1,1,0,0,1,10.00,10.00,1,0,0,0,0,10.00 DI,2,999,-2.28,3,0,1.000,1,XYX,0,0, SAP SE or an SAP affiliate company. All rights reserved. Records

19

20 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies. Please see sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices.