Introduction

Welcome to the TPAPI-POS API! unTill Server provides a SOAP interface and a JSON Rest API for 3rd party applications which may be used for remotely working with POS: reading configuration, making orders, etc.: TPAPI-POS API.

This document describes the SOAP interface and provides code samples (XML) in the dark area to the right.

In case you might have any questions about our API, please create a new support ticket.

You must replace the your_username and your_password placeholders used in the sample requests with the credentials provided to you by your unTill Database Administrator.

Architecture Overview

TPAPI-POS Entry Point

The TPAPI-POS WSDL consists of the hostname, port and looks like this:

http://<hostname>:<port>/wsdl/ITPAPIPOS

WSDL example: http://testapi.untill.com:3063/wsdl/ITPAPIPOS

This WSDL can be used to generate a client for the TPAPI web-service on any programming language. The Endpoint address for this web-service will then look like this:

http://<hostname>:<port>/soap/ITPAPIPOS

Endpoint example: http://testapi.untill.com:3063/soap/ITPAPIPOS

The default port is UNTILLSRV_PORT+3 but this may be redefined in untill.ini if required. The default UNTILLSRV_PORT is 3060, if not redefined in untill.ini with port setting.

SSL Support

Since unTill version 132, TPAPI-POS also supports SSL. When SSL is enabled, the WSDL will look like this:

https://<hostname>/shield/tpapi/wsdl/ITPAPIPOS

Test environment:


WSDL	https://testapi.untill.com/shield/tpapi/wsdl/ITPAPIPOS
Endpoint	https://testapi.untill.com/shield/tpapi/soap/ITPAPIPOS

TPAPI AppToken and AppName

Each TPAPI request has AppToken and AppName properties for identifying the 3rd party working with the TPAPI interface. Starting version 134.0, valid tokens must be added in every request.

AppToken - A unique application token obtained from unTill. If this token is unspecified, unTill displays a warning telling that an unknown 3rd party is working with TPAPI.
AppName (optional) - User friendly name of the 3rd party application working with the TPAPI interface.

An application developer should contact unTill to request a valid token. This token must be used every time when the application works with the TPAPI. If the same developer is going to introduce a new application using TPAPI functionality, a new token must be requested from unTill.

User Permissions

TPAPI permissions have been added in version 2.29 (unTill version 134.0). The following permissions can be assigned to a user in unTill Backoffice:

Backoffice view
Backoffice modify
User management
Ordering
Apply Discounts
Payment
Client management
Reporting
Reservations
Misc

Starting unTill version 134.0 it is possible to override the article price when ordering an article using the CreateOrder function. In order to receive the additional documentation about this feature, we require you to sign an additional agreement. Please create a new support ticket if you need this. Please note that if you have not signed an NDA yet, you will have to do this before you can request the addendum.

The functions in this document are listed per permission, unless indicated differently in the description of the function. When the user doesn’t has the required permission assigned, TPAPI returns error code 9.

Reading POS Configuration

The POS configuration should be read using the following algorythm:

Read the list of Sales Areas with GetSalesAreasInfo
Read the list of Prices with GetPricesInfo
Read the list of Options with GetOptionsInfo
Read the list of Departments with GetDepartmentsInfo
Read the list of Articles with GetArticlesInfo
Read the list of Payments with GetPaymentsInfo

This sequence may be repeated from time to time to keep POS configuration up-to-date on the client side.

For convenience, a part of the backoffice hierarchy is shown below:

Categories
- Groups
  - Departments
    - Condiment
    - Supplement
    - Articles
      - Must-have options
      - Free option

Please note that each Department, Article and Option has it's own availability settings.

After the configuration has been received, GetActiveOrders may be called at any time to get the current availability of tables. Use CreateOrder for creating a new order, and CloseOrder for paying and closing an existing order.
Some functions require TableNumber and TablePart, where TablePart is a letter in the range from “a” to “f”. Other values are not accepted.

Ordering Overview

The following articles and option types can be ordered with TPAPI:

Regular articles
Must-have options for an article: When an article has must-have options (Options) configured, you must process all of them and add one item of each option group to the order as “Must have option”.
Free option for an article: When an article has a free option (FreeOption) configured, the articles in this option group can be added to this article as “Free option”. Please note that the items in this option group are not for free by default (price 0), the option is just not required to be used.
Supplements for an article: When a department has a Supplement (Supplement) configured, the articles in this option group can be added as “Supplement” to all regular items which belong to this deparment.
Condiments for an article: When a department has a Condiment (Condiment) configured, the articles in this option group can be added as “Condiment” to all regular items which belong to this deparment.
Menu items: When a certain article is a menu (IsMenu = true), the list of “must-have options” (Options) for this article acts as a list of article-groups. You may order one article per option and this article needs to be included into order as “Menu item”.
Article message: Text which may be informative either for certain order item, the order part or the complete order.

To identify the item type, there is the OrderItemType field in the OrderItem structure. It is not required to specify in CreateOrderRequest if certain article has IsMenu enabled: the only requirement is to identify it’s menu items. Below there are a few examples. Order items are shown hierarchically just for convenience. In the list of items they follow one after another.

List of regular articles:
- Article 1: OrderItemType = 0
- Article 2: OrderItemType = 0
- ...
Article with “Must-have” options:
- Article 1: OrderItemType = 0
  - Must-have option 1, article 1: OrderItemType = 1
  - Must-have option 2, article 1: OrderItemType = 1
  - ...
Article with different types of options:
- Article 1: OrderItemType = 0
  - Must-have option 1, article 1: OrderItemType = 1
  - Must-have option 2, article 1: OrderItemType = 1
  - Free option, article 1: OrderItemType = 2
  - Condiment, article 1: OrderItemType = 4
  - Supplement, article 1: OrderItemType = 3
  - Supplement, article 2: OrderItemType = 3
Menus:
- Menu 1: OrderItemType = 0 (article with IsMenu = true)
  - Option 1, article 1: OrderItemType = 5
  - Option 2, article 1: OrderItemType = 5
  - Option 3, article 1: OrderItemType = 5
Each menu item may also have options:
- Menu 1: OrderItemType = 0 (article with IsMenu = true)
  - Option 1, article 1: OrderItemType = 5
  - Option 2, article 1: OrderItemType = 5
    - Must-have option 1, article 1: OrderItemType = 1
    - Must-have option 2, article 1: OrderItemType = 1
  - Option 3, article 1: OrderItemType = 5
Article with free text:
- Article 1: OrderItemType = 0
  - Free text 1: OrderItemType = 6
- Article 2: OrderItemType = 0
- ...

JSON Rest API

Starting unTill version 135, there is also a JSON Rest API available which contains almost all functionality that is also available in the SOAP interface.

Documentation

The current API description of this interface is available through the unTill installation where the URL consists of the hostname and the port. The default port here is UNTILLSRV_PORT + 4.

Example:

http://<hostname>:<port>/api/

Official test environment documentation:


Non-SSL	http://testapi.untill.com:3064/api/
SSL	https://testapi.untill.com/shield/api/

Endpoint

The base URL consists of the hostname, port, API version and the database name:

http://<hostname>:<port>/api/v<api_version>/<database_name>/

The database name at this environment is "DEMO" so the base URL's for requests are:


Non-SSL	http://testapi.untill.com:3064/api/v1/DEMO/
SSL	https://testapi.untill.com/shield/api/v1/DEMO/

Backoffice View

GetAllergensInfo

Returns the list of allergens, declared in the backoffice.

GetAllergensInfo Request

GetAllergensInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetAllergensInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetAllergensInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetAllergensInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`is_active`	1 / 0 / -1	1: Active only 0: Inactive only -1: Both active and inactive

GetAllergensInfo Response

GetAllergensInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetAllergensInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetAllergensInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Allergens xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TAllergenInfo[14]">...</Allergens>
         </return>
      </NS1:GetAllergensInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Countries	[AllergenInfo]	Array of Allergens
Extra	[ExtraInfo]	List of extra fields

GetArticles

Returns a brief list of the available Articles in the unTill database. Inactive Articles are not returned by this function.

GetArticles Request

GetArticles Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetArticles soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetArticlesRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <SalesAreaId xsi:type="xsd:long">5000000208</SalesAreaId>
         </Request>
      </urn:GetArticles>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
SalesAreaId	Long	Optional	Specify to request Articles of a certain Sales Area only

GetArticles Response

GetArticles Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetArticlesResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetArticlesResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Articles xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TArticleShort[x]">...</Articles>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetArticlesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Articles	[ArticleShort]	Array of articles
Extra	[ExtraInfo]	List of extra fields

GetArticlesInfo

Returns a detailed list of the Articles and their options.

GetArticlesInfo Request

GetArticlesInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetArticlesInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetArticlesInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <ArticleId xsi:type="xsd:long">0</ArticleId>
            <SalesAreaId xsi:type="xsd:long">0</SalesAreaId>
            <GetInactive xsi:type="xsd:boolean">true</GetInactive>
            <Extra xsi:type="urn:TExtraInfoArray" soapenc:arrayType="urn:TExtraInfo[2]">
               <item xsi:type="NS3:TExtraInfo">
                  <Key xsi:type="xsd:string">course_id</Key>
                  <Value xsi:type="xsd:string">0</Value>
               </item>
               <item xsi:type="NS3:TExtraInfo">
                  <Key xsi:type="xsd:string">dailystock</Key>
                  <Value xsi:type="xsd:string">true</Value>
               </item>
            </Extra>
         </Request>
      </urn:GetArticlesInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
ArticleId	Long	Optional	Specify to request information for certain Article only
SalesAreaId	Long	Optional	Specify to request Articles of a certain Sales Area only
GetInactive	Boolean	Optional	If set to true, also the inactive Articles will be returned
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`course_id`	Long	Only return articles of a specific course
`dailystock`	Boolean	Additionally return data about the daily stock status for all Articles. The data is returned in the ArticleInfo.Extra field
`plu`	List of PLU	Searches Articles by PLU number. The list of PLU can either be a single PLU number or a comma-separated list
`id`	List of Id	Returns a list of articles with the specified Ids. Overrides the `ArticleId` parameter
`allergens`	Boolean	Additionally return information about active Allergens

GetArticlesInfo Response

GetArticlesInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetArticlesInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetArticlesInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Articles xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TArticleInfo[x]">...</Articles>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetArticlesInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Articles	[ArticleInfo]	Array of articles
Extra	[ExtraInfo]	List of extra fields

GetCategoriesInfo

Returns a list of the active Categories in the unTill database.

GetCategoriesInfo Request

GetCategoriesInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetCategoriesInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetCategoriesInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetCategoriesInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetCategoriesInfo Response

GetCategoriesInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetCategoriesInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetCategoriesInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Categories xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TCategoryInfo[x]">...</Categories>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetCategoriesInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Categories	[CategoryInfo]	Array of Categories
Extra	[ExtraInfo]	List of extra fields

GetCountries

Returns the list of countries, declared in the backoffice.

GetCountries Request

GetCountries Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetCountries soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetCountriesRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetCountries>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`id`	String	Search Country by Id.
`is_active`	1 / 0 / -1	1: Active only 0: Inactive only -1: Both active and inactive

GetCountries Response

GetCountries Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetCountriesResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetCountriesResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Countries xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TCountry[x]">...</Countries>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetCountriesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Countries	[Country]	Array of Countries
Extra	[ExtraInfo]	List of extra fields

GetCourses

Returns a list of the active Courses in the unTill database.

GetCourses Request

GetCourses Request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetCourses soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetCoursesRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">99999</Password>
            <UserName xsi:type="xsd:string">TPAPI</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetCourses>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Description
`id`	Searches for active Course by Id.
`is_active`	1: Active only 0: Inactive only -1: Both active and inactive.

GetCourses Response

GetCourses Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetCoursesResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetCoursesResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
            <Courses xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TCourse[x]">...</Courses>
         </return>
      </NS1:GetCoursesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Courses	[Course]	Array of Courses
Extra	[ExtraInfo]	List of extra fields

GetDepartmentsInfo

Returns a list of the active Departments in the unTill database.

GetDepartmentsInfo Request

GetDepartmentsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetDepartmentsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetDepartmentsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <SalesAreaId xsi:type="xsd:long">0</SalesAreaId>
            <DepartmentId xsi:type="xsd:long">0</DepartmentId>
         </Request>
      </urn:GetDepartmentsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
SalesAreaId	Long	Optional	Specify to request Departments of a certain Sales Area only
DepartmentId	Long	Optional	Specify to request information of a certain Department only

GetDepartmentsInfo Response

GetDepartmentsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetDepartmentsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetDepartmentsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Departments xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TDepartmentInfo[x]">...</Departments>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetDepartmentsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Departments	[DepartmentInfo]	Array of Departments
Extra	[ExtraInfo]	List of extra fields

GetDiscountGroupsInfo

Returns list of discount groups with details.

GetDepartmentsInfo Request

GetDepartmentsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetDiscountGroupsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetDiscountGroupsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetDiscountGroupsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetDiscountGroups Response

GetDiscountGroups Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetDiscountGroupsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetDiscountGroupsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <DiscountGroups xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TDiscountGroupInfo[x]">...</DiscountGroups>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetDiscountGroupsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
DiscountGroups	[DiscountGroupInfo]	Array of Discount Groups
Extra	[ExtraInfo]	List of extra fields

GetDiscountReasons

Returns the list of Discount Reasons, declared in the backoffice.

GetDiscountReasons Request

GetDiscountReasons Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetDiscountReasons soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetDiscountReasonsRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetDiscountReasons>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

GetDiscountReasons Response

GetDiscountReasons Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetDiscountReasonsResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetDiscountReasonsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TReason[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetDiscountReasonsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[Reason]	Array of Reasons
Extra	[ExtraInfo]	List of extra fields

GetGroupsInfo

Returns a list of the active Groups in the unTill database.

GetGroupsInfo Request

GetGroupsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetGroupsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetGroupsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetGroupsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetGroupsInfo Response

GetGroupsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetGroupsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetGroupsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Groups xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TGroupInfo[x]">...</Groups>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetGroupsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Groups	[GroupInfo]	Array of Groups
Extra	[ExtraInfo]	List of extra fields

GetOptionsInfo

Returns a list of the active Options in the unTill database.

GetOptionsInfo Request

GetOptionsInfo Request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetOptionsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetOptionsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <OptionId xsi:type="xsd:long">0</OptionId>
            <SalesAreaId xsi:type="xsd:long">0</SalesAreaId>
         </Request>
      </urn:GetOptionsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
OptionId	Long	Optional	Specify to request information for a certain Option only
SalesAreaId	Long	Optional	Specify to request Options of a certain Sales Area only

GetOptionsInfo Response

GetOptionsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetOptionsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetOptionsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Options xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TOptionInfo[x]">...</Options>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetOptionsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Options	[OptionInfo]	Array of Options
Extra	[ExtraInfo]	List of extra fields

GetPaymentsInfo

Returns a list of the active Payments in the unTill database.

GetPaymentsInfo Request

GetPaymentsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetPaymentsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetPaymentsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetPaymentsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetPaymentsInfo Response

GetPaymentsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetPaymentsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetPaymentsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Payments xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TPaymentInfo[x]">...</Payments>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetPaymentsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Payments	[PaymentInfo]	Array of Payments
Extra	[ExtraInfo]	List of extra fields

GetPeriodsInfo

Returns a list of the active Periods in the unTill database.

GetPeriodsInfo Request

GetPeriodsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetPeriodsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetPeriodsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetPeriodsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetPeriodsInfo Response

GetPeriodsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetPeriodsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetPeriodsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Period xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TPeriodInfo[1]">...</Period>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetPeriodsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Period	[PeriodInfo]	Array of Periods
Extra	[ExtraInfo]	List of extra fields

GetPricesInfo

Returns a list of the active Prices in the unTill database.

GetPricesInfo Request

GetPricesInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetPricesInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetPricesInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetPricesInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetPricesInfo Response

GetPricesInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetPricesInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetPricesInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Prices xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TPriceInfo[x]">...</Prices>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetPricesInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Prices	[PriceInfo]	Array of Prices
Extra	[ExtraInfo]	List of extra fields

GetPrintersInfo

Returns the list of Printers, declared in the backoffice.

GetPrintersInfo Request

GetPrintersInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetPrintersInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetPrintersInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetPrintersInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

GetPrintersInfo Response

GetPrintersInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetPrintersInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetPrintersInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Printers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TPrinterInfo[x]">...</Printers>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetPrintersInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Printer	[PrinterInfo]	Array of Printers
Extra	[ExtraInfo]	List of extra fields

GetSalesAreasInfo

Returns a list of the active Sales Areas in the unTill database.

GetSalesAreasInfo Request

GetSalesAreasInfo Request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetSalesAreasInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetSalesAreasInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetSalesAreasInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetSalesAreasInfo Response

GetSalesAreasInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetSalesAreasInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetSalesAreasInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <SalesAreas xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TSalesAreaInfo[x]">...</SalesAreas>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetSalesAreasInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
SalesAreas	[SalesAreaInfo]	Array of Sales Areas
Extra	[ExtraInfo]	List of extra fields

GetSizeModifiersInfo

Returns the list of Size Modifiers, declared in the backoffice.

GetSizeModifiersInfo Request

GetSizeModifiersInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetSizeModifiersInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetSizeModifiersInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetSizeModifiersInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`is_active`	1 / 0 / -1	1: Active only (default) 0: Inactive only -1: Both active and inactive

GetSizeModifiersInfo Response

GetSizeModifiersInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetSizeModifiersInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetSizeModifiersInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <SizeModifiers xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TSizeModifierInfo[xx]">...</SizeModifiers>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetSizeModifiersInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
SizeModifiers	[SizeModifierInfo]	Array of Size Modifiers
Extra	[ExtraInfo]	List of extra fields

GetSmartcardGroupsInfo

Returns the list of Smartcard Groups, declared in the backoffice.

GetSmartcardGroupsInfo Request

GetSmartcardGroupsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetSmartcardGroupsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetSmartcardGroupsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetSmartcardGroupsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Description
`id`	Search group by Id
`is_active`	Select by activity flag: 0: Only inactive 1: Only active (default) -1: Both active and inactive

GetSmartcardGroupsInfo Response

GetSmartcardGroupsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetSmartcardGroupsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetSmartcardGroupsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TSmartCardGroupInfo[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetSmartcardGroupsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[SmartcardGroupInfo]	Array of Smartcard groups
Extra	[ExtraInfo]	List of extra fields

GetSmartcardsInfo

Returns the list of Smartcards, declared in the backoffice.

GetSmartcardsInfo Request

GetSmartcardsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetSmartcardsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetSmartcardsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetSmartcardsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Description
`id`	Search card by Id
`uid`	Search card by UID
`group_id`	Search card by group Id
`is_active`	Select by activity flag: 0: Only inactive 1: Only active (default) -1: Both active and inactive

GetSmartcardsInfo Response

GetSmartcardsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetSmartcardsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetSmartcardsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TSmartCardInfo[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetSmartcardsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[SmartcardInfo]	Array of Smartcards
Extra	[ExtraInfo]	List of extra fields

GetSuppliersInfo

Returns the list of suppliers, declared in the backoffice.

GetSuppliersInfo Request

GetSuppliersInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetSuppliersInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetSuppliersInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetSuppliersInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`is_active`	1 / 0 / -1	1: Active only (default) 0: Inactive only -1: Both active and inactive

GetSuppliersInfo Response

GetSuppliersInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetSuppliersInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetSuppliersInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TSupplierInfo[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetSuppliersInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[Supplier]	Array of Suppliers
Extra	[ExtraInfo]	List of extra fields

GetUsersInfo

Returns a list of the active Users in the unTill database.

GetUsersInfo Request

GetUsersInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetUsersInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetUsersInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetUsersInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetUsersInfo Response

GetUsersInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetUsersInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetUsersInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Users xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TUserInfo[x]">...</Users>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetUsersInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Users	[UserInfo]	Array of active Users
Extra	[ExtraInfo]	List of extra fields

GetVoidReasons

Returns the list of Void Reasons, declared in the backoffice.

GetVoidReasons Request

GetVoidReasons Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetVoidReasons soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetVoidReasonsRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetVoidReasons>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

GetVoidReasons Response

GetVoidReasons Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetVoidReasonsResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetVoidReasonsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TReason[x]">...</Items>
         </return>
      </NS1:GetVoidReasonsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[Reason]	Array of Reasons
Extra	[ExtraInfo]	List of extra fields

GetVouchersInfo

Get list of vouchers.

GetVouchersInfo Request

GetVouchersInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetVouchersInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetVouchersInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetVouchersInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Description
`id`	Search voucher by Id
`barcode`	Search voucher by Barcode

GetVouchersInfo Response

GetVouchersInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetVouchersInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetVouchersInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TVoucherInfo[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetVouchersInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[VoucherInfo]	Array of Vouchers
Extra	[ExtraInfo]	List of extra fields

Backoffice Modify

AddPouring

Registers pouring in database so the pouring appears in reports and Beverage Control Statistics.

AddPouring Request

AddPouring Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:AddPouring soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TAddPouringRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_appname</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Pourings xsi:type="urn:TPouringsArray" soapenc:arrayType="urn:TPouring[]">
                <item xsi:type="urn:TPouring">
                    <PLU xsi:type="xsd:int">1</PLU>
                    <Quantity xsi:type="xsd:int">1</Quantity>
                    <DateTime xsi:type="xsd:dateTime">2018-11-20T15:30:44.000Z</DateTime>
                    <WaiterID xsi:type="xsd:double">999</WaiterID>      
                    <ClientCard xsi:type="xsd:string">80518B22694F04</ClientCard>                   
                </item>
           </Pourings>
         </Request>
      </urn:AddPouring>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Pourings	[Pouring]	Mandatory	List of Pourings to register

AddPouring Response

AddPouring Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:AddPouringResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TAddPouringResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:AddPouringResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Extra	[ExtraInfo]	List of extra fields

UpdateCountries

Adds or updates countries in database. When CountryId = 0, country is added otherwise it is updated. It is not allowed to add a country when a country with same name is already exists.

UpdateCountries Request

UpdateCountries Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:UpdateCountries soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TUpdateCountriesRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_appname</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Countries soapenc:arrayType="urn1:TCountry[1]" xsi:type="urn1:TCountriesArray" xmlns:urn1="urn:TPAPIPosTypesU">
                <item xsi:type="urn:TCountry">
                    <CountryId xsi:type="xsd:long">65000348984</CountryId>
                    <CountryName xsi:type="xsd:string">The Netherlands</CountryName>
                    <Kind xsi:type="xsd:int">0</Kind>
                    <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
                </item>
            </Countries>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:UpdateCountries>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Countries	[Country]	Mandatory	List of countries to be added or updated

UpdateCountries Response

UpdateCountries Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:UpdateCountriesResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TUpdateCountriesResponse">
            <AddedCountries xsi:type="xsd:int">0</AddedCountries>
            <UpdatedCountries xsi:type="xsd:int">1</UpdatedCountries>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
                <item xsi:type="NS3:TExtraInfo">
                    <Key xsi:type="xsd:string">result_ids</Key>
                    <Value xsi:type="xsd:string">65000348984</Value>
                    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
                </item>
            </Extra>
        </return>
      </NS1:UpdateCountriesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
AddedCountries	Integer	Number of added Countries
UpdatedCountries	Integer	Number of updated Countries
Extra	[ExtraInfo]	List of extra fields

List of available extra fields:

Key	Description
`result_ids`	Comma separated list of Id's of created and/or updated Countries. The number of Id's returned is equal to the number of Countries sent in the request.

UpdateSalesAreaPrice

Updates the current price level for a Sales Area.

UpdateSalesAreaPrice Request

UpdateSalesAreaPrice Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:UpdateSalesAreaPrice soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TUpdateSalesAreaPriceRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_appname</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <SalesAreaId xsi:type="xsd:long">5000000208</SalesAreaId>
            <PriceId xsi:type="xsd:long">5000000206</PriceId>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:UpdateSalesAreaPrice>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
SalesAreaId	Long	Mandatory	Id of Sales Area
PriceId	Long	Mandatory	Id of Price Level to set for the Sales Area

UpdateSalesAreaPrice Response

UpdateSalesAreaPrice Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:UpdateSalesAreaPriceResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TUpdateSalesAreaPriceResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:UpdateSalesAreaPriceResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Extra	[ExtraInfo]	List of extra fields

UpdateUsers

Create new user(s) or update existing users. If the ID is other than 0, the user is updated, otherwise a new user is created.

Required user permission: User management
It is not possible to make changes to the system users: Admin, Guest, System

UpdateUsers Request

UpdateUsers Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:UpdateUsers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TUpdateUsersRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_appname</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Users xsi:type="urn:TUserInfoArray" soapenc:arrayType="urn:TUserInfo[1]">
                ...
            </Users>
         </Request>
      </urn:UpdateUsers>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Users	[UserInfo]	Mandatory	List of users to be added or updated

UpdateUsers Response

UpdateUsers Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:UpdateUsersResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TUpdateUsersResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <AddedUsers xsi:type="xsd:int">1</AddedUsers>
            <UpdatedUsers xsi:type="xsd:int">0</UpdatedUsers>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
               <item xsi:type="NS3:TExtraInfo">
                  <Key xsi:type="xsd:string">result_ids</Key>
                  <Value xsi:type="xsd:string">5000030865</Value>
                  <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
               </item>
            </Extra>
         </return>
      </NS1:UpdateUsersResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
AddedUsers	Integer	Number of added Users
UpdatedUsers	Integer	Number of updated Users
Extra	[ExtraInfo]	List of extra fields

List of available extra fields:

Key	Description
`result_ids`	Comma separated String of Id's of created and/or updated Users. The number of Id's returned is equal to the number of Users sent in the request

Ordering

CreateOrder

Creates an Order.

CreateOrder Request

CreateOrder Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TCreateOrderRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <ClientName xsi:type="xsd:string"></ClientName>
            <OrderName xsi:type="xsd:string"></OrderName>
            <OrderDescr xsi:type="xsd:string"></OrderDescr>
            <Items soapenc:arrayType="urn1:TOrderItem[2]" xsi:type="urn1:TOrderItemArray" xmlns:urn1="urn:TPAPIPosTypesU">...</Items>
            <Covers xsi:type="xsd:int">2</Covers>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
            <ClientId xsi:type="xsd:long">0</ClientId>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to order on
TablePart	String	Mandatory	Table part to order on ("a" - "f")
ClientName	String	Optional	Client name
OrderName	String	Optional	Order name
OrderDescr	String	Optional	Order description
Covers	Integer	Optional	Number of covers
Items	[OrderItem]	Mandatory	Items to be ordered
ClientId	Long	Optional	Id of the Client to assign to the transaction
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`extraN`	1..10	These fields are available in the unTill datasets "Order" (screens/tickets) and "Bills" (reports). They will also be returned in the "Extra" field of the GetActiveOrders response
`OifDate`	YYYYMMDD-HHNN	When specified, an Order in the Future is created
`OifDepositAmount`	Cents	Deposit amount for the Order in the Future, to be specified in cents
`OifDepositPaymentModeId`	Id	Id of the payment mode to use for the Order in the Future
`GuestNotifierCode`	String	Code of Guest Notifier to add to this order
`TableSmartcardId`	Long	ID of the smartcard to open table
`TableSmartcardUid`	String	UID of the smartcard to open table

CreateOrder Response

CreateOrder Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:CreateOrderResponse xmlns:NS2="urn:TPAPIPosIntfU">
         <return xsi:type="NS2:TCreateOrderResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
         </return>
      </NS1:CreateOrderResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message

Take Away order

To create a Take Away order in unTill you use the CreateOrder function and add at least the ta_timestamp extra from the available extra's for Take Away orders:

Key	Value	Description
`ta_onhold`	Boolean	Set to `true` when the Take Away order needs to be put on hold
`ta_external_id`	String	Optional external Id of the Take Away order
`ta_timestamp`	YYYYMMDD-HHNN	Date/time for the Take Away order, mandatory
`ta_notes`	String	Optional notes to add to the Take Away order

Note: Take Away orders that are put on hold will be activated automatically. The activation interval is defined in unTill and can't be accessed/changed using TPAPI.

GetActiveOrders

Returns a list of the active Orders in the unTill database.

GetActiveOrders Request

GetActiveOrders Request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetActiveOrders soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetActiveOrdersRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <SalesAreaId xsi:type="xsd:long">0</SalesAreaId>
         </Request>
      </urn:GetActiveOrders>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
SalesAreaId	Long	Optional	Specify to request Orders of a certain Sales Area only

GetActiveOrders Response

GetActiveOrders Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetActiveOrdersResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetActiveOrdersResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Orders xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TOrderInfo[x]">...</Orders>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetActiveOrdersResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Orders	[OrderInfo]	Array of Orders
Extra	[ExtraInfo]	List of extra fields

GetActiveTableInfo

Returns transaction structure and amounts (total, remaining, extra) for a certain table number.

GetActiveTableInfo Request

GetActiveTableInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetActiveTableInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetActiveTableInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">27</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetActiveTableInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to get info from
TablePart	String	Mandatory	Table part to get info from ("a" - "f")

GetActiveTableInfo Response

GetActiveTableInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetActiveTableInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetActiveTableInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Transaction xsi:type="NS3:TTurnoverTransaction">...</Transaction>
            <TotalAmount xsi:type="xsd:double">7.7</TotalAmount>
            <RemainingAmount xsi:type="xsd:double">5.7</RemainingAmount>
            <ExtraAmount xsi:type="xsd:double">0</ExtraAmount>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetActiveTableInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Transaction	TurnoverTransaction	Transaction structure
TotalAmount	Decimal	Total amount of the transaction
RemainingAmount	Decimal	Remaining amount to be paid
ExtraAmount	Decimal	Extra amount
Extra	[ExtraInfo]	List of extra fields

GetActiveTableInfoEx

Returns transaction structure and amounts (total, remaining, extra) based on certain conditions.

GetActiveTableInfoEx Request

GetActiveTableInfoEx Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetActiveTableInfoEx soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetActiveTableInfoExRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
            <Conditions xsi:type="urn:TExtraInfoArray" soapenc:arrayType="urn:TExtraInfo[1]">
               <item xsi:type="urn:TExtraInfo">
                  <Key xsi:type="xsd:string">smartcard_uid</Key>
                  <Value xsi:type="xsd:string">9AF12C13</Value>
              </item>
           </Conditions>
         </Request>
      </urn:GetActiveTableInfoEx>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Conditions	[ExtraInfo]	Mandatory	Table select conditions
Extra	[ExtraInfo]	Optional	List of extra fields

List of available conditions:

Key	Value	Description
smartcard_uid	UID of client smartcard	Finds open table with client attached having the specified smartcard

GetActiveTableInfoEx Response

GetActiveTableInfoEx Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetActiveTableInfoExResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetActiveTableInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Transaction xsi:type="NS3:TTurnoverTransaction">...</Transaction>
            <TotalAmount xsi:type="xsd:double">7.8</TotalAmount>
            <RemainingAmount xsi:type="xsd:double">7.8</RemainingAmount>
            <ExtraAmount xsi:type="xsd:double">0</ExtraAmount>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetActiveTableInfoExResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Transaction	TurnoverTransaction	Transaction structure
TotalAmount	Decimal	Total amount of the transaction
RemainingAmount	Decimal	Remaining amount to be paid
ExtraAmount	Decimal	Extra amount
Extra	[ExtraInfo]	List of extra fields

GetTableItemsInfo

Get list of items on the active table. This function returns a consolidated list of ordered items on the table, in the same way they’re displayed in the order screen at POS. Each item has a signature which can be used in per-items operations, e.g. when applying discounts.

GetTableItemsInfo Request

GetTableItemsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetTableItemsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetTableItemsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">22</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetTableItemsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to apply the next course to
TablePart	String	Mandatory	Table part to apply the next course to ("a" - "f")
Extra	[ExtraInfo]	Optional	List of extra fields

GetTableItemsInfo Response

GetTableItemsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetTableItemsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetTableItemsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <OpenDateTime xsi:type="xsd:dateTime">2020-04-01T15:25:12.000+02:00</OpenDateTime>
            <TableNumber xsi:type="xsd:int">22</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Covers xsi:type="xsd:int">0</Covers>
            <UserId xsi:type="xsd:long">5000001848</UserId>
            <DiscountOnTotal xsi:type="xsd:double">0</DiscountOnTotal>
            <ServiceCharge xsi:type="xsd:double">0</ServiceCharge>
            <ClientId xsi:type="xsd:long">0</ClientId>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTableItem[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetTableItemsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
OpenDateTime	Timestamp	Date when table was initially opened
TableNumber	Integer	Table number
TablePart	String	Table part
Covers	Integer	Number of covers
UserId	Long	User Id
DiscountOnTotal	Decimal	Amount of the discount for the complete bill
ServiceCharge	Decimal	Amount of the Service Charge
ClientId	Long	Client Id
Items	[TableItem]	List of table items
Extra	[ExtraInfo]	List of extra fields

NextCourse

Apply next course to table. If no more courses on table, the ReturnCode will be 7 with ReturnMessage: “There are no more courses”.

NextCourse Request

NextCourse Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:NextCourse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TNextCourseRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:NextCourse>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to apply the next course to
TablePart	String	Mandatory	Table part to apply the next course to ("a" - "f")

NextCourse Response

NextCourse Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:NextCourseResponse xmlns:NS2="urn:TPAPIPosIntfU">
         <return xsi:type="NS2:TNextCourseResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
         </return>
      </NS1:NextCourseResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message

SetTableCourse

Apply certain course to table. When course is not changed because given course is already set, no error will be returned. If it is unable to set given course for this table, the ReturnCode will be 7 with ReturnMessage: “Unable to change table course to [...]”

SetTabeCourse Request

SetTableCourse Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:SetTableCourse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TSetTableCourseRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <CourseId xsi:type="xsd:long">5000001334</CourseId>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:SetTableCourse>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to apply course to
TablePart	String	Mandatory	Table part to apply course to ("a" - "f")
CourseId	Long	Mandatory	Course to apply to the table

SetTabeCourse Response

SetTabeCourse Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:SetTableCourseResponse xmlns:NS2="urn:TPAPIPosIntfU">
         <return xsi:type="NS2:TSetTableCourseResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
         </return>
      </NS1:SetTableCourseResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message

Apply Discounts

ApplyDiscountToItems

Apply discount to table items. This can be either in percent or absolute amount. When an absolute amount is used, the discount can only be applied if this amount is less than or equal to the total price of the items.

ApplyDiscountToItems Request

ApplyDiscountToItems Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ApplyDiscountToItems soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TApplyDiscountToItemsRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">21</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <DiscountReason xsi:type="xsd:long">5000000103</DiscountReason>
            <Description xsi:type="xsd:string"/>
            <Discount xsi:type="xsd:double">25</Discount>
            <PercentValue xsi:type="xsd:boolean">1</PercentValue>
            <Items xsi:type="urn:TDiscountedItemArray" soapenc:arrayType="urn:TDiscountedItem[x]">...</Items>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:ApplyDiscountToItems>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to apply discount on
TablePart	String	Mandatory	Table part to apply discount on
DiscountReason	Long	Optional	Id of discount reason. Required if Description is empty
Description	String	Optional	Discount description (aka “free discount reason”). Required if DiscountReason is empty
Discount	Decimal	Mandatory	Discount value
PercentValue	Boolean	Optional	True if discount value is given in percentage
Items	[DiscountedItem]	Mandatory	List of items, identifying the table items the discount must be applied to
Extra	[ExtraInfo]	Optional	List of extra fields

ApplyDiscountToItems Response

ApplyDiscountToItems Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:ApplyDiscountToItemsResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TApplyDiscountToItemsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:ApplyDiscountToItemsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message

ApplyDiscountToTable

Apply discount to the complete table. This function can only accepts an abosolute discount amount.

ApplyDiscountToTable Request

ApplyDiscountToTable Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ApplyDiscountToTable soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TApplyDiscountToTableRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">22</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <DiscountReason xsi:type="xsd:long">5000000103</DiscountReason>
            <Description xsi:type="xsd:string"/>
            <Discount xsi:type="xsd:double">5.00</Discount>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:ApplyDiscountToTable>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to apply discount on
TablePart	String	Mandatory	Table part to apply discount on
DiscountReason	Long	Optional	Id of discount reason
Description	String	Optional	Discount description (aka “free discount reason”). Required if DiscountReason is empty
Discount	Decimal	Mandatory	Discount amount
Extra	[ExtraInfo]	Optional	List of extra fields

ApplyDiscountToTable Response

ApplyDiscountToTable Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:ApplyDiscountToTableResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TApplyDiscountToTableResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:ApplyDiscountToTableResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message

Payment

CloseOrder

CLose the order and pay with the specified payment type.

CloseOrder Request

CloseOrder Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:CloseOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TCloseOrderRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <PaymentId xsi:type="xsd:long">5000000055</PaymentId>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:CloseOrder>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to close
TablePart	String	Mandatory	Table part to close ("a" - "f")
PaymentId	Long	Mandatory	Id of the Payment mode to use
Extra	[ExtraInfo]	Optional	List of extra fields

CloseOrder Response

CloseOrder Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:CloseOrderResponse xmlns:NS2="urn:TPAPIPosIntfU">
         <return xsi:type="NS2:TCloseOrderResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
         </return>
      </NS1:CloseOrderResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message

Pay

Make payment on table with specified payment type.

Pay Request

Pay Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:Pay soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TPayRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <PaymentId xsi:type="xsd:long">5000000055</PaymentId>
            <Amount xsi:type="xsd:double">0</Amount>
            <EFTData xsi:type="xsd:string"></EFTData>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:Pay>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to make the payment to
TablePart	String	Mandatory	Table part to make the payment to
PaymentId	Long	Mandatory	Id of the Payment mode to use
Amount	Decmial	Mandatory	Specify the amount to pay or use "0" to pay the complete amount
EFTData	String	Optional	When specified and not empty, means that EFT payment processed externally and shouldn’t be handled by unTill. Key=Value pairs separated by LF charachter: Syntax: “key1=value1\nkey2=value2...”
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`external_id`	String	Unique Id (up to 50 characters) which may be assigned to the bill
`get_bill`	-	If added, then unTill does not print the bill but returns it in PayResponse.Extra instead, under the key “bill_text”
`bill_layout`	String	Use custom ticket layout. Value is the Id of an unTill ticket
`tip`	String	Add tips (amount to be specified in cents)
`proforma_signature`	String	Specify the signature of a proforma to be paid
`printer_id`	Long	Id of Printer to send the bill to
`eft_params`	String	Use to override EftParams for card payment
`guest-reservation-id`	String	Specify guest reservationID (also known as FolioNr) to handle ROOM payment

Pay Response

Pay Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:PayResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TPayResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
                <item xsi:type="NS3:TExtraInfo">
                    <Key xsi:type="xsd:string">bill_text</Key>
                    <Value xsi:type="xsd:string">*** BILL_TEXT ***</Value>
                    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
                </item>
            </Extra>
         </return>
      </NS1:PayResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Extra	[ExtraInfo]	List of extra fields

List of available extra fields:

Key	Value	Description
`bill_text`	String	Receipt in the form of plain text returned in this ExtraInfo if `get_bill` has been added in PayRequest.Extra

PrintProforma

Allows to print proforma and optionally return proforma text.

PrintProforma Request

PrintProforma Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:PrintProforma soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TPrintProformaRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:PrintProforma>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
TableNumber	Integer	Mandatory	Table number to print the Proforma for
TablePart	String	Mandatory	Table part to print the Proforma for
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`get_receipt`	-	If added, then unTill does not print the Proforma but returns it in PrintProformaResponse.Extra instead, under the key “receipt_text”
`layout_id`	String	Specify a custom layout for printing the Proforma. Value is the Id of an unTill ticket
`handle_by_drivers`	Boolean	Setting this to “false” means that unTill doesn’t call BillsHandler drivers when printing this proforma. Defaults to “true”
`printer_id`	Long	Id of Printer to send the proforma to

PrintProforma Response

PrintProforma Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:PrintProformaResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TPrintProformaResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
                <item xsi:type="NS3:TExtraInfo">
                    <Key xsi:type="xsd:string">receipt_text</Key>
                    <Value xsi:type="xsd:string">*** RECEIPT_TEXT ***</Value>
                    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
                </item>
            </Extra>
         </return>
      </NS1:PrintProformaResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Extra	[ExtraInfo]	List of extra fields

List of available extra fields:

Key	Value	Description
`receipt_text`	String	Text of Proforma, if requested with get_receipt in PrintProformaRequest.Extra

ReadHotelGuestInfo

Reads hotel guest information. Note: Can only be used when a Hotel Interface is configured.

ReadHotelGuestInfo Request

ReadHotelGuestInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ReadHotelGuestInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TReadHotelGuestInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <PaymentId xsi:type="xsd:long">5000000088</PaymentId>
            <Criteria xsi:type="xsd:string">guest-room</Criteria>
            <Value xsi:type="xsd:string">31</Value>
            <Sequence xsi:type="xsd:int">0</Sequence>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:ReadHotelGuestInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Criteria	String	Mandatory	“guest-room” or “guest-reservation-id”
Value	String	Mandatory	Criteria value
Sequence	Integer	Optional	Optional sequence for room number criteria
Extra	[ExtraInfo]	Optional	List of extra fields

ReadHotelGuestInfo Response

ReadHotelGuestInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:ReadHotelGuestInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TReadHotelGuestInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Guests xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:THotelGuestInfo[x]">...</Guests>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:ReadHotelGuestInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Guests	[HotelGuestInfo]	List of hotel guests found by the request
Extra	[ExtraInfo]	List of extra fields

Client Management

GetClients

Read the list of Clients.

GetClients Request

GetClients Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetClients soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetClientsRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetClients>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetClients Response

GetClients Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetClientsResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetClientsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Clients xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TClient[x]">...</Clients>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetClientsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Clients	[Client]	List of Clients
Extra	[ExtraInfo]	List of extra fields

GetClientsEx

Reads the list of Clients using additional filters.

GetClientsEx Request

GetClientsEx Request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetClientsEx soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetClientsExRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <ModifiedSince xsi:type="xsd:dateTime">2018-10-01T08:00:00+02:00</ModifiedSince>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetClientsEx>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
ModifiedSince	Timestamp	Optional	Specify this value to return only clients added/updated since that date/time
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`id`	Long	Searches for active Client by Id (ModifiedSince is ignored when this extra is added)
`is_active`	1 / 0 / -1	1: Active only 0: Inactive only -1: Both active and inactive
`smartcard_uid`	String	Searches Clients by smartcard UID (ModifiedSince is ignored when this extra is added)

GetClientsEx Response

GetClientsEx Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetClientsExResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetClientsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Clients xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TClient[x]">...</Clients>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetClientsExResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Clients	[Client]	List of Clients
Extra	[ExtraInfo]	List of extra fields

UpdateClients

Create or update clients in database. When Id is other than 0, client is updated, else new client is created. When using this request, the fields AccountBalance and SavePoints are not updated. Use the ClientDeposit request for updating the AccountBalance.

UpdateClients Request

UpdateClients Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:UpdateClients soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TUpdateClientsRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Clients xsi:type="urn1:TClientsArray" soapenc:arrayType="urn1:TClient[2]">
                <item xsi:type="NS3:TClient">
                    <Id xsi:type="xsd:long">0</Id>
                    <Name xsi:type="xsd:string">John Doe</Name>
                    <Phone xsi:type="xsd:string">585-924-1525</Phone>
                    <Email xsi:type="xsd:string">brabtleater1957@rhyta.com</Email>
                    <Address xsi:type="xsd:string">1951 Cherry Ridge Drive</Address>
                    <BirthDate xsi:type="xsd:dateTime">1995-03-07T00:00:00.000+01:00</BirthDate>
                    <CardNumber xsi:type="xsd:string">MjY3MDIwNjQ2OTU0RA==</CardNumber>
                    <OnInvoice xsi:type="xsd:boolean">true</OnInvoice>
                    <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="NS3:TExtraInfo[1]">
                        <item xsi:type="NS3:TExtraInfo">
                            <Key xsi:type="xsd:string">smartcard_uid</Key>
                            <Value xsi:type="xsd:string">48C44B8C</Value>
                            <Extra xsi:type="SOAP-ENC:Array" soapenc:arrayType="NS3:TExtraInfo[0]"/>
                        </item>
                    </Extra>
                </item>
                <item xsi:type="NS3:TClient">
                    <Id xsi:type="xsd:long">20000156715</Id>
                    <Name xsi:type="xsd:string">Jane Doe</Name>
                    <Phone xsi:type="xsd:string">314-657-2903</Phone>
                    <Email xsi:type="xsd:string">broas1937@einrot.com</Email>
                    <Address xsi:type="xsd:string">3618 Hawks Nest Lane</Address>
                    <BirthDate xsi:type="xsd:dateTime">1999-06-15T00:00:00.000+02:00</BirthDate>
                    <OnInvoice xsi:type="xsd:boolean">false</OnInvoice>
                </item>
            </Clients>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:UpdateClients>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Clients	[Client]	Mandatory	List of Clients to be added or updated

UpdateClients Response

UpdateClients Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:UpdateClientsResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TUpdateClientsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <AddedClients xsi:type="xsd:int">1</AddedClients>
            <UpdatedClients xsi:type="xsd:int">1</UpdatedClients>
            <AddedClients xsi:type="xsd:int">1</AddedClients>
            <UpdatedClients xsi:type="xsd:int">1</UpdatedClients>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
                <item xsi:type="NS3:TExtraInfo">
                   <Key xsi:type="xsd:string">result_ids</Key>
                   <Value xsi:type="xsd:string">20000156720, 20000156715</Value>
                   <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
                </item>
            </Extra>
         </return>
      </NS1:UpdateClientsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
AddedClients	Integer	Number of added Clients
UpdatedClients	Integer	Number of updated Clients
Extra	[ExtraInfo]	List of extra fields

List of available extra fields:

Key	Description
`result_ids`	Comma separated String of Id's of created and/or updated Clients. The number of Id's returned is equal to the number of Clients sent in the request

GetClientCardNamesInfo

Read the list of avaialble Client Card names.

GetClientCardNamesInfo Request

GetClientCardNamesInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetClientCardNamesInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetClientCardNamesInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetClientCardNamesInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetClientCardNamesInfo Response

GetClientCardNamesInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetClientCardNamesInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetClientCardNamesInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TClientCardNameInfo[xx]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetClientCardNamesInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[ClientCardNameInfo]	List of Client Card Names
Extra	[ExtraInfo]	List of extra fields

GetClientCardsInfo

Read the list of avaialble Client Cards.

GetClientCardsInfo Request

GetClientCardsInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetClientCardsInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetClientCardsInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <ClientId xsi:type="xsd:long">0</ClientId>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetClientCardsInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
ClientId	Long	Optional	Id of Client to request cards for. If empty, 0 or omitted, all Client Cards are returned

GetClientCardsInfo Response

GetClientCardsInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetClientCardsInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetClientCardsInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TClientCardInfo[xx]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetClientCardsInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[ClientCardInfo]	List of Client Cards
Extra	[ExtraInfo]	List of extra fields

UpdateClientCards

Create or update clients cards database. When Id is other than 0, client card is updated, else new client card is created.

UpdateClientCards Request

UpdateClientCards Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:UpdateClientCards soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TUpdateClientCardsRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Cards soapenc:arrayType="urn1:TClientCardInfo[1]" xsi:type="urn1:TOrderItemArray" xmlns:urn1="urn:TPAPIPosTypesU">
                <item xsi:type="urn:TClientCardInfo">
                  <Id xsi:type="xsd:long">70002116857</Id>
                  <Number xsi:type="xsd:int">1</Number>
                  <ClientId xsi:type="xsd:long">65001352781</ClientId>
                  <CardNameId xsi:type="xsd:long">70002116856</CardNameId>
                  <Card xsi:type="xsd:string">ckttYWhodDM3VE00WUd6M0pQekg=</Card>
                  <IsActive xsi:type="xsd:boolean">true</IsActive>
                  <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
               </item>
            </Cards>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:UpdateClientCards>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Cards	[ClientCardInfo]	Mandatory	List of Clients Cards to be added or updated

UpdateClientCards Response

UpdateClientCards Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:UpdateClientCardsResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TUpdateClientCardsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:UpdateClientCardsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Extra	[ExtraInfo]	List of extra fields

AddClientSavepoints

Adds Save Points to client account.

AddClientSavepoints Request

AddClientSavepoints Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:AddClientSavepoints soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TAddClientSavepointsRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <ClientId xsi:type="xsd:long">65001352781</ClientId>
            <Quantity xsi:type="xsd:int">20</Quantity>
            <Comments xsi:type="xsd:string">Comment</Comments>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:AddClientSavepoints>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
ClientId	Long	Mandatory	Id of the Client to add the save points to
Quantity	Integer	Mandatory	Number of save points to increase/decrease
Comments	String	Optional	Optional comment
Extra	[ExtraInfo]	List of extra fields

AddClientSavepoints Response

AddClientSavepoints Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:AddClientSavepointsResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TAddClientSavepointsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <SavepointsBalance xsi:type="xsd:int">70</SavepointsBalance>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:AddClientSavepointsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
SavepointsBalance	Integer	New save points balance
Extra	[ExtraInfo]	List of extra fields

ClientDeposit

Makes Deposit to Client Account.

ClientDeposit Request

ClientDeposit Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ClientDeposit soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TClientAccountDepositRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <ClientId xsi:type="xsd:long">5000096068</ClientId>
            <PaymentId xsi:type="xsd:long">5000000055</PaymentId>
            <Amount xsi:type="xsd:double">10</Amount>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:ClientDeposit>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
ClientId	Long	Mandatory	Id of the Client to make the deposit to
PaymentId	Long	Mandatory	Id of the Payment to use for the deposit
Amount	Decimal	Mandatory	Amount of the deposit
Extra	[ExtraInfo]	List of extra fields

List of available extra fields:

Key	Value	Description
`get_receipt`	-	Instead of printing deposit receipt unTill sends it back in ClientDepositResponse.Extra as plain text. The value of ExtraInfo with this key doesn’t matter
`dont_show_in_reports`	0/1	Defines if the deposit should be shown in reports. Set to 1 for registering an initial deposit

ClientDeposit Response

ClientDeposit Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:ClientDepositResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TClientAccountDepositResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <OldBalance xsi:type="xsd:double">40.0</OldBalance>
            <NewBalance xsi:type="xsd:double">50.0</NewBalance>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:ClientDepositResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
OldBalance	Decmial	Account balance before deposit
NewBalance	Decimal	Account balance after deposit
Extra	[ExtraInfo]	List of extra fields

List of available extra fields:

Key	Description
`receipt_text`	Receipt in the form of a plain text returned in this ExtraInfo if `get_receipt` has been added in ClientDepositRequest.Extra

Reporting

GetTurnoverReport

Get the list of Transactions including the ordered items.

GetTurnoverReport Request

GetTurnoverReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetTurnoverReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetTurnoverReportRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <UserId xsi:type="xsd:long">0</UserId>
            <SalesAreaId xsi:type="xsd:long">0</SalesAreaId>
            <From xsi:type="xsd:dateTime">2018-09-21T08:00:00+02:00</From>
            <Till xsi:type="xsd:dateTime">2018-09-22T08:00:00+02:00</Till>
         </Request>
      </urn:GetTurnoverReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
UserId	Long	Optional	Specify to request the report for a certain User only
SalesAreaId	Long	Optional	Specify to request report of a certain Sales Area only
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time

GetTurnoverReport Response

GetTurnoverReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetTurnoverReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetTurnoverReportResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Data xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTurnoverBill[x]">...</Data>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetTurnoverReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Data	[TurnoverBill]	List of bills with included items
Extra	[ExtraInfo]	List of extra fields

GetDetailedTurnoverReport

Returns the detailed list of transactions for the specified period. For each transaction, a list of orders, bills, proformas and re-prints is returnd.

GetDetailedTurnoverReport Request

GetDetailedTurnoverReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetDetailedTurnoverReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetDetailedTurnoverReportRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <From xsi:type="xsd:dateTime">2018-09-11T08:00:00+01:00</From>
            <Till xsi:type="xsd:dateTime">2018-09-12T08:00:00+01:00</Till>
            <SalesAreaId xsi:type="xsd:long">0</SalesAreaId>
            <Extra xsi:type="urn:TExtraInfoArray" soapenc:arrayType="urn:TExtraInfo[1]">
               <item xsi:type="urn:TExtraInfo">
                <Key xsi:type="xsd:string">OnlyPaid</Key>
                <Value xsi:type="xsd:string">1</Value>
              </item>
           </Extra>
         </Request>
      </urn:GetDetailedTurnoverReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time
SalesAreaId	Long	Optional	Specify to request report of a certain Sales Area only
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`OnlyPaid`	Boolean	When true, it includes only order items which have been paid during this period. By default this property is “False”
`TaxesPerBill`	Boolean	When true, it returns information about extra taxes in TurnoverTransaction.Extra: `service_charge_amount` and `vat_on_service_charge_amount`
`TaxesPerOrderItem`	Boolean	When true, it returns information about extra taxes in TransactionOrderItem.Extra: `service_charge_amount` and `vat_on_service_charge_amount`
`DiscountReason`	Boolean	When true, it returns name of discount reason in TransactionOrderItem.Extra (Key = `discount_reason`)
`ModificationDates`	Boolean	When true, it returns transaction modification dates in TurnoverTransaction.Extra (Key = `modified`)
`IncludeReopen`	Boolean	When true, re-opened bills are included in transactions (disabled by default). Fe. when a bill is paid with CASH, then re-opened and paid by VISA, all three bills will be included: 1. Positive CASH, 2. Negative CASH and 3. Positive VISA
`EftExtras`	String	Comma-separated list of EFT fields which should be returned in TransactionBillPayment.Extra for card payments. A list of possible fields can be found in Constants. The meaning of the values contained in these fields depend on the EFT model used for processing card payments
`TranExtras`	Boolean	When true, it returns user-defined extra fields in TurnoverTransaction.Extra (when specified in the CreateOrder request)
`BillNumber`	String	When specified, only those transaction(s) are returned which have a bill with the specified number
`BillSuffix`	String	Can be specified in addition to `BillNumber`. If not specified, it means that unTill searches for bills with any (or without) a suffix
`TranNumber`	String	When specified, only those transaction(s) are returned which have the specified number
`TranSuffix`	String	Can be specified in addition to `TranNumber`. If not specified, it means that unTill searches for transactions with any (or without) a suffix
`LookupByFirstBill`	Boolean	Whe set to true, then it searches by the time of first bill. If the first bill in the transaction is made in the specified time range, this transaction is included in the response with all it’s history. Can be combined with `OnlyPaid` and `IncludeReopen` extras.

GetDetailedTurnoverReport Response

GetDetailedTurnoverReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetDetailedTurnoverReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetDetailedTurnoverReportResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Data xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTurnoverTransaction[x]">...</Data>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetDetailedTurnoverReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Data	[TurnoverTransaction]	List of transactions with included orders & payments
Extra	[ExtraInfo]	List of extra fields

GetCancelledItemsReport

Returns the list of articles which have been cancelled (added to an order and then removed by “Cancel” or “Void” button).

GetCancelledItemsReport Request

GetCancelledItemsReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetCancelledItemsReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetCancelledItemsReportRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <From xsi:type="xsd:dateTime">2018-11-20T08:00:00+01:00</From>
            <Till xsi:type="xsd:dateTime">2018-11-21T08:00:00+01:00</Till>
         </Request>
      </urn:GetCancelledItemsReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time

GetCancelledItemsReport Response

GetCancelledItemsReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetCancelledItemsReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetCancelledItemsReportResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TCancelledItem[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetCancelledItemsReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[CancelledItem]	List of cancelled items
Extra	[ExtraInfo]	List of extra fields

GetCardDepositsReport

Returns the list of card deposits per time period.

GetCardDepositsReport Request

GetCardDepositsReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetCardDepositsReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetCardDepositsReportRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <From xsi:type="xsd:dateTime">2020-07-29T08:00:00+02:00</From>
            <Till xsi:type="xsd:dateTime">2020-07-30T08:00:00+02:00</Till>
         </Request>
      </urn:GetCardDepositsReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time
Extra	[ExtraInfo]	Optional	List of extra fields

GetCardDepositsReport Response

GetDepositsReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetCardDepositsReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetCardDepositsReportResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TCardDepositItem[1]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetCardDepositsReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[CardDepositItem]	List of card deposits
Extra	[ExtraInfo]	List of extra fields

GetDepositsReport

Returns the list of deposits per time period.

GetDepositsReport Request

GetDepositsReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetDepositsReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetDepositsReportRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <From xsi:type="xsd:dateTime">2018-11-20T08:00:00+01:00</From>
            <Till xsi:type="xsd:dateTime">2018-11-21T08:00:00+01:00</Till>
            <SalesAreaId xsi:type="xsd:long">0</SalesAreaId>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetDepositsReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time
SalesAreaId	Long	Optional	Specify to request report for a certain Sales Area only
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`EftExtras`	String	Comma-separated list of EFT fields which should be returned in DepositItem.Extra when made with card payments. A list of possible fields can be found in Constants. The meaning of the values contained in these fields depend on the EFT model used for processing card deposits

GetDepositsReport Response

GetDepositsReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetDepositsReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetDepositsReportResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TDepositItem[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetDepositsReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[DepositItem]	List of deposits
Extra	[ExtraInfo]	List of extra fields

GetTimeAttendanceReport

Get the Time and Attendance report.

GetTimeAttendanceReport Request

GetTimeAttendanceReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetTimeAttendanceReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetTimeAttendanceRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <UserId xsi:type="xsd:long">5000000575</UserId>
            <From xsi:type="xsd:dateTime">2018-07-01T08:00:00+02:00</From>
            <Till xsi:type="xsd:dateTime">2018-07-01T08:00:00+02:00</Till>
         </Request>
      </urn:GetTimeAttendanceReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
UserId	Long	Optional	Specify to request the report for a certain User only
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time

GetTimeAttendanceReport Response

GetTimeAttendanceReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetTimeAttendanceReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetTimeAttendanceResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Data xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTimeAttendanceRecord[x]">...</Data>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetTimeAttendanceReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Data	[TimeAttendanceRecord]	List of time & attendance records
Extra	[ExtraInfo]	List of extra fields

GetInOutCashReport

Returns the list of “In/Out” cash entries from the database per time period.

GetInOutCashReport Request

GetInOutCashReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetInOutCashReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetInOutCashReportRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <From xsi:type="xsd:dateTime">2018-11-20T08:00:00+01:00</From>
            <Till xsi:type="xsd:dateTime">2018-11-21T08:00:00+01:00</Till>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetInOutCashReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time

GetInOutCashReport Response

GetInOutCashReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetInOutCashReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetInOutCashReportResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TInOutCashItem[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetInOutCashReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[InOutCashItem]	List of in/out cash entries
Extra	[ExtraInfo]	List of extra fields

GetVoucherPaymentsReport

Returns the list of Voucher Payment entries from the database per time period.

GetVoucherPaymentsReport Request

GetVoucherPaymentsReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetVoucherPaymentsReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetVoucherPaymentsReportRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <From xsi:type="xsd:dateTime">2020-04-14T08:00:00+02:00</From>
            <Till xsi:type="xsd:dateTime">2020-04-15T08:00:00+02:00</Till>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetVoucherPaymentsReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time
Extra	[ExtraInfo]	Optional	List of extra fields

GetVoucherPaymentsReport Response

GetVoucherPaymentsReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetVoucherPaymentsReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetVoucherPaymentsReportResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TVoucherPaymentItem[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetVoucherPaymentsReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[VoucherPaymentItem]	List of voucher payments
Extra	[ExtraInfo]	List of extra fields

FindTransactions

Searches and returns Transactions by certain conditions specified in “Conditions” field. Conditions is a set of ExtraInfo entities where each condition has a key and a value.

FindTransactions Request

FindTransactions Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:FindTransactions soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TFindTransactionsRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Conditions xsi:type="urn:TExtraInfoArray" soapenc:arrayType="urn:TExtraInfo[1]">
               <item xsi:type="urn:TExtraInfo">
                <Key xsi:type="xsd:string">transaction_id</Key>
                <Value xsi:type="xsd:string">25000158204</Value>
              </item>
           </Conditions>
            <Limit xsi:type="xsd:int">0</Limit>
            <Desc xsi:type="xsd:boolean">false</Desc>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:FindTransactions>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
Conditions	[ExtraInfo]	Mandatory	List of conditions
Limit	Integer	Optional	0 - All records
Desc	Boolean	Optional	False: Return transactions in the order of creation True: Return in reversed order
Extra	[ExtraInfo]	Optional	List of extra fields

List of supported conditions:

Key	Value	Description
`transaction_id`	Long	Transaction Id. Note: Starting version 2.27 a comma separated list is supported
`bill_external_id`	Long	Extrnal Id of a TransactionBill

FindTransactions Response

FindTransactions Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:FindTransactionsResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TFindTransactionsResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Transactions xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTurnoverTransaction[1]">...</Transactions>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:FindTransactionsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Transactions	[TurnoverTransaction]	List of found transactions
Extra	[ExtraInfo]	List of extra fields

GetSmartcardDepositsReport

Returns the list of Smarcard deposit entries from the database per time period.

GetSmartcardDepositsReport Request

GetSmartcardDepositsReport Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetSmartcardDepositsReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetSmartcardDepositsReportRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <From xsi:type="xsd:dateTime">2019-06-05T08:00:00+01:00</From>
            <Till xsi:type="xsd:dateTime">2019-06-06T08:00:00+01:00</Till>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetSmartcardDepositsReport>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name
From	Timestamp	Mandatory	Report start date/time
Till	Timestamp	Mandatory	Report end date/time

GetSmartcardDepositsReport Response

GetSmartcardDepositsReport Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetSmartcardDepositsReportResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetSmartcardDepositsReportResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TSmartcardDepositReportItem[x]">...</Items>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetSmartcardDepositsReportResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Items	[SmartcardDepositReportItem]	List of deposits entries
Extra	[ExtraInfo]	List of extra fields

Misc

GetBOStatus

Returns the status including BO database signature. Everytime any backoffice data is updated, this signature changes.

GetBOStatus Request

GetBOStatus Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetBOStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetBOStatusRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetBOStatus>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetBOStatus Response

GetBOStatus Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetBOStatusResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetBOStatusResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <CurrentSignature xsi:type="xsd:string">669bff6702861fa34909f6fd79ce74bed18c2006</CurrentSignature>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetBOStatusResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
CurrentSignature	String	Current BO database signature

GetServerInfo

Returns general TPAPI server information.

GetServerInfo Request

GetServerInfo Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetServerInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetServerInfoRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
         </Request>
      </urn:GetServerInfo>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetServerInfo Response

GetServerInfo Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetServerInfoResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetServerInfoResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <DateTime xsi:type="xsd:dateTime">2018-11-20T09:54:40.796+01:00</DateTime>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
         </return>
      </NS1:GetServerInfoResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
DateTime	Timestamp	Current server date/time

GetVersion

Read current TPAPI protocol version.

GetVersion Request

GetVersion Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetVersion soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TGetVersionRequest" xmlns:urn="urn:TPAPIPosIntfU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:GetVersion>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

GetVersion Response

GetVersion Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:GetVersionResponse xmlns:NS2="urn:TPAPIPosIntfU" xmlns:NS3="urn:TPAPIPosTypesU">
         <return xsi:type="NS2:TGetVersionResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
            <Major xsi:type="xsd:int">2</Major>
            <Minor xsi:type="xsd:int">23</Minor>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
               <item xsi:type="NS3:TExtraInfo">
                  <Key xsi:type="xsd:string">untill_version</Key>
                  <Value xsi:type="xsd:string">133.0.A.31016</Value>
                  <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
               </item>
            </Extra>
         </return>
      </NS1:GetVersionResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message
Major	Integer	Version Major number
Minor	Integer	Version Minor number
Extra	[ExtraInfo]	List of extra fields

List of available extra fields:

Key	Description
`untill_version`	unTill application version

PosRestart

Restarts POS.

PosRestart Request

PosRestart Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:PosRestart soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="urn:TPosRestartRequest" xmlns:urn="urn:TPAPIPosTypesU">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
         </Request>
      </urn:PosRestart>
   </soapenv:Body>
</soapenv:Envelope>

Parameter	Type	Status	Description
UserName	String	Mandatory	Username of unTill user
Password	String	Mandatory	TPAPI password of unTill user
AppToken	String	Mandatory	Unique application token
AppName	String	Optional	Third party application name

PosRestart Response

PosRestart Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:NS1="urn:TPAPIPosIntfU-ITPAPIPOS">
      <NS1:PosRestartResponse xmlns:NS2="urn:TPAPIPosIntfU">
         <return xsi:type="NS2:TPosRestartResponse">
            <ReturnCode xsi:type="xsd:int">0</ReturnCode>
            <ReturnMessage xsi:type="xsd:string">ok</ReturnMessage>
         </return>
      </NS1:PosRestartResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameter	Type	Description
ReturnCode	Integer	Return code
ReturnMessage	String	Return message

SOAP Examples

Order article

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000633</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

In this example we order a single item, 'Coca-Cola' (Id: 5000000633).
Because this is a normal item, we set the OrderItemType to 0.

Order article with manual price

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">70001538750</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
                  <ManualPrice xsi:type="xsd:double">3.5</ManualPrice>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

Articles can also be set to have a manual price, this means that the price should be entered when it is added to the order.

In this example we order the item 'Open Drinks' (Id: 70001538750) which has a manual price. This is also a normal item so we set the OrderItemType to 0. To define the price for this article, we have to add the ManualPrice field and specify the price.

Order article with must-have options

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">45000012856</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">2</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000644</ArticleId>
                  <OrderItemType xsi:type="xsd:int">1</OrderItemType>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">3</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000625</ArticleId>
                  <OrderItemType xsi:type="xsd:int">1</OrderItemType>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

There are various types of options that can be added to an article. One of them are the 'must-have options'. If an article has them configured, they are returned in the Options property of the ArticleInfo. These options have to be processed, and in the same order as they are shown in the options property of the article, otherwise the order will not be accepted.

In this example we order the article 'Fillet Steak' (Id: 45000012856) which has 2 must-have options configured:

Cooking Preferences (Id: 5000000096)
Steak Sauce Options (Id: 45000291682)

This means that from both options groups, one item has to be added to the order with OrderItemType set to 1. Here we have added:

Medium (Id: 5000000644) from the 'Cooking Preferences' option group
Bearnaise Sauce (Id: 5000000625) from the 'Steak Sauce Options' option group

Order article with composed option

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000821</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">2</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000673</ArticleId>
                  <OrderItemType xsi:type="xsd:int">1</OrderItemType>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">3</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000674</ArticleId>
                  <OrderItemType xsi:type="xsd:int">1</OrderItemType>
                   <Extra soapenc:arrayType="urn:TExtraInfo[1]" xsi:type="urn:TExtraInfoArray">
                     <item xsi:type="NS3:TExtraInfo">
                        <Key xsi:type="xsd:string">last</Key>
                     </item>
                   </Extra>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

In exceptional cases, it happens that a must-have option configured for an article has the 'Compose' setting enabled. When this is done, you can add multiple items from the option group to the article when you order it. If this is enabled, it will be returned in the composed_options Extra in the ArticleInfo. Ordering is the same as in the previous example with the exception that an ExtraInfo with the Key last should be added to the last option item.

In this example we order the item 'Lemonade Mixer' (Id: 5000000821) which has 1 must-have option configured that has 'Compose' enabled:

Drinks Options (Id: 5000000100)

From this option group, we have added 2 items:

with Lemon (Id: 5000000673)
with Lime (Id: 5000000674)

The ExtraInfo is added to the item 'with Lime'.

Order article with supplement

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000734</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">2</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000622</ArticleId>
                  <OrderItemType xsi:type="xsd:int">3</OrderItemType>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

Option groups can also be linked to a department, and the items in these groups can be added to all articles which belong to that department. This can be either as a supplement (optionally paid) or as a condiment (always free).

In this example we order the article 'Full Ribs' (Id: 5000000734) from the department 'Grill' which has the supplement 'Extras' (Id: 5000000109) configured. From this group we add the item 'Bone Marrow Gravy' (Id: 5000000622) to the Full Ribs. Supplements are always ordered setting the OrderItemType to 3.

Order article with condiment

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000734</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">2</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000660</ArticleId>
                  <OrderItemType xsi:type="xsd:int">4</OrderItemType>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

In this example we order the article 'Full Ribs' (Id: 5000000734) from the department 'Grill' which has the condiment 'Instructions' (Id: 5000000112) configured. From this group we add the item 'Salad Not Chips' (Id: 5000000660) to the Full Ribs. Supplements are always ordered setting the OrderItemType to 4.

Order article with free option

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">15000119731</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">2</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000678</ArticleId>
                  <OrderItemType xsi:type="xsd:int">2</OrderItemType>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

In addition to the must-have options, there are also free options. These are configured per item and can be both free and paid. The big difference with the must-have options is that they may be skipped.

In this example we order the article 'Oyster&Champagne' (Id: 15000119731) from the department 'Small Plates' which has the free options 'Spritzers' (Id: 5000000104) configured. From this group we add the item 'with Ice' (Id: 5000000678) to the Oyster&Champagne. Free options are always ordered setting the OrderItemType to 2.

Order article with an article message

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000633</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">2</ItemNumber>
                  <ArticleId xsi:type="xsd:long">0</ArticleId>
                  <Text xsi:type="xsd:string">Example message</Text>>
                  <OrderItemType xsi:type="xsd:int">6</OrderItemType>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

An article message can be added to any regular item (where OrderItemType is 0). This is an OrderItem of type 6. The ArticleId can either be set to 0 or omitted.

In this example we order a single item, 'Coca-Cola' (Id: 5000000633) with an article message "Example message".

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:TPAPIPosIntfU-ITPAPIPOS" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <urn:CreateOrder soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xmlns:urn="urn:TPAPIPosIntfU" xsi:type="urn:TCreateOrderRequest">
            <Password xsi:type="xsd:string">your_password</Password>
            <UserName xsi:type="xsd:string">your_username</UserName>
            <AppToken xsi:type="xsd:string">your_apptoken</AppToken>
            <AppName xsi:type="xsd:string">your_appname</AppName>
            <TableNumber xsi:type="xsd:int">1</TableNumber>
            <TablePart xsi:type="xsd:string">a</TablePart>
            <Items xsi:type="urn:TOrderItemArray" soapenc:arrayType="urn:TOrderItem[2]">
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">1</ItemNumber>
                  <ArticleId xsi:type="xsd:long">70001588718</ArticleId>
                  <OrderItemType xsi:type="xsd:int">0</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">2</ItemNumber>
                  <ArticleId xsi:type="xsd:long">45000012856</ArticleId>
                  <OrderItemType xsi:type="xsd:int">5</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">3</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000644</ArticleId>
                  <OrderItemType xsi:type="xsd:int">1</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">4</ItemNumber>
                  <ArticleId xsi:type="xsd:long">5000000625</ArticleId>
                  <OrderItemType xsi:type="xsd:int">1</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
               <item xsi:type="urn:TOrderItem">
                  <ItemNumber xsi:type="xsd:int">5</ItemNumber>
                  <ArticleId xsi:type="xsd:long">45000032135</ArticleId>
                  <OrderItemType xsi:type="xsd:int">5</OrderItemType>
                  <Quantity xsi:type="xsd:int">1</Quantity>
               </item>
            </Items>
         </Request>
      </urn:CreateOrder>
   </soapenv:Body>
</soapenv:Envelope>

When an article has the property IsMenu set to true, the items chosen options should be sent with OrderItemType set to 5 (Menu Item). If a menu item has any must-have options, these should be processed as such.

In this example we order the item 'Daily Menu' (Id: 70001588718) which has two option grous configured:

Daily Menu Main (Id: 70001588527)
Daily Menu Dessert (Id: 70001588630)

This means that from both options groups, one item has to be added to the order with OrderItemType set to 5. Here we have added:

Fillet Steak (Id: 45000012856) from the 'Daily Menu Main' option group
Creme brulee (Id: 45000032135) from the 'Daily Menu Dessert' option group

Because the item 'Fillet Steak' has must-have options, we also have to process these options.

Types and Classes

All strings are unicode UTF8 strings. Other classes are listed below.

AllergenInfo

AllergenInfo Object

<item xsi:type="NS3:TAllergenInfo">
    <Id xsi:type="xsd:long">9999999931</Id>
    <Number xsi:type="xsd:int">1</Number>
    <Name xsi:type="xsd:string">Egg</Name>
    <Description xsi:type="xsd:string"/>
    <IsActive xsi:type="xsd:boolean">true</IsActive>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Allergen	Always
Number	Integer	Number of this Allergen	Always
Name	String	Name of this Allergen	Always
Description	String	Description of this Allergen	Optional
Value	Boolean	True if Allergen is active	Always
Extra	[ExtraInfo]	List of extra fields	Optional

ArticleDiscountItemInfo

ArticleDiscountItemInfo Object

<item xsi:type="NS3:TArticleDiscountItemInfo">
    <ArticleId xsi:type="xsd:long">5000000633</ArticleId>
    <DiscountPercent xsi:type="xsd:double">10</DiscountPercent>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
ArticleId	Long	Article Id	Always
DiscountPercent	Decimal	Discount in percents	Always
Extra	[ExtraInfo]	List of extra fields	Optional

ArticleInfo

ArticleInfo Object

<item xsi:type="NS3:TArticleInfo">
    <ArticleId xsi:type="xsd:long">5000001716</ArticleId>
    <ArticleName xsi:type="xsd:string">Coca Cola</ArticleName>
    <ArticleNumber xsi:type="xsd:int">1</ArticleNumber>
    <Available xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:long[3]">
        <item>5000000210</item>
        <item>5000000208</item>
        <item>5000000209</item>
    </Available>
    <DepartmentId xsi:type="xsd:long">5000000170</DepartmentId>
    <Prices xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TItemPrice[2]">
        <item xsi:type="NS3:TItemPrice">
            <ArticleId xsi:type="xsd:long">5000001716</ArticleId>
            <PriceId xsi:type="xsd:long">5000000206</PriceId>
            <Amount xsi:type="xsd:double">2</Amount>
            <Vat xsi:type="xsd:double">21</Vat>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TItemPrice">
            <ArticleId xsi:type="xsd:long">5000001716</ArticleId>
            <PriceId xsi:type="xsd:long">5000000207</PriceId>
            <Amount xsi:type="xsd:double">1.7</Amount>
            <Vat xsi:type="xsd:double">12</Vat>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Prices>
    <FreeOption xsi:type="xsd:long">5000000145</FreeOption>
    <Options xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:long[1]">
        <item>5000000143</item>
    </Options>
    <IsMenu xsi:type="xsd:boolean">false</IsMenu>
    <IsManualPrice xsi:type="xsd:boolean">false</IsManualPrice>
    <IsActive xsi:type="xsd:boolean">true</IsActive>
    <Promo xsi:type="xsd:boolean">false</Promo>
    <HqId xsi:type="xsd:string">Coca Cola</HqId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[5]">
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">daily_stock_active</Key>
            <Value xsi:type="xsd:string">0</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">daily_stock_qty</Key>
            <Value xsi:type="xsd:string">0</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">purchase_price</Key>
            <Value xsi:type="xsd:string">0.0000</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
            </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">course_id</Key>
            <Value xsi:type="xsd:string">5000001331</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">info</Key>
            <Value xsi:type="xsd:string"/>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Extra>
</item>

Parameter	Type	Description	Value?
ArticleId	Long	Internal Id of this Article	Always
ArticleName	String	Name of this Article	Always
ArticleNumber	Integer	Number of this Article	Always
Available	[Long]	List of Sales Area Id's where this Article is available	Optional
Prices	[ItemPrice]	List of Prices for this Article	Always
DepartmentId	Long	Id of the Department where this Article belongs to	Always
FreeOption	Long	Free Option ID	Optional
Options	[Long]	List of must-have options	Optional
IsMenu	Boolean	Returns true if this Article is a menu	Always
IsManualPrice	Boolean	Returns true if this Article requires a manual price input when ordered	Always
IsActive	Boolean	Returns if true is this Article is active	Always
Promo	Boolean	Return true if this Article is a Combo/Promo article	Always
HqId	String	HQ Id	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`course_id`	Only return articles of a specific course
`daily_stock_active`	1/0 (if DailyStock=1 was specified in request’s Extra fields)
`daily_stock_qty`	Daily stock quantity (if DailyStock=1 was specified in request’s Extra fields)
`info`	Article info (tab 9 of the article settings in back-office)
`plu`	When PLU is not zero
`purchase_price`	Purchase price
`size_modifier_id`	Id of Size Modifier, when defined for Article
`composed_options`	Comma separated list of options having 'Composed' enabled for this article. Syntax: OptionId : Maximum number of unique items allowed to order from this option
`disabled_in_sales_areas`	Comma separated list of Sales Area IDs where the article is disabled in POS
`allergens`	Article allergens (returned when `allergens` = 1 was specified in the request’s Extra fields) in ExtraInfo key/value pair. The key is the Allergen Id and the value is "comments"

ArticleShort

ArticleShort Object

<item xsi:type="NS3:TArticleShort">
    <ArticleId xsi:type="xsd:long">5000001716</ArticleId>
    <ArticleName xsi:type="xsd:string">Coca Cola</ArticleName>
    <ArticleNumber xsi:type="xsd:int">1</ArticleNumber>
    <SalesAreaId xsi:type="xsd:long">5000000210</SalesAreaId>
    <DepartmentId xsi:type="xsd:long">5000000170</DepartmentId>
    <HqId xsi:type="xsd:string">Coca Cola</HqId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
ArticleId	Long	Internal Id of this Article	Always
ArticleName	String	Name of this Article	Always
ArticleNumber	Integer	Number of this Article	Always
SalesAreaId	Long	Id of the Sales Area where this Article is available	Always
DepartmentId	Long	Id of the Department where this Article belongs to	Always
HqId	String	HQ Id	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

CancelledItem

CancelledItem Object

<item xsi:type="NS3:TCancelledItem">
    <ArticleId xsi:type="xsd:long">5000001722</ArticleId>
    <DateTime xsi:type="xsd:dateTime">2018-11-20T16:30:42.000+01:00</DateTime>
    <UserId xsi:type="xsd:long">5000001377</UserId>
    <TableNo xsi:type="xsd:int">21</TableNo>
    <TablePart xsi:type="xsd:string">a</TablePart>
    <Quantity xsi:type="xsd:int">1</Quantity>
    <Price xsi:type="xsd:double">2</Price>
    <PriceId xsi:type="xsd:long">5000000206</PriceId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
ArticleId	Long	Article Id	Always
DateTime	Timestamp	Date/time of cancelling the article	Always
UserId	Long	Waiter Id	Always
TableNo	Integer	Table number where the article was cancelled	Always
TablePart	String	Table part where the article was cancelled	Always
Quantity	Integer	Quantity of cancelled articles	Always
Price	Decimal	Price	Always
PriceId	Long	Id of the Price level	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`size_modifier_item_id`	Id of Size Modifier (when applied)

CardDepositItem

CardDepositItem Object

<item xsi:type="NS3:TCardDepositItem">
    <Id xsi:type="xsd:long">25000213510</Id>
    <DateTime xsi:type="xsd:dateTime">2020-07-29T15:10:26.000+02:00</DateTime>
    <UserId xsi:type="xsd:long">5000001377</UserId>
    <Amount xsi:type="xsd:double">10</Amount>
    <ComputerName xsi:type="xsd:string">PCPASCAL</ComputerName>
    <PaymentId xsi:type="xsd:long">5000000055</PaymentId>
    <DepositNumber xsi:type="xsd:string">7</DepositNumber>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[2]">
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">bookkeeping_account</Key>
            <Value xsi:type="xsd:string">10000</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">bookkeeping_account_name</Key>
            <Value xsi:type="xsd:string">Cash</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Extra>
</item>

Parameter	Type	Description	Value?
Id	Long	Id of the Deposit	Always
DateTime	Timestamp	Deposit date/time	Always
UserId	Long	Waiter Id	Always
Amount	Decimal	Deposit amount	Always
ComputerName	String	Computer name	Always
PaymentId	Long	Payment Id	Always
DepositNumber	String	Deposit number	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`bookkeeping_account`	Bookeeping account number (if bookkeeping assigned)
`bookkeeping_account_name`	Bookeeping account name (if bookkeeping assigned)

CategoryInfo

CategoryInfo Object

<item xsi:type="NS3:TCategoryInfo">
    <CategoryId xsi:type="xsd:long">5000000036</CategoryId>
    <CategoryName xsi:type="xsd:string">1.Bar</CategoryName>
    <HqId xsi:type="xsd:string">1.Bar</HqId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
CategoryId	Long	Internal Id of this Category	Always
CategoryName	String	Name of this Category	Always
HqId	String	Hq Id	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

Client

Client Object

<item xsi:type="NS3:TClient">
    <Id xsi:type="xsd:long">65000353067</Id>
    <Number xsi:type="xsd:int">1</Number>
    <Name xsi:type="xsd:string">John Doe</Name>
    <Country xsi:type="xsd:string">United States</Country>
    <Phone xsi:type="xsd:string">585-924-1525</Phone>
    <Fax xsi:type="xsd:string"/>
    <Email xsi:type="xsd:string">brabtleater1957@rhyta.com</Email>
    <Website xsi:type="xsd:string"/>
    <Address xsi:type="xsd:string">1951 Cherry Ridge Drive</Address>
    <Info xsi:type="xsd:string"/>
    <BirthDate xsi:type="xsd:dateTime">1995-03-07T00:00:00.000+01:00</BirthDate>
    <CardNumber xsi:type="xsd:string">MjY3MDIwNjQ2OTU0RA==</CardNumber>
    <Code xsi:type="xsd:string"/>
    <OnInvoice xsi:type="xsd:boolean">true</OnInvoice>
    <PriceActive xsi:type="xsd:boolean">true</PriceActive>
    <Price xsi:type="xsd:long">65000333282</Price>
    <PromotionPrice xsi:type="xsd:long">0</PromotionPrice>
    <AccountBalance xsi:type="xsd:double">0</AccountBalance>
    <AccountLimit xsi:type="xsd:double">0</AccountLimit>
    <IsSharedAccount xsi:type="xsd:boolean">false</IsSharedAccount>
    <SharedAccount xsi:type="xsd:string"/>
    <SavePoints xsi:type="xsd:int">1636</SavePoints>
    <SaveAmount xsi:type="xsd:int">0</SaveAmount>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[4]">
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">last_update</Key>
            <Value xsi:type="xsd:string">2018.11.20 10:36:14</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">is_active</Key>
            <Value xsi:type="xsd:string">1</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">country_id</Key>
            <Value xsi:type="xsd:string">65000353071</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">smartcard_uid</Key>
            <Value xsi:type="xsd:string">48C44B8C</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Extra>
</item>

Parameter	Type	Description	Read	Write
Id	Long	Internal Id of this Client	Always	Required when updating
Number	Integer	Number of this Client	Always	Required when updating
Name	String	Name of this Client	Always	Required
Country	String	Country name (Id of country is sent in `Extra`)	Optional	Optional
Phone	String	Client phone	Optional	Optional
Fax	String	Client fax	Optional	Optional
Email	String	Client email	Optional	Optional
Website	String	Client website	Optional	Optional
Address	String	Client address	Optional	Optional
Info	String	Client info	Optional	Optional
BirthDate	Timestamp	Client birthdate (Only > 01-01-1900 allowed)	Optional	Optional
CardNumber	String	Client cardnumber (Base64-encoded)	Optional	Optional
Code	String	Client code	Optional	Optional
OnInvoice	Boolean	True if Client is allowed to consume on invoice	Always	Optional
PriceActive	Boolean	True if Client has a special price level assigned	Always	Optional
Price	Long	Special price level Id assigned to this Client	Optional	Optional
PromotionPrice	Long	Not used	Optional	N/A
AccountBalance	Decimal	Current Client balance	Always	Not updatable
AccountLimit	Decimal	Client limit	Always	Optional
IsSharedAccount	Boolean	True if this Client belongs to a Shared Account	Always	Optional
SharedAccount	String	Shared Account name	Optional	Optional
SavePoints	Integer	Current savepoints balance	Always	Not updatable
SaveAmount	String	Current saveamount balance	Always	Optional
Extra	[ExtraInfo]	List of extra fields	Always	Optional

List of available extra fields:

Key	Value	Description	Read	Write
`is_active`	1/0	Activity flag.	Always	Optional, default = 1.
`country_id`	Long	Id of Country.	Always	Optional
`last_update`	Timestamp	When client was updated for the last time.	Always	N/A
`smartcard_uid`	String (Hex)	Smartcard UID(s), comma-separated	If not null	Optional
`expiry_date`	Date (YYYYMMDD)	Expiration date	If not null	Optional: YYYYMMDD or "null"

Note: Starting unTill version 135, only the first Card is returned for every client when reading clients. When updating, the value of this field is ignored. Use functions GetClientCardsInfo and UpdateClientCards for managing client cards.

ClientCardInfo

ClientCardInfo Object

<item xsi:type="NS3:TClientCardInfo">
    <Id xsi:type="xsd:long">70002116857</Id>
    <Number xsi:type="xsd:int">1</Number>
    <ClientId xsi:type="xsd:long">65001352781</ClientId>
    <CardNameId xsi:type="xsd:long">70002116856</CardNameId>
    <Card xsi:type="xsd:string">MjY3MDIwNjQ2OTU0RA==</Card>
    <IsActive xsi:type="xsd:boolean">true</IsActive>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Read	Write
Id	Long	Internal Id of this Client Card	Always	Required when updating, set to 0 when adding a new card
Number	Integer	Number of card in list	Always	Optional
ClientId	Long	Id of Client	Always	Always
CardNameId	Long	Id of CardName	Always	Always
Card	String	Base64 encoded	Always	Always
IsActive	Boolean	True if Card Name is active	Always	Optional
Extra	[ExtraInfo]	List of extra fields	Optional	Optional

ClientCardNameInfo

ClientCardNameInfo Object

<item xsi:type="NS3:TClientCardNameInfo">
    <Id xsi:type="xsd:long">70002116856</Id>
    <Name xsi:type="xsd:string">Default client cards</Name>
    <IsActive xsi:type="xsd:boolean">true</IsActive>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Card Name	Always
Name	String	Name of this Card	Always
IsActive	Boolean	True if Card Name is active	Always
Extra	[ExtraInfo]	List of extra fields	Optional

Country

Country Object

<item xsi:type="NS3:TCountry">
    <CountryId xsi:type="xsd:long">65000348984</CountryId>
    <CountryName xsi:type="xsd:string">Netherlands</CountryName>
    <Kind xsi:type="xsd:int">0</Kind>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">is_active</Key>
            <Value xsi:type="xsd:string">1</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Extra>
</item>

Parameter	Type	Description	Read	Write
Id	Long	Internal Id of this Country	Always	Required when updating
CountryName	String	Name of this Country	Always	Always
Kind	Integer	0: Home Country 1: Member EC 2: Other	Always	Always
Extra	[ExtraInfo]	List of extra fields	Always	Optional

List of available extra fields:

Key	Value	Description	Read	Write
`is_active`	1/0	Activity flag	Always	Optional, default = 1.

Course

Course Object

<item xsi:type="NS3:TCourse">
    <Id xsi:type="xsd:long">5000000468</Id>
    <Name xsi:type="xsd:string">Mains</Name>
    <Number xsi:type="xsd:int">3</Number>
    <Separate xsi:type="xsd:boolean">true</Separate>
    <Changeable xsi:type="xsd:boolean">true</Changeable>
    <AutoFire xsi:type="xsd:boolean">false</AutoFire>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">is_active</Key>
            <Value xsi:type="xsd:string">1</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Extra>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Course	Always
Name	String	Name of this Course	Always
Number	Integer	Number of this Course	Always
Separate	Boolean	True if this Course is separate	Always
Changeable	Boolean	True if this Course is changeable	Always
AutoFire	Boolean	True is this Course is fired automatically	Always
Extra	[ExtraInfo]	List of extra fields	Always

List of available extra fields:

Key	Value	Description
`is_active`	1/0	Activity flag

Credential

ExtraInfo Object

<item xsi:type="NS3:TCredential">
    <CredentialGuid xsi:type="xsd:string">{56DAFD3A-B188-43A5-B337-EFE84DB88C33}</CredentialGuid>
    <CredentialName xsi:type="xsd:string">Administrator</CredentialName>
</item>

Parameter	Type	Description	Value?
CredentialGuid	String	Credential GUID	Always
CredentialName	String	Credential Name	Always

DepartmentInfo

DepartmentInfo Object

<item xsi:type="NS3:TDepartmentInfo">
    <DepartmentId xsi:type="xsd:long">5000000170</DepartmentId>
    <DepartmentNumber xsi:type="xsd:int">9002</DepartmentNumber>
    <DepartmentName xsi:type="xsd:string">Cold Drinks</DepartmentName>
    <Available xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:long[3]">
        <item>5000000208</item>
        <item>5000000209</item>
        <item>5000000210</item>
    </Available>
    <Supplement xsi:type="xsd:long">5000000157</Supplement>
    <Condiment xsi:type="xsd:long">5000000156</Condiment>
    <GroupId xsi:type="xsd:long">5000000043</GroupId>
    <SpecialArticles xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:long[0]"/>
    <HqId xsi:type="xsd:string">Cold Drinks</HqId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
DepartmentId	Long	Internal Id of this Department	Always
DepartmentName	String	Name of this Department	Always
DepartmentNumber	Integer	Number of this Department	Always
Available	[Long]	List of Sales Areas where this Department is available	Optional
Supplement	Long	Supplement Option Id	Optional
Condiment	Long	Condiment Option Id	Optional
GroupId	Long	Group Id	Always
SpecialArticles	[Long]	List of extra Articles added to this Department	Optional
HqId	String	Hq Id	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

DepositItem

DepositItem Object

<item xsi:type="NS3:TDepositItem">
    <Id xsi:type="xsd:long">20000156484</Id>
    <SalesAreaId xsi:type="xsd:long">5000000208</SalesAreaId>
    <ClientId xsi:type="xsd:long">5000096068</ClientId>
    <Amount xsi:type="xsd:double">10</Amount>
    <Comments xsi:type="xsd:string"/>
    <PaymentId xsi:type="xsd:long">5000000055</PaymentId>
    <ComputerName xsi:type="xsd:string">TESTPC</ComputerName>
    <UserId xsi:type="xsd:long">5000001380</UserId>
    <DateTime xsi:type="xsd:dateTime">2018-11-20T14:33:47.000+01:00</DateTime>
    <DepositNumber xsi:type="xsd:string">13</DepositNumber>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Id of the Deposit	Always
SalesAreaId	Long	Sales Area Id	Always
Amount	Decimal	Deposit amount	Always
Comments	String	Deposit comments	Optional
PaymentId	Long	Payment Id	Always
ComputerName	String	Computer name	Always
UserId	Long	Waiter Id	Always
DateTime	Timestamp	Deposit date/time	Always
DepositNumber	String	Deposit number	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`bookkeeping_account`	Bookeeping account number (if bookkeeping assigned)
`bookkeeping_account_name`	Bookeeping account name (if bookkeeping assigned)

DiscountedItem

DiscountedItem Object

<item xsi:type="urn:TDiscountedItem">
   <Signature xsi:type="xsd:string">cc1b3d3e65d8273b5e0dcf7f12d71442</Signature>
   <Quantity xsi:type="xsd:int">1</Quantity>    
</item>

Parameter	Type	Status	Description
Signature	String	Mandatory	Item signature
Quantity	Integer	Mandatory	Number of items to be discounted

DiscountGroupInfo

DiscountGroupInfo Object

<item xsi:type="NS3:TDiscountGroupInfo">
    <Id xsi:type="xsd:long">65000577970</Id>
    <Name xsi:type="xsd:string">Test Group</Name>
    <Barcode xsi:type="xsd:string">978020137962</Barcode>
    <CheapestArticleDiscountedOnly xsi:type="xsd:boolean">false</CheapestArticleDiscountedOnly>
    <Articles xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TArticleDiscountItemInfo[3]">
        <item xsi:type="NS3:TArticleDiscountItemInfo">
            <ArticleId xsi:type="xsd:long">5000000633</ArticleId>
            <DiscountPercent xsi:type="xsd:double">10</DiscountPercent>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TArticleDiscountItemInfo">
            <ArticleId xsi:type="xsd:long">5000000634</ArticleId>
            <DiscountPercent xsi:type="xsd:double">10</DiscountPercent>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TArticleDiscountItemInfo">
            <ArticleId xsi:type="xsd:long">45000075087</ArticleId>
            <DiscountPercent xsi:type="xsd:double">15</DiscountPercent>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Articles>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Discount Group	Always
Name	String	Name of this Discount Group	Always
Barcode	String	Barcode of this Discount Group	Optional
CheapestArticleDiscountedOnly	Boolean	True if cheapest article is discounted only	Always
Articles	[ArticleDiscountItemInfo]	List of articles	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

ExtraInfo

ExtraInfo Object

<Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
  <item xsi:type="NS3:TExtraInfo">
     <Key xsi:type="xsd:string">key</Key>
     <Value xsi:type="xsd:string">value</Value>
     <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
  </item>
</Extra>

Parameter	Type	Description	Value?
Key	String	Extra Info Item Key	Always
Value	String	Extra Info Item Value	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

GroupInfo

GroupInfo Object

<item xsi:type="NS3:TGroupInfo">
    <GroupId xsi:type="xsd:long">5000000043</GroupId>
    <GroupName xsi:type="xsd:string">1.Without Alcohol</GroupName>
    <CategoryId xsi:type="xsd:long">5000000036</CategoryId>
    <HqId xsi:type="xsd:string">1.Without Alcohol</HqId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[2]">
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">bookkeeping_turnover</Key>
            <Value xsi:type="xsd:string">81030</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">bookkeeping_vat</Key>
            <Value xsi:type="xsd:string"/>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Extra>
</item>

Parameter	Type	Description	Value?
GroupId	Long	Internal Id of this Group	Always
GroupName	String	Name of this Group	Always
CategoryId	Long	Category Id	Always
HqId	String	Hq Id	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`bookkeeping_turnover`	Bookkeeping turnover number
`bookkeeping_vat`	Bookkeeping VAT number

HotelGuestInfo

HotelGuestInfo Object

<item xsi:type="NS3:THotelGuestInfo">
    <Room xsi:type="xsd:string">031</Room>
    <Sequence xsi:type="xsd:int">1</Sequence>
    <Name xsi:type="xsd:string">Guest</Name>
    <ReservationId xsi:type="xsd:string">SCH-F2319</ReservationId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
    <ExtraDisplayInfo xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TKeyValue[4]">
        <item xsi:type="NS3:TKeyValue">
            <Key xsi:type="xsd:string">Credit Limit</Key>
            <Value xsi:type="xsd:string">0</Value>
        </item>
        <item xsi:type="NS3:TKeyValue">
            <Key xsi:type="xsd:string">Message Waiting</Key>
            <Value xsi:type="xsd:string">false</Value>
        </item>
        <item xsi:type="NS3:TKeyValue">
            <Key xsi:type="xsd:string">Country</Key>
            <Value xsi:type="xsd:string">NEDERLAND</Value>
        </item>
        <item xsi:type="NS3:TKeyValue">
            <Key xsi:type="xsd:string">Charge Allowed</Key>
            <Value xsi:type="xsd:string">true</Value>
        </item>
    </ExtraDisplayInfo>
</item>

Parameter	Type	Description	Value?
Room	String	Room number	Always
Sequence	Integer	Optional sequence	Optional
Name	String	Guest name	Always
ReservationId	String	Guest’s Reservation ID	Always
ExtraDispalyInfo	[KeyValue]	List of extra display items	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

HourlyWageItem

HourlyWageItem Object

<item xsi:type="NS3:THourlyWageItem">
    <Position xsi:type="xsd:string">Manager</Position>
    <HourlyWage xsi:type="xsd:double">15</HourlyWage>
    <HourlyWageOvertime xsi:type="xsd:double">22.5</HourlyWageOvertime>
</item>

Parameter	Type	Description	Value?
Position	String	Waiter Position	Always
HourlyWage	Decimal	Hourly wage	Always
HourlyWageOvertime	Decimal	Overtime hourly wage	Always

InOutCashItem

InOutCashItem Object

<item xsi:type="NS3:TInOutCashItem">
    <Id xsi:type="xsd:long">20000156558</Id>
    <DateTime xsi:type="xsd:dateTime">2018-11-20T15:47:05.000+01:00</DateTime>
    <ComputerName xsi:type="xsd:string">TESTPC</ComputerName>
    <UserId xsi:type="xsd:long">5000001377</UserId>
    <Amount xsi:type="xsd:double">-50</Amount>
    <Reason xsi:type="xsd:string">Out Cash</Reason>
    <Supplier xsi:type="xsd:string">unTill Software Development Group B.V.</Supplier>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Item Id	Always
DateTime	Timestamp	In/Out Cash date/time	Always
ComputerName	String	Computer name	Always
UserId	Long	Waiter Id	Always
Amount	Decimal	Amount. Positive for "In" cash and negative for "Out" cash items	Always
Reason	String	In/Out Cash reason	Always
Supplier	String	In/Out Cash supplier	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`supplier_id`	Id of Supplier Note that this extra only non-empty for in-out cash operations made in unTill version number 129.0 and above

Note: Supplier field is deprecated since version 2.24 (unTill version 129.0), use supplier_id from Extra instead.

ItemPrice

ItemPrice Object

<item xsi:type="NS3:TItemPrice">
    <ArticleId xsi:type="xsd:long">5000001716</ArticleId>
    <PriceId xsi:type="xsd:long">5000000206</PriceId>
    <Amount xsi:type="xsd:double">2</Amount>
    <Vat xsi:type="xsd:double">21</Vat>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
ArticleId	Long	Internal Id of this article	Always
PriceId	Long	Internal Id of the price level	Always
Amount	Decimal	Price amount	Always
VAT	Decimal	VAT percent	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`size_modifiers`	When Size Modifier is configured for an article, this extra will return a list of prices per Size Modifier Item. “Items” property of this `Extra` declares a map where the Key is the Size Modifier Item `Id` and the Value is the price
`exceptions`	List of price exception pairs <Period Id, Price Id>

KeyValue

KeyValue Object

<item xsi:type="NS3:TKeyValue">
    <Key xsi:type="xsd:string">key</Key>
    <Value xsi:type="xsd:string">value</Value>
</item>

Parameter	Type	Description	Value?
Key	String	Item Key	Always
Value	String	Item Value	Always

Language

Language Object

<Language xsi:type="NS3:TLanguage">
    <LangCode xsi:type="xsd:string">0000</LangCode>
    <Language xsi:type="xsd:string">English (Default)</Language>
</Language>

Parameter	Type	Description	Value?
LangCode	String	Language Code	Always
Language	String	Language Name	Always

OptionInfo

OptionInfo Object

<item xsi:type="NS3:TOptionInfo">
    <OptionId xsi:type="xsd:long">5000000157</OptionId>
    <OptionName xsi:type="xsd:string">Supplement Cold Drinks</OptionName>
    <Available xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="xsd:long[3]">
        <item>5000000208</item>
        <item>5000000209</item>
        <item>5000000210</item>
    </Available>
    <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TItemPrice[4]">
        <item xsi:type="NS3:TItemPrice">
            <ArticleId xsi:type="xsd:long">5000001996</ArticleId>
            <PriceId xsi:type="xsd:long">5000000206</PriceId>
            <Amount xsi:type="xsd:double">0.5</Amount>
            <Vat xsi:type="xsd:double">21</Vat>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TItemPrice">
            <ArticleId xsi:type="xsd:long">5000001996</ArticleId>
            <PriceId xsi:type="xsd:long">5000000207</PriceId>
            <Amount xsi:type="xsd:double">0.5</Amount>
            <Vat xsi:type="xsd:double">21</Vat>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TItemPrice">
            <ArticleId xsi:type="xsd:long">5000002025</ArticleId>
            <PriceId xsi:type="xsd:long">5000000206</PriceId>
            <Amount xsi:type="xsd:double">0.5</Amount>
            <Vat xsi:type="xsd:double">21</Vat>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TItemPrice">
            <ArticleId xsi:type="xsd:long">5000002025</ArticleId>
            <PriceId xsi:type="xsd:long">5000000207</PriceId>
            <Amount xsi:type="xsd:double">0.5</Amount>
            <Vat xsi:type="xsd:double">21</Vat>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Items>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
OptionId	Long	Internal Id of this Option	Always
OptionName	String	Name of this Option	Always
Available	[Long]	List of Sales Areas where this Option is available	Optional
Items	[ItemPrice]	List of Option items with their prices	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

OrderInfo

OrderInfo Object

<item xsi:type="NS3:TOrderInfo">
    <TableNumber xsi:type="xsd:int">1</TableNumber>
    <TablePart xsi:type="xsd:string">a</TablePart>
    <OrderName xsi:type="xsd:string">Test</OrderName>
    <CientName xsi:type="xsd:string">John Doe</CientName>
    <OrderDescr xsi:type="xsd:string"/>
    <SalesAreaId xsi:type="xsd:long">5000000208</SalesAreaId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
TableNumber	Integer	Table number	Always
TablePart	String	Table part	Always
OrderName	String	Order Name	Optional
ClientName	String	Name of the client assigned to the Order	Optional
OrderDescr	String	Order description	Optional
SalesAreaId	Long	Id of the Sales Area	Always
Extra	[ExtraInfo]	List of extra fields	Optional

OrderItem

OrderItem Object

<item xsi:type="urn:TOrderItem">
    <ItemNumber xsi:type="xsd:int">1</ItemNumber>
    <ArticleId xsi:type="xsd:long">5000001716</ArticleId>
    <OrderItemType xsi:type="xsd:int">0</OrderItemType>
    <Text xsi:type="xsd:string"></Text>
    <ManualPrice xsi:type="xsd:double">0</ManualPrice>
    <Quantity xsi:type="xsd:int">1</Quantity>
    <Extra xsi:type="urn1:TExtraInfoArray" soapenc:arrayType="urn1:TExtraInfo[]" xmlns:urn1="urn:TPAPIPosTypesU"/>
</item>

Parameter	Type	Status	Description
ItemNumber	Integer	Mandatory	Sequential order item number
ArticleId	Long	Mandatory	Id of Article to order. Specify '0' when OrderItemType = 6
OrderItemType	Integer	Mandatory	Type of order item
Text	String	Optional	Text when OrderItemType = 6
ManualPrice	Decimal	Optional	Only required when the Article has ManualPrice = true
Quantity	Integer	Mandatory	Quantity of ordered items. Note: Only valid when OrderItemType = 0 or 5
Extra	[ExtraInfo]	Optional	List of extra fields

List of available extra fields:

Key	Value	Description
`last`	-	Add this extra when this item is the last of a must-have option that has "Compose" enabled, and the next item is also a must-have option
`course_id`	Id of Course	Id of course to set for this item. Current item course, and destination course must both be “Changeable”
`size_modifier_item_id`	Id of Size Modifier	Id of Size Mofidifer Item
`allergens`	When added this tells which allergens must be specified. This value is a comma-separated list of Allergen Id's

PaymentInfo

PaymentInfo Object

<item xsi:type="NS3:TPaymentInfo">
    <PaymentId xsi:type="xsd:long">5000000055</PaymentId>
    <PaymentNumber xsi:type="xsd:int">1</PaymentNumber>
    <PaymentName xsi:type="xsd:string">Cash</PaymentName>
    <PaymentKind xsi:type="xsd:int">0</PaymentKind>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
PaymentId	Long	Internal Id of this Payment	Always
PaymentNumber	Integer	Number of this Payment	Always
PaymentName	String	Name of this Payment	Always
PaymentKind	Integer	Payment kind	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`guid`	Unique identifier which doesn´t change after export/import of the database

PeriodInfo

PeriodInfo Object

<item xsi:type="NS3:TPeriodInfo">
    <Id xsi:type="xsd:long">5000000254</Id>
    <Name xsi:type="xsd:string">TestPeriod</Name>
    <Values xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TPeriodValue[1]">...</Values>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Period	Always
Name	String	Name of this Period	Always
Values	[PeriodValue]	List of values for this Period	Always
Extra	[ExtraInfo]	List of extra fields	Optional

PeriodValue

PeriodValue Object

<item xsi:type="NS3:TPeriodValue">
    <Id xsi:type="xsd:long">5000000255</Id>
    <Name xsi:type="xsd:string">Friday</Name>
    <FromDay xsi:type="xsd:int">4</FromDay>
    <ToDay xsi:type="xsd:int">5</ToDay>
    <IsActive xsi:type="xsd:boolean">true</IsActive>
    <FromTime xsi:type="xsd:string">00:00:00</FromTime>
    <ToTime xsi:type="xsd:string">00:00:00</ToTime>
    <ValueType xsi:type="xsd:int">0</ValueType>
    <FromOneDay xsi:type="xsd:string">12-30-1899</FromOneDay>
    <ToOneDay xsi:type="xsd:string">12-30-1899</ToOneDay>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Period Value	Always
Name	String	Name of this Period Value	Always
FromDay	Integer	The number of the day of the week, which the period begins¹	Always
ToDay	Integer	The number of the day of the week, which the period ends¹	Always
IsActive	Boolean	True when active	Always
FromTime	String	Period start time	Always
ToTime	String	Period end time	Always
Type	Integer	Type of value²	Always
FromOneDay	String	Day and month of the beginning of the period³	Always
ToOneDay	String	Day and month of the end of the period³	Always
Extra	[ExtraInfo]	List of extra fields	Optional

¹ Monday - 0, Sunday - 6
² Weekly - 0, One time use - 1, Annual - 2, Daily - 3
³ In the annual period, the year does not matter

Pouring

Pouring Object

<item xsi:type="urn:TPouring">
    <PLU xsi:type="xsd:int">1</PLU>
    <Quantity xsi:type="xsd:int">1</Quantity>
    <TableNumber xsi:type="xsd:int">2</TableNumber>
    <DateTime xsi:type="xsd:dateTime">2018-11-20T15:30:44.000Z</DateTime>
    <WaiterID xsi:type="xsd:double">999</WaiterID>      
    <ClientCard xsi:type="xsd:string">80518B22694F04</ClientCard>                   
</item>

Parameter	Type	Description	Write
PLU	Integer	PLU of the Article	Mandatory
Quantity	Integer	Quantity	Mandatory
TableNumber	Integer	Table number for which the pouring has been made	Optional
DateTime	Timestamp	Date/time of pouring	Mandatory
WaiterID	Integer	Waiter number (Users / Beverage Control / Waiter ID)	Optional
ExteranalID	Long	Id of pouring in 3rd party system	Optional
ExternalUID	String (max. 50)	A unique UID of pouring in 3rd party system. When not empty, unTill only inserts pouring if no pouring with the same External UID already exists in database	Optional
ClientCard	String	Client Card	Optional
LCU	Integer	Logical Control Unit number which identifies the device	Optional

PrinterInfo

PrinterInfo Object

<item xsi:type="NS3:TPrinterInfo">
    <Id xsi:type="xsd:long">5000001099</Id>
    <Name xsi:type="xsd:string">1.Bill</Name>
    <Guid xsi:type="xsd:string">A418783184D40945A4251F6EC2041CC9</Guid>
    <NullPrinter xsi:type="xsd:boolean">false</NullPrinter>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Printer	Always
Name	String	Name of this Printer	Always
Guid	String	GUID	Always
NullPrinter	Boolean	True if “Null printer” option is enabled for this printer	Always
Extra	[ExtraInfo]	List of extra fields	Optional

PriceInfo

PriceInfo Object

<item xsi:type="NS3:TPriceInfo">
    <PriceId xsi:type="xsd:long">5000000206</PriceId>
    <PriceName xsi:type="xsd:string">Normal</PriceName>
    <HqId xsi:type="xsd:string"/>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
PriceId	Long	Internal Id of this Price	Always
PriceName	String	Name of this Price	Always
HqId	String	Hq Id	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

Reason

Reason Object

<item xsi:type="NS3:TReason">
    <Id xsi:type="xsd:long">5000000086</Id>
    <Name xsi:type="xsd:string">On the House</Name>
    <Number xsi:type="xsd:int">0</Number>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Reason	Always
Name	String	Name of this Reason	Always
Number	Integer	Number of this Reason	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`bookkeeping_account`	Bookeeping account number (for discount reasons only)
`bookkeeping_account_name`	Bookeeping account name (for discount reasons only)
`guid`	Unique identifier which doesn´t change after export/import of the database

SalesAreaInfo

SalesAreaInfo Object

<item xsi:type="NS3:TSalesAreaInfo">
    <SalesAreaId xsi:type="xsd:long">5000000208</SalesAreaId>
    <SalesAreaNumber xsi:type="xsd:int">1</SalesAreaNumber>
    <SalesAreaName xsi:type="xsd:string">Restaurant</SalesAreaName>
    <PriceId xsi:type="xsd:long">5000000206</PriceId>
    <Tables xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTableRange[x]">...</Tables>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
SalesAreaId	Long	Internal Id of this Sales Area	Always
SalesAreaNumber	Integer	Number of this Sales Area	Always
SalesAreaName	String	Name of this Sales Area	Always
PriceId	Long	Id of the active Price Level for this Sales Area	Always
Tables	[TableRange]	List of Table Ranges for this Sales Area	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`exceptions`	List of price exception pairs <Period Id, Price Id>

SizeModifierInfo

SizeModifierInfo Object

<item xsi:type="NS3:TSizeModifierInfo">
    <Id xsi:type="xsd:long">5000000549</Id>
    <Number xsi:type="xsd:int">1</Number>
    <Name xsi:type="xsd:string">Tap Beer</Name>
    <IsActive xsi:type="xsd:boolean">true</IsActive>
    <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TSizeModifierItemInfo[x]">...</Items>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Size Modifier	Always
Number	Integer	Number of this Size Modifier	Always
Name	String	Name of this Size Modifier	Always
IsActive	Boolean	Activity flag	Always
Items	[SizeModifierItemInfo]	List of Size Modifier Items for this Size Modifier	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

SizeModifierItemInfo

SizeModifierItemInfo Object

<item xsi:type="NS3:TSizeModifierItemInfo">
    <Id xsi:type="xsd:long">5000000553</Id>
    <Number xsi:type="xsd:int">1</Number>
    <Name xsi:type="xsd:string">Pint</Name>
    <IsActive xsi:type="xsd:boolean">true</IsActive>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Size Modifier Item	Always
Number	Integer	Number of this Size Modifier Item	Always
Name	String	Name of this Size Modifier Item	Always
IsActive	Boolean	Activity flag	Always
Extra	[ExtraInfo]	List of extra fields	Optional

SmartcardDepositReportItem

SmartcardDepositReportItem Object

<item xsi:type="NS3:TSmartcardDepositReportItem">
    <Id xsi:type="xsd:long">5000015635</Id>
    <DateTime xsi:type="xsd:dateTime">2019-06-05T10:27:30.000+02:00</DateTime>
    <SmartcardId xsi:type="xsd:long">5000015633</SmartcardId>
    <UserId xsi:type="xsd:long">9999999999</UserId>
    <PaymentId xsi:type="xsd:long">5000000062</PaymentId>
    <Number xsi:type="xsd:string">1</Number>
    <PCName xsi:type="xsd:string">TESTPC</PCName>
    <Amount xsi:type="xsd:double">10</Amount>
    <Initial xsi:type="xsd:boolean">true</Initial>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this deposit	Always
DateTime	Timestamp	Date/time the deposit was made	Always
SmartcardId	Long	Id of the Smartcard the deposit was made to	Always
UserId	Long	Id of the waiter who made the deposit	Always
PaymentId	Long	Id of the payment mode used for the deposit	Always
Number	String	Deposit number	Always
PCName	String	PC Name	Always
Amount	Decimal	Deposit amount	Always
Initial	Boolean	True if this deposit is the initial smartcard value	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`bookkeeping_account`	Bookeeping account number (if bookkeeping assigned)
`bookkeeping_account_name`	Bookeeping account name (if bookkeeping assigned)

SmartCardGroupInfo

SmartCardGroupInfo Object

<item xsi:type="NS3:TSmartCardGroupInfo">
    <Id xsi:type="xsd:long">5000015631</Id>
    <Name xsi:type="xsd:string">Test Group</Name>
    <Description xsi:type="xsd:string">Group for testing Smart Cards</Description>
    <Kind xsi:type="xsd:int">0</Kind>
    <PriceId xsi:type="xsd:long">0</PriceId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Smartcard Group	Always
Name	String	Name of this Smartcard Group	Always
Description	String	Description	Optional
Kind	Int	0: unTill 1: Tap2Order 2: TTG 3: Card Table	Always
PriceId	Long	Id of the price level set for this group	Always
Extra	[ExtraInfo]	List of extra fields	Optional

SmartCardInfo

SmartCardInfo Object

<item xsi:type="NS3:TSmartCardInfo">
    <Id xsi:type="xsd:long">5000015633</Id>
    <SmartcardGroupId xsi:type="xsd:long">5000015631</SmartcardGroupId>
    <Uid xsi:type="xsd:string">9AF37FB3</Uid>
    <ClientId xsi:type="xsd:long">0</ClientId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Smartcard	Always
Uid	String	UID of this Smartcard	Always
SmartcardGroupId	Long	Id of the Smartcard group	Always
ClientId	Long	Id of the Client linked to this card	Always
Extra	[ExtraInfo]	List of extra fields	Optional

SupplierInfo

SupplierInfo Object

<item xsi:type="NS3:TSupplierInfo">
    <Id xsi:type="xsd:long">5000000074</Id>
    <Name xsi:type="xsd:string">unTill Software Development Group B.V.</Name>
    <Number xsi:type="xsd:int">1</Number>
    <Address xsi:type="xsd:string">Choorhoekseweg 8 4424NW Wemeldinge</Address>
    <AccountNumber xsi:type="xsd:string"/>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Supplier Id	Always
Name	String	Supplier name	Always
Number	Integer	Supplier number	Always
Address	String	Supplier address	Optional
AccountNumber	String	Supplier account number	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

TableItem

TableItem Object

<item xsi:type="NS3:TTableItem">
    <Id xsi:type="xsd:long">0</Id>
    <ArticleId xsi:type="xsd:long">5000002234</ArticleId>
    <ItemNumber xsi:type="xsd:int">0</ItemNumber>
    <Kind xsi:type="xsd:int">1</Kind>
    <Quantity xsi:type="xsd:int">1</Quantity>
    <SinglePrice xsi:type="xsd:double">2</SinglePrice>
    <Price xsi:type="xsd:double">2</Price>
    <Discount xsi:type="xsd:double">0</Discount>
    <Vat xsi:type="xsd:double">0.3471</Vat>
    <VatPercent xsi:type="xsd:double">21</VatPercent>
    <Text xsi:type="xsd:string">Coca Cola</Text>
    <HqId xsi:type="xsd:string">Coca Cola</HqId>
    <Signature xsi:type="xsd:string">cc1b3d3e65d8273b5e0dcf7f12d71442</Signature>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Order item Id	Always
ArticleId	Long	Article Id	Always
ItemNumber	Integer	Number in order	Always
Kind	Integer	1: Article 2: Option 3: Article message	Always
Quantity	Integer	Quantity of ordered articles	Always
SinglePrice	Decimal	Single Price	Always
Price	Decimal	Total price	Always
Discount	Decimal	Discount amount	Always
Vat	Decimal	VAT value	Always
VatPercent	Decimal	VAT percent	Always
Text	String	Article name or article message when Kind = `3`	Always
HqId	String	HqId	Optional
Signature	String	Signature identifying a table item. Only for top-level items (Kind = `1`)	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

TableRange

TableRange Object

<item xsi:type="NS3:TTableRange">
    <FromTable xsi:type="xsd:int">1</FromTable>
    <ToTable xsi:type="xsd:int">12</ToTable>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
FromTable	Integer	Internal Table range start	Always
ToTable	Integer	Table range end	Always
Extra	[ExtraInfo]	List of extra fields	Optional

TimeAttendanceRecord

TimeAttendanceRecord Object

<item xsi:type="NS3:TTimeAttendanceRecord">
    <UserId xsi:type="xsd:long">15000001214</UserId>
    <Start xsi:type="xsd:dateTime">2018-07-26T16:05:13.621+02:00</Start>
    <Stop xsi:type="xsd:dateTime">2018-07-26T23:15:21.000+02:00</Stop>
    <TotalTime xsi:type="xsd:string">07:10</TotalTime>
    <TotalDecimal xsi:type="xsd:double">7.1667</TotalDecimal>
    <TotalCosts xsi:type="xsd:double">0</TotalCosts>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
UserId	Long	Id of the User	Always
Start	Timestamp	Record start	Always
Stop	Timestamp	Record end ("1899-12-30" means that the User has not clocked out yet)	Always
TotalTime	String	Record duration - Format " HH:MM"	Always
TotalDecimal	Decimal	Record duration, in decimal	Always
TotalCosts	Decimal	Total costs	Always
Extra	[ExtraInfo]	List of extra fields	Optional

TransactionBill

TransactionBill Object

<item xsi:type="NS3:TTransactionBill">
    <Id xsi:type="xsd:long">25000158240</Id>
    <DateTime xsi:type="xsd:dateTime">2018-12-12T11:41:54.000+01:00</DateTime>
    <RealDateTime xsi:type="xsd:dateTime">2018-12-12T11:41:54.000+01:00</RealDateTime>
    <ComputerName xsi:type="xsd:string">TESTPC</ComputerName>
    <BillNumber xsi:type="xsd:string">1106</BillNumber>
    <UserId xsi:type="xsd:long">5000001377</UserId>
    <ClientName xsi:type="xsd:string"/>
    <SalesAreaId xsi:type="xsd:long">5000000208</SalesAreaId>
    <Tip xsi:type="xsd:double">0</Tip>
    <Payments xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTransactionBillPayment[x]">...</Payments>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
    <ClientId xsi:type="xsd:long">0</ClientId>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Bill Id	Always
DateTime	Timestamp	Bill date/tme (first date/time of payment)	Always
RealDateTime	Timestamp	Real date/time of payment	Always
ComputerName	String	Computer name	Always
BillNumber	String	Bill number	Always
UserId	Long	Waiter Id	Always
ClientName	String	Name of client assigned to this bill	Optional
ClientId	Long	Id of client assigned to this bill	Always
SalesAreaId	Long	Id of Sales Area	Always
Tip	Double	Tip amount¹	Always
Payments	[TransactionBillPayment]	List of payments used in this bill	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`external_id`	External Id of the bill which may be assigned in the Pay request
`eft_tips`	EFT tips amount, when added

¹ Tip amount only includes normal tips (added on payment screen)

TransactionBillPayment

TransactionBillPayment Object

<item xsi:type="NS3:TTransactionBillPayment">
    <Id xsi:type="xsd:long">25000158242</Id>
    <PaymentId xsi:type="xsd:long">5000000055</PaymentId>
    <Amount xsi:type="xsd:double">2</Amount>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[2]">
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">bookkeeping_account</Key>
            <Value xsi:type="xsd:string">12002</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
        <item xsi:type="NS3:TExtraInfo">
            <Key xsi:type="xsd:string">bookkeeping_account_name</Key>
            <Value xsi:type="xsd:string">Maestro</Value>
            <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
        </item>
    </Extra>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Bill payment Id	Always
PaymentId	Long	Id of Payment mode	Always
Amount	Decimal	Payment amount	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`voucher_id`	Id of Voucher used for payment
`bookkeeping_account`	Bookeeping account number (if bookkeeping assigned)
`bookkeeping_account_name`	Bookeeping account name (if bookkeeping assigned)

TransactionBillReprint

TransactionBillReprint Object

<item xsi:type="NS3:TTransactionBillReprint">
    <Id xsi:type="xsd:long">25000158293</Id>
    <DateTime xsi:type="xsd:dateTime">2018-12-13T11:29:34.000+01:00</DateTime>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Bill reprint Id	Always
DateTime	Timestamp	Date/time of reprint	Always
Extra	[ExtraInfo]	List of extra fields	Optional

TransactionOrder

TransactionOrder Object

<item xsi:type="NS3:TTransactionOrder">
    <Id xsi:type="xsd:long">25000158203</Id>
    <DateTime xsi:type="xsd:dateTime">2018-12-12T11:41:43.000+01:00</DateTime>
    <ComputerName xsi:type="xsd:string">TESTPC</ComputerName>
    <OrderNumber xsi:type="xsd:string">1215</OrderNumber>
    <UserId xsi:type="xsd:long">5000001377</UserId>
    <SalesAreaId xsi:type="xsd:long">5000000208</SalesAreaId>
    <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTransactionOrderItem[x]">...</Items>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Order Id	Always
DateTime	Timestamp	Date/time of order	Always
ComputerName	String	Computer name	Always
OrderNumber	String	Order number	Always
UserId	Long	Waiter Id	Always
SalesAreaId	Long	Id of Sales Area	Always
Items	[TransactionOrderItem]	List of order items	Always
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`GuestNotifierCode`	Returned when Guest Notifier is assigned to the order

TransactionOrderItem

TransactionOrderItem Object

<item xsi:type="NS3:TTransactionOrderItem">
   <Id xsi:type="xsd:long">25000158207</Id>
   <ArticleId xsi:type="xsd:long">5000001722</ArticleId>
   <ItemNumber xsi:type="xsd:int">1</ItemNumber>
   <Kind xsi:type="xsd:int">1</Kind>
   <Quantity xsi:type="xsd:int">1</Quantity>
   <SinglePrice xsi:type="xsd:double">2</SinglePrice>
   <Price xsi:type="xsd:double">2</Price>
   <Discount xsi:type="xsd:double">0</Discount>
   <Vat xsi:type="xsd:double">0.3471</Vat>
   <VatPercent xsi:type="xsd:double">21</VatPercent>
   <Text xsi:type="xsd:string"/>
   <HqId xsi:type="xsd:string">Coca Cola</HqId>
   <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Order item Id	Always
ArticleId	Long	Article Id	Always
ItemNumber	Integer	Number in order	Always
Kind	Integer	1. Article 2. Option 3. Message text	Always
Quantity	Integer	Quantity of ordered articles	Always
SinglePrice	Decimal	Single price	Always
Price	Decimal	Total price	Always
Discount	Decimal	Discount amount	Always
Vat	Decimal	VAT amount	Always
VatPercent	Decimal	Vat percent	Always
Text	String	Text (in case when Id = 0)	Optional
HqId	String	HQ Id	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Description
`extra_taxes`	When requested in GetDetailedTurnoverRequest
`void`	When item is a result of a 'Void' operation (only when OnlyPaid = 0 in GetDetailedTurnoverRequest)
`discount_reason`	Name of the Discount Reason (only when DiscountReason = 1 in GetDetailedTurnoverRequest)
`discount_reason_id`	Id of the Discount Reason, when applied
`void_reason_id`	Id of the Void Reason, when applied
`returned`	When item is a result of a 'Return' operation
`transferred_from_bill_id`	For items which are transferred from other transactions
`size_modifier_item_id`	Id of Size Modifier (when applied)
`price_id`	Id of the Price Level

TransactionProforma

TransactionProforma Object

<item xsi:type="NS3:TTransactionProforma">
    <Id xsi:type="xsd:long">25000158236</Id>
    <DateTime xsi:type="xsd:dateTime">2018-12-12T11:41:49.000+01:00</DateTime>
    <UserId xsi:type="xsd:long">5000001377</UserId>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Internal Proforma Id	Always
DateTime	Timestamp	Date/time when Proforma was printed	Always
UserId	Long	Id of waiter who printed the Proforma	Always
Extra	[ExtraInfo]	List of extra fields	Optional

TurnoverBill

TurnoverBill Object

<item xsi:type="NS3:TTurnoverBill">
    <OpenDateTime xsi:type="xsd:dateTime">2018-09-21T08:21:02.000+02:00</OpenDateTime>
    <CloseDateTime xsi:type="xsd:dateTime">2018-09-21T08:21:02.000+02:00</CloseDateTime>
    <ComputerName xsi:type="xsd:string">TESTPC</ComputerName>
    <BillNumber xsi:type="xsd:int">38795</BillNumber>
    <BillSuffix xsi:type="xsd:string"/>
    <TableNumber xsi:type="xsd:int">103</TableNumber>
    <TablePart xsi:type="xsd:string">a</TablePart>
    <Covers xsi:type="xsd:int">5</Covers>
    <UserId xsi:type="xsd:long">65000358137</UserId>
    <SalesAreaId xsi:type="xsd:long">5000000146</SalesAreaId>
    <Items xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTurnoverBillItem[x]">...</Items>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
OpenDateTime	Timestamp	Transaction open date/time	Always
CloseDateTime	Timestamp	Transaction close date/time	Always
ComputerName	String	Computer name	Always
BillNumber	Integer	Transaction number	Always
BillSuffix	String	Transaction suffix	Optional
TableNumber	Integer	Table number	Always
TablePart	String	Table part	Always
Covers	Integer	Number of covers	Always
UserId	Long	Id of the User	Always
SalesAreaId	Long	Id of the Sales Area	Always
Items	[TurnoverBillItem]	List of ordered items	Always
Extra	[ExtraInfo]	List of extra fields	Optional

TurnoverBillItem

TurnoverBillItem Object

<item xsi:type="NS3:TTurnoverBillItem">
    <ArticleId xsi:type="xsd:long">15000028541</ArticleId>
    <DateTime xsi:type="xsd:dateTime">2018-09-21T08:21:02.000+02:00</DateTime>
    <ItemNumber xsi:type="xsd:int">0</ItemNumber>
    <ComputerName xsi:type="xsd:string">TESTPC</ComputerName>
    <Quantity xsi:type="xsd:int">3</Quantity>
    <Price xsi:type="xsd:double">15</Price>
    <UserId xsi:type="xsd:long">65000358137</UserId>
    <HqId xsi:type="xsd:string"/>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
ArticleId	Long	Article Id	Always
DateTime	Timestamp	Date/time of ordering	Always
ItemNumber	Integer	Number of item in order	Always
ComputerName	String	Computer name	Always
Quantity	Integer	Quantity of ordered items	Always
Price	Decmial	Price	Always
UserId	Long	Waiter Id	Always
HqId	String	HQ Id	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

Key	Description
`size_modifier_item_id`	Id of Size Modifier (when applied)

TurnoverTransaction

TurnoverTransaction Object

<Transaction xsi:type="NS3:TTurnoverTransaction">
   <Id xsi:type="xsd:long">25000158204</Id>
   <OpenDateTime xsi:type="xsd:dateTime">2018-12-12T11:41:43.000+01:00</OpenDateTime>
   <CloseDateTime xsi:type="xsd:dateTime">1899-12-30T00:00:00.000+01:00</CloseDateTime>
   <TranNumber xsi:type="xsd:string">931</TranNumber>
   <TableNumber xsi:type="xsd:int">27</TableNumber>
   <TablePart xsi:type="xsd:string">a</TablePart>
   <Covers xsi:type="xsd:int">0</Covers>
   <UserId xsi:type="xsd:long">5000001377</UserId>
   <DiscountOnTotal xsi:type="xsd:double">0</DiscountOnTotal>
   <ServiceCharge xsi:type="xsd:double">0</ServiceCharge>
   <ClientName xsi:type="xsd:string"/>
   <Orders xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTransactionOrder[x]">...</Orders>
   <Bills xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTransactionBill[x]">...</Bills>
   <Proformas xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTransactionProforma[x]">...</Proformas>
   <BillReprints xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TTransactionBillReprint[x]">...</BillReprints>
   <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[1]">
      <item xsi:type="NS3:TExtraInfo">
         <Key xsi:type="xsd:string">service_tax</Key>
         <Value xsi:type="xsd:string">0</Value>
         <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
      </item>
   </Extra>
   <ClientId xsi:type="xsd:long">0</ClientId>
</Transaction>

Parameter	Type	Description	Value?
Id	Long	Internal Id of this Transaction	Always
OpenDateTime	Timestamp	Transaction open date/time	Always
CloseDateTime	Timestamp	Transaction close date/time (1899-12-30 is returned when the transaction is not closed yet)	Always
TranNumber	String	Transaction number	Always
TableNumber	Integer	Table number	Always
TablePart	String	Table part	Always
Covers	Integer	Number of covers	Always
UserId	Long	Waiter Id	Always
DiscountOnTotal	Decimal	Discount amount on transaction total	Always
ServiceCharge	Decimal	Service charge, in percents	Always
ClientName	String	Name of Client	Optional
ClientId	Long	Id of Client	Always
Orders	[TransactionOrder]	List of orders for this transaction	Optional
Bills	[TransactionBill]	List of bills for this transaction	Optional
Proformas	[TransactionProforma]	List of proformas for this transaction	Optional
BillReprints	[TransactionBillReprint]	List of bill re-prints	Optional
Extra	[ExtraInfo]	List of extra fields	Optional

List of available extra fields:

Key	Value	Description
`service_tax`	String	Percent value of Service Tax applied to the transaction
`service_charge_amount`	String	Service charge amount, only returned when service charge is applied
`course_id`	Long	Course Id
`extra_taxes`	Extra taxes	Optionally
`dscount_reason`	Discount reason	Optionally
`modified`	Timestamp	Optionally (YYYYMMDD-HHMMSS)
`order_type`	String	Contains the “OrderType” name when specified for the current Transaction
`is_dirty`	Integer	Returns 1 when table is still dirty after payment

UserGroup

UserGroup Object

<Group xsi:type="NS3:TUserGroup">
    <GroupId xsi:type="xsd:long">5000000575</GroupId>
    <GroupName xsi:type="xsd:string">Manager</GroupName>
</Group>

Parameter	Type	Description	Value?
GroupId	Long	Group Id	Always
GroupName	String	Group name	Always

UserInfo

UserInfo Object

<item xsi:type="NS3:TUserInfo">
    <UserId xsi:type="xsd:long">50000309682</UserId>
    <UserName xsi:type="xsd:string">unTill</UserName>
    <FirstName xsi:type="xsd:string">John</FirstName>
    <LastName xsi:type="xsd:string">Doe</LastName>
    <Group xsi:type="NS3:TUserGroup">...</Group>
    <Credentials xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TCredential[x]">...</Credentials>
    <Language xsi:type="NS3:TLanguage">
        <LangCode xsi:type="xsd:string">0000</LangCode>
        <Language xsi:type="xsd:string">English (Default)</Language>
    </Language>
    <Void xsi:type="xsd:boolean">true</Void>
    <ClockIn xsi:type="xsd:boolean">false</ClockIn>
    <TagReaderCode xsi:type="xsd:string"/>
    <OperatorId xsi:type="xsd:string">123</OperatorId>
    <Address xsi:type="xsd:string">Choorhoeksweg 8</Address>
    <Country xsi:type="xsd:string">Netherlands</Country>
    <Phone xsi:type="xsd:string">+31123456789</Phone>
    <Birthdate xsi:type="xsd:dateTime">1986-08-15T00:00:00.000+02:00</Birthdate>
    <Insurance xsi:type="xsd:string">00000000097</Insurance>
    <HourlyWage xsi:type="xsd:double">15</HourlyWage>
    <HourlyWages xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:THourlyWageItem[x]">...</HourlyWages>
    <Void_number xsi:type="xsd:int">0</Void_number>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Read	Write
UserId	Long	Internal Id of this User	Always	Required when updating
UserName	String	Name of this User	Always	Optional
FirstName	String	First name of this User	Optional	Optional
LastName	String	Last name of this User	Optional	Optional
Group	UserGroup	Group this user belongs to	Optional	Optional¹
Credentials	[Credential]	List of assigned credentials	Always	N/A²
Language	Language	User language	Always	Optional³
Void	Boolean	True if this User is allowed to void ordered Articles	Always	Optional
ClockIn	Boolean	True if this User has time registration enabled	Always	Optional
TagReaderCode	String	Tag Reader Code, Base64 encoded	Optional	Optional
OperatorId	String	Value passed to EFT-devices	Optional	Optional
Address	String	Address of this User	Optional	Optional
Country	String	Country of this User	Optional	Optional
Phone	String	Phone number of this User	Optional	Optional
Birthdate	Timestamp	Birtdate of this User	Always	Optional
Insurance	String	Insurance number of this User	Optional	Optional
HourlyWage	Decimal	Deprecated since v1.4 (unTill build 92)	Always (0 by default)	N/A
HourlyWages	[HourlyWageItem]	List of hourly wages for this User (since v1.4 (unTill build 92))	Optional	N/A
Void_number	Integer	Number of voids allowed per day (0 = unlimited)	Always	Optional
Extra	[ExtraInfo]	List of extra fields	Optional	Optional

List of available extra fields:

Key	Value	Description	Read	Write
`is_active`	1/0	Activity flag	Always	Optional, default = 1.
`pos_password`	String	Pos password	Always	Optional
`transfer`	1/0	Activity flag	Always	Optional, default = 0.
`common_drawer`	Integer	0 - First, 1 - Second, 2 - None	Always	Optional

Notes regarding using UserInfo with UpdateUsers:

UserId is a mandatory field
UserName is a mandatory field for new users
All other fields may be omitted in the SOAP request: For a new user a default value will be used. For updated users the omitted field will not cause any change in the database

¹ Only the GroupId value is used in the UpdateUsers function
² For the new users, the “Waiter+” credential is assigned
³ Only the LangCode is used in the UpdateUsers function

VoucherInfo

VoucherInfo Object

<item xsi:type="NS3:TVoucherInfo">
    <Id xsi:type="xsd:long">5000002072</Id>
    <Barcode xsi:type="xsd:string">BKN3QA5GI</Barcode>
    <Status xsi:type="xsd:int">1</Status>
    <OriginalValue xsi:type="xsd:double">100</OriginalValue>
    <RemainingValue xsi:type="xsd:double">100</RemainingValue>
    <CreationDate xsi:type="xsd:dateTime">2017-01-02T15:09:50.000+01:00</CreationDate>
    <ExpirationDate xsi:type="xsd:dateTime">2018-01-02T15:09:50.000+01:00</ExpirationDate>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Voucher Id	Always
Barcode	String	Voucher Barcode	Always
Status	Integer	0: Blocked 1: Active 2: Not Paid	Always
OriginalValue	Decimal	Voucher original value	Always
RemainingValue	Decimal	Voucher remaning value	Always
CreationDate	Timestamp	Voucher creation date	Always
ExpirationDate	Timestamp	Voucher expiration date	Always
Extra	[ExtraInfo]	List of extra fields	Optional

VoucherPaymentItem

VoucherPaymentItem Object

<item xsi:type="NS3:TVoucherPaymentItem">
    <Id xsi:type="xsd:long">70001630739</Id>
    <DateTime xsi:type="xsd:dateTime">2020-04-14T10:33:48.000+02:00</DateTime>
    <ComputerName xsi:type="xsd:string">DEMO</ComputerName>
    <UserId xsi:type="xsd:long">50000309682</UserId>
    <Barcode xsi:type="xsd:string">XQZX4V4CNT53V</Barcode>
    <PaymentId xsi:type="xsd:long">5000000031</PaymentId>
    <Amount xsi:type="xsd:double">25</Amount>
    <Extra xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="NS3:TExtraInfo[0]"/>
</item>

Parameter	Type	Description	Value?
Id	Long	Voucher Id	Always
DateTime	Timestamp	Payment date	Always
ComputerName	String	Computer Name	Always
UserId	Long	User Id	Always
Barcode	String	Voucher Barcode	Always
PaymentId	Long	Payment Mode Id	Always
Amount	Decimal	Payment amount	Always
Extra	[ExtraInfo]	List of extra fields	Optional

Return Codes

Each function returns a ResultCode and a ResultMessage. When the function completes without any errors, the ResultCode will be 0 and the ResultMessage will be ok. For the complete list of result codes, please see the table below:

Result Code	Result Message	Description
0	ok	The operation completed without any errors
1	Exception class, message, stacktrace	Internal server error
2	Authentication error	Authentication error
3	Details	Illegal request argument (fe. incorrect SalesAreaId)
4	Details	Database not available
5	Details	TPAPI disabled
6	TPAPI not allowed by unTill license	The TPAPI module is not enabled in the license
7	Reason	Your request cannot be processed
8	Invalid Token	This AppToken can not be used for working with the TPAPI
9	Insufficient user permissions for this operation	Insufficient user permission. Check user permissions in backoffice

Constants

Order item types

Type	Description
0	Normal article (either regular or menu)
1	Must have option
2	Free option
3	Supplement
4	Condiment
5	Menu item
6	Article message

Payment kinds

Type	Description
0	Cash
1	Card
2	On Account / On Invoice
3	Room (Hotel)
4	Cheque
5	Hash
6	Service Charge
7	Discount
8	Smart Card
9	Cashdro
10	Newyse
11	Gift Card
12	Prepaid Beverage Control
13	Voucher
14	Zapper

EftFields

masked_pan
expire
auth_number
controlno
cardname
acquier_code
terminalid
aid
tvr
tsi
account_type
merchant_id
chargetype
field1
field2
field3
field4
field5
field5
field6
field7
field8
field9
field10
field11
field12
field13
field14
field15

Version History

Version	yyyy/mm/dd	unTill version	Changes
2.0	2015/04/01	108	Initial version
2.1	2015/04/03	108.3	New Extra `get_receipt` added to ClientDeposit
2.2	2015/04/06	109	New function GetDepositsReport added
2.3	2015/04/23	109	New Extra `DiscountReason` added to GetDetailedTurnoverReportRequest
2.4	2015/05/05	109	New Extra `ModificationDates` added to GetDetailedTurnoverReportRequest
2.5	2015/05/20	109	New Extra `result_ids` added to UpdateClientsResponse
2.6	2015/06/03	110	TPAPI performance improvements
2.7	2015/06/24	110	New function GetInOutCashReport added
2.8	2015/07/22	110.12	Added the possibility to create Orders In Future using CreateOrder
2.9	2015/09/02	110.12	New Extra `void` added to TransactionOrderItem
2.10	2015/09/17	111.1	New Extra `IncludeReopen”` added to GetDetailedTurnoverReportRequest
2.11	2015/09/18	111.1	New function PrintProforma added
2.12	2015/10/20	111.1	New functions GetCountries and UpdateCountries added New Extra `country_id` added to Client
2.14	2015/12/24	113.1	New Extra `tip` added to PayRequest
2.15	2016/01/21	113.1	New function GetDiscountGroupsInfo New Extra `untill_version` added to GetVersionResponse
2.16	2016/04/25	115.1	New Extra `proforma_signature` added in PayRequest
2.17	2016/05/13	115.1	New Extra `last` added to OrderItem
2.18	2016/06/20	115.1	New Extra `smartcard_uid` added to Client and GetClientsExRequest (filter) New Extra `plu` added to ArticleInfo and GetArticlesInfoRequest (filter) New function AddPouring New Extra `EftExtras` and `TranExtras` added to GetDetailedTurnoverReportRequest
2.19	2016/11/21	116.1	New function GetCourses added New Extra `OifDepositAmount` and `OifDepositPaymentModeId` added to CreateOrderRequest
2.20	2017/05/11	120.1	New Extra `purchase_price` added to ArticleInfo New Extra `service_charge_amount` added to TurnoverTransaction
2.21	2017/07/05	122.1	New Extra `BillNumber`, `BillSuffix` `TranNumber` and `TranSuffix` added to GetDetailedTurnoverReportRequest
2.22	2017/10/20	125.1	New Extra `LookupByFirstBill` added to GetDetailedTurnoverReportRequest
2.23	2018/04/24	127.0	New function UpdateSalesAreaPrice added
2.24	2019/02/15	129.0	New function GetSuppliersInfo added New Extra `supplier_id` added to InOutCashItem New function GetVouchersInfo added New Extra `voucher_id` added to TransactionBillPayment New Extra `order_type` added to TurnoverTransaction Fixes issue that the `OrderDescr` and `OrderName` used in the CreateOrder function are not appended anymore but replaced in POS when there already is an existing one New function GetDiscountReasons added New function GetVoidReasons added New Extras `returned`, `discount_reason_id`, `void_reason_id` and `transferred_from_bill_id` added to TransactionOrderItem
2.25	2019/04/17	129.9	New Extra `bookkeeping_account` and `bookkeeping_account_name` added to TransactionBillPayment New Extra `course_id` added to OrderItem
2.26	2019/05/30	130.0	New function GetSmartcardGroupsInfo added New function GetSmartcardsInfo added New function GetSmartcardDepositsReport added EftExtras added in GetDepositsReportRequest
2.27	2019/08/20	130.7	The Extra `transaction_id` in FindTransactions now supports a comma-separated list New Extra `is_dirty` added to TurnoverTransaction
2.28	2019/09/17	132.0	New function GetPrintersInfo added New function GetSizeModifiersInfo added New Extra `size_modifier_item_id` added to OrderItem, CancelledItem, TransactionOrderItem, TurnoverBillItem New Extra `size_modifier_id` added to ArticleInfo New Extra `size_modifiers` added to ItemPrice New Extra `printer_id` and `eft_params` added to PayRequest New Extra `composed_options` added to ArticleInfo
2.29	2020/05/20	134.0	AppToken and AppName added in every request User Permissions added New Extra `dont_show_in_reports` added to ClientDeposit New function GetTableItemsInfo added New function ApplyDiscountToItems added New function ApplyDiscountToTable added New function GetVoucherPaymentsReport added New Extras `bookkeeping_code` and `bookkeeping_name` added to Reason (discount reason only) New Extras `bookkeeping_account` and `bookkeeping_account_name` added to SmartcardDepositReportItem and DepositItem New Extra `GuestNotifierCode` added to CreateOrder and TransactionOrder New function GetActiveTalbeInfoEx added Multiple Smartcard UIDs supported per Client
2.30	2020/11/01	135.0	New function AddClientSavepoints added New Extra `id` added to GetArticlesInfoRequest New Extra `guid` retured in types Reason and PaymentInfo New Extra `expiry_date` added to Client New Extra `handle_by_drivers` added in PrintProformaRequest New Extra `disabled_in_sales_areas` returned in ArticleInfo New functions GetClientCardNamesInfo, GetClientCardsInfo and UpdateClientCards added
2.31	2020/12/10	135.5	New function ReadHotelGuestInfo added New Extra `guest-reservation-id` added to PayRequest New Extra `printer_id` added to PrintProformaRequest
2.31	2021/05/01	136.0	Added the possibility to create Take Away orders New Extra `price_id` added to TransactionOrderItem
2.32	2021/05/28	136.5	New Extra `TableSmartcardId`, `TableSmartcardUid` added to CreateOrderRequest
2.32	2021/07/15	137.0	New function UpdateUsers added
2.33	2021/10/15	137.15	New Extra `transfer`, `common_drawer` added to UserInfo
2.34	2021/11/01	138.0	New function GetCardDepositsReport added New function GetAllergensInfo added New function GetPeriodsInfo added New Extra `exceptions` added to SalesAreaInfo New Extra `exceptions` added to ItemPrice New Extra `allergens` added to GetArticlesInfoRequest New Extra `allergens` added to ArticleInfo New Extra `allergens` added to OrderItem New Extra `eft_tips` added to TransactionBill