1. Access

  • HTTP Basic Authentication basicAuth

2. Endpoints

2.1. AuthenticationService

2.1.1. authenticationService.authenticate

POST /com.gk_software.pos.api.service.security.AuthenticationService/authenticate

Performs a login based on passed data in AuthenticationRequest.

Description

Performs a login based on passed data in AuthenticationRequest.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The AuthenticationRequest object. ComGkSoftwarePosApiServiceSecurityAuthenticationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSecurityAuthenticationResult

500

in case of any error.

2.1.2. authenticationService.updatePassword

POST /com.gk_software.pos.api.service.security.AuthenticationService/updatePassword

Update the operator password

Description

Update the operator password

Parameters
Body Parameter
Name Description Required Default Pattern

body

The UpdatePasswordRequest object. ComGkSoftwarePosApiServiceSecurityUpdatePasswordRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceSecurityUpdatePasswordResult

2.2. AuthorizationService

2.2.1. authorizationService.authorize

POST /com.gk_software.pos.api.service.security.AuthorizationService/authorize

Performs authorization of operator for defined right

Description

Performs authorization of operator for defined right

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link AuthorizationRequest} ComGkSoftwarePosApiServiceSecurityAuthorizationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSecurityAuthorizationResult

500

if authorization failed

2.2.2. authorizationService.clearResourceOverrideCache

POST /com.gk_software.pos.api.service.security.AuthorizationService/clearResourceOverrideCache

Clear resource override cache related to given operator.

Description

Clear resource override cache related to given operator.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the operator id [String]

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.3. BillDocWebService

2.3.1. billDocWebService.getInvoiceData

POST /com.gk_software.pos.api.service.communication.ws.billdoc.BillDocWebService/getInvoiceData

Method that allows retrieving of invoice data using the invoice number.

Description

Method that allows retrieving of invoice data using the invoice number.
WssbRfcBillDocRead

Parameters
Body Parameter
Name Description Required Default Pattern

body

The BillDocRequest object. ComGkSoftwarePosApiServiceCommunicationWsBilldocBillDocRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCommunicationWsBilldocBillDocResponse

500

in case of any error.

2.4. CouponingService

2.4.1. couponService.checkCoupons

POST /com.gk_software.pos.api.service.coupon.CouponingService/checkCoupons

Executes a verification of the given coupons.

Description

Executes a verification of the given coupons.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The checkCoupons request object ComGkSoftwarePosApiServiceCouponCheckCouponsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCouponCheckCouponsResponse

500

In case that the operation fails for any reason

2.4.2. couponService.returnCoupons

POST /com.gk_software.pos.api.service.coupon.CouponingService/returnCoupons

Executes a return/redeem of coupons.

Description

This method executes a return/redeem operation of the coupons in the current transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The returnCoupons request object ComGkSoftwarePosApiServiceCouponReturnCouponsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCouponReturnCouponsResponse

500

In case that the operation fails for any reason

2.5. CustomerByIdWebService

2.5.1. customerByIdWebService.searchCustomerById

POST /com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerByIdWebService/searchCustomerById

Search customer by customer id

Description

Search customer by customer id

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerWebserviceRequest including customer identifier and web service config ComGkSoftwarePosApiServiceCommunicationWsCustomerByIdCustomerWebserviceRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCommunicationWsCustomerByIdCustomerWebServiceResultSAPERP

500

  • WS_INTERNAL_ERROR

  • WS_CUSTOMER_NOT_FOUND_ERROR

2.6. CustomerOperationService

2.6.1. customerOperationService.createCustomer

POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/createCustomer

Create new customer in given data provider with specified details.

Description

Create new customer in given data provider with specified details.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the UpdateCustomerRequest ComGkSoftwarePosApiServiceCommunicationWsOperationUpdateCustomerRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

in case of any error

2.6.2. customerOperationService.findCustomerById

POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerById

Search customer by given ID.

Description

Search customer by given ID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FindCustomerByIdRequest ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerByIdRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerDO

500

In case an error occurs.

2.6.3. customerOperationService.findCustomerByPartyIdentification

POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerDataByPartyIdentification

Find customer list by given party identification.

Description

Find customer list by given party identification.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FindCustomerByPartyIdentificationRequest ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerByPartyIdentificationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerDO]

500

in case of any error

2.6.4. customerOperationService.findCustomerContactViewListByFilter

POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerContactViewListByFilter

Search customer by filter.

Description

Search customer by filter.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SearchCustomerRequest including the search criteria ComGkSoftwarePosApiServiceCommunicationWsCustomerSearchByCriteriaSearchCustomerRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerContactView]

500

in case of any error.

2.6.5. customerOperationService.findCustomerData

POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerDataById

Search customer by given ID.

Description

Search customer by given ID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FindCustomerDataRequest ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerDataRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosFlowLibsCustomerCustomerData

500

in case of any error

2.6.6. customerOperationService.updateCustomer

POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/updateCustomer

Update customer in given data provider with specified details.

Description

Update customer in given data provider with specified details.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The UpdateCustomerRequest ComGkSoftwarePosApiServiceCommunicationWsOperationUpdateCustomerRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

in case of any error.

2.6.7. findLastCustomerId

POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findLastCustomerId

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.6.8. mapCustomerDOToCustomerData

POST /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/mapCustomerDOToCustomerData

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosFlowLibsCustomerCustomerData

2.7. CustomerTransactionService

2.7.1. customerTransactionService.createAndAddOrUpdateRetailTransactionCustomer

POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/createAndAddOrUpdateRetailTransactionCustomer

Assign customer to current transaction by adding or updating existing customer.

Description

Assign customer to current transaction by adding or updating existing customer.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerAssignmentRequest, it customer data required for assignment ComGkSoftwarePosApiServiceTransactionCustomerCustomerAssignmentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.7.2. customerTransactionService.createAndAddRetailTransactionCustomer

POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/createAndAddRetailTransactionCustomer

Assign customer to current transaction

Description

Assign customer to current transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerAssignmentRequest, it consist of data required for assignment ComGkSoftwarePosApiServiceTransactionCustomerCustomerAssignmentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.7.3. customerTransactionService.registerCustomer

POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/registerCustomer

Registers a customer to current transaction.

Description

Registers a customer to current transaction.Following steps are done dependent on config/request values:

  • Search for customer if searchDatabase=true (Local DB)

  • Assign customer to transaction {@link #createAndAddOrUpdateRetailTransactionCustomer(CustomerAssignmentRequest)}

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerRegistrationRequest ComGkSoftwarePosApiServiceTransactionCustomerCustomerRegistrationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of error

2.7.4. customerTransactionService.removeCustomerFromTransaction

POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/removeCustomerFromTransaction

Remove customer from current transaction

Description

Remove customer from current transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerRemovalRequest ComGkSoftwarePosApiServiceTransactionCustomerCustomerRemovalRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.7.5. customerTransactionService.removeCustomerFromTransactionByTypeCode

POST /com.gk_software.pos.api.service.transaction.customer.CustomerTransactionService/removeCustomerFromTransactionByTypeCode

Remove customer from current transaction for given address type code.

Description

Remove customer from current transaction for given address type code.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The addressTypdeCode [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.8. DataPrivacyLogService

2.8.1. dataPrivacyLogService.storeCustomerDataChangedDataEvent

POST /com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataChangedDataEvent

Stores a data privacy event log by the given StoreCustomerDataChangedDataEventRequest when customer data is changed.

Description

Stores a data privacy event log by the given StoreCustomerDataChangedDataEventRequest when customer data is changed.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The StoreCustomerDataChangedDataEventRequest object ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataChangedDataEventRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.8.2. dataPrivacyLogService.storeCustomerDataCreatedDataEvent

POST /com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataCreatedDataEvent

Stores a data privacy event log by the given StoreCustomerDataCreatedDataEventRequest when customer data is created.

Description

Stores a data privacy event log by the given StoreCustomerDataCreatedDataEventRequest when customer data is created.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The StoreCustomerDataCreatedDataEventRequest object ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataCreatedDataEventRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.8.3. dataPrivacyLogService.storeCustomerDataReadDataEvent

POST /com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerDataReadDataEvent

Stores a data privacy event log by the given StoreCustomerDataReadDataEventRequest when customer data is read.

Description

Stores a data privacy event log by the given StoreCustomerDataReadDataEventRequest when customer data is read.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The StoreCustomerDataReadDataEventRequest object ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataReadDataEventRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.8.4. dataPrivacyLogService.storeCustomerSearchCriteriaEvent

POST /com.gk_software.pos.api.service.data_privacy_log.DataPrivacyLogService/storeCustomerSearchCriteriaEvent

Stores a data privacy event log by the given StoreCustomerSearchCriteriaEventRequest when customer data is se…​

Description

Stores a data privacy event log by the given StoreCustomerSearchCriteriaEventRequest when customer data is searchedby criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The StoreCustomerSearchCriteriaEventRequest ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerSearchCriteriaEventRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.9. Default

2.9.1. consolidateTransaction

POST /com.gk_software.pos.api.service.transaction.consolidation.ConsolidationService/consolidateTransaction

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiTxpoolDtoTransaction

2.9.2. customerCardCodeConverterService.convertCodeToCustomerCardCode

POST /com.gk_software.pos.api.service.customer.CustomerCardCodeConverterService/convertCodeToCustomerCardCode

Obtains CustomerCardCode from given strings.

Description

Obtains CustomerCardCode from given strings.

Parameters
Body Parameter
Name Description Required Default Pattern

body

List of strings with aztec codes [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosFlowLibsCustomerCustomerCardCode

500

In case that the operation fails for any reason

2.9.3. customerCardCodeConverterService.convertCustomerCardCodeToCode

POST /com.gk_software.pos.api.service.customer.CustomerCardCodeConverterService/convertCustomerCardCodeToCode

Obtains list of aztec codes parsed from given CustomerCardCode.

Description

Obtains list of aztec codes parsed from given CustomerCardCode.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerCardCode containing the information about customer card ComGkSoftwarePosFlowLibsCustomerCustomerCardCode

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[[String]]

500

In case that the operation fails for any reason

2.10. DigitalReceiptService

2.10.1. digitalReceiptService.processDigitalReceipt

POST /com.gk_software.pos.api.service.digital_receipt.DigitalReceiptService/processDigitalReceipt

This method sends, uploads or stores the digital combined PDF receipts.

Description

This method sends, uploads or stores the digital combined PDF receipts.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The processDigitalReceipt request object ComGkSoftwarePosApiServiceDigitalReceiptProcessDigitalReceiptRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceDigitalReceiptProcessDigitalReceiptResponse

500

In case that the operation fails for any reason

2.11. DynamicTableauService

2.11.1. dynamicTableauService.FindDynamicTableauItemListUpdateViewsByCriteria

POST /com.gk_software.pos.api.service.tableau.DynamicTableauDataService/FindDynamicTableauItemListUpdateViewsByCriteria

Find dynamic tableau item list update views by criteria.

Description

Find dynamic tableau item list update views by criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FindDynamicTableauItemListUpdateViewsRequest object ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListUpdateViewsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListUpdateViewsResponse

500

In case that the operation fails for any reason

2.11.2. dynamicTableauService.FindDynamicTableauItemListViewsByCriteria

POST /com.gk_software.pos.api.service.tableau.DynamicTableauDataService/FindDynamicTableauItemListViewsByCriteria

Find dynamic tableau item list views by criteria.

Description

Find dynamic tableau item list views by criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FindDynamicTableauItemListViewsRequest object ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListViewsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListViewsResponse

500

In case that the operation fails for any reason

2.12. EventLogService

2.12.1. eventLogService.searchEventLog

POST /com.gk_software.pos.api.service.event_log.EventLogService/searchEventLog

Searches for event log messages meeting the given search criteria.

Description

Searches for event log messages meeting the given search criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The EventLogSearchParameters. ComGkSoftwareGkrApiEventchannelDtoEventLogSearchParameters

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiEventchannelDtoEventLogSearchResult

2.12.2. eventLogService.storeEventLog

POST /com.gk_software.pos.api.service.event_log.EventLogService/storeEventLog

Stores the given event log messages.

Description

Stores the given event log messages.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The EventLogStoreRequest containing the event log messages to be stored. ComGkSoftwareGkrApiEventchannelDtoEventLogStoreRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.13. EwicItemCategoryService

2.13.1. ewicItemCategoryService.findWicCategoryByKey

POST /com.gk_software.pos.api.service.ewic.EwicItemCategoryService/findWicCategoryByKey

Find eWIC item category

Description

Find eWIC item category

Parameters
Body Parameter
Name Description Required Default Pattern

body

the benefits request ComGkSoftwarePosApiServiceEwicEwicItemSubcategoryBenefitsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiServerMdItemWicDtoDomWicCategoryDO

500

if an error occurs while attempting to read master data

2.13.2. ewicItemCategoryService.getBasketMatchingPrescription

POST /com.gk_software.pos.api.service.ewic.EwicItemCategoryService/getBasketMatchingPrescription

Gets the items which match the prescription

Description

Gets the items which match the prescription

Parameters
Body Parameter
Name Description Required Default Pattern

body

the basket request ComGkSoftwarePosApiServiceEwicEwicBasketRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceEwicEwicMatchingPrescriptionResult

500

if an error occurs while attempting to get the basket

2.13.3. ewicItemCategoryService.resetNTEItemPrice

POST /com.gk_software.pos.api.service.ewic.EwicItemCategoryService/resetNTEItemPrice

Reset the Item Price with NTE Price

Description

Reset the Item Price with NTE Price

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error

2.14. ExternalCartService

2.14.1. externalCartService.addItemToExternalCartForCustomer

POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/addItemToExternalCartForCustomer

Adds an item to a customer cart

Description

Adds an item to a customer cart

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartLineItemRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionExternalLineItemData

2.14.2. externalCartService.addItemToExternalCartForCustomer_1

POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/addItemToExternalCartForCustomer

Adds an item to a customer cart

Description

Adds an item to a customer cart

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartLineItemRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionExternalLineItemData

2.14.3. externalCartService.createExternalCartForAnonymous

POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/createExternalCartForAnonymous

Creates a session cart for anonymous

Description

Creates a session cart for anonymous

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.14.4. externalCartService.createExternalCartForAnonymous_2

POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/createExternalCartForAnonymous

Creates a session cart for anonymous

Description

Creates a session cart for anonymous

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.14.5. externalCartService.createExternalCartForCustomer

POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/createExternalCartForCustomer

Creates a new cart for a customer

Description

Creates a new cart for a customer

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.14.6. externalCartService.createExternalCartForCustomer_3

POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/createExternalCartForCustomer

Creates a new cart for a customer

Description

Creates a new cart for a customer

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.14.7. externalCartService.getExternalCart

POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/getExternalCart

Get cart by customerID and cartID

Description

Get cart by customerID and cartID

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.14.8. externalCartService.getExternalCart_4

POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/getExternalCart

Get cart by customerID and cartID

Description

Get cart by customerID and cartID

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.14.9. externalCartService.getExternalCartsForCustomer

POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/getExternalCartsForCustomer

Get Cart list by customerID

Description

Get Cart list by customerID

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwarePosApiServiceExternalCartExternalCartData]

2.14.10. externalCartService.getExternalCartsForCustomer_5

POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/getExternalCartsForCustomer

Get Cart list by customerID

Description

Get Cart list by customerID

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwarePosApiServiceExternalCartExternalCartData]

2.14.11. externalCartService.mergeAnonymousCart

POST /com.gk_software.pos.api.service.external.cart.ExternalCartService/mergeAnonymousCart

Merges an anonymous cart to a customer cart

Description

Merges an anonymous cart to a customer cart

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.14.12. externalCartService.mergeAnonymousCart_6

POST /com.gk_software.pos.api.service.external.cart.ExternalCartServiceDelegate/mergeAnonymousCart

Merges an anonymous cart to a customer cart

Description

Merges an anonymous cart to a customer cart

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.15. ExternalCustomerService

2.15.1. externalCustomerService.addAddress

POST /com.gk_software.pos.api.service.external.customer.ExternalCustomerService/addAddress

Adds new address to existing external customer.

Description

Adds new address to existing external customer.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCustomerAddressRequest containing the new address ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerAddressRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdContactDtoDomContactAddress

2.15.2. externalCustomerService.addAddress_1

POST /com.gk_software.pos.api.service.external.customer.ExternalCustomerServiceDelegate/addAddress

Adds new address to existing external customer.

Description

Adds new address to existing external customer.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCustomerAddressRequest containing the new address ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerAddressRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdContactDtoDomContactAddress

2.15.3. externalCustomerService.findCustomer

POST /com.gk_software.pos.api.service.external.customer.ExternalCustomerService/findCustomer

Search for external customer for given criteria.

Description

Search for external customer for given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCustomerDetailsRequest containing lookup information ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerDetailsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerDO

2.15.4. externalCustomerService.findCustomer_2

POST /com.gk_software.pos.api.service.external.customer.ExternalCustomerServiceDelegate/findCustomer

Search for external customer for given criteria.

Description

Search for external customer for given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCustomerDetailsRequest containing lookup information ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerDetailsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerDO

2.16. ExternalItemQueryService

2.16.1. externalItemQueryService.getItemImageUrl

POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getItemImageUrl

Gets the external item image url.

Description

Gets the external item image url.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.16.2. externalItemQueryService.getItemImageUrl_1

POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryServiceDelegate/getItemImageUrl

Gets the external item image url.

Description

Gets the external item image url.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.16.3. externalItemQueryService.getItemInformation

POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getItemInformation

Gets the external item information pos item id.

Description

Gets the external item information pos item id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiModelDomAppItemInformationItemInformation

2.16.4. externalItemQueryService.getItemInformation_2

POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryServiceDelegate/getItemInformation

Gets the external item information pos item id.

Description

Gets the external item information pos item id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiModelDomAppItemInformationItemInformation

2.16.5. externalItemQueryService.getPosUOMItemDO

POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryService/getPosUOMItemDO

Get PosUOMItemDO from external item service by ExternalItemInformationRequest

Description

Get PosUOMItemDO from external item service by ExternalItemInformationRequest

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDO

2.16.6. externalItemQueryService.getPosUOMItemDO_3

POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryServiceDelegate/getPosUOMItemDO

Get PosUOMItemDO from external item service by ExternalItemInformationRequest

Description

Get PosUOMItemDO from external item service by ExternalItemInformationRequest

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalItemInformationRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDO

2.16.7. externalItemQueryService.searchItemInformationList

POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryService/searchItemInformationList

Find external item list by filter.

Description

Find external item list by filter.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalItemSearchRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemSearchRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwarePosApiModelDomAppItemInformationItemInformation]

2.16.8. externalItemQueryService.searchItemInformationList_4

POST /com.gk_software.pos.api.service.external.item.ExternalItemQueryServiceDelegate/searchItemInformationList

Find external item list by filter.

Description

Find external item list by filter.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalItemSearchRequest object ComGkSoftwarePosApiServiceExternalItemExternalItemSearchRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwarePosApiModelDomAppItemInformationItemInformation]

2.17. ExternalOrderService

2.17.1. externalOrderService.addDeliveryCostsToTransaction

POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/addDeliveryCostsToTransaction

Adds delivery costs line item to the POS Transaction

Description

Adds delivery costs line item to the POS Transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.17.2. externalOrderService.addDeliveryCostsToTransaction_1

POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/addDeliveryCostsToTransaction

Adds delivery costs line item to the POS Transaction

Description

Adds delivery costs line item to the POS Transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.17.3. externalOrderService.preCalculateOrderWithDeliveryCosts

POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/preCalculateOrderWithDeliveryCosts

Calculates the delivery costs for the current order in preparation

Description

Calculates the delivery costs for the current order in preparation

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.17.4. externalOrderService.preCalculateOrderWithDeliveryCosts_2

POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/preCalculateOrderWithDeliveryCosts

Calculates the delivery costs for the current order in preparation

Description

Calculates the delivery costs for the current order in preparation

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceExternalCartExternalCartData

2.17.5. externalOrderService.setDeliveryAddress

POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/setDeliveryAddress

Sets a delivery address to an order in preparation

Description

Sets a delivery address to an order in preparation

Parameters
Body Parameter
Name Description Required Default Pattern

body

The DeliveryAddressRequest object ComGkSoftwarePosApiServiceExternalOrderDeliveryAddressRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.17.6. externalOrderService.setDeliveryAddress_3

POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/setDeliveryAddress

Sets a delivery address to an order in preparation

Description

Sets a delivery address to an order in preparation

Parameters
Body Parameter
Name Description Required Default Pattern

body

The DeliveryAddressRequest object ComGkSoftwarePosApiServiceExternalOrderDeliveryAddressRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.17.7. externalOrderService.setDeliveryMode

POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/setDeliveryMode

Sets a delivery model to an order in preparation

Description

Sets a delivery model to an order in preparation

Parameters
Body Parameter
Name Description Required Default Pattern

body

The DeliveryModeRequest object ComGkSoftwarePosApiServiceExternalOrderDeliveryModeRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.17.8. externalOrderService.setDeliveryMode_4

POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/setDeliveryMode

Sets a delivery model to an order in preparation

Description

Sets a delivery model to an order in preparation

Parameters
Body Parameter
Name Description Required Default Pattern

body

The DeliveryModeRequest object ComGkSoftwarePosApiServiceExternalOrderDeliveryModeRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.17.9. externalOrderService.setPaymentDetails

POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/setPaymentDetails

Sets payment details (like billing address)

Description

Sets payment details (like billing address)

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentDetailsRequest object ComGkSoftwarePosApiServiceExternalOrderPaymentDetailsRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.17.10. externalOrderService.setPaymentDetails_5

POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/setPaymentDetails

Sets payment details (like billing address)

Description

Sets payment details (like billing address)

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentDetailsRequest object ComGkSoftwarePosApiServiceExternalOrderPaymentDetailsRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.17.11. externalOrderService.simulateOrder

POST /com.gk_software.pos.api.service.external_order.ExternalOrderService/simulateOrder

Checks if the prepared order is valid for invocation

Description

Checks if the prepared order is valid for invocation

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.17.12. externalOrderService.simulateOrder_6

POST /com.gk_software.pos.api.service.external_order.ExternalOrderServiceDelegate/simulateOrder

Checks if the prepared order is valid for invocation

Description

Checks if the prepared order is valid for invocation

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ExternalCartRequest object ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.18. FuelService

2.18.1. fuelService.createDispenserTotalsList

POST /com.gk_software.pos.api.service.fuel.FuelService/createDispenserTotalsList

Create EOD Total transaction.

Description

Create EOD Total transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The createDispenserTotalsList request ComGkSoftwarePosApiServiceFuelDispenserTotalRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

in case createDispenserTotalsList fails

2.18.2. fuelService.createFuelPriceChangeList

POST /com.gk_software.pos.api.service.fuel.FuelService/createFuelPriceChangeList

Create Fuel Price Change transaction.

Description

Create Fuel Price Change transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FuelPriceChangeRequest request ComGkSoftwarePosApiServiceFuelFuelPriceChangeRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

in case createFuelPriceChangeList fails

2.18.3. fuelService.findFuellingPointList

POST /com.gk_software.pos.api.service.fuel.FuelService/findFuellingPointList

Find FuellingPointDO list.

Description

Find FuellingPointDO list.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwareGkrApiServerMdPetrolDtoDomFuellingPointDO]

500

in case findFuellingPointList fails

2.18.4. fuelService.findGradeList

POST /com.gk_software.pos.api.service.fuel.FuelService/findGradeList

Find grade list.

Description

Find grade list.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwareGkrApiServerMdPetrolDtoDomGradeDO]

500

in case findGradeList fails

2.18.5. fuelService.findNozzleList

POST /com.gk_software.pos.api.service.fuel.FuelService/findNozzleList

Find nozzle list.

Description

Find nozzle list.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwareGkrApiServerMdPetrolDtoDomNozzleDO]

500

in case findNozzleList fails

2.18.6. fuelService.findPetrolItem

POST /com.gk_software.pos.api.service.fuel.FuelService/findPetrolItem

Get itemId from NozzleId and fuelingPointId.

Description

Get itemId from NozzleId and fuelingPointId.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

in case find petrol item fails

2.18.7. fuelService.findPetrolItem_1

POST /com.gk_software.pos.api.service.fuel.FuelService/findPetrolItemGrade

Get itemId from GradeId.

Description

Get itemId from GradeId.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

in case find petrol item fails

2.18.8. fuelService.findTankList

POST /com.gk_software.pos.api.service.fuel.FuelService/findTankList

Find tank list.

Description

Find tank list.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwareGkrApiServerMdPetrolDtoDomTankDO]

500

in case findTankList fails

2.19. GiftCertificateTransactionService

2.19.1. giftCertificateTransactionService.cancelAllGiftCertLineItemsOnCurrentTransaction

POST /com.gk_software.pos.api.service.transaction.gift_certificate.GiftCertificateTransactionService/cancelAllGiftCertLineItemsOnCurrentTransaction

Cancels all gift certificate line items on a currently active transaction

Description

Cancels all gift certificate line items on a currently active transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

{@link CancelGiftCertTransactionRequest}, request containing data about gift certificate to cancel. ComGkSoftwarePosApiServiceStoredValueServerCancelGiftCertTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the cancellation of gift certificate line item fails

2.19.2. giftCertificateTransactionService.createAndAddGiftCertificateLineItem

POST /com.gk_software.pos.api.service.transaction.gift_certificate.GiftCertificateTransactionService/createAndAddGiftCertificateLineItem

Creates a gift certificate line item.

Description

Creates a gift certificate line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The GiftCertificateRegistrationRequest, contains data of gift certificate ComGkSoftwarePosApiServiceTransactionGiftCertificateGiftCertificateRegistrationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the line item cannot be registered

2.20. GkrSvsPrepaidServerService

2.20.1. gkrSvsPrepaidServerService.acquirePrepaidPin

POST /com.gk_software.pos.api.service.prepaid.GkrSvsPrepaidServerService/acquirePrepaidPin

Calls \"acquire prepaid pin\" on underlying prepaid service.

Description

Calls \"acquire prepaid pin\" on underlying prepaid service. For each containing prepaid item a prepaid PIN is sold. The PIN status on the server is set to “sold”.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PrepaidPinRequest containing the prepaid items. PrepaidPinRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PrepaidPinResponse

500

in case of any error.

2.21. HospitalityService

2.21.1. hospitalityService.activateHospitalityReceipt

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/activateHospitalityReceipt

This method will activate or deactivate hospitality receipt.

Description

This method will activate or deactivate hospitality receipt

Parameters
Body Parameter
Name Description Required Default Pattern

body

The activateHospitalityReceipt request object ComGkSoftwarePosApiServiceHospitalityActivateHospitalityReceiptRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the operation fails for any reason

2.21.2. hospitalityService.addLineItemCourseNumber

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/addLineItemCourseNumber

Adds course number to line item.

Description

Adds course number to line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The 'add line item course number' request object ComGkSoftwarePosApiServiceHospitalityAddLineItemCourseNumberRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the operation fails for any reason

2.21.3. hospitalityService.changeTableOwner

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/changeTableOwner

This method will change the table owner of the given tables.

Description

This method will change the table owner of the given tables.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The 'change table owner' request object ComGkSoftwarePosApiServiceHospitalityChangeTableOwnerRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityChangeTableOwnerResponse

500

In case that the operation fails for any reason

2.21.4. hospitalityService.createBelatedTipTransaction

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/createBelatedTipTransaction

This method will create a transaction for 'belated tip' purpose.

Description

This method will create a transaction for 'belated tip' purpose.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The createBelatedTipTransaction request object ComGkSoftwarePosApiServiceHospitalityCreateBelatedTipTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityCreateBelatedTipTransactionResponse

500

In case that the operation fails for any reason

2.21.5. hospitalityService.createOrRetrieveTransaction

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/createOrRetrieveTransaction

Create or retrieve a transaction.

Description

Create or retrieve a transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The createOrRetrieveTransaction request ComGkSoftwarePosApiServiceHospitalityCreateOrRetrieveTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityCreateOrRetrieveTransactionRequest

500

In case that the operation fails for any reason

2.21.6. hospitalityService.deleteLineItemCourseNumber

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/deleteLineItemCourseNumber

Deletes course number from line item.

Description

Deletes course number from line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The 'delete line item course number' request object ComGkSoftwarePosApiServiceHospitalityDeleteLineItemCourseNumberRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the operation fails for any reason

2.21.7. hospitalityService.executeBelatedVoidLineItem

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/executeBelatedVoidLineItem

This method executed the belated voiding of a line item.

Description

This method executed the belated voiding of a line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The executeBelatedVoidLineItem request object ComGkSoftwarePosApiServiceHospitalityBelatedVoidLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityBelatedVoidLineItemResponse

500

In case that the operation fails for any reason

2.21.8. hospitalityService.finalizeMovementTransactions

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/finalizeMovementTransactions

This method will finalize all transactions (of type movement).

Description

This method will finalize all transactions (of type movement)

Parameters
Body Parameter
Name Description Required Default Pattern

body

The finalizeMovementTransactions request object ComGkSoftwarePosApiServiceHospitalityFinalizeMovementTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityMoveLineItemsResponse

500

In case that the operation fails for any reason

2.21.9. hospitalityService.isLineItemAddedOrVoided

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/isLineItemAddedOrVoided

It is checked, if line items were added or if already ordered line items were voided belated.

Description

It is checked, if line items were added or if already ordered line items were voided belated.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The isLineItemAddedOrVoided request ComGkSoftwarePosApiServiceHospitalityIsLineItemAddedOrVoidedRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityPreparePrintOrderDataResponse

500

In case that the operation fails for any reason

2.21.10. hospitalityService.loadComboMealItems

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/loadComboMealItems

This method will load combo meal items.

Description

load combo meal items.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The 'load combo leam items' request object ComGkSoftwarePosApiServiceHospitalityLoadComboMealItemsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityLoadComboMealItemsResponse

500

In case that the operation fails for any reason

2.21.11. hospitalityService.loadCondiments

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/loadCondiments

This method will load condiments.

Description

This method will load condiments.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The 'load conditments' request object ComGkSoftwarePosApiServiceHospitalityLoadCondimentsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityLoadCondimentsResponse

500

In case that the operation fails for any reason

2.21.12. hospitalityService.loadTableStatus

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/loadTableStatus

Load the table status.

Description

Load the table status.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The loadTableStatus request object ComGkSoftwarePosApiServiceHospitalityLoadTableStatusRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityLoadTableStatusResponse

500

In case that the operation fails for any reason

2.21.13. hospitalityService.moveLineItems

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/moveLineItems

This method will move line item(s) from one transaction to another.

Description

This method will move line item(s) from one transaction to another.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The moveLineItems request object ComGkSoftwarePosApiServiceHospitalityMoveLineItemsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityMoveLineItemsResponse

500

In case that the operation fails for any reason

2.21.14. hospitalityService.preparePrintOrderData

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/preparePrintOrderData

Prepares print order related data.

Description

Prepares print order related data.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The preparePrintOrderData request object ComGkSoftwarePosApiServiceHospitalityPreparePrintOrderDataRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityPreparePrintOrderDataResponse

500

In case that the operation fails for any reason

2.21.15. hospitalityService.recoverTransaction

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/recoverTransaction

This method will recover a hospitality related transaction

Description

This method will recover a hospitality related transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The recoverTransaction request object ComGkSoftwarePosApiServiceHospitalityRecoverTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityRecoverTransactionResponse

500

In case that the operation fails for any reason

2.21.16. hospitalityService.registerCondiments

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/registerCondiments

Register condiments.

Description

Register condiments.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The 'register condiment' request object ComGkSoftwarePosApiServiceHospitalityRegisterCondimentsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the operation fails for any reason

2.21.17. hospitalityService.resetToFoodOrderTransaction

POST /com.gk_software.pos.api.service.hospitality.HospitalityService/resetToFoodOrderTransaction

Resets the current transaction to a food order transaction.

Description

Resets the current transaction to a food order transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The resetToFoodOrderTransaction request object ComGkSoftwarePosApiServiceHospitalityResetToFoodOrderTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceHospitalityCreateOrRetrieveTransactionRequest

500

In case that the operation fails for any reason

2.22. ItemQueryService

2.22.1. itemQueryService.findPosUOMItemSearchViewListByFilter

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/findPosUOMItemSearchViewListByFilter

Find pos uom item search view list by filter.

Description

Find pos uom item search view list by filter.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ItemSearchRequest object ComGkSoftwarePosApiServiceMasterdataItemBlItemSearchRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ItemSearchResponse

2.22.2. itemQueryService.getInformationStockInfo

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getInformationStockInfo

Gets the stock details for given POS items. For each requested ID an ItemInformation object containing

Description

Gets the stock details for given POS items. For each requested ID an ItemInformation object containingthe details is returned.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The InformationStockInfoRequest object ComGkSoftwarePosApiServiceMasterdataItemInformationStockInfoRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwarePosApiModelDomAppItemInformationItemInformation]

2.22.3. itemQueryService.getItemInformationPosItemId

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getItemInformationPosItemId

Gets the item information for an item with specified POS item id.

Description

Gets the item information for an item with specified POS item id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ItemInformationRequest ComGkSoftwarePosApiServiceMasterdataItemItemInformationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiModelDomAppItemInformationItemInformation

2.22.4. itemQueryService.getItemInformationStockInfo

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getItemInformationStockInfo

Gets the stock info prepared for an item with specified POS item id.

Description

Gets the stock info prepared for an item with specified POS item id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the ItemInformationStockInfoRequest object ComGkSoftwarePosApiServiceMasterdataItemItemInformationStockInfoRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiModelDomAppItemInformationItemInformation

2.22.5. itemQueryService.getItemPriceNoCache

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/getItemPriceNoCache

Get price from ItemId no cache.

Description

Get price from ItemId no cache.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ItemId String [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.22.6. itemQueryService.loadItemDOByKey

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOByKey

Loads item master data for specified POS itemDO key.

Description

Loads item master data for specified POS item ID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the POS itemDO key ComGkSoftwarePosApiServiceMasterdataItemLoadItemDOByKeyRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDO

2.22.7. itemQueryService.loadItemDOByPosItemId

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOByPosItemId

Loads item master data for specified POS item ID.

Description

Loads item master data for specified POS item ID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the POS item ID [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDO

2.22.8. itemQueryService.loadItemDOListByPosItemIdList

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadItemDOListByPosItemIdList

Loads list of items for the specified POS item IDs.

Description

Loads list of items for the specified POS item IDs.

Parameters
Body Parameter
Name Description Required Default Pattern

body

List of POS item IDs [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDO]

2.22.9. itemQueryService.loadSimplePosUomItemDO

POST /com.gk_software.pos.api.service.masterdata.item.ItemQueryService/loadSimplePosUomItemDO

Loads item data for given item ID and returns it in form of SimplePosUomItemDO.

Description

Loads item data for given item ID and returns it in form of SimplePosUomItemDO.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The item ID [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataItemSimplePosUomItemDO

2.23. LayawayService

2.23.1. layawayService.calculatePaymentPlan

POST /com.gk_software.pos.api.service.layaway.LayawayService/calculatePaymentPlan

Adds a payment plan to transaction.

Description

Adds a payment plan to transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentPlanRequest object ComGkSoftwarePosApiServiceLayawayPaymentPlanRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceLayawayPaymentPlanResult

500

In case that the operation fails for any reason

2.23.2. layawayService.createCompleteVoidTransaction

POST /com.gk_software.pos.api.service.layaway.LayawayService/createCompleteVoidTransaction

Creates a new void transaction (complete layaway void) for the given request.

Description

Creates a new void transaction (complete layaway void) for the given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateCompleteVoidTransactionRequest request object ComGkSoftwarePosApiServiceLayawayCreateCompleteVoidTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.23.3. layawayService.createCustomerTransaction

POST /com.gk_software.pos.api.service.layaway.LayawayService/createCustomerTransaction

Creates a new transaction with customer for the given request.

Description

Creates a new transaction with customer for the given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateCustomerTransactionRequest request object ComGkSoftwarePosApiServiceLayawayCreateCustomerTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.23.4. layawayService.createDownPaymentAndFeeLineItem

POST /com.gk_software.pos.api.service.layaway.LayawayService/createDownPaymentAndFeeLineItem

Creates a new layaway down payment and fee line item for the given request.

Description

Creates a new layaway down payment and fee line item for the given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The DownPaymentAndFeeLineItemRequest object ComGkSoftwarePosApiServiceLayawayDownPaymentAndFeeLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.23.5. layawayService.createDownPaymentTransaction

POST /com.gk_software.pos.api.service.layaway.LayawayService/createDownPaymentTransaction

Creates a new layaway down payment transaction for the given request.

Description

Creates a new layaway down payment transaction for the given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The DownPaymentTransactionRequest object ComGkSoftwarePosApiServiceLayawayDownPaymentTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.23.6. layawayService.createFinalPaymentTransaction

POST /com.gk_software.pos.api.service.layaway.LayawayService/createFinalPaymentTransaction

Creates a final payment transaction for the given request.

Description

Creates a create final payment transaction for the given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FinalPaymentTransactionRequest object ComGkSoftwarePosApiServiceLayawayFinalPaymentTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.23.7. layawayService.createLayawayExtendTransaction

POST /com.gk_software.pos.api.service.layaway.LayawayService/createLayawayExtendTransaction

Creates a new layaway extend transaction for the given request.

Description

Creates a new layaway extend transaction for the given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The createLayawayExtendTransaction request object ComGkSoftwarePosApiServiceLayawayCreateLayawayExtendTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.23.8. layawayService.createPartialVoidTransaction

POST /com.gk_software.pos.api.service.layaway.LayawayService/createPartialVoidTransaction

Creates a new void transaction (partial layaway void) for the given request.

Description

Creates a new void transaction (partial layaway void) for the given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreatePartialVoidTransactionRequest request object ComGkSoftwarePosApiServiceLayawayCreatePartialVoidTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.23.9. layawayService.createRetrieveMoneyTransaction

POST /com.gk_software.pos.api.service.layaway.LayawayService/createRetrieveMoneyTransaction

Creates a new retrieve money transaction for the given request.

Description

Creates a new retrieve money transaction for the given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateRetrieveMoneyTransactionRequest request object ComGkSoftwarePosApiServiceLayawayCreateRetrieveMoneyTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.23.10. layawayService.findLayawayByCriteria

POST /com.gk_software.pos.api.service.layaway.LayawayService/findLayawayByCriteria

Find a Layaway by criteria.

Description

Find a Layaway by criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FindLayawayByCriteriaRequest object ComGkSoftwarePosApiServiceLayawayFindLayawayByCriteriaRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceLayawayFindLayawayByCriteriaResponse

500

In case that the operation fails for any reason

2.23.11. layawayService.findLayawayListByCriteria

POST /com.gk_software.pos.api.service.layaway.LayawayService/findLayawayListByCriteria

Find layaway list by criteria.

Description

Find layaway list by criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FindLayawayListByCriteriaRequest object ComGkSoftwarePosApiServiceLayawayFindLayawayListByCriteriaRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceLayawayFindLayawayListByCriteriaResponse

500

In case that the operation fails for any reason

2.23.12. layawayService.openScopedTxForLayaway

POST /com.gk_software.pos.api.service.layaway.LayawayService/openScopedTxForLayaway

Creates a scoped transaction with given information in the request object (e.g. the layaway)

Description

Creates a scoped transaction with given information in the request object (e.g. the layaway). SaleReturnLineItems of the layaway and other needed information will be copied to the transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The open transaction request object ComGkSoftwarePosApiServiceLayawayOpenScopedTxForLayawayRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

The exception is thrown if an unexpected error occurs.

2.23.13. layawayService.validateLayaway

POST /com.gk_software.pos.api.service.layaway.LayawayService/validateLayaway

Validate Layaway.

Description

Validate Layaway.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ValidateLayawayRequest object ComGkSoftwarePosApiServiceLayawayValidateLayawayRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

In case that the operation fails for any reason

2.24. LineItemService

2.24.1. lineItemService.activateTaxExempt

POST /com.gk_software.pos.api.service.transaction.LineItemService/activateTaxExempt

Activates tax exempt for line item

Description

Activates tax exempt for line item

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ActivateTaxExemptRequest object ComGkSoftwarePosApiServiceTransactionActivateTaxExemptRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.24.2. lineItemService.addOrderInformationToItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/addOrderInformationToItem

Retrieves the last registered item and adds information about the active order to it.

Description

Retrieves the last registered item and adds information about the active order to it.

Parameters
Body Parameter
Name Description Required Default Pattern

body

request ComGkSoftwarePosApiServiceTransactionSalesOrderPosition

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of price fails for any reason.

2.24.3. lineItemService.addRetailTransactionLineItemComment

POST /com.gk_software.pos.api.service.transaction.LineItemService/addRetailTransactionLineItemComment

Adds comment to line item.

Description

Adds comment to line item.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the operation fails for any reason

2.24.4. lineItemService.addSubtotalLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/addSubtotalLineItem

Creates and adds subtotal line item to the active transaction.

Description

Creates and adds subtotal line item to the active transaction.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.5. lineItemService.cancelGiftCertLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/cancelGiftCertLineItem

Cancels successful booked gift certificate line items by call of stored value service.

Description

Cancels successful booked gift certificate line items by call of stored value service.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CancelGiftCertLineItemRequest object ComGkSoftwarePosApiServiceTransactionCancelGiftCertLineItemRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

In case of any error

2.24.6. lineItemService.checkPriceLimitExceeded

POST /com.gk_software.pos.api.service.transaction.LineItemService/checkPriceLimitExceeded

Checks whether a price change is inside of defined limits (absolute and percental).

Description

Checks whether a price change is inside of defined limits (absolute and percental).

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CheckPriceLimitRequest object. ComGkSoftwarePosApiServiceTransactionCheckPriceLimitRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

PRICE_DIFFERENCE_POSITION_LIMIT_EXCEEDED in case of price position limit exceeded

2.24.7. lineItemService.checkQuantityInputProhibited

POST /com.gk_software.pos.api.service.transaction.LineItemService/checkQuantityInputProhibited

Checks if quantity input is prohibited by selling rule for selected line item throws exception in case of prohibition

Description

Checks if quantity input is prohibited by selling rule for selected line item throws exception in case of prohibition

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CheckQuantityInputProhibitedRequest object ComGkSoftwarePosApiServiceTransactionCheckQuantityInputProhibitedRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

with causing exception as cause.

2.24.8. lineItemService.checkQuantityInputProhibitedByItemSellingRule

POST /com.gk_software.pos.api.service.transaction.LineItemService/checkQuantityInputProhibitedByItemSellingRule

Checks if quantity input is prohibited by selling rule for selected line item throws exception in case of prohibition.

Description

Checks if quantity input is prohibited by selling rule for selected line item throws exception in case of prohibition.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The line item key ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemKey

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

with causing exception as cause.

2.24.9. lineItemService.clearItemTraceableUnitIDs

POST /com.gk_software.pos.api.service.transaction.LineItemService/clearItemTraceableUnitIDs

Clears the ItemTraceableUnitID for all items in the current transaction.

Description

Clears the ItemTraceableUnitID for all items in the current transaction.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the transaction cannot be updated

2.24.10. lineItemService.createAndAddCustomerAccountPaymentItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddCustomerAccountPaymentItem

Creates new line item for customer account payment

Description

Creates new line item for customer account payment

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RegisterCustomerAccountPaymentRequest object. ComGkSoftwarePosApiServiceTransactionRegisterCustomerAccountPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that request fails for any reason.

2.24.11. lineItemService.createAndAddDownpaymentLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddDownpaymentLineItem

Creates a new line item for a down payment.

Description

Creates a new line item for a down payment.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateDownpaymentLineItemRequest object. ComGkSoftwarePosApiServiceTransactionCreateDownpaymentLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of price fails for any reason.

2.24.12. lineItemService.createAndAddInvoicePaymentLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddInvoicePaymentLineItem

Creates a new line item for an invoice payment.

Description

Creates a new line item for an invoice payment.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateInvoicePaymentLineItemRequest object. ComGkSoftwarePosApiServiceTransactionCreateInvoicePaymentLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of price fails for any reason.

2.24.13. lineItemService.createAndAddLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/createMerchandiseCategorySaleItem

Creates and add a merchandise category sale line item to currently active transaction.

Description

Creates and add a merchandise category sale line item to currently active transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateLineItemRequest object ComGkSoftwarePosApiServiceTransactionCreateLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.24.14. lineItemService.createAndAddPayInOutLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddPayInOutLineItem

Creates and adds a pay-in/pay-out line item to the currently active transaction. The entered reason-specific data is …​

Description

Creates and adds a pay-in/pay-out line item to the currently active transaction. The entered reason-specific data is saved with theline item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PayInOutLineItemRequest object ComGkSoftwarePosApiServiceTransactionPayInOutLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

the transaction operation failed exception

2.24.15. lineItemService.createAndAddRetailTransactionLineItemExtension

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetailTransactionLineItemExtension

Add key value pair to a line item extension

Description

Add key value pair to a line item extension

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LineItemExtensionRequest object. ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case an error occurs during the process.

2.24.16. lineItemService.createAndAddRetrievedSalesOrderItems

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetrievedSalesOrderItems

Creates and adds new line item(s) for retrieved sales order items.

Description

Creates and adds new line item(s) for retrieved sales order items.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link RegisterRetrievedSalesOrderRequest} object. ComGkSoftwarePosApiServiceTransactionRegisterRetrievedSalesOrderRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of price fails for any reason.

2.24.17. lineItemService.createAndAddSaleReturnLineItemExtension

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddSaleReturnLineItemExtension

Adds extension record on specified item in transaction.

Description

Adds extension record on specified item in transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LineItemExtensionRequest the request ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.18. lineItemService.createAndAddSaleReturnLineItemExtensions

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddSaleReturnLineItemExtensions

Adds a list of extension records on sale return line items in transaction.

Description

Adds a list of extension records on sale return line items in transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LineItemExtensionRequest object ComGkSoftwarePosApiServiceTransactionLineItemExtensionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.19. lineItemService.createAndAddScaleTransactionItems

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddScaleTransactionItems

Creates new line item(s) for scale transaction items

Description

Creates new line item(s) for scale transaction items

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RegisterScaleTransactionRequest object. ComGkSoftwarePosApiServiceTransactionRegisterScaleTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that during the line item creation an error occurs

2.24.20. lineItemService.createAndAddWorkerDiscountLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddWorkerDiscountLineItem

Creates and adds a worker discount line item to the currently active transaction.

Description

Creates and adds a worker discount line item to the currently active transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateWorkerDiscountLineItemRequest object. ComGkSoftwarePosApiServiceTransactionCreateWorkerDiscountLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

the transaction operation failed exception

2.24.21. lineItemService.deactivateTaxExempt

POST /com.gk_software.pos.api.service.transaction.LineItemService/deactivateTaxExempt

Deactivates tax exempt for line item.

Description

Deactivates tax exempt for line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The DeactivateTaxExemptRequest object ComGkSoftwarePosApiServiceTransactionDeactivateTaxExemptRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.24.22. lineItemService.deleteRetailTransactionLineItemComment

POST /com.gk_software.pos.api.service.transaction.LineItemService/deleteRetailTransactionLineItemComment

Deletes comment from line item.

Description

Deletes comment from line item.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the operation fails for any reason

2.24.23. lineItemService.recalculateTransactionPromotions

POST /com.gk_software.pos.api.service.transaction.LineItemService/recalculateTransactionPromotions

Recalculation to apply temp promotions.

Description

Recalculation to apply temp promotions.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.24.24. lineItemService.reduceLineItems

POST /com.gk_software.pos.api.service.transaction.LineItemService/reduceLineItems

Reduces the line items for given line item keys into multiple positions in the currently active transaction according to provided quantity.

Description

Reduces the line items for given line item keys into multiple positions in the currently active transaction according to provided quantity.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ReduceLineItemsRequest object. ComGkSoftwarePosApiServiceTransactionReduceLineItemsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that splitting of positions fails for any reason.

2.24.25. lineItemService.registerExternalLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/registerExternalLineItem

Adds a line item to the currently active transaction. If the transaction is not opened right now, a new one is create…​

Description

Adds a line item to the currently active transaction. If the transaction is not opened right now, a new one is created. Theregistration of the item might fail for several reasons; e.g. the item is not valid of some data is missing. The resultcontains the according information.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RegistrationRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationExternalRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that the registration fails for any reason.

2.24.26. lineItemService.registerInternalLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/registerInternalLineItem

Adds a internal line item to the currently active transaction. If the transaction is not opened right now, a new one …​

Description

Adds a internal line item to the currently active transaction. If the transaction is not opened right now, a new one is created. Theregistration of the item might fail for several reasons; e.g. the item is not valid of some data is missing. The resultcontains the according information.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RegistrationInternalRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationInternalRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that the registration fails for any reason.

2.24.27. lineItemService.registerLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/registerLineItem

Adds a line item to the currently active transaction. If the transaction is not opened right now, a new one is create…​

Description

Adds a line item to the currently active transaction. If the transaction is not opened right now, a new one is created. Theregistration of the item might fail for several reasons; e.g. the item is not valid of some data is missing. The resultcontains the according information.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RegistrationRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionRegistrationResult

500

in case that the registration fails for any reason.

2.24.28. lineItemService.registerServiceFeeLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/registerServiceFeeLineItem

Adds a service fee line item to the currently active transaction.

Description

Adds a service fee line item to the currently active transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RegistrationRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationServiceFeeRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that the registration fails for any reason.

2.24.29. lineItemService.removeLastLineItemIfOpen

POST /com.gk_software.pos.api.service.transaction.LineItemService/removeLastLineItemIfOpen

Removes the last retail transaction line item of currently active transaction, in case that it is open.

Description

Removes the last retail transaction line item of currently active transaction, in case that it is open.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.30. lineItemService.removeLastSaleReturnLineItemIfOpen

POST /com.gk_software.pos.api.service.transaction.LineItemService/removeLastSaleReturnLineItemIfOpen

Removes the last sale return line item of currently active transaction, in case that it is open.

Description

Removes the last sale return line item of currently active transaction, in case that it is open.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.31. lineItemService.removeSaleReturnLineItemsExtensions

POST /com.gk_software.pos.api.service.transaction.LineItemService/removeSaleReturnLineItemsExtensions

Removes sale return line extensions containing given keys from given line items.

Description

Removes sale return line extensions containing given keys from given line items.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RemoveLineItemsExtensionsRequest the request ComGkSoftwarePosApiServiceTransactionRemoveLineItemsExtensionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.32. lineItemService.repeatLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/repeatLineItem

Repeat the specified line item.

Description

Repeat the specified line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RepeatLineItemRequest object. ComGkSoftwarePosApiServiceTransactionRepeatLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case line item repetition fails for any reason.

2.24.33. lineItemService.requestPointsRefund

POST /com.gk_software.pos.api.service.transaction.LineItemService/requestPointsRefund

Sends request to refund of loyalty points to respective service.

Description

Sends request to refund of loyalty points to respective service.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PointsRefundRequest} ComGkSoftwarePosApiServiceTransactionPointsRefundRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

in case of any error.

2.24.34. lineItemService.rollbackQuantityAccumulation

POST /com.gk_software.pos.api.service.transaction.LineItemService/rollbackQuantityAccumulation

Rollback the quantity accumulation process.

Description

Rollback the quantity accumulation process.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case an error occurs during the process.

2.24.35. lineItemService.setCustomFields

POST /com.gk_software.pos.api.service.transaction.LineItemService/setCustomFields

Set line item custom field values on the given line item on the transaction which is associated with the passed sessi…​

Description

Set line item custom field values on the given line item on the transaction which is associated with the passed session. Ifthe close position configuration indicates that the previous position should be closed a new line item with the given valuewill be created. The behavior depends on close position configuration of the passed {@link PositionOperationConfig}.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SetLineItemCustomFieldsRequest object. ComGkSoftwarePosApiServiceTransactionSetLineItemCustomFieldsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of custom fields fails for any reason.

2.24.36. lineItemService.setLineItemsTaxGroupId

POST /com.gk_software.pos.api.service.transaction.LineItemService/setLineItemsTaxGroupId

Validates and sets the tax group IDs to the related line items according to the request.

Description

Validates and sets the tax group IDs to the related line items according to the request.The tax group IDs are set only if all tax group IDs in the request are successfully validated.

Parameters
Body Parameter
Name Description Required Default Pattern

body

contains the tax group ids that must be set and the keys to the line items that should be modified. ComGkSoftwarePosApiServiceTransactionStoreLineItemTaxGroupIdRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

An exception is thrown if an error occurs either during the tax group id validation or storage of new changes.

2.24.37. lineItemService.setPrice

POST /com.gk_software.pos.api.service.transaction.LineItemService/setPrice

Sets/updates the price of the last line item in the currently active transaction. If the close position configuration

Description

Sets/updates the price of the last line item in the currently active transaction. If the close position configurationindicates that the previous position should be closed a new line item with the given value will be created. The behaviordepends on close position configuration of the passed {@link PositionOperationConfig}.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RegistrationRequest object. ComGkSoftwarePosApiServiceTransactionRegistrationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of price fails for any reason.

2.24.38. lineItemService.setQuantity

POST /com.gk_software.pos.api.service.transaction.LineItemService/setQuantity

Sets/updates the quantity of line item in the currently active transaction. If the close position configuration indic…​

Description

Sets/updates the quantity of line item in the currently active transaction. If the close position configuration indicatesthat the previous position should be closed a new line item with the given value will be created. The behavior depends onclose position configuration of the passed {@link PositionOperationConfig}.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SetQuantityRequest object. ComGkSoftwarePosApiServiceTransactionSetQuantityRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of quantity fails for any reason.

2.24.39. lineItemService.setRetailTransactionLineItemExtension

POST /com.gk_software.pos.api.service.transaction.LineItemService/setRetailTransactionLineItemExtension

Update or add key value pair to a line item extension

Description

Update or add key value pair to a line item extension

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LineItemExtensionRequest object. ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case an error occurs during the process.

2.24.40. lineItemService.setSaleReturnLineItemsExtensions

POST /com.gk_software.pos.api.service.transaction.LineItemService/setSaleReturnLineItemsExtensions

Sets the extension records with provided keys on specified line items in transaction with given values.

Description

Sets the extension records with provided keys on specified line items in transaction with given values.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LineItemExtensionsRequest the request ComGkSoftwarePosApiServiceTransactionLineItemExtensionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.41. lineItemService.setSalesPersonNumber

POST /com.gk_software.pos.api.service.transaction.LineItemService/setSalesPersonNumber

Sets the sales person number. Sets/updates the workerId of the last line item in the currently active transaction.

Description

Sets the sales person number. Sets/updates the workerId of the last line item in the currently active transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SalesPersonNumberRequest ComGkSoftwarePosApiServiceTransactionSalesPersonNumberRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.24.42. lineItemService.setSerialNumber

POST /com.gk_software.pos.api.service.transaction.LineItemService/setSerialNumber

Sets/updates serial number of last line item in the transaction. If the close position configuration indicates that the

Description

Sets/updates serial number of last line item in the transaction. If the close position configuration indicates that theprevious position should be closed a new line item with the given value will be created. The behavior depends on closeposition configuration of the passed {@link PositionOperationConfig}.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SetSerialNumberRequest object. ComGkSoftwarePosApiServiceTransactionSetSerialNumberRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of serial number fails for any reason.

2.24.43. lineItemService.syncLineItemsTraceableUnitID

POST /com.gk_software.pos.api.service.transaction.LineItemService/syncLineItemsItemsTraceableUnitID

Synchronizes the traceable unit id with line items registered in the current transaction in session.

Description

Synchronizes the traceable unit id with line items registered in the current transaction in session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

contains the tax group ids that must be set and the keys to the line items that should be modified. ComGkSoftwarePosApiServiceTransactionSyncLineItemsTraceableUnitIDRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

An exception is thrown if an error occurs either during the void item process or transaction storage process.

2.24.44. lineItemService.updateSaleReturnTaxLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/updateSaleReturnTaxLineItem

Overrides tax for line item. Changes taxValue or taxAmount depending on which parameter is null.

Description

Overrides tax for line item. Changes taxValue or taxAmount depending on which parameter is null.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ReturnLineItemRequest object ComGkSoftwarePosApiServiceTransactionReturnLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.45. lineItemService.updateSalesOrderItemInformation

POST /com.gk_software.pos.api.service.transaction.LineItemService/updateSalesOrderItemInformation

retrieves the last registered item and adds information about the active order to it.

Description

retrieves the last registered item and adds information about the active order to it.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link UpdateSalesOrderItemRequest} object ComGkSoftwarePosApiServiceTransactionUpdateSalesOrderItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case that setting of price fails for any reason.

2.24.46. lineItemService.updateSalesOrderSelectedDeliveryItemInformation

POST /com.gk_software.pos.api.service.transaction.LineItemService/updateSalesOrderSelectedDeliveryItemInformation

Update sales order selected delivery item information.

Description

Update sales order selected delivery item information.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the UpdateSalesOrderSelectedDeliveryItemRequest ComGkSoftwarePosApiServiceTransactionUpdateSalesOrderSelectedDeliveryItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.24.47. lineItemService.voidLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/voidLineItem

Voids the specified line item.

Description

Voids the specified line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The VoidLineItemRequest object ComGkSoftwarePosApiServiceTransactionVoidLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.48. lineItemService.voidLineItemBatch

POST /com.gk_software.pos.api.service.transaction.LineItemService/voidLineItemBatch

Voids a batch of line items.

Description

Voids a batch of line items.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The VoidLineItemBatchRequest object ComGkSoftwarePosApiServiceTransactionVoidLineItemBatchRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.49. lineItemService.voidPointsLineItems

POST /com.gk_software.pos.api.service.transaction.LineItemService/voidPointsLineItems

Sends request to refund loyalty points and void internally refunded line items.

Description

Sends request to refund loyalty points and void internally refunded line items.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PointsRefundBatchRequest object ComGkSoftwarePosApiServiceTransactionPointsRefundBatchRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.24.50. lineItemService.voidTenderLineItem

POST /com.gk_software.pos.api.service.transaction.LineItemService/voidTenderLineItem

Voids the specified tender line item.

Description

Voids the specified tender line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The VoidTenderLineItemRequest object ComGkSoftwarePosApiServiceTransactionVoidTenderLineItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if the transaction operation failed exception

2.24.51. posTransactionService.createAndAddRetailTransactionLineItemAssociations

POST /com.gk_software.pos.api.service.transaction.LineItemService/createAndAddRetailTransactionLineItemAssociations

Creates and adds retail transaction line item associations.

Description

Creates and adds retail transaction line item associations. In case of an error the whole operation is aborted/cancelled, either all associations are created or none.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateTransactionLineItemAssociationsRequest object. ComGkSoftwarePosApiServiceTransactionCreateTransactionLineItemAssociationsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.25. LoyaltyRewardService

2.25.1. loyaltyRewardService.processLoyaltyRewardCoupon

POST /com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardCoupon

Process active loyalty reward promotions which lead to coupon issuance

Description

Process active loyalty reward promotions which lead to coupon issuance

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.25.2. loyaltyRewardService.processLoyaltyRewardCouponByRequest

POST /com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardCouponByRequest

Process active loyalty reward promotions which lead to coupon issuance

Description

Process active loyalty reward promotions which lead to coupon issuance

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.25.3. loyaltyRewardService.processLoyaltyRewardGiftCertificate

POST /com.gk_software.pos.api.service.promotion.LoyaltyRewardService/processLoyaltyRewardGiftCertificate

Process active loyalty reward promotions which lead to gift certificate issuance

Description

Process active loyalty reward promotions which lead to gift certificate issuance

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LoyaltyRewardGiftCertificateRequest object ComGkSoftwarePosApiServicePromotionLoyaltyRewardGiftCertificateRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error.

2.26. LoyaltySystemService

2.26.1. loyaltySystemService.getCustomerLoyaltyAccounts

GET /com.gk_software.pos.api.service.loyalty.LoyaltySystemService/customer-loyalty-accounts

This method returns the loyalty accounts of a customer.

Description

This method returns the loyalty accounts of a customer.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerLoyaltyAccountsRequest object ComGkSoftwarePosApiServiceLoyaltyTypesCustomerLoyaltyAccountsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceLoyaltyTypesCustomerLoyaltyAccountsResponse

404

Customer not found

500

with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR

2.26.2. loyaltySystemService.getLoyaltyProgram

GET /com.gk_software.pos.api.service.loyalty.LoyaltySystemService/loyalty-programs

This method returns the loyalty program.

Description

This method returns the loyalty program.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LoyaltyProgramRequest object ComGkSoftwarePosApiServiceLoyaltyTypesLoyaltyProgramRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceLoyaltyTypesLoyaltyProgramResponse

500

with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR

2.26.3. loyaltySystemService.redeemPoints

POST /com.gk_software.pos.api.service.loyalty.LoyaltySystemService/redeemPoints

This method redeems points.

Description

This method redeems points.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PointsRedemptionRequest object ComGkSoftwarePosApiServiceLoyaltyTypesPointsRedemptionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceLoyaltyTypesPointsRedemptionResponse

400

Not enough points

404

Customer account not found

500

with ErrorCodes WS_INTERNAL_ERROR, WS_CONNECTION_ERROR

2.26.4. loyaltySystemService.refundPoints

POST /com.gk_software.pos.api.service.loyalty.LoyaltySystemService/refundPoints

This method refunds points.

Description

This method refunds points.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PointsRefundRequest object ComGkSoftwarePosApiServiceLoyaltyTypesPointsRefundRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceLoyaltyTypesPointsRefundResponse

404

Redemption not found

500

with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR

2.27. MasterDataService

2.27.1. masterDataService.findAllScaleDomains

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findAllScaleDomains

Finds all scale domains available for given business unit group id.

Description

Finds all scale domains available for given business unit group id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The business unit group ID [Long]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwareGkrApiServerMdScaleDomainDtoDomScaleDomainDO]

2.27.2. masterDataService.findBusinessUnitDOListByFilter

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitDOListByFilter

Gets a list of BusinessUnitDO object for the given filter.

Description

Gets a list of BusinessUnitDO object for the given filter.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The BusinessUnitByFilterRequest object ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitListByFilterRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitDOListByFilterResult

2.27.3. masterDataService.findBusinessUnitTextListByReceiptTextId

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitTextListByReceiptTextId

Method find BusinessUnitText by businessUnitID and receiptTextID.

Description

Method find BusinessUnitText by businessUnitID and receiptTextID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The BusinessUnitTextRequest object ComGkSoftwarePosApiServiceMasterdataBusinessUnitTextRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataBusinessUnitTextResponse

2.27.4. masterDataService.findBusinessUnitViewListByFilter

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findBusinessUnitViewListByFilter

Gets a list of BusinessUnitView object for the given filter.

Description

Gets a list of BusinessUnitView object for the given filter.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The BusinessUnitByFilterRequest object ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitListByFilterRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitViewListByFilterResult

2.27.5. masterDataService.findCurrencyRoundingRule

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCurrencyRoundingRule

Finds currency rounding rule

Description

Finds currency rounding rule

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CurrencyRoundingRuleRequest request ComGkSoftwarePosApiServiceMasterdataCurrencyRoundingRuleRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdCurrencyRoundingRuleDtoDomCurrencyRoundingRuleDO

2.27.6. masterDataService.findCustomer

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomer

Finds customer according to customer identifier

Description

Finds customer according to customer identifier

Parameters
Body Parameter
Name Description Required Default Pattern

body

The customer ID [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerDO

2.27.7. masterDataService.findCustomerContactViewListByFilter

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerContactViewListByFilter

Finds customers overview according to criteria in filter object

Description

Finds customers overview according to criteria in filter object

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerContactViewRequest object ComGkSoftwarePosApiServiceMasterdataCustomerContactViewRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataCustomerContactViewResult

2.27.8. masterDataService.findCustomerListByPartyIdentification

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerListByPartyIdentification

Finds customers according to party identifier

Description

Finds customers according to party identifier

Parameters
Body Parameter
Name Description Required Default Pattern

body

The party identification [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataCustomerResult

2.27.9. masterDataService.findCustomerTenderGroups

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findCustomerTenderGroups

Returns a list of customer tender groups matching the given customer group code.

Description

Returns a list of customer tender groups matching the given customer group code.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The customer tender group code [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwareGkrApiServerMdCustomerTenderRuleDtoDomCustomerTenderGroupDO]

2.27.10. masterDataService.findMHGChildren

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findMHGroupSubGroups

Gets a merchandise hierarchy group by filter

Description

Gets a merchandise hierarchy group by filter

Parameters
Body Parameter
Name Description Required Default Pattern

body

The MHGroupRequest object ComGkSoftwarePosApiServiceMasterdataMHGroupRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataMHGroupResult

2.27.11. masterDataService.findMHGroup

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findMHGroup

Gets a merchandise hierarchy group by ID

Description

Gets a merchandise hierarchy group by ID

Parameters
Body Parameter
Name Description Required Default Pattern

body

The merchandise hierarchy group ID [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareSweeSesApiServerMdMhgDtoSoMhgSO

2.27.12. masterDataService.findOperator

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findOperator

Finds the operator object for the given id

Description

Finds the operator object for the given id

Parameters
Body Parameter
Name Description Required Default Pattern

body

The operator id [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareSweeSesApiServerUmOperatorDtoSoAbstractOperatorSO

2.27.13. masterDataService.findSalesRestriction

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findSalesRestriction

Gets SalesRestrictionSO by ID.
Description

Gets SalesRestrictionSO by ID.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareSweeSesApiServerMdMhgDtoSoMhgSO

2.27.14. masterDataService.findScaleDomain

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findScaleDomain

Finds ScaleDomain by scaleDomainRequest

Description

Finds ScaleDomain by scaleDomainRequest

Parameters
Body Parameter
Name Description Required Default Pattern

body

The scale domain request ComGkSoftwarePosApiServiceMasterdataScaleDomainRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataScaleDomainResult

2.27.15. masterDataService.findTenderAdjustmentRules

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderAdjustmentRules

Gets a list of TenderAdjustmentRuleDO objects for the given tender type codes.

Description

Gets a list of TenderAdjustmentRuleDO objects for the given tender type codes.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The TenderAdjustmentRuleRequest object ComGkSoftwarePosApiServiceMasterdataTenderAdjustmentRuleRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataTenderAdjustmentRuleResult

2.27.16. masterDataService.findTenderByCurrencyAndClassCode

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByCurrencyAndClassCode

Searches for a tender by currency ID and tender class code

Description

Searches for a tender by currency ID and tender class code

Parameters
Body Parameter
Name Description Required Default Pattern

body

The TenderRequest} object ComGkSoftwarePosApiServiceMasterdataTenderRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

2.27.17. masterDataService.findTenderByCurrencyAndGroupCode

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByCurrencyAndGroupCode

Searches for a tender by currency ID and tender group code

Description

Searches for a tender by currency ID and tender group code

Parameters
Body Parameter
Name Description Required Default Pattern

body

The TenderRequest object ComGkSoftwarePosApiServiceMasterdataTenderRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

2.27.18. masterDataService.findTenderByTypeCode

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findTenderByTypeCode

Searches for a tender by tender type code

Description

Searches for a tender by tender type code

Parameters
Body Parameter
Name Description Required Default Pattern

body

The tender type code [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

2.27.19. masterDataService.findUnitOfMeasure

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findUnitOfMeasure

Finds unit of measure for given code

Description

Finds unit of measure for given code

Parameters
Body Parameter
Name Description Required Default Pattern

body

The unit of measure code [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareSweeSesApiServerMdUomDtoSoUomSO

2.27.20. masterDataService.findWorker

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/findWorkerDO

Gets the WorkerDO for the given criteria

Description

Gets the WorkerDO for the given criteria

Parameters
Body Parameter
Name Description Required Default Pattern

body

The WorkerRequest object ComGkSoftwarePosApiServiceMasterdataWorkerRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdWorkerDtoDomWorkerDO

2.27.21. masterDataService.getBaseClientMasterData

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getBaseClientMasterData

Returns base client master data.

Description

Returns base client master data.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The BaseClientMasterDataRequest object. ComGkSoftwarePosApiServiceMasterdataBaseClientMasterDataRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataBaseClientMasterDataResult

2.27.22. masterDataService.getBusinessUnit

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getBusinessUnit

Get business unit for given ID.

Description

Get business unit for given ID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The business unit ID [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomBusinessUnitDO

2.27.23. masterDataService.getCalculationModuleVersion

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getCalculationModuleVersion

Returns the calculation module version that is certified by the PTB.

Description

Returns the calculation module version that is certified by the PTB.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.27.24. masterDataService.getCurrencies

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrencies

Get the available currencies for the business unit group which is associated with the current session.

Description

Get the available currencies for the business unit group which is associated with the current session.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

CurrencyResult

2.27.25. masterDataService.getCurrenciesAndExchangeRates

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrenciesAndExchangeRates

Get the available currencies and corresponding exchange rates which are related to the default currency of the busine…​

Description

Get the available currencies and corresponding exchange rates which are related to the default currency of the business unitgroup which is associated to the current session.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

CurrencyResult

2.27.26. masterDataService.getCurrenciesForBusinessUnit

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getCurrenciesForBusinessUnit

Get the available currencies for given business unit ID.

Description

Get the available currencies for given business unit ID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The business unit ID [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

CurrencyResult

2.27.27. masterDataService.getDefaultCurrency

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getDefaultCurrency

Get the default currency for the business unit group which is associated with the current session.

Description

Get the default currency for the business unit group which is associated with the current session.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdCurrencyDtoDomCurrencyDO

2.27.28. masterDataService.getDefaultCurrencyForBusinessUnit

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getDefaultCurrencyForBusinessUnit

Get the default currency for the for the business unit group which is associated with given business unit.

Description

Get the default currency for the for the business unit group which is associated with given business unit.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The business unit ID [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdCurrencyDtoDomCurrencyDO

2.27.29. masterDataService.getDenominations

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getDenominations

Gets available DenominationDO.

Description

Gets available DenominationDO.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The DenominationRequest object ComGkSoftwarePosApiServiceMasterdataDenominationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataDenominationResult

2.27.30. masterDataService.getDiscountInfoIcons

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getDiscountInfoIcons

Returns a list of promotions for a given item

Description

Returns a list of promotions for a given item

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PromotionItemRequest object ComGkSoftwarePosApiServiceMasterdataPromotionItemRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwarePosFlowLibsTransactionDiscountIconList]

2.27.31. masterDataService.getEndDateTimestampExtension

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getEndDateTimestampExtension

Returns transaction extension for end date timestamp

Description

Returns transaction extension for end date timestamp

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiTxpoolDtoTransactionExtension

2.27.32. masterDataService.getExchangeRatesForCurrency

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getExchangeRatesForCurrency

Get the available currencies and corresponding exchange rates which are related to the given currency of the business…​

Description

Get the available currencies and corresponding exchange rates which are related to the given currency of the business unitgroup which is associated to the current session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The code of the currency [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ExchangeRatesResult

500

in case of any error

2.27.33. masterDataService.getGiftCertificateClass

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getGiftCertificateClass

Gets the gift certificate class

Description

Gets the gift certificate class

Parameters
Body Parameter
Name Description Required Default Pattern

body

The gc type code [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiServerMdGiftCertificateClassDtoDomGiftCertificateClassDO

2.27.34. masterDataService.getPromotion

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getPromotion

Gets the data for the given promotion.

Description

Gets the data for the given promotion.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ID of the promotion. [Long]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionSO

2.27.35. masterDataService.getPromotionByExternalId

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getPromotionByExternalId

Gets the data for the given external promotion ID.

Description

Gets the data for the given external promotion ID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ID of the promotion. [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionSO

2.27.36. masterDataService.getReasonCodeGroup

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getReasonCodeGroup

Gets the reason code group with the given ID.

Description

Gets the reason code group with the given ID.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The group ID [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataReasonResult

2.27.37. masterDataService.getSimpleTaxList

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getSimpleTaxList

Returns a consolidated tax list with simple data structure TAX_GROUP_ID = percent value.

Description

Returns a consolidated tax list with simple data structure TAX_GROUP_ID = percent value.Used for fiscalization!

Parameters
Body Parameter
Name Description Required Default Pattern

body

the business unit group ID [Long]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataSimpleTaxListResult

2.27.38. masterDataService.getSimpleTaxValue

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getSimpleTaxValue

Returns a consolidated tax percent value for the given tax group ID.

Description

Returns a consolidated tax percent value for the given tax group ID.Used for fiscalization!

Parameters
Body Parameter
Name Description Required Default Pattern

body

The tax group ID [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Double]

2.27.39. masterDataService.getTenders

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getTenders

Gets all available tenders.

Description

Gets all available tenders.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataTenderResult

2.27.40. masterDataService.getTendersByRequest

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getTendersByRequest

Get all tenders associated to a reason.

Description

Get all tenders associated to a reason.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The TenderRequest object ComGkSoftwarePosApiServiceMasterdataTenderRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceMasterdataTenderResult

2.27.41. masterDataService.getTimePeriods

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/getTimePeriods

Get available TimePeriods for a given internalTimeGroupId (of a timegroup)

Description

Get available TimePeriods for a given internalTimeGroupId(of a timegroup)

Parameters
Body Parameter
Name Description Required Default Pattern

body

The internal time group id [Long]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

List[ComGkSoftwareGkrApiServerMdTimeGroupDtoDomTimePeriod]

2.27.42. masterDataService.isImmediateVoidingAllowed

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/isImmediateVoidingAllowed

Searches for a tender by given tender type code and returns immediateVoidingAllowedFlag.

Description

Searches for a tender by given tender type code and returns immediateVoidingAllowedFlag.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The tender type code [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.27.43. masterDataService.isPosUOMItemAvailable

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/isPosUOMItemAvailable

Checks whether an PosUOMItemDO with the specified POS item ID exists or not.

Description

Checks whether an PosUOMItemDO with the specified POS item ID exists or not.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The POS item ID [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.27.44. masterDataService.isPromotionAvailable

POST /com.gk_software.pos.api.service.masterdata.MasterDataService/isPromotionAvailable

Checks whether a promotion with given external promotion ID exists.

Description

Checks whether a promotion with given external promotion ID exists.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The external promotion ID [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.28. PayablesAccountWebService

2.28.1. payablesAccountWebService.getAccountBalance

POST /com.gk_software.pos.api.service.communication.ws.payables_account.PayablesAccountWebService/getAccountBalance

Queries the customer account balancing in the ERP service.

Description

Queries the customer account balancing in the ERP service. It gives the current status of a customer account, i.e. the (positive or negative) open amount.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The account balance request containing the necessary information for the balance request, as web service configuration, customer id and accounting area. ComGkSoftwarePosApiServiceCommunicationWsPayablesAccountAccountBalanceRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCommunicationWsPayablesAccountAccountBalanceResult

500

The exception is thrown if an unexpected error occurs, i.e.:

  • WS_CONNCTION_ERROR

  • WS_CUSTOMER_NOT_FOUND_ERROR

2.29. PaymentService

2.29.1. paymentService.addCashChangeAmountAlreadyPaidExtensions

POST /com.gk_software.pos.api.service.payment.PaymentService/addCashChangeAmountAlreadyPaidExtensions

Adds the cash change amount already paid extensions.

Description

Adds the cash change amount already paid extensions.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the config ComGkSoftwarePosApiModelConfigProcessActionPositionOperationConfig

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error

2.29.2. paymentService.addTerminalPrintoutsToLineItem

POST /com.gk_software.pos.api.service.payment.PaymentService/addTerminalPrintoutsToLineItem

Appends merchant and/or customer terminal receipts to line item.

Description

Appends merchant and/or customer terminal receipts to line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the request ComGkSoftwarePosApiServicePaymentAddTerminalPrintoutsToLineItemRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

in case of any error

2.29.3. paymentService.calculateChangeAfterGivenAmount

POST /com.gk_software.pos.api.service.payment.PaymentService/calculateChangeAfterGivenAmount

Calculates the change once the given amount is accounted.

Description

Calculates the change once the given amount is accounted.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The amount that will be payed or received to be considered during change calculation. [Double]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Double]

500

If any error occurs.

2.29.4. paymentService.cancelPayment

POST /com.gk_software.pos.api.service.payment.PaymentService/cancelPayment

Cancel payment mode before moving to registration mode

Description

Cancel payment mode before moving to registration mode

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

including error code TRANSACTION_NOT_FOUND

2.29.5. paymentService.checkLimits

POST /com.gk_software.pos.api.service.payment.PaymentService/checkLimits

Checks an entered payment amount according to minimum and maximum accepted amount of the tender

Description

Checks an entered payment amount according to minimum and maximum accepted amount of the tender

Parameters
Body Parameter
Name Description Required Default Pattern

body

The AmountValidationRequest object ComGkSoftwarePosApiServicePaymentAmountValidationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentAmountValidationResult

500

in case of any error

2.29.6. paymentService.checkMaxDenominationDifference

POST /com.gk_software.pos.api.service.payment.PaymentService/checkMaxDenominationDifference

Checks an entered payment amount according to maximum denomination difference for the used currency

Description

Checks an entered payment amount according to maximum denomination difference for the used currency

Parameters
Body Parameter
Name Description Required Default Pattern

body

The AmountValidationRequest object ComGkSoftwarePosApiServicePaymentAmountValidationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentAmountValidationResult

500

in case of any error

2.29.7. paymentService.createChangeAndGetPaymentAmounts

POST /com.gk_software.pos.api.service.payment.PaymentService/createChangeAndGetPaymentAmounts

Calculates the change amount and creates a change tender line item in case of overpayment for the transaction which is

Description

Calculates the change amount and creates a change tender line item in case of overpayment for the transaction which isassociated with the current session

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentRequest object ComGkSoftwarePosApiServicePaymentPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that the operation fails for any reason

2.29.8. paymentService.createTenderExchangeTransaction

POST /com.gk_software.pos.api.service.payment.PaymentService/createTenderExchangeTransaction

Creates and prepares the transaction for tender exchange for finalization.

Description

Creates and prepares the transaction for tender exchange for finalization.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentRequest for the tender exchange. ComGkSoftwarePosApiServicePaymentPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that the operation fails for any reason

2.29.9. paymentService.filterPerTender

POST /com.gk_software.pos.api.service.payment.PaymentService/filterPerTender

Filter per tender. Several checks are executed on all tenders of the TenderCollection. In case that a check a…​

Description

Filter per tender. Several checks are executed on all tenders of the TenderCollection. In case that a check applieson a tender the tender will be forbidden.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FilterPerTenderRequest request ComGkSoftwarePosApiServicePaymentFilterPerTenderRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

FilterPerTenderResult

500

If any error occurs.

2.29.10. paymentService.getCustomerExclusiveTenderGroupCode

POST /com.gk_software.pos.api.service.payment.PaymentService/getCustomerExclusiveTenderGroupCode

Get the tender group code if there exists an customer exclusive tender.

Description

Get the tender group code if there exists an customer exclusive tender.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The customer id to check the tenders for [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

in case of any error

2.29.11. paymentService.getExclusiveCustomerTender

POST /com.gk_software.pos.api.service.payment.PaymentService/getExclusiveCustomerTender

Get the exclusive customer tender, if there exists one.

Description

Get the exclusive customer tender, if there exists one.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

500

in case of any error

2.29.12. paymentService.getFoodStampsTotal

POST /com.gk_software.pos.api.service.payment.PaymentService/getFoodStampsTotal

Calculates the sum of all items allowed for payment with Foods stamps.

Description

Calculates the sum of all items allowed for payment with Foods stamps.

Parameters
Body Parameter
Name Description Required Default Pattern

body

indicates whether discounts should be considered [Boolean]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Double]

500

in case of any error

2.29.13. paymentService.getOpenTotal

POST /com.gk_software.pos.api.service.payment.PaymentService/getOpenTotal

Get transaction open total

Parameters
Body Parameter
Name Description Required Default Pattern

body

The base iso currency code [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Double]

500

In case that the operation fails for any reason

2.29.14. paymentService.getPaymentAmounts

POST /com.gk_software.pos.api.service.payment.PaymentService/getPaymentAmounts

Calculates the change amount for the transaction which is associated with the current session

Description

Calculates the change amount for the transaction which is associated with the current session

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentRequest object ComGkSoftwarePosApiServicePaymentPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentAmountsResult

500

In case that the operation fails for any reason

2.29.15. paymentService.getSpecialReturnAmountLookupKey

POST /com.gk_software.pos.api.service.payment.PaymentService/getSpecialReturnAmountLookupKey

Get the lookup key for the return amounts processing

Description

Get the lookup key for the return amounts processing

Parameters
Body Parameter
Name Description Required Default Pattern

body

the request ComGkSoftwarePosApiServicePaymentSpecialReturnAmountLookupKeyRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

If any error occurs.

2.29.16. paymentService.getTenderExchangeAmounts

POST /com.gk_software.pos.api.service.payment.PaymentService/getTenderExchangeAmounts

Calculates the amounts after tender exchange.

Description

Calculates the amounts after tender exchange.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentRequest for the tender exchange. ComGkSoftwarePosApiServicePaymentPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentAmountsResult

500

in case of any error

2.29.17. paymentService.getTenderPayableAmount

POST /com.gk_software.pos.api.service.payment.PaymentService/getTenderPayableAmount

Gets the tender payable amount

Description

Gets the tender payable amount

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentRequest object ComGkSoftwarePosApiServicePaymentPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPayableAmountResult

500

in case of any error

2.29.18. paymentService.getTotalTenderAmount

POST /com.gk_software.pos.api.service.payment.PaymentService/getTotalTenderAmount

Calculates the total tender amount (given payments) for the transaction which is associated with the current session

Description

Calculates the total tender amount (given payments) for the transaction which is associated with the current session

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Double]

500

In case that the operation fails for any reason

2.29.19. paymentService.getTotalTenderAmountForTender

POST /com.gk_software.pos.api.service.payment.PaymentService/getTotalTenderAmountForTender

Calculates the total tender amount (given payments) of a specific tender for the transaction which is associated with…​

Description

Calculates the total tender amount (given payments) of a specific tender for the transaction which is associated with thecurrent session

Parameters
Body Parameter
Name Description Required Default Pattern

body

Tender to be checked ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Double]

500

In case that the operation fails for any reason

2.29.20. paymentService.isReplaceSubtotalRequired

POST /com.gk_software.pos.api.service.payment.PaymentService/isReplaceSubtotalRequired

Checks whether the subtotal rounding should be replaced.

Description

Checks whether the subtotal rounding should be replaced.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

in case of any error

2.29.21. paymentService.isTenderAllowedForAllCustomer

POST /com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForAllCustomer

Checks whether a tender is allowed for all customers in general according to default settings.

Description

Checks whether a tender is allowed for all customers in general according to default settings.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the tender type code [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

in case of any error

2.29.22. paymentService.isTenderAllowedForCustomer

POST /com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForCustomer

Checks whether a tender is allowed for customer of customers assigned to the current transaction.

Description

Checks whether a tender is allowed for customer of customers assigned to the current transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the tender type code [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

in case of any error

2.29.23. paymentService.isTenderAllowedForCustomerGroup

POST /com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForCustomerGroup

Checks whether a tender is allowed for customer groups of customers assigned to the current transaction.

Description

Checks whether a tender is allowed for customer groups of customers assigned to the current transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the tender type code [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

in case of any error

2.29.24. paymentService.isTenderAllowedForSaleReturnLineItemReason

POST /com.gk_software.pos.api.service.payment.PaymentService/isTenderAllowedForSaleReturnLineItemReason

Checks whether a tender is allowed for sale return line item reasons of items with the given item type in current

Description

Checks whether a tender is allowed for sale return line item reasons of items with the given item type in currenttransaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the sale return line item item type [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

in case of any error

2.29.25. paymentService.markTenderAuthorizationForBackOfficeCancellation

POST /com.gk_software.pos.api.service.payment.PaymentService/markTenderAuthorizationForBackOfficeCancellation

Marks the tender authorization as invalid so that the backoffice agent can roll back the started payment.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The tender authorization object ComGkSoftwareGkrApiTxpoolDtoTenderAuthorization

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the operation fails for any reason.

2.29.26. paymentService.reduceTaxableAmountForFoodStamp

POST /com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForFoodStamp

Calculates the sum of all items minus amount allowed for payment with Foods stamps.

Description

Calculates the sum of all items minus amount allowed for payment with Foods stamps.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the amount [Double]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Double]

500

in case of any error

2.29.27. paymentService.reduceTaxableAmountForWicVoucher

POST /com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForWicVoucher

Calculates the sum of all items minus amount allowed for payment with Wic Voucher.

Description

Calculates the sum of all items minus amount allowed for payment with Wic Voucher.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the amount [Double]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

in case of any error

2.29.28. paymentService.registerCashPayment

POST /com.gk_software.pos.api.service.payment.PaymentService/registerCashPayment

Adds a tender line item to transaction which is associated with the current session. If there is a cashback value &gt…​

Description

Adds a tender line item to transaction which is associated with the current session. If there is a cashback value > 0 acashback tender line item with appropriate value will be added to the transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CashPaymentRequest object ComGkSoftwarePosApiServicePaymentCashPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that the operation fails for any reason

2.29.29. paymentService.registerCashTenderLineItem

POST /com.gk_software.pos.api.service.payment.PaymentService/registerCashTenderLineItem

Register cash tender line item

Parameters
Body Parameter
Name Description Required Default Pattern

body

The amount [Double]

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

In case that the operation fails for any reason

2.29.30. paymentService.registerCashTenderLineItemInRecovery

POST /com.gk_software.pos.api.service.payment.PaymentService/registerCashTenderLineItemInRecovery

Register cash tender line item

Parameters
Body Parameter
Name Description Required Default Pattern

body

The amount [Double]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the operation fails for any reason

2.29.31. paymentService.registerCheckPayment

POST /com.gk_software.pos.api.service.payment.PaymentService/registerCheckPayment

Adds a TenderLineItem with check payment information to the transaction

Description

Adds a TenderLineItem with check payment information to the transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CheckPaymentRequest object ComGkSoftwarePosApiServicePaymentCheckPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that access to transaction data fails.

2.29.32. paymentService.registerCreditPayment

POST /com.gk_software.pos.api.service.payment.PaymentService/registerCreditPayment

Adds a tender line item to transaction which is associated with the current session.

Description

Adds a tender line item to transaction which is associated with the current session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreditPaymentRequest object ComGkSoftwarePosApiServicePaymentCreditPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that the operation fails for any reason

2.29.33. paymentService.registerGiftCertificatePayment

POST /com.gk_software.pos.api.service.payment.PaymentService/registerGiftCertificatePayment

Adds a TenderLineItem with gift certificate payment information to the transaction

Description

Adds a TenderLineItem with gift certificate payment information to the transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The GiftCertificatePaymentRequest object ComGkSoftwarePosApiServicePaymentGiftCertificatePaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that access to transaction data fails.

2.29.34. paymentService.registerGiftCertificateSpvPayment

POST /com.gk_software.pos.api.service.payment.PaymentService/registerGiftCertificateSpvPayment

Adds a SaleReturnLineItem with single purpose voucher information to the transaction

Description

Adds a SaleReturnLineItem with gift certificate single purpose voucher payment information to the transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The GiftCertificateSpvPaymentRequest object ComGkSoftwarePosApiServicePaymentGiftCertificateSpvPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that access to transaction data fails.

2.29.35. paymentService.registerMobilePayment

POST /com.gk_software.pos.api.service.payment.PaymentService/registerMobilePayment

Registers a payment position with custom tenderClassCode for mobile payment

Description

Registers a payment position with custom tenderClassCode for mobile payment

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PaymentRequest for the tender exchange ComGkSoftwarePosApiServicePaymentPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that the operation fails for any reason

2.29.36. paymentService.registerPointsPayment

POST /com.gk_software.pos.api.service.payment.PaymentService/registerPointsPayment

Adds a tender line item to transaction which is associated with the current session. If there is a cashback value &gt…​

Description

Adds a tender line item to transaction which is associated with the current session. If there is a cashback value > 0 acashback tender line item with appropriate value will be added to the transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PointsPaymentRequest object ComGkSoftwarePosApiServicePaymentPointsPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that the operation fails for any reason

2.29.37. paymentService.registerTerminalPayment

POST /com.gk_software.pos.api.service.payment.PaymentService/registerTerminalPayment

Adds a CreditDebitCard TenderLineItem to the transaction which is associated with current session.

Description

Adds a CreditDebitCard TenderLineItem to the transaction which is associated with current session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The TerminalPaymentRequest object. ComGkSoftwarePosApiServicePaymentTerminalPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentPaymentResult

500

In case that access to transaction data fails.

2.29.38. paymentService.resetTaxForEwicTender

POST /com.gk_software.pos.api.service.payment.PaymentService/reduceTaxableAmountForEwic

Calculates the sum of all items minus amount allowed for payment with eWIC.

Description

Calculates the sum of all items minus amount allowed for payment with eWIC.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the request ComGkSoftwarePosApiServicePaymentReduceTaxableAmountRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Double]

500

in case of any error

2.29.39. paymentService.updateTerminalTenderAuthorization

POST /com.gk_software.pos.api.service.payment.PaymentService/updateTerminalTenderAuthorization

Updates terminal tender authorization with basic payment data.

Description

Updates terminal tender authorization with basic payment data.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The TerminalPaymentRequest object ComGkSoftwarePosApiServicePaymentTerminalPaymentRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that access to transaction data fails.

2.29.40. paymentService.validateAmount

POST /com.gk_software.pos.api.service.payment.PaymentService/validateAmount

Validate an entered payment amount

Description

Validate an entered payment amount

Parameters
Body Parameter
Name Description Required Default Pattern

body

The AmountValidationRequest object ComGkSoftwarePosApiServicePaymentAmountValidationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePaymentAmountValidationResult

500

in case of any error

2.29.41. posTransactionService.removeTerminalPaymentDataInVoiding

POST /com.gk_software.pos.api.service.payment.PaymentService/removeTerminalPaymentDataInVoiding

Removes payment data from the voided tx after tender line items are created and this data is not more needed.

Description

Removes payment data from the voided tx after tender line items are created and this data is not more needed.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The voided transaction. ComGkSoftwareGkrApiTxpoolDtoTransaction

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

Only in case of an unexpected error.

2.30. PosFrontendService

2.30.1. posFrontendService.finishCustomerSession

POST /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/finishCustomerSession

This method updates customer session after the sales transaction is paid - points are updated, used coupons are redeemed, unused coupons are unblocked.

Parameters
Return Type

-

Responses
Code Message Datatype

200

Successful operation response.

500

with ErrorCodes WS_CONNECTION_ERROR, WS_CUSTOMER_NOT_FOUND_ERROR, WS_INTERNAL_ERROR

2.30.2. posFrontendService.getCustomerLoyaltyAccounts

GET /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/customer-loyalty-accounts

This method returns the loyalty accounts of a customer.

Description

This method returns the loyalty accounts of a customer.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CustomerLoyaltyAccountsRequest object ComGkSoftwarePosApiServicePosFrontendServiceCustomerLoyaltyAccountsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePosFrontendServiceCustomerLoyaltyAccountsResponse

404

Customer not found

500

with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR

2.30.3. posFrontendService.getLoyaltyProgram

GET /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/loyalty-programs

This method returns the loyalty program.

Description

This method returns the loyalty program.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LoyaltyProgramRequest object ComGkSoftwarePosApiServicePosFrontendServiceLoyaltyProgramRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServicePosFrontendServiceLoyaltyProgramResponse

500

with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR

2.30.4. posFrontendService.redeemPoints

POST /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/redeemPoints

This method redeems points.

Description

This method redeems points.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RedeemPointsRequest object ComGkSoftwarePosApiServicePosFrontendServiceRedeemPointsRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

400

Not enough points

404

Customer account not found

500

with ErrorCodes WS_INTERNAL_ERROR, WS_CONNECTION_ERROR

2.30.5. posFrontendService.startCustomerSession

POST /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/startCustomerSession

This method provides customer loyalty accounts, coupons of the customer, promotions for base point factor, tier multilicator promotions and tier rewards promotions. Additionally, the coupons are marked as blocked for the current sales transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The StartCustomerSessionRequest object ComGkSoftwarePosApiServicePosFrontendServiceStartCustomerSessionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Successful operation response.

ComGkSoftwarePosApiServicePosFrontendServiceStartCustomerSessionResponse

404

Customer not found

500

with ErrorCodes WS_CONNECTION_ERROR, WS_CUSTOMER_NOT_FOUND_ERROR, WS_INTERNAL_ERROR

2.30.6. posFrontendService.voidPointsRedemption

POST /com.gk_software.pos.api.service.pos_frontend_service.PosFrontendService/voidPointsRedemption

This method voids the points redemption of a customer.

Description

This method voids the points redemption of a customer.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The VoidPointsRedemptionRequest object ComGkSoftwarePosApiServicePosFrontendServiceVoidPointsRedemptionRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

404

Redemption not found

500

with ErrorCodes WS_CONNECTION_ERROR, WS_INTERNAL_ERROR

2.31. PosGroupManagementService

2.31.1. logoutAllOperators

POST /com.gk_software.pos.api.service.posgroup.PosGroupManagementService/logoutAllOperators

Parameters
Return Type

-

Responses
Code Message Datatype

0

successful operation

2.31.3. posGroupManagementService.logout

POST /com.gk_software.pos.api.service.posgroup.PosGroupManagementService/logout

Performs a pos group logout (just removes the pos session).

Description

Performs a pos group logout (just removes the pos session).

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PosGroupOperatorLogoutRequest object. ComGkSoftwarePosApiServiceSessionPosgroupPosGroupOperatorLogoutRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSessionPosgroupPosGroupOperatorLogoutResult

500

If there is no session with the identifier given in the request.

2.32. PosSessionService

2.32.1. posSessionService.activateMainTransaction

POST /com.gk_software.pos.api.service.session.PosSessionService/activateMainTransaction

Sets main transaction as active.

Description

Sets main transaction as active.

Parameters
Return Type

-

Responses
Code Message Datatype

200

Success

500

in case of any error.

2.32.2. posSessionService.activateNewMainTransaction

POST /com.gk_software.pos.api.service.session.PosSessionService/activateNewMainTransaction

Activates provided transaction as a new main transaction in current session.

Description

Activates provided transaction as a new main transaction in current session.

Parameters
Return Type

-

Responses
Code Message Datatype

200

Success

500

in case of any error.

2.32.3. posSessionService.clearPriceCalculationSession

POST /com.gk_software.pos.api.service.session.PosSessionService/clearPriceCalculationSession

Clears price calculation session.

Description

Clears price calculation session.

Parameters
Return Type

-

Responses
Code Message Datatype

200

Success

2.32.4. posSessionService.createAnonymousLogin

POST /com.gk_software.pos.api.service.session.PosSessionService/createAnonymousLogin

Creates an anonymous session/login.

Description

Creates an anonymous session/login.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LoginRequest object ComGkSoftwarePosApiServiceSessionLoginRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSessionLoginResult

500

If authentication failed.

2.32.5. posSessionService.createAnonymousSession

POST /com.gk_software.pos.api.service.session.PosSessionService/createAnonymousSession

Creates an anonymous session.

Description

Creates an anonymous session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The LoginRequest object ComGkSoftwarePosApiServiceSessionLoginRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiSessionPosSessionId

500

If authentication failed.

2.32.6. posSessionService.getSession

POST /com.gk_software.pos.api.service.session.PosSessionService/getSession

Gets the session associated with the session id.

Description

Gets the session associated with the session id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The session id. ComGkSoftwarePosApiSessionPosSessionId

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

PosSession

2.32.7. posSessionService.getSessions

POST /com.gk_software.pos.api.service.session.PosSessionService/getSessions

Gets all existing sessions.

Description

Gets all existing sessions.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Map]

2.32.8. posSessionService.isValidSession

POST /com.gk_software.pos.api.service.session.PosSessionService/isValidSession

Checks whether the given session id is valid.

Description

Checks whether the given session id is valid.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The session id to be verified. ComGkSoftwarePosApiSessionPosSessionId

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.32.9. posSessionService.lockSession

POST /com.gk_software.pos.api.service.session.PosSessionService/lockSession

Performs a lock for the associated session. After this, the session is locked.

Description

Performs a lock for the associated session. After this, the session is locked.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiTxpoolDtoTransaction

2.32.11. posSessionService.logout

POST /com.gk_software.pos.api.service.session.PosSessionService/logoutWithRequest

Performs a logout for the associated session with validation of the user credentials if requested. Internally an auth…​

Description

Performs a logout for the associated session with validation of the user credentials if requested. Internally an authentication requestwith the operatorId out of the session and the passed password is performed. On success the session will be removed. If anauthentication failure occurs a {@link AuthenticationFailedException} is thrown.

Parameters
Body Parameter
Name Description Required Default Pattern

body

ComGkSoftwarePosApiServiceSessionLogoutRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSessionLogoutResult

500

If the authentication fails for any reason

2.32.12. posSessionService.logoutIfAnonymous

POST /com.gk_software.pos.api.service.session.PosSessionService/logoutIfAnonymous

Logs out if the current session is a anonymous session.

Description

Logs out if the current session is a anonymous session.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceSessionLogoutResult

2.32.13. posSessionService.logoutIfNecessary

POST /com.gk_software.pos.api.service.session.PosSessionService/logoutIfNecessary

Checks whether a sign on transaction exists for the given parameters.

Description

Checks whether a sign on transaction exists for the given parameters.If a sign on transaction exists a sign off transaction with operator/worker/till from the sign on transaction will becreated. Furthermore logout of operator and till is executed on Login manager.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request object, with the relevant businessUnitId and the workstationId ComGkSoftwarePosApiServiceSessionLogoutRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceSessionLogoutResult

2.32.14. posSessionService.logoutPreserveSession

POST /com.gk_software.pos.api.service.session.PosSessionService/logoutPreserveSession

Performs a technical logout for the associated session.

Description

Performs a technical logout for the associated session. Technical logout means:

  • Logout on POS-Server

  • Create SIGN-OFF transactionAfter this, the session is still valid.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceSessionLogoutResult

2.32.15. posSessionService.removeSession

POST /com.gk_software.pos.api.service.session.PosSessionService/removeSession

Removes/invalidates actual session.

Description

Removes/invalidates actual session.

Parameters
Return Type

-

Responses
Code Message Datatype

0

successful operation

2.32.16. posSessionService.removeSessionRequest

POST /com.gk_software.pos.api.service.session.PosSessionService/removeSessionRequest

Removes/invalidates actual session.

Description

Removes/invalidates actual session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request with session id and clear session holder possibility. ComGkSoftwarePosApiServiceSessionRemoveSessionRequest

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.32.17. posSessionService.setActiveTransaction

POST /com.gk_software.pos.api.service.session.PosSessionService/setActiveTransaction

Sets transaction for given scope as active transaction

Description

Sets transaction for given scope as active transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The scope [String]

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.32.18. posSessionService.setLanguageSettings

POST /com.gk_software.pos.api.service.session.PosSessionService/setLanguageSettings

Sets the language settings (active scope and language hierarchies) for the current session.

Description

Sets the language settings (active scope and language hierarchies) for the current session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The language settings. ComGkSoftwarePosApiServiceSessionLanguageSettings

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.32.19. posSessionService.setLastServerStatus

POST /com.gk_software.pos.api.service.session.PosSessionService/setLastServerStatus

Sets last server status.

Description

Sets last server status.

Parameters
Body Parameter
Name Description Required Default Pattern

body

[Boolean]

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

in case of any error.

2.32.20. posSessionService.setPosSessionData

POST /com.gk_software.pos.api.service.session.PosSessionService/setPosSessionData

Sets store specific data to pos session

Description

Sets store specific data to pos session

Parameters
Body Parameter
Name Description Required Default Pattern

body

ComGkSoftwarePosApiSessionPosSessionData

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.32.21. posSessionService.unlockByForeignUser

POST /com.gk_software.pos.api.service.session.PosSessionService/unlockByForeignUser

Performs an unlock for the associated session with a new user. If the authentication for the new user is successful, …​

Description

Performs an unlock for the associated session with a new user. If the authentication for the new user is successful, then theprevious user will be logged out, the new user is logged in and unlocks the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request object ComGkSoftwarePosApiServiceSessionLoginRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSessionSwitchUserResult

500

If authentication failed

2.32.22. posSessionService.unlockSession

POST /com.gk_software.pos.api.service.session.PosSessionService/unlockSessionRequest

Performs a unlock for the associated session.

Description

Performs a unlock for the associated session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The unlock request. ComGkSoftwarePosApiServiceSessionUnlockSessionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareGkrApiTxpoolDtoTransaction

2.32.23. posSessionService.updateScopedTransaction

POST /com.gk_software.pos.api.service.session.PosSessionService/updateScopedTransaction

Overrides the scoped transaction in session

Description

Overrides the scoped transaction in session

Parameters
Body Parameter
Name Description Required Default Pattern

body

The scoped Transaction ComGkSoftwareGkrApiTxpoolDtoTransaction

X

Return Type

-

Responses
Code Message Datatype

0

successful operation

2.33. PosTransactionService

2.33.1. getNewSessionTransactionInvoiceNumber

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getNewSessionTransactionInvoiceNumber

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.33.2. posTransactionService.activateSendByEmail

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/activateSendByEmail

Activates send receipt as email for the transaction assigned to the session.

Description

Activates send receipt as email for the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link ReceiptAsEmailActivationRequest} object. ComGkSoftwarePosApiServiceTransactionReceiptAsEmailActivationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.3. posTransactionService.activateTaxExempt

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/activateTaxExempt

Activates tax exempt for the transaction assigned to the session.

Description

Activates tax exempt for the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PosTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionPosTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session or if the tax exempt is already active for the transaction.

2.33.4. posTransactionService.activateTaxFreeSale

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/activateTaxFreeSale

Activates tax free sale on transaction.

Description

Activates tax free sale on transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The activate tax free sale request ComGkSoftwarePosApiServiceTransactionActivateTaxFreeSaleRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case the operation fails.

2.33.5. posTransactionService.addExternalTransactionAdditionalPrintout

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/addExternalTransactionAdditionalPrintout

Adds additional external printouts to the transaction.

Description

Adds additional external printouts to the transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link AddExternalTransactionAdditionalPrintoutRequest} object. ComGkSoftwarePosApiServiceTransactionAddExternalTransactionAdditionalPrintoutRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

Only in case of an unexpected error.

2.33.6. posTransactionService.addFiscalizationDataToTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/addFiscalizationDataToTransaction

Adds and stores fiscalization data like receipt number given by fiscal printer and current open fiscal day number to

Description

Adds and stores fiscalization data like receipt number given by fiscal printer and current open fiscal day number totransaction. Will be called from client after fiscal receipt was printed on fiscal printer.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link AddFiscalizationDataToTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionAddFiscalizationDataToTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the transaction cannot be found.

2.33.7. posTransactionService.addReturnInfoToTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/addReturnInfoToTransaction

Adds a TransactionCategory for the return info to the transaction. If there is a transaction identifier given…​

Description

Adds a TransactionCategory for the return info to the transaction. If there is a transaction identifier given, thenit is tried to load the matching transaction. If there is no matching transaction, then it is checked for a transactionalready assigned to the session. If there is also no transaction assigned to the session, then a new transaction is created.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The transaction identifier. [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

Only in case of an unexpected error.

2.33.8. posTransactionService.addTerminalPrintoutsToTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/addTerminalPrintoutsToTransaction

Adds terminal printouts to line items in active transaction.

Description

Adds terminal printouts to line items in active transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link AddTerminalPrintoutsToTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionAddTerminalPrintoutsToTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.9. posTransactionService.addTransactionAdditionalPrintouts

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/addTransactionAdditionalPrintouts

Adds additional printouts to the transaction.

Description

Adds additional printouts to the transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link AddTransactionAdditionalPrintoutsRequest} object. ComGkSoftwarePosApiServiceTransactionAddTransactionAdditionalPrintoutsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.10. posTransactionService.addTransactionExtensionToTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/addTransactionExtensionToTransaction

Adds a single given transaction extension to the transaction. If there is no transaction assigned to the session, the…​

Description

Adds a single given transaction extension to the transaction. If there is no transaction assigned to the session, then a newtransaction is created.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The AddTransactionExtensionRequest object. ComGkSoftwarePosApiServiceTransactionAddTransactionExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

Only in case of an unexpected error.

2.33.11. posTransactionService.addTransactionExtensionsToTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/addTransactionExtensionsToTransaction

Adds the given transaction extensions to the transaction. The transaction assigned to the session is used as long as …​

Description

Adds the given transaction extensions to the transaction. The transaction assigned to the session is used as long as there isnot transaction identifier set in the request. If there is a transaction identifier set, then it is tried to load thematching transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The AddTransactionExtensionsRequest object. ComGkSoftwarePosApiServiceTransactionAddTransactionExtensionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the transaction cannot be found, when a transaction identifier was given or if the transaction cannot be stored.

2.33.12. posTransactionService.addTransactionTimerToTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/addTransactionTimerToTransaction

Adds transaction timer to transaction.

Description

Adds transaction timer to transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The add transaction timer request ComGkSoftwarePosApiServiceTransactionAddTransactionTimerRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If transaction cannot be open.

2.33.13. posTransactionService.calculateReturnUnitPrices

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/calculateReturnUnitPrices

Calculates the return unit prices for line items of the transaction assigned to the session.

Description

Calculates the return unit prices for line items of the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link CalculateReturnUnitPricesRequest} object. ComGkSoftwarePosApiServiceTransactionCalculateReturnUnitPricesRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.14. posTransactionService.cancelAllExternalLineItemsOnVoidingTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/cancelAllExternalLineItemsOnVoidingTransaction

Cancels all external line items on current voiding transaction (assigned to the session) in the following order:

Description

Cancels all external line items on current voiding transaction (assigned to the session) in the following order: * Gift Cards * Gift Certificates * Loyalty Points * External Transactions

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CancelAllExternalLineItemsRequest object. ComGkSoftwarePosApiServiceTransactionCancelAllExternalLineItemsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionCancelAllExternalLineItemsResult

500

If there is no transaction assigned to the session or the cancel process failed for any type at the very first item.

2.33.15. posTransactionService.cancelTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/cancelTransaction

Cancels an uncompleted transaction, which is associated to the session.

Description

Cancels an uncompleted transaction, which is associated to the session.

Parameters
Return Type

-

Responses
Code Message Datatype

200

Success

500

If no transaction is assigned to session

2.33.16. posTransactionService.cancelTransactionWithReason

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/cancelTransactionWithReason

Cancels an uncompleted transaction, which is associated to the session, with the reason set in the request object.

Description

Cancels an uncompleted transaction, which is associated to the session, with the reason set in the request object.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CancelTransactionRequest object. ComGkSoftwarePosApiServiceTransactionCancelTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If no transaction is assigned to session

2.33.17. posTransactionService.checkItemAvailable

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/checkItemAvailable

Checks whether a PosUOMItemDO for the given RetailTransactionLineItem is available in the master data…​

Description

Checks whether a PosUOMItemDO for the given RetailTransactionLineItem is available in the master data. Ifnot, an according exception is thrown.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RetailTransactionLineItem containing the item to be checked. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

If no matching item was found.

2.33.18. posTransactionService.checkReturnableItemsAvailable

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/checkReturnableLineItemsAvailable

Checks whether the returnable line items of the transaction for the given identifier are available in the master data…​

Description

Checks whether the returnable line items of the transaction for the given identifier are available in the master data. Ifnot, an according exception is raised.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The transaction identifier of the transaction to check. [String]

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

If one or more items are not available or no transaction was found.

2.33.19. posTransactionService.checkTransactionVoidable

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/checkTransactionVoidable

Checks, whether the given transaction is voidable. If not, an according exception is thrown.

Description

Checks, whether the given transaction is voidable. If not, an according exception is thrown.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link CheckTransactionVoidableRequest} object. ComGkSoftwarePosApiServiceTransactionCheckTransactionVoidableRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

with according error code in case transaction is not cancellable.

2.33.20. posTransactionService.checkUnexportedTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/checkUnexportedTransactions

Checks whether all transactions are already processed by transaction pool.

Description

Checks whether all transactions are already processed by transaction pool.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The retail store identifier, which is used to determine business unit group identifier for the search. Can be left <code>null</code> to search for all stores. [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

If the business unit for the given identifier cannot be found.

2.33.21. posTransactionService.closeLastLineItem

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/closeLastLineItem

Closes the last position of the transaction, if there is one open position.

Description

Closes the last position of the transaction, if there is one open position.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PositionOperationConfig} object. ComGkSoftwarePosApiModelConfigProcessActionPositionOperationConfig

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction or the last position cannot be closed.

2.33.22. posTransactionService.convertScaleSuspendCodes

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/convertScaleSuspendCodes

Converts suspend code to ConvertedSuspendCodesResponse object.

Description

Converts scale suspend code to ConvertedSuspendCodesResponse object.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ConvertSuspendCodesRequest object. ComGkSoftwarePosApiServiceTransactionConvertSuspendCodesRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionConvertSuspendCodesResponse

500

In case an error occurs.

2.33.23. posTransactionService.convertSuspendCodes

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/convertSuspendCodes

Converts suspend code to ConvertedSuspendCodesResponse object.

Description

Converts suspend code to ConvertedSuspendCodesResponse object.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ConvertSuspendCodesRequest object. ComGkSoftwarePosApiServiceTransactionConvertSuspendCodesRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionConvertSuspendCodesResponse

500

In case an error occurs.

2.33.24. posTransactionService.countSuspendedTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/countSuspendedTransactions

Searches and counts suspended transactions that matches the given criteria.

Description

Searches and counts suspended transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SearchSuspendedTransactionsRequest} object. ComGkSoftwarePosApiServiceTransactionSearchSuspendedTransactionsRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Integer]

500

In case of an unexpected exception (if no transaction is found, no exception is thrown, but the return value is 0)

2.33.25. posTransactionService.createAndAddRetailTransactionCouponSummary

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createAndAddRetailTransactionCouponSummary

Creates and adds a {@link RetailTransactionCouponSummary} based on the given information to the transaction. If there…​

Description

Creates and adds a {@link RetailTransactionCouponSummary} based on the given information to the transaction. If there is notransaction assigned to the session a new transaction will be created.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link EnterCouponRequest} object. ComGkSoftwarePosApiServiceTransactionEnterCouponRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the request contains a privilege type that is unknown.

2.33.26. posTransactionService.createAndAddTransactionBinaryData

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createAndAddTransactionBinaryData

Creates and adds transaction binary data to the transaction assigned to the session or if a transaction identifier wa…​

Description

Creates and adds transaction binary data to the transaction assigned to the session or if a transaction identifier was givento the matching loaded transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionBinaryDataRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionBinaryDataRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.33.27. posTransactionService.createAndAddTransactionBinaryDataWithExtension

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createAndAddTransactionBinaryDataWithExtension

Creates and adds transaction binary data to the transaction assigned to the session or if a transaction identifier wa…​

Description

Creates and adds transaction binary data to the transaction assigned to the session or if a transaction identifier was givento the matching loaded transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionBinaryDataWithExtensionRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionBinaryDataWithExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session or if the transaction cannot be found.

2.33.28. posTransactionService.createCancelDrawerAccountsTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createCancelDrawerAccountsTransaction

Creates the transaction for drawer accounts cancellation.

Description

Creates the transaction for drawer accounts cancellation.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateDrawerAccountsRequest object ComGkSoftwarePosApiServiceTransactionCreateDrawerAccountsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

In case an error occurs.

2.33.29. posTransactionService.createCashRecyclerCashExchangeTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createCashRecyclerCashExchangeTransaction

Create an Cash Recycler Cash Exchange Transaction

Description

Create an Cash Recycler Cash Exchange Transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

The POS transaction request ComGkSoftwarePosApiServiceTransactionPosTransactionCRSCashExchangeRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.33.30. posTransactionService.createCashRecyclerVerificationTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createCashRecyclerVerificationTransaction

Create an CashRecycler Verification Transaction

Description

Create an CashRecycler Verification Transaction

Parameters
Body Parameter
Name Description Required Default Pattern

body

request ComGkSoftwarePosApiServiceTransactionPosTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.33.31. posTransactionService.createDrawerAccountsTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createDrawerAccountsTransactions

Creates the transactions for drawer accounts.

Description

Creates the transactions for drawer accounts.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateDrawerAccountsRequest object ComGkSoftwarePosApiServiceTransactionCreateDrawerAccountsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

In case an error occurs.

2.33.32. posTransactionService.createFailFiscalTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createFailFiscalTransaction

Creates a fail fiscal transaction for given request.

Description

Creates a fail fiscal transaction for given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link CreateFailFiscalTransactionRequest} request. ComGkSoftwarePosApiServiceTransactionCreateFailFiscalTransactionRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

If there is a session and the given transaction identifier does not match with the transaction assigned to the session. If there is no session and there is no business unit found for the given identifier.

2.33.33. posTransactionService.createFiscalControlTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createFiscalControlTransaction

Creates a fiscal control transaction.

Description

Creates a fiscal control transaction.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

Only in case of an unexpected error.

2.33.34. posTransactionService.createFiscalStartTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createFiscalStartTransaction

Creates a fiscal start control transaction.

Description

Creates a fiscal start control transaction.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

Only in case of an unexpected error.

2.33.35. posTransactionService.createInvoiceNumber

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createInvoiceNumber

Creates the invoice number and sets it to the transaction assigned to the session or if a transaction identifier was …​

Description

Creates the invoice number and sets it to the transaction assigned to the session or if a transaction identifier was given tothe matching loaded transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link InvoiceNumberRequest} object. ComGkSoftwarePosApiServiceTransactionInvoiceNumberRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session or if the transaction cannot be found or stored.

2.33.36. posTransactionService.createItemInfoTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createItemInfoTransaction

Creates item information transaction and stores it.

Description

Creates item information transaction and stores it. Creates {@link com.gk_software.gkr.api.txpool.dto.Transaction}, {@link com.gk_software.gkr.api.txpool.dto.RetailTransaction} with RetailTransactionTypeCode=II, {@link com.gk_software.gkr.api.txpool.dto.SaleReturnLineItem} with itemType=II. {@link com.gk_software.gkr.api.txpool.dto.SaleReturnLineItem} is created from {@link com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDO}.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.33.37. posTransactionService.createOpenDrawerTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createOpenDrawerTransaction

Creates an open till/drawer control transaction.

Description

Creates an open till/drawer control transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PosTransactionRequest object. ComGkSoftwarePosApiServiceTransactionPosTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the operator for the given identifier was not found.

2.33.38. posTransactionService.createPrintTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createPrintTransaction

Creates the print transaction for an existing transaction.

Description

Creates the print transaction for an existing transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionPrintRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionPrintRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If the transaction cannot be found.

2.33.39. posTransactionService.createSuspendCodes

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createSuspendCodes

Creates suspend code from transaction. This codes will be added to binary data.

Description
Creates suspend code from transaction. This codes will be added to binary data.
Parameters
Body Parameter
Name Description Required Default Pattern

body

The request ComGkSoftwarePosApiServiceTransactionCreateSuspendCodeRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.33.40. posTransactionService.createTenderAmountAdjustmentTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createTenderAmountAdjustmentTransaction

Creates the tender amount adjustment transaction.

Description

Creates the tender amount adjustment transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionTenderRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionTenderRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

Only in case of an unexpected error.

2.33.41. posTransactionService.createTenderLoanTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createTenderLoanTransaction

Creates the tender loan transaction.

Description

Creates the tender loan transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionTenderRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionTenderRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

Only in case of an unexpected error.

2.33.42. posTransactionService.createTenderPickupTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createTenderPickupTransaction

Creates the tender pickup transaction.

Description

Creates the tender pickup transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionTenderRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionTenderRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

Only in case of an unexpected error.

2.33.43. posTransactionService.createTerminalDiagnosticTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createTerminalDiagnosticTransaction

Creates the terminal diagnostic transaction.

Description

Creates the terminal diagnostic transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PosTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionPosTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If the business unit for the given identifier cannot be found.

2.33.44. posTransactionService.createTerminalEodTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createTerminalEodTransaction

Create terminal end of day control transaction.

Description

Create terminal end of day control transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PosTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionPosTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If the business unit for the given identifier cannot be found.

2.33.45. posTransactionService.createTerminalLoginTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createTerminalLoginTransaction

Create terminal login control transaction.

Description

Create terminal login control transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PosTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionPosTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If the business unit for the given identifier cannot be found.

2.33.46. posTransactionService.createTerminalReprintTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createTerminalReprintTransaction

Creates the terminal reprint transaction.

Description

Creates the terminal reprint transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PosTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionPosTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If the business unit for the given identifier cannot be found.

2.33.47. posTransactionService.createTillTenderSettlementTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createTillTenderSettlementTransaction

Creates till tender settlement transaction.

Description

Creates till tender settlement transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionTenderRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionTenderRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

Only in case of an unexpected error.

2.33.48. posTransactionService.createVoidTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/createVoidTransaction

Creates a new void transaction for given request.

Description

Creates a new void transaction for given request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The CreateVoidTransactionRequest object. ComGkSoftwarePosApiServiceTransactionCreateVoidTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction for the given transaction identifier or if the transaction is not voidable.

2.33.49. posTransactionService.deactivateSendByEmail

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/deactivateSendByEmail

Deactivates send receipt as email for the transaction assigned to the session.

Description

Deactivates send receipt as email for the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link ReceiptAsEmailActivationRequest} object. ComGkSoftwarePosApiServiceTransactionReceiptAsEmailActivationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.50. posTransactionService.deactivateTaxExempt

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/deactivateTaxExempt

Deactivates tax exempt for the transaction assigned to the session.

Description

Deactivates tax exempt for the transaction assigned to the session.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session or if the tax exempt was not activated before.

2.33.51. posTransactionService.deleteScopedTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/deleteScopedTransaction

Delete the scoped transaction from the session.

Description

Delete the scoped transaction from the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The scope [String]

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

If there is no current transaction.

2.33.52. posTransactionService.deleteTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/deleteTransaction

Delete the transaction from the session and database. If the transaction is a fiscal transaction it will only be remo…​

Description

Delete the transaction from the session and database. If the transaction is a fiscal transaction it will only be removed fromsession, but not deleted in database (the deletion is then silently skipped).

Parameters
Return Type

-

Responses
Code Message Datatype

200

Success

500

TRANSACTION_NOT_FOUND - If no transaction is assigned to session
TRANSACTION_COULD_NOT_BE_DELETED - If transaction could not be deleted

2.33.53. posTransactionService.fillTransactionFinalData

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/fillTransactionFinalData

Fill final data by the promotion service to the transaction.

Description

Fill final data by the promotion service to the transaction.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.54. posTransactionService.finalizeControlTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/finalizeControlTransaction

Finalize a control transaction.

Description

Finalize a control transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The transaction identifier. [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

In case an error occurs

2.33.55. posTransactionService.finalizeTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/finalizeTransaction

Finalize the transaction. If the request does not contain a transaction identifier, then the transaction assigned to the

Description

Finalize the transaction. If the request does not contain a transaction identifier, then the transaction assigned to thesession is used.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The FinalizeTransactionRequest ComGkSoftwarePosApiServiceTransactionFinalizeTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.33.56. posTransactionService.finishLocalAccountingTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/finishLocalAccountingTransactions

Finish local accounting transactions.

Description

Finish local accounting transactions.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwareGkrApiTxpoolDtoTransaction]

500

In case an error occurs

2.33.57. posTransactionService.finishUnfinishedTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/finishUnfinishedTransactions

Finish for the unfinished transactions that matches the given criteria. The matching transactions will be deleted and…​

Description

Finish for the unfinished transactions that matches the given criteria. The matching transactions will be deleted and a failcontrol transaction will be created for the original transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

unfinishedTransactionsRequest ComGkSoftwarePosApiServiceTransactionUnfinishedTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionIdsResult

500

If transactions cannot be found.

2.33.58. posTransactionService.getCurrentChange

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getCurrentChange

Find current change by LOAN transactions in local DB.

Description

Find current change by LOAN transactions in local DB.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Double]

2.33.59. posTransactionService.getCustomerInfoTransactionDataViewsByIds

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getCustomerInfoTransactionDataViewsByIds

Get {@link CustomerInfoTransactionData} objects for the given list of transaction identifiers.

Description

Get {@link CustomerInfoTransactionData} objects for the given list of transaction identifiers.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionIdsRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionIdsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwarePosApiModelDomAppViewsCustomerInfoTransactionData]

500

If a transaction cannot be found.

2.33.60. posTransactionService.getNewPKORKODocumentNumber

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getNewPKORKODocumentNumber

Retrieves a new document number for PKO/RKO reports.

Description

Retrieves a new document number for PKO/RKO reports.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PKORKONumberRequest} object. ComGkSoftwarePosApiServiceTransactionPKORKONumberRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

If no transaction was found for the given identifier.

2.33.61. posTransactionService.getOrCreateEndDateTimestampExtension

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateEndDateTimestampExtension

Gets or creates a new TransactionExtension for temporary end date timestamp.

Description

Gets or creates a new TransactionExtension for temporary end date timestamp.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionGetOrCreateEndDateTimestampExtensionResult

500

Only in case of an unexpected error.

2.33.62. posTransactionService.getOrCreateEndDateTimestampExtensionFromRequest

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateEndDateTimestampExtensionFromRequest

Gets or creates a new TransactionExtension for temporary end date timestamp.

Description

Gets or creates a new TransactionExtension for temporary end date timestamp.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link GetEndDateTimestampExtensionRequest} object. ComGkSoftwarePosApiServiceTransactionGetEndDateTimestampExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionGetOrCreateEndDateTimestampExtensionResult

500

If there is no transaction for the given transaction identifier.

2.33.63. posTransactionService.getOrCreateEndDateTimestampLoginLogoutRequestExtension

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateEndDateTimestampLoginLogoutRequestExtension

Gets or creates a new TransactionExtension for temporary end date timestamp.

Description

Gets or creates a new TransactionExtension for temporary end date timestamp.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link GetEndDateTimestampExtensionRequest} object. ComGkSoftwarePosApiServiceTransactionGetEndDateTimestampExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionGetOrCreateEndDateTimestampExtensionResult

500

If there is no transaction for the given transaction identifier.

2.33.64. posTransactionService.getOrCreateScopedCopyTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateScopedCopyTransaction

Gets or creates a scoped {@link PosTransaction}. The created scoped {@link PosTransaction} will include a copy of the

Description

Gets or creates a scoped {@link PosTransaction}. The created scoped {@link PosTransaction} will include a copy of thetransaction associated to the session, if there exists a transaction associated to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The scope [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If the creation of new scoped transaction is not possible.

2.33.65. posTransactionService.getOrCreateScopedTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateScopedTransaction

Gets or creates a scoped {@link PosTransaction}.

Description

Gets or creates a scoped {@link PosTransaction}.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The scope [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If the creation of new scoped transaction is not possible.

2.33.66. posTransactionService.getOrCreateTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateTransaction

Gets the current {@link PosTransaction} associated with the session. If there is no transaction associated to current

Description

Gets the current {@link PosTransaction} associated with the session. If there is no transaction associated to currentsession, then a new {@link PosTransaction} will be created and associated to the session.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If the creation of new transaction is not possible.

2.33.67. posTransactionService.getOrCreateTransactionById

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getOrCreateTransactionById

Gets or creates the current RetailTransaction associated with the session. If the transaction has to be created it wi…​

Description

Gets or creates the current RetailTransaction associated with the session. If the transaction has to be created it will becreated with the given transaction UUID. If the transaction UUID is <code>null</code>, then it will be generated bytransaction pool.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The transaction UUID. [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If the creation of new transaction is not possible.

2.33.68. posTransactionService.getRefundTransactionById

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getRefundTransactionById

Load {@link RefundTransaction} based on its key attribute.

Description

Load {@link RefundTransaction} based on its key attribute.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The transaction identifier [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiRefundServiceDtoRefundTransaction

500

If it is not possible to load a refund transaction with the given transaction identifier.

2.33.69. posTransactionService.getTerminalToRefundDataOnVoidingTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getTerminalToRefundDataOnVoidingTransaction

Get terminal line items data to refund during voiding transaction.

Description

Get terminal line items data to refund during voiding transaction.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTerminalToRefundData

500

If there is not transaction assigned to the session.

2.33.70. posTransactionService.getTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getTransaction

Gets the current active {@link PosTransaction} associated with the session.

Description

Gets the current active {@link PosTransaction} associated with the session.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If there is no current transaction.

2.33.71. posTransactionService.getTransactionById

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getTransactionById

Load transaction based on its key attribute.

Description

Load transaction based on its key attribute.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The transaction identifier [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If it is not possible to load a transaction with the given transaction identifier.

2.33.72. posTransactionService.getTransactionSearchViewsByIds

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/getTransactionSearchViewsByIds

Get {@link TransactionSearchView} objects for the given list of transaction identifiers.

Description

Get {@link TransactionSearchView} objects for the given list of transaction identifiers.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TransactionIdsRequest} object. ComGkSoftwarePosApiServiceTransactionTransactionIdsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionSearchViewsResult

500

If a transaction cannot be found.

2.33.73. posTransactionService.isAtLeastOneFiscalStartTransactionCreated

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/isAtLeastOneFiscalStartTransactionCreated

Checks whether there is at least one fiscal start transaction matching the given data.

Description

Checks whether there is at least one fiscal start transaction matching the given data.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SearchFiscalStartTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionSearchFiscalStartTransactionRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

Only in case of an unexpected error.

2.33.74. posTransactionService.isTransactionPrinted

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/isTransactionPrinted

Checks whether the transaction for the given identifier is printed.

Description

Checks whether the transaction for the given identifier is printed.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The transaction identifier. [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

If the transaction cannot be found.

2.33.75. posTransactionService.isTransactionVoided

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/isTransactionVoided

Checks whether the transaction for the given identifier is voided.

Description

Checks whether the transaction for the given identifier is voided.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The transaction identifier. [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

If the transaction cannot be found.

2.33.76. posTransactionService.loadCompleteTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/loadCompleteTransaction

Loads the complete transaction.

Description

Loads the complete transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The flag which indicates if the tx is searched localy only. [Boolean]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoCompleteTransaction

500

If it is not possible to load the complete transaction.

2.33.77. posTransactionService.overtakeScaleScopedTransactionItems

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/overtakeScaleScopedTransactionItems

Overtakes items from scoped scale transaction.

Description

Overtakes items from scoped scale transaction.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If it is not possible to overtake items from scale scoped transaction.

2.33.78. posTransactionService.prepareLastSuspendOpenSSCTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/prepareLastSuspendOpenSSCTransaction

Suspends open SSC Transaction that matches the given criteria.

Description

Suspends open SSC Transaction that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RetrieveOpenSSCTransactionRequest object ComGkSoftwarePosApiServiceTransactionRetrieveOpenSSCTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.33.79. posTransactionService.recalculateLineItems

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/recalculateLineItems

Recalculates amounts of items and return the items back.

Description

Recalculates amounts of items and return the items back.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link RecalculateLineItemsRequest} object. ComGkSoftwarePosApiServiceTransactionRecalculateLineItemsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem]

500

If the calculation failed by any reason.

2.33.80. posTransactionService.recalculateTaxesOnActiveTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/recalculateTaxesOnActiveTransaction

Recalculates taxes on the transaction assigned to the session.

Description

Recalculates taxes on the transaction assigned to the session.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session or the tax calculation failed.

2.33.81. posTransactionService.recoverTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/recoverTransaction

Checks whether there is an open transaction stored in the persistence. If yes, it is loaded and set as the current

Description

Checks whether there is an open transaction stored in the persistence. If yes, it is loaded and set as the currenttransaction. This method is used in order to recover from a failed/crashed POS in order to restore the transaction.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If the recovery of the transaction is not possible.

2.33.82. posTransactionService.recoverTransactionWithRequest

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/recoverTransactionWithRequest

Checks whether there is an open transaction stored in the persistence. If yes, it is loaded and set as the current

Description

Checks whether there is an open transaction stored in the persistence. If yes, it is loaded and set as the currenttransaction. This method is used in order to recover from a failed/crashed POS in order to restore the transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RecoverTransactionRequest object. ComGkSoftwarePosApiServiceTransactionRecoverTransactionRequest

-

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If the recovery of the transaction is not possible.

2.33.83. posTransactionService.refundNonVoidedTendersInMainCurrencyCash

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/refundNonVoidedTendersInMainCurrencyCash

Creates a new cash {@link TenderLineItem} in main currency in order to refund all non voided tender line items from the

Description

Creates a new cash {@link TenderLineItem} in main currency in order to refund all non voided tender line items from thetransaction assigned to the session. Before any action it is also verified that the given transaction identifier in therequest matches the transaction identifier from the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link CashRefundRequest} object. ComGkSoftwarePosApiServiceTransactionCashRefundRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session or the transaction identifiers does not match.

2.33.84. posTransactionService.registerEmptiesTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/registerEmptiesTransaction

Retrieves and registers an empties return transaction.

Description

Retrieves and registers an empties return transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link RegisterEmptiesTransactionRequest} ComGkSoftwarePosApiServiceTransactionRegisterEmptiesTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionRegisterEmptiesTransactionResult

500

In case of an error during retrieve of the empties return transaction or an invalid state.

2.33.85. posTransactionService.registerScaleTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/registerScaleTransaction

Retrieves and registers a scale transaction.

Description

Retrieves and registers a scale transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link RegisterScaleTransactionRequest} ComGkSoftwarePosApiServiceTransactionRegisterScaleTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionRegisterScaleTransactionResult

500

In case of an error during retrieve of the scale transaction or an invalid state.

2.33.86. posTransactionService.removeBinaryDataFromTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/removeBinaryDataFromTransaction

Removes all binary data from transaction related to the given name

Description

Removes all binary data from transaction related to the given name

Parameters
Body Parameter
Name Description Required Default Pattern

body

name to be removed [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.33.87. posTransactionService.removeBrokenTenderAuthorizations

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/removeBrokenTenderAuthorizations

Removes broken tender authorizations.

Description

Removes broken tender authorizations. This is the case if TenderLineItemSequenceNumber is null.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.33.88. posTransactionService.removeExtensionsFromAllSaleReturnLineItems

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/removeExtensionsFromAllSaleReturnLineItems

Removes all extensions with given keys from all sale return line items contained in current session’s transaction.

Description

Removes all extensions with given keys from all sale return line items contained in current session’s transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

Object containing the keys of extensions to be removed and a storeTransaction flag, which can be used for persisting the transaction after the extensions are removed. ComGkSoftwarePosApiServiceTransactionRemoveSaleReturnLineItemExtensionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if transaction does not exist in current session or requested transaction storage fails.

2.33.89. posTransactionService.removeTransactionAdditionalPrintouts

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/removeTransactionAdditionalPrintouts

Removes transaction additional printouts.

Description

Removes transaction additional printouts.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link RemoveTransactionAdditionalPrintoutsRequest} object. ComGkSoftwarePosApiServiceTransactionRemoveTransactionAdditionalPrintoutsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.90. posTransactionService.removeTransactionExtensionFromTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/removeTransactionExtensionFromTransaction

Removes the given transaction extension from the transaction assigned to the session.

Description

Removes the given transaction extension from the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The key from the transaction extension to be removed from the transaction. [String]

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.91. posTransactionService.removeTransactionExtensionFromTransaction_1

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/removeTransactionExtensionFromTransactionRequest

Removes the given transaction extension from the transaction referred to by the id.

Description

Removes the given transaction extension from the transaction referred to by the id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RemoveTransactionExtensionRequest object. ComGkSoftwarePosApiServiceTransactionRemoveTransactionExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the transaction cannot be found.

2.33.92. posTransactionService.reopenLastScaleTransactionForActiveOperator

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/reopenLastScaleTransactionForActiveOperator

Reopen last scale transaction for active operator.

Description

Reopen last scale transaction for active operator.

Parameters
Body Parameter
Name Description Required Default Pattern

body

Transaction search request details ComGkSoftwarePosApiServiceTransactionSearchRetailTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If transaction cannot be open.

2.33.93. posTransactionService.retrieveSuspendedRetailTransactionsByIds

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/retrieveSuspendedRetailTransactionsByIds

Retrieves suspended transactions for the given list of transaction identifiers.

Description

Retrieves suspended transactions for the given list of transaction identifiers.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link RetrieveSuspendedRetailTransactionsByIdsRequest} object. ComGkSoftwarePosApiServiceTransactionRetrieveSuspendedRetailTransactionsByIdsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If suspended transactions cannot be found.

2.33.94. posTransactionService.retrieveTransactionFromConvertedSuspendCodes

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/retrieveTransactionFromConvertedSuspendCodes

Retrieves transaction from converted suspend codes.

Description

Retrieves transaction from converted suspend codes.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The RetrieveTransactionFromSuspendCodeRequest object. ComGkSoftwarePosApiServiceTransactionRetrieveTransactionFromSuspendCodeRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionConvertSuspendCodesResponse

500

In case an error occurs.

2.33.95. posTransactionService.returnLineItemsWithTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/returnLineItemsWithTransaction

Returns a list of line items of a given transaction and adds according return line items to current transaction.

Description

Returns a list of line items of a given transaction and adds according return line items to current transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link ReturnLineItemBulkRequest} object. ComGkSoftwarePosApiServiceTransactionReturnLineItemBulkRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If a line item cannot be returned or the transaction cannot be found.

2.33.96. posTransactionService.returnTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/returnTransaction

Returns all line items of the given transaction and adds according return line items to this transaction.

Description

Returns all line items of the given transaction and adds according return line items to this transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link ReturnTransactionRequest} object. ComGkSoftwarePosApiServiceTransactionReturnTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the transaction cannot be returned or found.

2.33.97. posTransactionService.returnTransactionWithTempSession

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/returnTransactionWithTempSession

Returns one or more items of a given transaction, or the complete transaction depending on the provided data.

Description

Returns one or more items of a given transaction, or the complete transaction depending on the provided data.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link ReturnTransactionWithTempSessionRequest} object. ComGkSoftwarePosApiServiceTransactionReturnTransactionWithTempSessionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the transaction cannot be returned or found.

2.33.98. posTransactionService.searchAndRetrieveSuspendedRetailTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchAndRetrieveSuspendedRetailTransactions

Searches and retrieves suspended transactions that matches the given criteria.

Description

Searches and retrieves suspended transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SearchAndRetrieveSuspendedRetailTransactionsRequest} object. ComGkSoftwarePosApiServiceTransactionSearchAndRetrieveSuspendedRetailTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If suspended transactions cannot be found.

2.33.99. posTransactionService.searchCustomerTransactionViews

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchCustomerTransactionViews

Searches for the customer transactions that matches the given criteria.

Description

Searches for the customer transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SearchCustomerTransactionsRequest} object ComGkSoftwarePosApiServiceTransactionSearchCustomerTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionSearchViewsResult

2.33.100. posTransactionService.searchCustomerTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchCustomerTransactions

Searches for customer transactions that matches the given criteria.

Description

Searches for customer transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SearchCustomerTransactionsRequest} object. ComGkSoftwarePosApiServiceTransactionSearchCustomerTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionIdsResult

500

If customer transactions cannot be found.

2.33.101. posTransactionService.searchDuplicatePrintTransactionSearchViews

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchDuplicatePrintTransactionSearchViews

Searches for the duplicate print out transactions that matches the given criteria.

Description

Searches for the duplicate print out transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

request ComGkSoftwarePosApiServiceTransactionDuplicatePrintOutTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionSearchViewsResult

500

If printout transactions cannot be found.

2.33.102. posTransactionService.searchLastFinalizedRetailTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchLastFinalizedRetailTransaction

Searches for last finalized retail transaction.

Description

Searches for last finalized retail transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SearchLastFinalizedRetailTransactionRequest object. ComGkSoftwarePosApiServiceTransactionSearchLastFinalizedRetailTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If no single matching transaction can be found.

2.33.103. posTransactionService.searchLastTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchLastTransaction

Searches for last transaction that matches given criteria.

Description

Searches for last transaction that matches given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SearchRetailTransactionRequest object. ComGkSoftwarePosApiServiceTransactionSearchRetailTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If no single matching transaction can be found.

2.33.104. posTransactionService.searchLastTransactionId

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchLastTransactionId

Searches for last transaction that matches given criteria.

Description

Searches for last transaction that matches given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SearchRetailTransactionRequest object. ComGkSoftwarePosApiServiceTransactionSearchRetailTransactionRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

If no single matching transaction identifier can be found.

2.33.105. posTransactionService.searchLastUnfinishedRetailTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchLastUnfinishedRetailTransaction

Searches for last unfinished retail transaction.

Description

Searches for last unfinished retail transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SearchLastUnfinishedRetailTransactionRequest object. ComGkSoftwarePosApiServiceTransactionSearchLastUnfinishedRetailTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If no single matching transaction can be found.

2.33.106. posTransactionService.searchPrintOutTransactionSearchViews

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchPrintOutTransactionSearchViews

Searches for printout transactions that matches the given criteria.

Description

Searches for printout transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PrintOutTransactionsRequest} object. ComGkSoftwarePosApiServiceTransactionPrintOutTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionSearchViewsResult

500

If printout transactions cannot be found.

2.33.107. posTransactionService.searchSingleFinishedRetailTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchSingleFinishedRetailTransaction

Searches for single transaction that matches given criteria.

Description

Searches for single transaction that matches given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SearchRetailTransactionRequest object. ComGkSoftwarePosApiServiceTransactionSearchRetailTransactionRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If no single matching transaction can be found.

2.33.108. posTransactionService.searchSingleFinishedRetailTransactionId

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchSingleFinishedRetailTransactionId

Searches for single transaction that matches given criteria.

Description

Searches for single transaction that matches given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SearchRetailTransactionRequest object. ComGkSoftwarePosApiServiceTransactionSearchRetailTransactionRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[String]

500

If no single matching transaction can be found.

2.33.109. posTransactionService.searchSuspendedTransactionSearchViews

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchSuspendedTransactionSearchViews

Searches for the suspended transactions that matches the given criteria.

Description

Searches for the suspended transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SearchSuspendedTransactionsRequest} object. ComGkSoftwarePosApiServiceTransactionSearchSuspendedTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionSearchViewsResult

500

If no suspended transaction was found.

2.33.110. posTransactionService.searchSuspendedTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchSuspendedTransactions

Searches for the suspended transactions that matches the given criteria.

Description

Searches for the suspended transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SearchSuspendedTransactionsRequest} object. ComGkSoftwarePosApiServiceTransactionSearchSuspendedTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionIdsResult

500

If no matching suspended transaction exists.

2.33.111. posTransactionService.searchUnfinishedTransactions

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/searchUnfinishedTransactions

Searches for the unfinished transactions that matches the given criteria.

Description

Searches for the unfinished transactions that matches the given criteria.

Parameters
Body Parameter
Name Description Required Default Pattern

body

unfinishedTransactionsRequest ComGkSoftwarePosApiServiceTransactionUnfinishedTransactionsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionIdsResult

500

If no matching transaction exists.

2.33.112. posTransactionService.setCustomFields

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/setCustomFields

Set transaction custom field (e.g. XXCustom01) values on the transaction which is associated to the session.

Description

Set transaction custom field (e.g. XXCustom01) values on the transaction which is associated to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SetTransactionCustomFieldsRequest with the custom field values. ComGkSoftwarePosApiServiceTransactionSetTransactionCustomFieldsRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

Only in case of an unexpected error.

2.33.113. posTransactionService.setFiscalReceiptNumber

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/setFiscalReceiptNumber

Sets the fiscal receipt number to the current transaction.

Description

Sets the fiscal receipt number to the current transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SetFiscalReceiptNumberRequest} object. ComGkSoftwarePosApiServiceTransactionSetFiscalReceiptNumberRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the transaction cannot be found.

2.33.114. posTransactionService.setInvoicePrintoutTypeCode

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/setInvoicePrintoutTypeCode

Sets the invoice printout type code to the transaction assigned to the session.

Description

Sets the invoice printout type code to the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link InvoicePrintoutTypeCodeRequest} object. ComGkSoftwarePosApiServiceTransactionInvoicePrintoutTypeCodeRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.115. posTransactionService.setPrintoutRelatedAttributes

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/setPrintoutRelatedAttributes

Sets the printout related attributes to the transaction assigned to the session.

Description

Sets the printout related attributes to the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PrintoutRelatedAttributesRequest} object. ComGkSoftwarePosApiServiceTransactionPrintoutRelatedAttributesRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.116. posTransactionService.setSuspendedLineItemsNotEditable

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/setSuspendedLineItemsNotEditable

Add extension (non editable) to the suspended line items on the transaction.

Description

Add extension (non editable) to the suspended line items on the transaction.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case an error occurs.

2.33.117. posTransactionService.setTransactionEndAttributes

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/setTransactionEndWorkstationId

Sets transaction end attributes for a transaction.

Description

Sets transaction end attributes for a transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SetTransactionEndAttributesRequest} object. It must have at least a filled transaction identifier and a workstation identifier. ComGkSoftwarePosApiServiceTransactionSetTransactionEndAttributesRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the request contains illegal arguments or if there is no transaction for the given identifier.

2.33.118. posTransactionService.setTransactionExtension

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/setTransactionExtension

Adds the given transaction extension to the transaction assigned to the session. If it is already existing, then the

Description

Adds the given transaction extension to the transaction assigned to the session. If it is already existing, then thetransaction extension is updated.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The AddTransactionExtensionsRequest object. ComGkSoftwarePosApiServiceTransactionAddTransactionExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.119. posTransactionService.setTransactionReason

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/setTransactionReason

Sets the reason data to a transaction. If there is no transaction identifier given, then the transaction assigned to the

Description

Sets the reason data to a transaction. If there is no transaction identifier given, then the transaction assigned to thesession is used.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link SetTransactionReasonRequest} object. ComGkSoftwarePosApiServiceTransactionSetTransactionReasonRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.33.120. posTransactionService.storeDriveOffDataToTransactionExtension

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/storeDriveOffDataToTransactionExtension

Store transaction extension based on its key attribute.

Description

Store transaction extension based on its key attribute.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link DriveOffDataRequest} object. ComGkSoftwarePosApiServiceFuelDriveOffDataRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

If it was not possible to store the transaction extension.

2.33.121. posTransactionService.storeTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/storeTransaction

Stores the current active {@link RetailTransaction} associated with the session.

Description

Stores the current active {@link RetailTransaction} associated with the session.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

If there is no transaction assigned to the session.

2.33.122. posTransactionService.suspendTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/suspendTransaction

Suspends an uncompleted transaction which is associated to the session.

Description

Suspends an uncompleted transaction which is associated to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The SuspendTransactionRequest ComGkSoftwarePosApiServiceTransactionSuspendTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If no transaction is assigned to session

2.33.123. posTransactionService.updateTaxGroupRelatedAttributes

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/updateTaxGroupRelatedAttributes

Updates the tax group related attributes on all line items of the transaction assigned to the session, dependent on the

Description

Updates the tax group related attributes on all line items of the transaction assigned to the session, dependent on thecurrent {@link AlternativeTaxInfos}s and maybe performs tax recalculation.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link AlternativeTaxRequest} object. ComGkSoftwarePosApiServiceTransactionAlternativeTaxRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.124. posTransactionService.updateTransactionCorrelations

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/updateTransactionCorrelations

Updates transaction correlations from the transaction assigned to the session.

Description

Updates transaction correlations from the transaction assigned to the session.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.125. posTransactionService.updateTransactionExtensionFromTransaction

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/updateTransactionExtensionFromTransaction

Updates the given transaction extension from the transaction assigned to the session.

Description

Updates the given transaction extension from the transaction assigned to the session.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The UpdateTransactionExtensionRequest object. ComGkSoftwarePosApiServiceTransactionUpdateTransactionExtensionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If there is no transaction assigned to the session.

2.33.126. posTransactionService.voidTransactionConsolidateCashInMainCurrency

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/voidTransactionConsolidateCashInMainCurrency

Consolidate cash tender line items in main currency and maybe add additional cashRefundAmount. Cash refund is the sum…​

Description

Consolidate cash tender line items in main currency and maybe add additional cashRefundAmount. Cash refund is the sum of allpayments (e.g. by terminal or points), where voiding was not possible anymore. The amount is then refunded in cash.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The VoidTransactionConsolidateCashInMainCurrencyRequest ComGkSoftwarePosApiServiceTransactionVoidTransactionConsolidateCashInMainCurrencyRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case that the voiding fails for any reason.

2.33.127. recoverTransactionById

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/recoverTransactionById

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

PosTransaction

2.33.128. returnWithTransactionService.isReturnableForRestrictionTypeCodes

POST /com.gk_software.pos.api.service.transaction.PosTransactionService/isReturnableForRestrictionTypeCodes

Determines whether the transaction is returnable, given the restriction type codes.

Description

Determines whether the transaction is returnable, given the restriction type codes. It is expected that the {@link com.gk_software.pos.api.model.config.process.flows.ReturnTenderRule} has been checked, and special tender handling should be performed. The restriction type codes are used to find matching tenders from the given {@link Transaction}. Return rules are used to determine whether there are any valid return tenders.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The ReturnableForRestrictionTypeCodesRequest object ComGkSoftwarePosApiServiceTransactionReturnableForRestrictionTypeCodesRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

2.34. PrepaidCreditTransactionService

2.34.1. prepaidCreditTransactionService.addPrepaidLineItems

POST /com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditTransactionService/addPrepaidLineItems

Adds a list of failed prepaid line items to the return receipt for refunding.

Description

Adds a list of failed prepaid line items to the return receipt for refunding.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PrepaidCreditRefundRequest containing all data for refunding the prepaid line items. ComGkSoftwarePosApiServiceTransactionPrepaidPrepaidCreditRefundRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

In case of any error

2.34.2. prepaidCreditTransactionService.createAndAddPrepaidCreditLineItem

POST /com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditTransactionService/createAndAddPrepaidCreditLineItem

Creates a line item for prepaid credit sale.

Description

Creates a line item for prepaid credit sale.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PrepaidCreditSaleRegistrationRequest containing all data for prepaid credit sale ComGkSoftwarePosApiServiceTransactionPrepaidPrepaidCreditSaleRegistrationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the line item cannot be registered

2.34.3. prepaidCreditTransactionService.updatePrepaidItem

POST /com.gk_software.pos.api.service.transaction.prepaid.PrepaidCreditTransactionService/updatePrepaidItem

Updates a line item for prepaid credit sale.

Description

Updates a line item for prepaid credit sale.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The PrepaidCreditSaleUpdateRequest containing all data for updating the prepaid credit sale line item. ComGkSoftwarePosApiServiceTransactionPrepaidPrepaidCreditSaleUpdateRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

If the line item cannot be updated

2.35. PricingService

2.35.1. pricingService.recalculateTransaction

POST /com.gk_software.pos.api.service.promotion.PricingService/recalculateTransaction

Recalculates whole transaction, all relevant data are passed to LE or PE (depending on configuration) and result is applied to transaction.

Description

Recalculates whole transaction, all relevant data are passed to LE or PE (depending on configuration) and result is applied to transaction.
Additionally depending on what interceptor is configured for the service, either PricingServiceMasterDataInterceptor or PricingServiceMasterDataInterceptorPCEOptimized, the loading of items from master data will be handled differently.
PricingServiceMasterDataInterceptor: All items in the request will be loaded from SDC.
PricingServiceMasterDataInterceptorPCEOptimized: Only items that are missing the actual unit price or that have no merchandise hirearchy groups will be loaded from SDC.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The Transaction to process. ComGkSoftwareGkrApiTxpoolDtoTransaction

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

in case of any error.

2.36. PromotionTriggerService

2.36.1. promotionTriggerService.addLineItemPromotionTrigger

POST /com.gk_software.pos.api.service.promotion.PromotionTriggerService/addLineItemPromotionTrigger

Adds a promotion trigger to a line item (manual line item discount).

Description

Adds a promotion trigger to a line item (manual line item discount).If no transaction exists in the current session, a new one is created with a new line item containing the requested promotion trigger. Otherwise, the current session transaction is updated.
The line item to which a promotion trigger is applied is referenced by the line item key sent in the service request.
If the line item key is not provided and there is an open line item, the open line item is used for inserting the new trigger.If the line item key is not provided and there is no open line item, or the provided line item key can not be found, a new line item is created and the promotion trigger added to it.
The promotion trigger is always applied to a main line item. That means the main line item for an item is usedif the line item key present in the request relates to a linked item.After the promotion trigger is added to the line item, it is checked whether the discount has been correctly applied.If for some reason the discount has not been applied, the trigger is removed from the line item and the error (LINE_PROMOTION_TRIGGER__TRIGGER_NOT_APPLIED) will be described in the result object in the failure field.
If the discount is successfully processed, a SaleReturnLineItemExtension with key MAX_REBATE_QUANTITY key is added to the line item containing the maximum allowed quantity for the line item.Finally, the transaction is recalculated and the active customer id and the active customer order sequence number are stored in the line item, if set in the request,and the updated transaction is stored.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request for applying a promotion trigger to the line item. ComGkSoftwarePosApiServicePromotionPromotionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.36.2. promotionTriggerService.addTransactionPromotionTrigger

POST /com.gk_software.pos.api.service.promotion.PromotionTriggerService/addTransactionPromotionTrigger

Adds a promotion trigger at transaction level (manual receipt discount) to the current session transaction, or to a n…​

Description

Adds a promotion trigger at transaction level (manual receipt discount) to the current session transaction, or to a new transaction if current session has no transaction.The transaction is then recalculated and stored.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The promotion request containing all information necessary for adding the promotion trigger to the transaction. ComGkSoftwarePosApiServicePromotionPromotionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if an unexpected error occurs.

2.36.3. promotionTriggerService.processPromotionInputValues

POST /com.gk_software.pos.api.service.promotion.PromotionTriggerService/processPromotionInputValues

Processes promotion input values entered by operator for manual promotion triggers and creates new promotion triggers.

Description

Processes promotion input values entered by operator for manual promotion triggers and creates new promotion triggers.This service can be used for processing triggers at both transaction and line item level.If line item is set in the request, the trigger for a line item is processed, otherwise, the trigger for the transactionwill be processed.The transaction is then recalculated and stored.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request for processing promotion input values entered by operator. PromotionInputResponse

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.36.4. promotionTriggerService.providePromotionInputRequestList

POST /com.gk_software.pos.api.service.promotion.PromotionTriggerService/providePromotionInputRequestList

Removes current promotion input requests from line item with given line item key, or current transaction (if line ite…​

Description

Removes current promotion input requests from line item with given line item key, or current transaction (if line item is not set in the request)and retrieves new promotion input requests for operator.
The transaction is then recalculated and stored.
Note: The pricing engine (PE) does not support this call and will never return a promotion input list for an operator through this call.This call is currently only used for supporting loyalty engine (LE).

Parameters
Body Parameter
Name Description Required Default Pattern

body

The key corresponding to a line item for which the promotion input requests should be retrieved for. This field is optional and if not provided the service will provide promotion input requests for complete transaction. ComGkSoftwarePosApiModelDomAppServicesTransactionRetailTransactionLineItemKey

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

2.36.5. promotionTriggerService.removeLineItemPromotionTriggers

POST /com.gk_software.pos.api.service.promotion.PromotionTriggerService/removeLineItemPromotionTriggers

Removes all promotion triggers from a line item (manual line item discounts), only if the line item is still open.

Description

Removes all promotion triggers from a line item (manual line item discounts), only if the line item is still open.If a line item key is provided in the request, the service will check the promotion triggers of the specified line item.Otherwise, the last open line item is used, if any exists. If a promotion trigger is removed, the transaction is recalculated and stored.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request object for removing promotion triggers for a line item. ComGkSoftwarePosApiServicePromotionPromotionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if any unexpected error occurs.

2.36.6. promotionTriggerService.removeTransactionPromotionTriggers

POST /com.gk_software.pos.api.service.promotion.PromotionTriggerService/removeTransactionPromotionTriggers

Removes all promotion triggers at transaction level (manual receipt discounts), if any exists.

Description

Removes all promotion triggers at transaction level (manual receipt discounts), if any exists.The transaction is then recalculated and stored.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

The exception is thrown if any unexpected error occurs.

2.36.7. promotionTriggerService.validateLineItemPromotionTriggers

POST /com.gk_software.pos.api.service.promotion.PromotionTriggerService/validateLineItemPromotionTriggers

Validates current promotion triggers on line item provided by request (manual line item discounts).

Description

Validates current promotion triggers on line item provided by request (manual line item discounts).
A promotion trigger validation consists of:

  • check if the line item can contain discounts

  • check if number of promotion triggers do not exceed configured maximum number of promotions with the same trigger value.

  • check if price change is allowed (in case a new price is requested).

  • check if price deviation is allowed with configured price deviation type.

  • check whether deduction limit is exceeded

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request object containing all information necessary for validating promotion triggers on a specific line item. ComGkSoftwarePosApiServicePromotionPromotionTriggerValidationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PromotionValidationResultType

500

The validation exception is thrown for the following validation errors:

  • Line item not found ({@link ErrorCodes#LINE_PROMOTION_TRIGGER__LINE_ITEM_NOT_FOUND})

  • Number of triggers exceeded ({@link ErrorCodes#LINE_PROMOTION_TRIGGER__TOO_MANY_TRIGGERS})

  • Zero price is not allowed ({@link ErrorCodes.LINE_PROMOTION_TRIGGER__ZERO_PRICE_NOT_ALLOWED})

  • Price change is prohibited ({@link ErrorCodes#LINE_PROMOTION_TRIGGER__PRICE_CHANGE_NOT_ALLOWED})

  • Higher price is not allowed ({@link ErrorCodes#LINE_PROMOTION_TRIGGER__HIGHER_PRICE_NOT_ALLOWED})

  • Lower price is not allowed ({@link ErrorCodes#LINE_PROMOTION_TRIGGER__LOWER_PRICE_NOT_ALLOWED})

2.36.8. promotionTriggerService.validateTransactionPromotionTriggers

POST /com.gk_software.pos.api.service.promotion.PromotionTriggerService/validateTransactionPromotionTriggers

Validates promotion triggers from current transaction at transaction level (manual receipt discounts).

Description

Validates promotion triggers from current transaction at transaction level (manual receipt discounts).A transaction promotion trigger validation consists of:

  • check whether deduction limit is exceeded.

  • check if number of promotion triggers do not exceed configured maximum number of promotions with the same trigger value.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request object containing all information necessary for validating promotion triggers at transaction level. ComGkSoftwarePosApiServicePromotionPromotionTriggerValidationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PromotionValidationResultType

500

The validation exception is thrown for the following validation errors:

  • Number of triggers exceeded ({@link ErrorCodes#TRANSACTION_PROMOTION_TRIGGER__TOO_MANY_TRIGGERS})

2.37. RescanService

2.37.1. rescanService.copyExternalTransactionLineItemsFullRescan

POST /com.gk_software.pos.api.service.rescan.RescanService/copyExternalTransactionLineItemsFullRescan

This methods copies line items from retrieved customer transaction to the current transaction.

Description

This methods copies line items from retrieved customer transaction to the current transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The copyExternalTransactionLineItemsFullRescan request object ComGkSoftwarePosApiServiceRescanCopyExternalTransactionLineItemsFullRescanRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanCopyExternalTransactionLineItemsFullRescanResponse

500

In case that the operation fails for any reason

2.37.2. rescanService.copyGiftCertificateLineItemFullRescan

POST /com.gk_software.pos.api.service.rescan.RescanService/copyGiftCertificateLineItemFullRescan

This methods copies a gift certificate line item from retrieved customer transaction to the current transaction.

Description

This methods copies a gift certificate line item from retrieved customer transaction to the current transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The copyGiftCertificateLineItemFullRescan request object ComGkSoftwarePosApiServiceRescanCopyGiftCertificateLineItemFullRescanRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanCopyGiftCertificateLineItemFullRescanResponse

500

In case that the operation fails for any reason

2.37.3. rescanService.executeRescanAnalysis

POST /com.gk_software.pos.api.service.rescan.RescanService/executeRescanAnalysis

Executes the rescan analysis and adds the result to the transaction.

Description

Executes the rescan analysis and adds the result to the transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The executeRescanAnalysis request object ComGkSoftwarePosApiServiceRescanExecuteRescanAnalysisRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanExecuteRescanAnalysisResponse

500

In case that the operation fails for any reason

2.37.4. rescanService.finishFullRescan

POST /com.gk_software.pos.api.service.rescan.RescanService/finishFullRescan

This method will execute the finish steps for the full rescan.

Description

This method will execute the finish steps for the full rescan.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The finishFullRescan request object ComGkSoftwarePosApiServiceRescanFinishFullRescanRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanFinishFullRescanResponse

500

In case that the operation fails for any reason

2.37.5. rescanService.finishPartialRescan

POST /com.gk_software.pos.api.service.rescan.RescanService/finishPartialRescan

This method will execute the finish steps for the partial rescan.

Description

This method will execute the finish steps for the partial rescan.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The finishPartialRescan request object ComGkSoftwarePosApiServiceRescanFinishPartialRescanRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanFinishPartialRescanResponse

500

In case that the operation fails for any reason

2.37.6. rescanService.prepareFullRescan

POST /com.gk_software.pos.api.service.rescan.RescanService/prepareFullRescan

Prepares various objects in the POS Session to be ready for a full rescan.

Description

Prepares various objects in the POS Session to be ready for a full rescan.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The prepareFullRescan request object ComGkSoftwarePosApiServiceRescanPrepareFullRescanRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanPrepareFullRescanResponse

500

In case that the operation fails for any reason

2.37.7. rescanService.preparePartialRescan

POST /com.gk_software.pos.api.service.rescan.RescanService/preparePartialRescan

Prepares various objects in the POS Session to be ready for a partial rescan.

Description

Prepares various objects in the POS Session to be ready for a partial rescan.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The preparePartialRescan request object ComGkSoftwarePosApiServiceRescanPreparePartialRescanRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanPreparePartialRescanResponse

500

In case that the operation fails for any reason

2.37.8. rescanService.processBarcodePartialRescan

POST /com.gk_software.pos.api.service.rescan.RescanService/processBarcodePartialRescan

This methods performs the barcode processing for partial rescan.

Description

This methods performs the barcode processing for partial rescan.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The processBarcodePartialRescan request object ComGkSoftwarePosApiServiceRescanProcessBarcodePartialRescanRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanProcessBarcodePartialRescanResponse

500

In case that the operation fails for any reason

2.37.9. rescanService.suspendAndRetrieveRescanTransaction

POST /com.gk_software.pos.api.service.rescan.RescanService/suspendAndRetrieveRescanTransaction

Suspends the current transaction and retrieves it to a new transaction.

Description

Suspends the current transaction and retrieves it to a new transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The suspendAndRetrieveRescanTransaction request object ComGkSoftwarePosApiServiceRescanSuspendAndRetrieveRescanTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceRescanSuspendAndRetrieveRescanTransactionResponse

500

In case that the operation fails for any reason

2.37.10. rescanService.validateQuantityPartialRescan

POST /com.gk_software.pos.api.service.rescan.RescanService/validateQuantityPartialRescan

This method will execute the quantity validation for the last sale return line item.

Description

This method will execute the quantity validation for the last sale return line item.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The validateQuantityPartialRescan request object ComGkSoftwarePosApiServiceRescanValidateQuantityPartialRescanRequest

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

In case that the operation fails for any reason

2.38. SalesOrderBasicWebService

2.38.1. salesOrderBasicWebService.getSalesOrders

POST /com.gk_software.pos.api.service.communication.ws.sales_order_basic.SalesOrderBasicWebService/getSalesOrders

Searches sales orders in ERP system with given parameters.

Description

Searches sales orders in ERP system with given parameters. The search is able to retrieve sales orders for multiple customers, and also to filter it by state (only open or all of them).In addition, it is also possible to limit the number of results.

Parameters
Body Parameter
Name Description Required Default Pattern

body

Sales order search request. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderBasicSalesOrdersRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceCommunicationWsSalesOrderBasicSalesOrdersResult

2.39. SalesOrderByIdV3WebService

2.39.1. salesOrderByIdV3WebService.getOrderById

POST /com.gk_software.pos.api.service.communication.ws.sales_order_by_id.SalesOrderByIdV3WebService/getOrderById

Returns details of a customer sales order in SAP ERP (a so-called \"SD sales order\") by sales order number search.

Description

Returns details of a customer sales order in SAP ERP (a so-called \"SD sales order\") by sales order number search.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The sales order request containing the sales order number and web service configuration. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderByIdSalesOrderByIdV3Request

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCommunicationWsSalesOrderByIdSalesOrderByIdV3Result

500

An exception is thrown if a sales order is not found or an unexpected error occurred (i.e.: web service is not reachable).

2.40. SalesOrderChangeRequestConfirmationWebService

2.40.1. salesOrderChangeRequestConfirmationWebService.requestChangeSalesOrderConfirmation

POST /com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.SalesOrderChangeRequestConfirmationWebService/requestChangeSalesOrderConfirmation

Creates a sales order change confirmation.

Description

Creates a sales order change confirmation.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request for sales order change confirmation. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesSalesOrderChangeConfirmationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesSalesOrderChangeConfirmationResult

500

An exception is thrown if an unexpected error occurs (i.e.: web service connection fails or sales order is not found).

2.40.2. salesOrderChangeRequestConfirmationWebService.requestVoidItemsSalesOrderConfirmation

POST /com.gk_software.pos.api.service.communication.ws.sales_order_change_request_confirmation.SalesOrderChangeRequestConfirmationWebService/requestVoidItemsSalesOrderConfirmation

Requests a sales order change confirmation for voiding line items from existing sales order change request.

Description

Requests a sales order change confirmation for voiding line items from existing sales order change request.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The sales order change request. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesSalesOrderChangeConfirmationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesSalesOrderChangeConfirmationResult

500

An exception is thrown if an unexpected error occurs (i.e.: web service connection fails or sales order is not found).

2.41. SalesOrderCreateCheckWebService

2.41.1. salesOrderCreateCheckWebService.createScopedTxForDeliveryOptionSelection

POST /com.gk_software.pos.api.service.communication.ws.sales_order_create_check.SalesOrderCreateCheckWebService/createScopedTxForDeliveryOptionSelection

Creates or updates a scoped transaction with given scope id by copying the customer list and

Description

Creates or updates a scoped transaction with given scope id by copying the customer list and line items eligible for sales order delivery from current session transaction.The scoped transaction is identified by provided scope id. A scope id is used for identifyinga specific scoped transaction as multiple scoped transactions may coexist in the same sessionfor different purposes.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The scope id used for transaction when an order delivery is selected. [String]

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

PosTransaction

500

The exception is thrown if an unexpected error occurs.

2.41.2. salesOrderCreateCheckWebService.launchValidationWsCall

POST /com.gk_software.pos.api.service.communication.ws.sales_order_create_check.SalesOrderCreateCheckWebService/launchValidationWsCall

This service performs a sales order validation in the ERP system.

Description

This service performs a sales order validation in the ERP system.The enterprise service allows to simulate a customer sales order in SAP ERP (a so-called \"SD sales order\").The service gives information about the availability of items for the entered delivery date (\"ATP check\" / ATP = availability to promise) and returns customer specific prices.The returned prices can then be compared with the results of the POS price calculation, and (depending on settings) a best price approach can be used.Similarly, any warning on the availability of items can be taken into account, before in the end a sales order is created.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The sales order data to be validated. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateCheckSalesOrderCreateCheckRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionSalesOrderCommonData

500

The exception is thrown if an unexpected error occurs (e.g.: web service is unavailable).

2.42. SalesOrderCreateRequestConfirmationWebService

2.42.1. salesOrderCreateRequestConfirmationWebService.requestCreateSalesOrderConfirmation

POST /com.gk_software.pos.api.service.communication.ws.sales_order_create_request_confirmation.SalesOrderCreateRequestConfirmationWebService/requestCreateSalesOrderConfirmation

Creates a sales order on the ERP system.

Description

Creates a sales order on the ERP system.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The sales order data. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesSalesOrderCreateConfirmationRequest

X

Content Type
  • application/json

2.43. SalesOrderSalesDocReadWebService

2.43.1. salesOrderSalesDocReadWebService.readOrderData

POST /com.gk_software.pos.api.service.communication.ws.sales_order_sales_doc_read.SalesOrderSalesDocReadWebService/readOrderData

Request to read data of a given sales order.

Description

Request to read data of a given sales order.

Parameters
Body Parameter
Name Description Required Default Pattern

body

the sales order data read request. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderSalesDocReadSalesOrderSalesDocReadRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceCommunicationWsSalesOrderSalesDocReadSalesOrderSalesDocReadResult

500

if an unexpected error occured during a sales order read process (eg.: connection failure with ERP service).

2.44. SalesOrderService

2.44.1. salesOrderService.addLineItemsToInitializedSalesOrders

POST /com.gk_software.pos.api.service.order.SalesOrderService/addLineItemsToInitializedSalesOrders

Sends one or more order change requests of existing initialized orders to SAP ERP with new items ordered by customer.

Description

Sends one or more order change requests of existing initialized orders to SAP ERP with new items ordered by customer.

Parameters
Body Parameter
Name Description Required Default Pattern

body

Map with change order requests for each sales order data. The map key consists of a TransactionExtension created for a sales order. The transaction extension value consists of sales order data grouped by a semi-column separator. Each sales order data field is part of an array of String, which possible indexes and contants can be seen in SalesOrderConstants. The map value must contain a SalesOrderChangeConfirmationRequest for correspondent sales order data key. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesSalesOrderChangeConfirmationRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

PosException if an unexpected exception occurs.

2.44.2. salesOrderService.updateSalesOrderDownPayments

POST /com.gk_software.pos.api.service.order.SalesOrderService/updateSalesOrderDownPayments

Update sales order down payments on the current session main transaction.

Description

Update sales order down payments on the current session main transaction.The update process consists of checking all current sales orders currently available in the transaction and voiding all down payments for one or more sales orders if the sum of down payments specific to this sales order is greater than the sales order amount and then a new down payment line item is created containing the sales order amount sum.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if an unexpected exception occurs.

2.45. SmartPOSMDReplicationStateProviderService

2.45.1. smartPOSMDReplicationStateProviderService.getLastReplicatedChangedEntityId

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/getLastReplicatedChangedEntityId

Gets the last replicated changed entity id.

Description

Gets the last replicated changed entity id.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.45.2. smartPOSMDReplicationStateProviderService.getLastReplicatedChangedEntityId_1

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderServiceDelegate/getLastReplicatedChangedEntityId

Gets the last replicated changed entity id.

Description

Gets the last replicated changed entity id.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.45.3. smartPOSMDReplicationStateProviderService.getMDReplicationEndEvent

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/getMDReplicationEndEvent

Gets the replication end event.

Description

Gets the replication end event.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceSmartposMDReplicationEndEvent

2.45.4. smartPOSMDReplicationStateProviderService.getMDReplicationEndEvent_2

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderServiceDelegate/getMDReplicationEndEvent

Gets the replication end event.

Description

Gets the replication end event.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceSmartposMDReplicationEndEvent

2.45.5. smartPOSMDReplicationStateProviderService.getMDReplicationProgressEvent

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/getMDReplicationProgressEvent

Gets the replication progress event.

Description

Gets the replication progress event.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceSmartposMDReplicationProgressEvent

2.45.6. smartPOSMDReplicationStateProviderService.getMDReplicationProgressEvent_3

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderServiceDelegate/getMDReplicationProgressEvent

Gets the replication progress event.

Description

Gets the replication progress event.

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwarePosApiServiceSmartposMDReplicationProgressEvent

2.45.7. smartPOSMDReplicationStateProviderService.isReplicationFinished

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/isReplicationFinished

Checks if replication is finished.

Description

Checks if replication is finished.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.45.8. smartPOSMDReplicationStateProviderService.isReplicationFinished_4

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderServiceDelegate/isReplicationFinished

Checks if replication is finished.

Description

Checks if replication is finished.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.45.9. smartPOSMDReplicationStateProviderService.isReplicationSucess

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderService/isReplicationSucess

Checks if replication finished with success.

Description

Checks if replication finished with success.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.45.10. smartPOSMDReplicationStateProviderService.isReplicationSucess_5

POST /com.gk_software.pos.api.service.smartpos.SmartPOSMDReplicationStateProviderServiceDelegate/isReplicationSucess

Checks if replication finished with success.

Description

Checks if replication finished with success.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[Boolean]

2.46. SmartPOSService

2.46.1. smartPOSService.checkAvailabilityAndCleanup

POST /com.gk_software.pos.api.service.smartpos.SmartPOSService/checkAvailabilityAndCleanup

This service is used for checking the availability of this service instance (ping) and performing

Description

This service is used for checking the availability of this service instance (ping) and performinga cleanup if necessary.The cleanup consists of updating offline keys if a main transaction is active as well as creatinga new {@link TransactionExtension} containing the timestamp of the service switch (OFFLINE if this is a slave service instance or ONLINE if this is the master service instance), and removal ofinvalid session if it exists. If an invalid session with an unfinished transaction exists, the transaction isalso deleted from database. Finally the last finalized transactions present in the request are storedin this service instance in order to guarantee updated sequence numbers and last transaction status.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request object contains the last finalized transactions to be stored in this service instancein order to avoid gaps and duplicates of sequence numbers, in addition to client current information in orderto remove invalid sessions. ComGkSoftwarePosApiServiceSmartposCheckAvailabilityAndCleanupRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if any unexpected error occurs during the process.

2.46.2. smartPOSService.checkAvailabilityAndCleanup_1

POST /com.gk_software.pos.api.service.smartpos.SmartPOSServiceDelegate/checkAvailabilityAndCleanup

This service is used for checking the availability of this service instance (ping) and performing

Description

This service is used for checking the availability of this service instance (ping) and performinga cleanup if necessary.The cleanup consists of updating offline keys if a main transaction is active as well as creatinga new {@link TransactionExtension} containing the timestamp of the service switch (OFFLINE if this is a slave service instance or ONLINE if this is the master service instance), and removal ofinvalid session if it exists. If an invalid session with an unfinished transaction exists, the transaction isalso deleted from database. Finally the last finalized transactions present in the request are storedin this service instance in order to guarantee updated sequence numbers and last transaction status.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The request object contains the last finalized transactions to be stored in this service instancein order to avoid gaps and duplicates of sequence numbers, in addition to client current information in orderto remove invalid sessions. ComGkSoftwarePosApiServiceSmartposCheckAvailabilityAndCleanupRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if any unexpected error occurs during the process.

2.46.3. smartPOSService.takeOverSession

POST /com.gk_software.pos.api.service.smartpos.SmartPOSService/takeOverSession

This service is used for transferring the current client session after communication with active service instance fails

Description

This service is used for transferring the current client session after communication with active service instance failsand client connects to a new smart pos service instance.

The session is transfered as follows:

  • It is checked if last finalized transaction either does not exist or exists but it is still not finalized in this service instance.This indicates that the transaction in current service instance database is not up to date and then the transaction is stored in this instance with complete information persisted at client.The last finalized retail transaction must always be compared with the last finalized transaction in order to make sure the last finalized retail transactionis also persisted in case the POS is abruptly stopped and the service switchoccurs during POS startup, and the last finalized transaction in this casewould be control transactions created by terminal, but we also need to storethe last finalized retail transaction properly in order to avoid an outdated unfinishedretail transaction to be recovered at the POS or avoid duplicated sequence numbers, if it has already been finalized before in a different service instance.

  • After we update the last finalized transactions, the session must be checked inthe new service instance. If a valid session already exists, it is reused, and its date is updatedwith current values from request (active and scoped transactions, session data and language settings,in addition to a new reference to the loyalty engine).If an invalid session exists, it is removed and any existing active unfinished main transaction is deleted,then a new session is created with values from request.Finally, if no session exists, a new one is created with values from request.

  • The transaction is recalculated in the loyalty engine.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The take over request contains all information necessary to update the transaction databaseand to restore the session at a new service instance. ComGkSoftwarePosApiServiceSmartposTakeOverSessionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if any unexpected error occurs during the process.

2.46.4. smartPOSService.takeOverSession_2

POST /com.gk_software.pos.api.service.smartpos.SmartPOSServiceDelegate/takeOverSession

This service is used for transferring the current client session after communication with active service instance fails

Description

This service is used for transferring the current client session after communication with active service instance failsand client connects to a new smart pos service instance.

The session is transfered as follows:

  • It is checked if last finalized transaction either does not exist or exists but it is still not finalized in this service instance.This indicates that the transaction in current service instance database is not up to date and then the transaction is stored in this instance with complete information persisted at client.The last finalized retail transaction must always be compared with the last finalized transaction in order to make sure the last finalized retail transactionis also persisted in case the POS is abruptly stopped and the service switchoccurs during POS startup, and the last finalized transaction in this casewould be control transactions created by terminal, but we also need to storethe last finalized retail transaction properly in order to avoid an outdated unfinishedretail transaction to be recovered at the POS or avoid duplicated sequence numbers, if it has already been finalized before in a different service instance.

  • After we update the last finalized transactions, the session must be checked inthe new service instance. If a valid session already exists, it is reused, and its date is updatedwith current values from request (active and scoped transactions, session data and language settings,in addition to a new reference to the loyalty engine).If an invalid session exists, it is removed and any existing active unfinished main transaction is deleted,then a new session is created with values from request.Finally, if no session exists, a new one is created with values from request.

  • The transaction is recalculated in the loyalty engine.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The take over request contains all information necessary to update the transaction databaseand to restore the session at a new service instance. ComGkSoftwarePosApiServiceSmartposTakeOverSessionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

if any unexpected error occurs during the process.

2.47. StockService

2.47.1. stockService.getStockInfo

POST /com.gk_software.pos.api.service.stock.StockService/getStockInfo

Silently retrieves item stock information from external service.

Description

Silently retrieves item stock information from external service.The current service implementation considers only the first item and the first store provided in the correspondent lists,and perform a query in the provided service URI. The current service implementation may return <code>null</code> if an error occurs(eg.: could not connect to service) and will not throw an exception in this case.

Parameters
Body Parameter
Name Description Required Default Pattern

body

provides information for item request on external service. See {@link StockServiceRequest}. ComGkSoftwarePosApiServiceStockStockServiceRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

ComGkSoftwareSweeSesApiServerCdDataProviderDtoSoStockAmountSO

2.48. StoredValueServerService

2.48.1. storedValueServerService.cancelGiftCertOnCurrentTransaction

POST /com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/cancelGiftCertOnCurrentTransaction

Service for canceling (voiding) a gift certificate from current session transaction.

Description

Service for canceling (voiding) a gift certificate from current session transaction.

Parameters
Body Parameter
Name Description Required Default Pattern

body

A request object containing the information required for canceling a gift certificate (see {@link GiftCertificateRequest}). ComGkSoftwarePosApiServiceStoredValueServerGiftCertificateRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiModelDomAppGiftCertificateServiceGiftCertServiceResult

500

An exception is throw if an error occurs during selling process (eg.: invalid gift certificate type is sent in the request).

2.48.2. storedValueServerService.cancelGiftCertTransaction

POST /com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/cancelGiftCertTransaction

Service for canceling (voiding) a gift certificate.

Description

Service for canceling (voiding) a gift certificate.

Parameters
Body Parameter
Name Description Required Default Pattern

body

A request object containing the information required for canceling a gift certificate (see {@link CancelGiftCertTransactionRequest}). ComGkSoftwarePosApiServiceStoredValueServerCancelGiftCertTransactionRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiModelDomAppGiftCertificateServiceGiftCertServiceResult

500

An exception is throw if an error occurs during selling process (eg.: invalid gift certificate type is sent in the request).

2.48.3. storedValueServerService.getGiftCertInfoList

POST /com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/getGiftCertInfoList

Queries gift certificate information on stored value server.

Description

Queries gift certificate information on stored value server.

Parameters
Body Parameter
Name Description Required Default Pattern

body

Request object containing information used for performing gift certificate query. ComGkSoftwarePosApiServiceStoredValueServerGiftCertificateRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

List[ComGkSoftwarePosApiModelDomAppGiftCertificateServiceGiftCertInfo]

2.48.4. storedValueServerService.payWithGiftCertificate

POST /com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/payWithGiftCertificate

Service for payment with a gift certificate.

Description

Service for payment with a gift certificate.

Parameters
Body Parameter
Name Description Required Default Pattern

body

A request object containing the information required for paying with a gift certificate (see {@link GiftCertificateRequest}). ComGkSoftwarePosApiServiceStoredValueServerGiftCertificateRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiModelDomAppGiftCertificateServiceGiftCertServiceResult

500

An exception is throw if an error occurs during selling process (eg.: invalid gift certificate type is sent in the request).

2.48.5. storedValueServerService.returnGiftCertificate

POST /com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/returnGiftCertificate

Service for returning a gift certificate according to request parameters.

Description

Service for returning a gift certificate according to request parameters.This service will delegate a call to proper service in stored value server depending on the gift certificate type.If a gift card ({@link StoredValueServer#TYPEGIFT_CARD}) is sent in the request, a debit operation is performed for reducing the current available amount on the gift card. Otherwise, if this is a gift certificate ({@link StoredValueServer#TYPEGIFT_CERT})or a promotion gift certificate ({@link StoredValueServer#TYPE__GC_BON}), a redeem request is sent to stored value server.

Parameters
Body Parameter
Name Description Required Default Pattern

body

A request object containing information required for returning a gift certificate (see {@link GiftCertificateRequest}). ComGkSoftwarePosApiServiceStoredValueServerGiftCertificateRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiModelDomAppGiftCertificateServiceGiftCertServiceResult

500

An exception is throw if an error occurs during selling process (eg.: invalid gift certificate type is sent in the request).

2.48.6. storedValueServerService.sellGiftCertificate

POST /com.gk_software.pos.api.service.stored_value_server.StoredValueServerService/sellGiftCertificate

Sells a gift certificate according to request parameters.

Description

Sells a gift certificate according to request parameters. This service will delegate a call to proper service in stored value server depending on the gift certificate type.If a gift card ({@link StoredValueServer#TYPEGIFT_CARD}) is sent in the request, a top up operation is performed. Else, if this is a gift certificate ({@link StoredValueServer#TYPEGIFT_CERT}), a sell operation is called.Finally, this is a promotion gift certificate ({@link StoredValueServer#TYPE__GC_BON}), a request for creation of gift certificate is sent to stored value server.

Parameters
Body Parameter
Name Description Required Default Pattern

body

giftCertificateRequest ComGkSoftwarePosApiServiceStoredValueServerGiftCertificateRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiModelDomAppGiftCertificateServiceGiftCertServiceResult

500

An exception is throw if an error occurs during selling process (eg.: invalid gift certificate type is sent in the request).

2.49. SubtotalService

2.49.1. subtotalService.processSubtotal

POST /com.gk_software.pos.api.service.subtotal.SubtotalService/processSubtotal

Process sub-total. During subtotal processing, taxes, promotions and transaction totals are calculated.

Description

Process sub-total. During subtotal processing, taxes, promotions and transaction totals are calculated.

Parameters
Body Parameter
Name Description Required Default Pattern

body

containing configuration for handling line item positions. ComGkSoftwarePosApiModelConfigProcessActionPositionOperationConfig

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

500

An exception is thrown if an unexpected error occurs (eg.: no valid tax authority rule for tax group ID exists)

2.49.2. subtotalService.processSubtotalCalculation

POST /com.gk_software.pos.api.service.subtotal.SubtotalService/processSubtotalCalculation

Process sub-total. During subtotal processing, taxes, promotions and transaction totals are calculated.

Description

Process sub-total. During subtotal processing, taxes, promotions and transaction totals are calculated.

Parameters
Body Parameter
Name Description Required Default Pattern

body

containing configuration for handling line item positions. ComGkSoftwarePosApiModelConfigProcessActionPositionOperationConfig

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTransactionSubtotalOperationResult

500

An exception is thrown if an unexpected error occurs (eg.: no valid tax authority rule for tax group ID exists)

2.50. SystemService

2.50.1. systemService.clearAllCaches

GET /com.gk_software.pos.api.service.system.SystemService/clearAllCaches

Clears all caches that may exist in service cache manager.

Description

Clears all caches that may exist in service cache manager.

Parameters
Return Type

-

Responses
Code Message Datatype

0

successful operation

2.50.2. systemService.commandProcessed

POST /com.gk_software.pos.api.service.system.SystemService/commandProcessed

Deletes a command for given key from server. Involves remote call to the server.

Description

Deletes a command for given key from server. Involves remote call to the server.This method should be used for confirming an execution of a command at client requested by server.

Parameters
Body Parameter
Name Description Required Default Pattern

body

{@link WorkstationCommand#Key} of command to be deleted from server. ComGkSoftwareGkrApiLoginManagerDtoWorkstationCommandKey

X

Return Type

-

Responses
Code Message Datatype

200

Success

500

if an error occurs during attempt to delete command from server (eg.: server is offline).

2.50.3. systemService.getApplicationInfo

GET /com.gk_software.pos.api.service.system.SystemService/applicationInfo

Get information about service application (version, revision, build number, jdk version and build date).

Description

Get information about service application (version, revision, build number, jdk version and build date).

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSystemApplicationInfo

500

thrown if an unexpected error occurs (current implementation should never throw it).

2.50.4. systemService.getPrdApplicationInfo

GET /com.gk_software.pos.api.service.system.SystemService/prdApplicationInfo

Get information about product service application (version, revision, build number, jdk version and build date).

Description

Get information about service application (version, revision, build number, jdk version and build date).

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSystemApplicationInfo

500

thrown if an unexpected error occurs (current implementation should never throw it).

2.50.5. systemService.getPrjApplicationInfo

GET /com.gk_software.pos.api.service.system.SystemService/prjApplicationInfo

Get information about project service application (version, revision, build number, jdk version and build date).

Description

Get information about project service application (version, revision, build number, jdk version and build date).

Parameters
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSystemApplicationInfo

500

thrown if an unexpected error occurs (current implementation should never throw it).

2.50.6. systemService.ping

POST /com.gk_software.pos.api.service.system.SystemService/ping

This service sends workstation status to POS-Server and retrieves any pending command for client execution.

Description

This service sends workstation status to POS-Server and retrieves any pending command for client execution.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link PingRequest} request object containing information from workstation. ComGkSoftwarePosApiServiceSystemPingRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceSystemPingResponse

500

if an error occurs during attempt to delete command from server (eg.: server is offline or business unit id is not found).

2.50.7. systemService.simplePing

POST /com.gk_software.pos.api.service.system.SystemService/simplePing

This service performs no action and can be used to simply check availability of services for heartbeat verification.

Description

This service performs no action and can be used to simply check availability of services for heartbeat verification.

Parameters
Return Type

-

Responses
Code Message Datatype

0

successful operation

2.50.8. systemService.whoami

GET /com.gk_software.pos.api.service.system.SystemService/whoami

Returns who is currently authenticated.

Description

Returns who is currently authenticated.This is just for OAuth2 implementation verification.TODO Should be eventually removed or replaced by something useful.

Parameters
Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

successful operation

[String]

2.51. TaxEngineService

2.51.1. taxEngineService.calculateTax

POST /com.gk_software.pos.api.service.taxengine.TaxEngineService/calculateTax

Calculates the taxes in the transaction, and applies the results to it. Also calculates retail transaction totals. Incoming transaction is expected to be populated with necessary fields for tax calculation, no backfilling of missing fields is performed.

Description

Calculates the taxes in the transaction, and applies the results to it. Also calculates retail transaction totals. Incoming transaction is expected to be populated with necessary fields for tax calculation, no backfilling of missing fields is performed.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The Transaction to process. ComGkSoftwareGkrApiTxpoolDtoTransaction

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwareGkrApiTxpoolDtoTransaction

500

in case of any error.

2.52. TillService

2.52.1. tillService.getAvailableTills

POST /com.gk_software.pos.api.service.till.TillService/getAvailableTills

Retrieves one till assigned to given business unit id and workstation id. If no till is found,

Description

Retrieves one till assigned to given business unit id and workstation id. If no till is found,another attempt is performed by searching tills assigned to given operator id and business unit id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

Request for retrieving available tills. See {@link TillRequest}. ComGkSoftwarePosApiServiceTillTillRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTillTillResponse

500

if some error occurs during the search process, for example, if given business unit id is not found.

2.52.2. tillService.getTillDOsByIds

POST /com.gk_software.pos.api.service.till.TillService/getTillDOsByIds

Gets the tillDOs for given TillIds.

Description

Gets the tillDOs for given TillIds.

Parameters
Body Parameter
Name Description Required Default Pattern

body

tillRequest ComGkSoftwarePosApiServiceTillTillRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTillTillResponse

500

in case of any error.

2.52.3. tillService.getTillTenderSummary

POST /com.gk_software.pos.api.service.till.TillService/getTillTenderSummary

Gets the till tender summary for given parameters

Description

Gets the till tender summary for given parameters

Parameters
Body Parameter
Name Description Required Default Pattern

body

request ComGkSoftwarePosApiServiceTillTillTenderSummaryRequest

X

Content Type
  • application/json

Responses
Code Message Datatype

200

Success

ComGkSoftwarePosApiServiceTillTillTenderSummaryResponse

500

in case of any error.

2.52.4. tillService.isOperatorTillCompatible

POST /com.gk_software.pos.api.service.till.TillService/isOperatorTillCompatible

Checks whether at least one of the tills provided in the request has a valid assignment

Description

Checks whether at least one of the tills provided in the request has a valid assignmenteither to the given workstation id and business unit id or to the given operator id and business unit id.

Parameters
Body Parameter
Name Description Required Default Pattern

body

The {@link TillRequest} containing a collection of tills to be verified for given business unit id, workstation id and operator id. ComGkSoftwarePosApiServiceTillTillRequest

X

Return Type
Content Type
  • application/json

Responses
Code Message Datatype

200

Success

[Boolean]

500

if an unexpected error occurs during the verification.

3. Models

3.1. ComGkSoftwareGkrApiEventchannelDtoEventLogMessageDO

EventLogMessageDO Represents one Event Log Message.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.eventchannel.dto.EventLogMessageDO.Key

created

X

String

Store wall time when the event has been created. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

createdUTC0

X

Date

UTC0 time when the event has been created. UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

type

X

String

Type of the event log.

subType

X

String

SubType of the event log.

level

X

String

Event log severity information.

application

X

String

Event’s origin application name.

stationID

String

StoreManager’s structure / station ID.

nodeID

X

String

Unique domain name or node identification in the cluster.

businessUnitGroupID

String

Business unit group identification.

operatorID

String

Operator identification.

payload

byte[]

Process specific payload.

byte

payloadDataID

String

Unique data identification in the payload. This identification must be unique across all the messages in the log.

processData01

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData02

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData03

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData04

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData05

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData06

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData07

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData08

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData09

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

processData10

String

Field for process specific data in the product. For example some information from the payload may be displayed here.

xid

String

Extension ID of the object

xxcustom03

String

Field for custom development.

xxcustom02

String

Field for custom development.

xxcustom05

String

Field for custom development.

xxcustom04

String

Field for custom development.

xxcustom01

String

Field for custom development.

xxcustom06

String

Field for custom development.

xxcustom07

String

Field for custom development.

xxcustom08

String

Field for custom development.

xxcustom09

String

Field for custom development.

xxcustom10

String

Field for custom development.

3.2. ComGkSoftwareGkrApiEventchannelDtoEventLogMessageDOKey

EventLogMessageDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

retailStoreID

X

String

Retail store ID, part of primary key

workstationID

X

String

WorkstationID, part of primary key

id

X

String

Unique Identifier (UUID) of the message

3.3. ComGkSoftwareGkrApiEventchannelDtoEventLogMessageSearchCriteria

EventLogMessageSearchCriteria Event log message search criteria

Field Name Required Type Description Format

createdFrom

String

Search for event log messages created from timestamp Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

createdTo

String

Search for event log messages created to timestamp Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

type

String

Search for type

subType

String

Search for particular subType

application

String

Search for particular application

level

String

Search for particular message level

retailStoreID

String

Search for particular retail store ID, equals condition

retailStoreIDList

List of [String]

Search for particular retail store IDs, in condition

businessUnitGroupID

String

Search for particular business unit group ID, equals condition

businessUnitGroupIDList

List of [String]

Search for particular business unit group IDs, in condition

stationID

String

Search for particular structure / station ID.

nodeID

String

Search for particular node ID.

operatorID

String

Search for particular operator ID.

workstationID

String

Search for particular workstation ID

payloadDataID

String

Search for particular payloadDataID

processData01

String

Search for particular processData field, equals condition

processData02

String

Search for particular processData field, equals condition

processData03

String

Search for particular processData field, equals condition

processData04

String

Search for particular processData field, equals condition

processData05

String

Search for particular processData field, equals condition

processData06

String

Search for particular processData field, equals condition

processData07

String

Search for particular processData field, equals condition

processData08

String

Search for particular processData field, equals condition

processData09

String

Search for particular processData field, equals condition

processData10

String

Search for particular processData field, equals condition

processData01List

List of [String]

Search for particular processData field, in condition

processData02List

List of [String]

Search for particular processData field, in condition

processData03List

List of [String]

Search for particular processData field, in condition

processData04List

List of [String]

Search for particular processData field, in condition

processData05List

List of [String]

Search for particular processData field, in condition

processData06List

List of [String]

Search for particular processData field, in condition

processData07List

List of [String]

Search for particular processData field, in condition

processData08List

List of [String]

Search for particular processData field, in condition

processData09List

List of [String]

Search for particular processData field, in condition

processData10List

List of [String]

Search for particular processData field, in condition

isLastEventLog

Boolean

Search for last event log

distance

Integer

Search 'distance' from other event-channel. 0 means local search, null means searching also in remote event-channels

int32

xxcustom01List

List of [String]

Search for particular custom field value, in condition

xxcustom02List

List of [String]

Search for particular custom field value, in condition

xxcustom03List

List of [String]

Search for particular custom field value, in condition

xxcustom04List

List of [String]

Search for particular custom field value, in condition

xxcustom05List

List of [String]

Search for particular custom field value, in condition

xxcustom06List

List of [String]

Search for particular custom field value, in condition

xxcustom07List

List of [String]

Search for particular custom field value, in condition

xxcustom08List

List of [String]

Search for particular custom field value, in condition

xxcustom09List

List of [String]

Search for particular custom field value, in condition

xxcustom10List

List of [String]

Search for particular custom field value, in condition

xxcustom03

String

Search for particular custom field value, equals condition

xxcustom02

String

Search for particular custom field value, equals condition

xxcustom05

String

Search for particular custom field value, equals condition

xxcustom04

String

Search for particular custom field value, equals condition

xxcustom01

String

Search for particular custom field value, equals condition

xxcustom06

String

Search for particular custom field value, equals condition

xxcustom07

String

Search for particular custom field value, equals condition

xxcustom08

String

Search for particular custom field value, equals condition

xxcustom09

String

Search for particular custom field value, equals condition

xxcustom10

String

Search for particular custom field value, equals condition

3.4. ComGkSoftwareGkrApiEventchannelDtoEventLogSearchParameters

EventLogSearchParameters Search request parameters.

Field Name Required Type Description Format

messageCriteria

X

com.gk_software.gkr.api.eventchannel.dto.EventLogMessageSearchCriteria

paging

com.gk_software.gkr.api.eventchannel.dto.PagingParameters

requestedValues

com.gk_software.gkr.api.eventchannel.dto.RequestedValues

3.5. ComGkSoftwareGkrApiEventchannelDtoEventLogSearchResult

EventLogSearchResult Event log search result.

Field Name Required Type Description Format

paging

com.gk_software.gkr.api.eventchannel.dto.PagingParameters

haveMoreData

Boolean

If criteria returned too many event logs that don’t fit into one response, this flag is set to true

messageList

X

List of ComGkSoftwareGkrApiEventchannelDtoEventLogMessageDO

The actual messages returned by the search request.

3.6. ComGkSoftwareGkrApiEventchannelDtoEventLogStoreRequest

EventLogStoreRequest Request to store Event Log Messge.

Field Name Required Type Description Format

asynchronous

X

Boolean

If request to store should be asynchronous (return immediately)

messageList

X

List of ComGkSoftwareGkrApiEventchannelDtoEventLogMessageDO

Event Log Message to store

3.7. ComGkSoftwareGkrApiEventchannelDtoPagingParameters

PagingParameters Parameters for search paging.

Field Name Required Type Description Format

orderingType

X

String

Ordering of the result, only DESC_EL_TS_CREATED supported at the moment (order by created descending).

pageStart

String

Magic string acquired from EventLogSearchResult

pageSize

X

Integer

Desired maximum page size.

int32

3.8. ComGkSoftwareGkrApiEventchannelDtoRequestedValues

RequestedValues Requested values by the search. Columns that are not specified by this entity are loaded by default. Null or false value = exclude the column from loading, true = load value.

Field Name Required Type Description Format

payloadEnabled

Boolean

Adds payload to search result when true, removes it from search when false or null.

3.9. ComGkSoftwareGkrApiLayawayDtoLayawayLineItem

LayawayLineItem undocumented

Field Name Required Type Description Format

retailTransactionLineItem

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem

3.10. ComGkSoftwareGkrApiLayawayDtoLayawaySummary

LayawaySummary undocumented

Field Name Required Type Description Format

businessUnitGroupID

X

String

BusinessUnitGroup identificator of the business unit, where the Layaway was created

layawayID

X

String

ID of the Layaway (= Transaction ID of Layaway create TX)

createTimestamp

X

String

Timestamp when Layaway was created; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

createTimestampUTC0

X

Date

UTC0 timestamp when Layaway was created; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

statusCode

X

String

Status of the Layaway. Supported are:ACTIVEVOIDED FULLY_PAIDCLAIMEDTERMINATEDEXPIREDREBOOKED

suspendedFlag

X

Boolean

Layaway is blocked while there is a suspended, non-retrieved Layaway relevant TX .Its not allowed to do anything else than to retrieve this suspend and finalize it. Or to expire/rebook/terminate a layaway.

rebookedFlag

X

Boolean

To know if layaway was already rebooked even if it is in CLAIMED status.Default: falseWill only be changed if Layaway Rebooking TX is consumed.

claimedFlag

X

Boolean

To know if layaway was already claimed even if it is in REBOOKED status.Default: falseWill only be changed if Layaway Claimed TX is consumed.

laywayUpdateSequence

X

Integer

Incrementing number counting modifications of a layaway, so that it is possible to find out which LW manipulation was the last

int32

pendingTransactionID

String

N/A

lastUpdateTimeStamp

X

String

Last change of StatusCode; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

lastUpdateTimeStampUTC0

X

Date

UTC0 timestamp of the last change of StatusCode; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

customerID

String

Assigned customer ID to Layaway.

expirationDate

String

Expiration date of the Layaway (including the tolerance time). Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

expirationDateUTC0

Date

UTC0 time of expiration date. UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

expirationNotificationDate

String

Expiration date for customer (excluding the tolerance time). Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

expirationNotificationDateUTC0

Date

UTC0 time of expiration date for customer. UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

terminationDate

String

Termination date of the layaway. This is the date after no futher modifications of layaway are not allowed. Be it payment or whatever. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

terminationDateUTC0

Date

UTC0 time of TerminationDate; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

totalAmount

X

Double

Total order value of the Layaway.

double

totalDownPaymentsAmount

X

Double

Total of the already payed down payments of the Layaway.

double

penaltyFee

Double

The fee has to be paid in case the customer retrieves its money back from an expired Layaway.

double

cancellationFee

Double

The fee has to be paid in case the customer is voiding the complete Layaway.

double

layawayLineItemList

List of ComGkSoftwareGkrApiLayawayDtoLayawayLineItem

List of Layaway line items

layawayCorrelationChecksum

String

Checksum of all related layaway transactions, used to guaranteee the state of the layaway while modifying it by storing additional transaction.

latestOrderPositionTransactionID

String

TransactionID for 'Latest Order Position Relevant TX'

expirationDateExtendedFlag

Boolean

To know if the expiration date of a layaway was already extended.Default: falseWill only be changed if Extended Layaway TX is consumed.

xxcustom03

String

standard extension pattern for extending calculation in project

xxcustom02

String

standard extension pattern for extending calculation in project

xxcustom05

String

standard extension pattern for extending calculation in project

xxcustom04

String

standard extension pattern for extending calculation in project

xxcustom01

String

standard extension pattern for extending calculation in project

3.11. ComGkSoftwareGkrApiLoginManagerDtoWorkstationCommand

WorkstationCommand This DB table contains info about commands for POSes registered by POS server processes.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.login_manager.dto.WorkstationCommand.Key

command

X

String

designed for POS server processes (e.g. EOD) to set some commands to POSes (e.g. PERFORM_EOD_PROCEDURE)

createTimestamp

X

String

time of creation; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

createTimestampUTC0

X

Date

UTC0 time of creation; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.12. ComGkSoftwareGkrApiLoginManagerDtoWorkstationCommandKey

WorkstationCommand.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

store ID

workstationID

X

String

workstation ID

sessionID

X

String

designed for POS server functions - the unique id from special pool will be generated'0' for POS

commandID

X

String

identificator for deleting by POS’s

3.13. ComGkSoftwareGkrApiLoginManagerDtoWorkstationStatus

WorkstationStatus This DB table contains information about

  • online/offline workstations

  • sign-on (also paused) / sign-off operators on workstations

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.login_manager.dto.WorkstationStatus.Key

workstationLastConnectedAddress

X

String

last workstation client address (IP + DNS name)

workstationLastConnectedTimestamp

String

the time of last workstation ping.if current time - WorkstationLastConnectedTimestamp > TIMEOUT (property pos_server.login_manager.timeout)then workstation is considered as offline; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

loginType

X

String

POS, ACCOUNTING, TECHNICAL - this info is used for concurrency check when the operator tries to login on more workstations

operatorID

String

signed operator id. EMPTY if operator does sign off.the information is not guaranteed if workstation is considered as offline

workstationLastConnectedTimestampUTC0

Date

the UTC0 time of last workstation ping.if current time - WorkstationLastConnectedTimestamp > TIMEOUT (property pos_server.login_manager.timeout)then workstation is considered as offline; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

token

String

token to be used in successive calls, otherwise the data will be rejected. This provides control if calls are done in correct order.If background process is about to notify server that client is still alive and operator is login in, request from the background process can get delayed and can be processed after login request, effectively login out the user, so correct order is important.

workstationTypeCode

String

Type of the workstationPOS - TakeAway, POSSCA - Omni Scale, Self Service ScaleSCO - Self Checkout, PaytowerMOB - Mobile clientelse 'null’POSWill be filled with SystemConfig.workstationTypeCode

updateStatus

String

Update Status depending on Error Codes sended by POS -POS_NOT_FULLY_STARTED - POS not startedPOS_IN_WRONG_CONTEXT - POS in useUNKNOWN -in case no result of UpdateStatus (= null) or if POS offline (if POS offline, then update status is set during maintenance phase) or unknown status was sentPOS_HAS_OPEN_TRANSACTION - Open transactionREADY_FOR_UPDATE - Ready for update (no error)POSWill be filled with ErrorCode of checkErrorCodeForReadyForUpdate()READY_FOR_UPDATE if checkErrorCodeForReadyForUpdate() returns no error (returns null)

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.14. ComGkSoftwareGkrApiLoginManagerDtoWorkstationStatusKey

WorkstationStatus.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

store ID

workstationID

X

String

workstation ID

sessionID

X

String

designed for POS server functions - the unique id from special pool will be generated'0' for POS

3.15. ComGkSoftwareGkrApiLoginManagerDtoWorkstationTenderRepositoryStatus

WorkstationTenderRepositoryStatus This DB table contains about safes and tills used on workstations.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.login_manager.dto.WorkstationTenderRepositoryStatus.Key

exclusiveLevel

X

Integer

0, 1, 2 - see business concept

int32

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.16. ComGkSoftwareGkrApiLoginManagerDtoWorkstationTenderRepositoryStatusKey

WorkstationTenderRepositoryStatus.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

store ID

workstationID

X

String

workstation ID

sessionID

X

String

designed for POS server functions - the unique id from special pool will be generated'0' for POS

tenderRepositoryID

X

String

assigned till or safe ID

tenderRepositoryClassType

X

String

TI, SA

3.17. ComGkSoftwareGkrApiRefundServiceDtoLineItemRefundData

LineItemRefundData undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.refund_service.dto.LineItemRefundData.Key

returnedQuantity

X

Double

returned quantity

double

3.18. ComGkSoftwareGkrApiRefundServiceDtoLineItemRefundDataKey

LineItemRefundData.Key Inner class for composite key attributes

Field Name Required Type Description Format

retailTransactionLineItemSequenceNumber

X

Integer

line item number

int32

3.19. ComGkSoftwareGkrApiRefundServiceDtoRefundTransaction

RefundTransaction undocumented

Field Name Required Type Description Format

transaction

X

com.gk_software.gkr.api.txpool.dto.Transaction

checksum

X

String

@deprecated Transaction checksum, mandatory parameter for checked calls. Deprecated, use correlation data from {@link #selfContainedCorrelationList}.

selfContainedTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoTransaction

List of all transactions that are related with key-transaction by correlations. No matter if parent, child, or cousin.

selfContainedCorrelationList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionCorrelationLink

All the links among transactions in selfContainedTransactionList.

lineItemRefundDataList

List of ComGkSoftwareGkrApiRefundServiceDtoLineItemRefundData

list of RefundData of line items

3.20. ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

TranslationDO TODO

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.common.translations.dto.dom.TranslationDO.Key

translationValue

String

TODO

3.21. ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDOKey

TranslationDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

tid

X

String

TODO

languageID

X

String

TODO

translationKey

X

String

TODO

3.22. ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomBankAccount

BankAccount Information about bank account.

Field Name Required Type Description Format

bankDescription

String

Bank description.

bankAccountNumber

String

Bank account number in a national format, not international.

nationalBankIdentificationCode

String

Bank identification code in a national format.

internationalBankAccountNumber

String

International bank account number (IBAN). A standard number standardized in accordance with the ECBS (European Commitee for Banking Standards) to represent bank details.

bankIdentificationCode

String

Bank identification code in the international format (BIC). Uniquely identifies a bank throughout the world.

bankAccountTypeCode

String

This type code is used to differ between multiple bank accounts. Optional - if not provided then filled in the import.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.23. ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomBusinessUnitContactFilter

BusinessUnitContactFilter Filter for searching of address

Field Name Required Type Description Format

businessUnitID

String

Identifier for a retail store, distribution center or administration center (internal identifier).

businessUnitGroupID

String

Identifier for a group of business units.

street

String

Street

city

String

City

postalCode

String

Postal code

businessUnitStatusCode

String

Enum: ENABLED, DISABLED, SCHEDULED_FOR_DELETION, DELETED,

3.24. ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomBusinessUnitDO

BusinessUnitDO A retail store, distribution center or administration center at which the retailer conducts retail operations.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO.Key

externalBusinessUnitID

String

External identifier for the business unit.

parentBusinessUnitGroupID

String

ID of the parent business unit group

parentExternalBusinessUnitGroupID

String

External ID of the parent business unit group

businessUnitGroupLevelID

String

A unique internal identifier for a level within the business unit grouping hierarchy.

externalBusinessUnitGroupLevelID

String

Name of the level within the business unit grouping hierarchy (external identifier of level).

globalLocationNumber

String

Global location number

vatRegistrationNumber

String

VAT registration number

isoCountryCode

String

The country code of the store.

timeZoneCode

String

SAP time zone code

timeZoneLongID

String

ID of the time zone in the Java format (e.g. 'US/Eastern', 'Europe/Prague')

languageID

String

ISO-Code of the language which is used in the business unit

name

String

The name of the business unit

surrogateName

String

The surrogate name of the business unit

gkEffectiveDate

String

Effective date of the assignment to the GK Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

regionFlag

Boolean

Determines the assignment to the RG business unit group hierarchy

independentRetailerFlag

Boolean

Determines the assignment to the SEH business unit group hierarchy

ownerOfMultipleStoresParentID

String

ID of the parent business unit group with the function code 'OMS'

gkSystemFlag

Boolean

Determines whether the GK system is installed in the store or not

mainCurrencyID

String

Identifier of the main currency of the retail store.

exportToGfkFlag

Boolean

Determines whether this store provides data to the GFK organization

size

Double

The size of the retail store. This is usually split by the non-sales and sales areas.

double

sellingAreaSize

Double

The size of the selling floor. In a large store this is further split by the sales floor and by the merchandise departments.

double

merchandiseHierarchyFunctionCode

String

Code of the MerchandiseHierarchyFunction which is relevant for that store

includesSalesTaxFlag

Boolean

Indicates if the prices include all applicable sales taxes or not.

taxNumber

String

The company’s tax number given by the tax office (this is not the sales tax ID).

alternateISOCurrencyCode

String

The second currency which is e.g. to be shown in the receipt total and to be printed on the receipt (during the time of changing of a local currency to EURO)

mainWeighingUnit

String

The name of the unit which is mainly used for weighing information

purchasingOrganization

String

An organizational unit responsible for procuring materials or services for one or more plants and for negotiating general conditions of purchase with suppliers.

receiverLocationList

List of [String]

List of receiving locations.

companyCodeList

List of [String]

List of company codes of the store.

bankAccountList

List of ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomBankAccount

List of bank accounts

partyID

String

ID of the party information

party

com.gk_software.gkr.api.server.md.party.dto.dom.PartyDO

contact

com.gk_software.gkr.api.server.md.contact.dto.dom.ContactDO

translationList

List of ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

List of translations for the business unit.

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

salesOrganizationID

String

Identifier of an organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims.

distributionChannelTypeCode

String

Distribution channel is the way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales.

deleteTimestampUTC0

Date

The UTC0 date and time when the business unit was finally deleted UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

businessUnitStatusCode

String

The status of business unit. Possible values include the codes for enabled, disabled, scheduled for deletion, deleted.

Enum: ENABLED, DISABLED, SCHEDULED_FOR_DELETION, DELETED,

latitudeDecimalDegrees

Double

Geo positional co-ordinates of a business unit specifying its latitude using Decimal Degrees system (ISO 6709).

double

longitudeDecimalDegrees

Double

Geo positional co-ordinates of a business unit specifying its longitude using Decimal Degrees system (ISO 6709).

double

openingHoursList

List of ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomOpeningHours

Opening hours of the business unit.

effectiveOpeningHoursList

List of ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomEffectiveOpeningHours

Effective opening hours for current week

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.25. ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomBusinessUnitDOKey

BusinessUnitDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitID

X

String

A unique retailer assigned identifier for a retail store, distribution center or administration center (internal identifier).

businessUnitGroupID

X

String

A unique system assigned identifier for the group of business units.

3.26. ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomEffectiveOpeningHours

EffectiveOpeningHours Effective opening hours of the business unit.

Field Name Required Type Description Format

weekDay

X

String

Day of week the opening period is valid.

Enum: MO, TU, WE, TH, FR, SA, SU,

startTime

X

String

The time of day that the open period commences. In 24h HH:MM format, eg 08:30

endTime

X

String

3.27. ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomOpeningHours

OpeningHours Opening hours of the business unit.

Field Name Required Type Description Format

dayOfWeekList

List of [String]

startTime

X

String

The time of day that the open period commences. In 24h HH:MM format, eg 08:30

endTime

X

String

effectiveDate

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

expirationDate

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

specialOpenPeriodFlag

X

Boolean

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.28. ComGkSoftwareGkrApiServerMdBusinessUnitGroupDtoDomBusinessUnitGroupDO

BusinessUnitGroupDO A related group of administration centers, distribution centers and retail stores, with names like group, cluster, region, district, zone and state. The lowest level of BusinessUnitGroup is in a one-to-one relationship with business unit. ie: The lowest level of each BusinessUnitGroupFunction hierarchy is a BusinessUnitGroup containing one & only one BusinessUnit.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.business_unit_group.dto.dom.BusinessUnitGroupDO.Key

languageID

String

Language of the business unit group.

name

String

The common name for the business unit group

externalBusinessUnitGroupID

String

External identifier of the business unit group.

businessUnitGroupFunctionID

String

A business function for which business unit groups are placed into separate grouping hierarchies.

businessUnitGroupLevelID

String

A unique internal identifier for a level within the business unit grouping hierarchy.

businessUnitGroupDepth

Integer

The distance from the root of the business unit group tree which applies to the business unit. Is used in order to increase the performance.

int32

translationList

List of ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

List of translations for business unit group.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.29. ComGkSoftwareGkrApiServerMdBusinessUnitGroupDtoDomBusinessUnitGroupDOKey

BusinessUnitGroupDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

3.30. ComGkSoftwareGkrApiServerMdBusinessUnitTextDtoDomBusinessUnitTextDO

BusinessUnitTextDO Receipt texts (header and footer).

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.business_unit_text.dto.dom.BusinessUnitTextDO.Key

receiptTextValue

X

String

The receipt text.

translationList

List of ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

List of translations for the denomination.

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.31. ComGkSoftwareGkrApiServerMdBusinessUnitTextDtoDomBusinessUnitTextDOKey

BusinessUnitTextDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitID

X

String

Ident of the retail store.

receiptTextKey

X

String

Type of the receipt text (e.g. FOOTER)

receiptTextSequenceNumber

X

Integer

A sequence number of the receipt text.

int32

3.32. ComGkSoftwareGkrApiServerMdContactDtoDomContactAddress

ContactAddress List of addresses

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.contact.dto.dom.ContactAddress.Key

city

String

The city, town or village component of the address.

postalCode

String

The postal or zip code of the address. Used also for postalCodeOfPOBox.

isoCountryCode

String

The country code of the company or the person.

subTerritoryName

String

Name of the region. Used also for district.

territoryName

String

Name of federal state.

addressLine1

String

The first line of the address, normally the street name and number. Used also for poBox.

addressLine2

String

The second line of an address, normally the Flat or Building Suite number.

addressLine3

String

The third line of the address

addressLine4

String

The fourth line of the address.

addressLine5

String

The fifth line of the address. Also used for salutation.

postalCodeExtension

String

The extension of the postal or zip code that further specifies a particular postal district.

territory

String

A state, province, or other region within a country.

marketingAllowedFlag

Boolean

Denotes if the contact address data can be used for marketing purposes.

taxHandlingCode

String

Tax handling code defined within the customer address (region) is used for the tax calculation.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.33. ComGkSoftwareGkrApiServerMdContactDtoDomContactAddressKey

ContactAddress.Key Inner class for composite key attributes

Field Name Required Type Description Format

contactPurposeTypeCode

X

String

Code denoting a reason for contacting a Party.

contactMethodTypeCode

X

String

A retailer assigned code denoting a method of contacting a Party. Suggested values include: WorkPhone, HomePhone, WorkFax, HomeFax, Mobile, Pager.

3.34. ComGkSoftwareGkrApiServerMdContactDtoDomContactDO

ContactDO List of various contacts for a Party, e.g. address, telephone, fax, email-address.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.contact.dto.dom.ContactDO.Key

internetURL

String

Internet URL

addressList

List of ComGkSoftwareGkrApiServerMdContactDtoDomContactAddress

List of the addresses.

telephoneList

List of ComGkSoftwareGkrApiServerMdContactDtoDomContactTelephone

List of the telephone contacts.

emailAddressList

List of ComGkSoftwareGkrApiServerMdContactDtoDomContactEmailAddress

List of the email-addresses.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.35. ComGkSoftwareGkrApiServerMdContactDtoDomContactDOKey

ContactDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

The unique identifier of the business unit group.

partyID

X

String

A unique, system assigned identity for a Party.

partyRoleTypeCode

X

String

A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs

sequenceNumber

X

Integer

A unique system assigned identifier for the particular assignment of Party to the PartyRole.

int32

3.36. ComGkSoftwareGkrApiServerMdContactDtoDomContactEmailAddress

ContactEmailAddress List of email addresses.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.contact.dto.dom.ContactEmailAddress.Key

emailAddress

String

E-mail address of the company or the person.

marketingAllowedFlag

Boolean

Denotes if the contact email address data can be used for marketing purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.37. ComGkSoftwareGkrApiServerMdContactDtoDomContactEmailAddressKey

ContactEmailAddress.Key Inner class for composite key attributes

Field Name Required Type Description Format

contactPurposeTypeCode

X

String

Code denoting a reason for contacting a Party.

contactMethodTypeCode

X

String

A retailer assigned code denoting a method of contacting a Party. Suggested values include: WorkPhone, HomePhone, WorkFax, HomeFax, Mobile, Pager.

3.38. ComGkSoftwareGkrApiServerMdContactDtoDomContactTelephone

ContactTelephone List of telephone and fax numbers.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.contact.dto.dom.ContactTelephone.Key

completeTelephoneNumber

String

The complete telephone number

marketingAllowedFlag

Boolean

Denotes if the contact telephone data can be used for marketing purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.39. ComGkSoftwareGkrApiServerMdContactDtoDomContactTelephoneKey

ContactTelephone.Key Inner class for composite key attributes

Field Name Required Type Description Format

contactPurposeTypeCode

X

String

Code denoting a reason for contacting a Party.

contactMethodTypeCode

X

String

A retailer assigned code denoting a method of contacting a Party. Suggested values include: WorkPhone, HomePhone, WorkFax, HomeFax, Mobile, Pager.

3.40. ComGkSoftwareGkrApiServerMdCurrencyDtoDomCurrencyDO

CurrencyDO Specifies the national designation and quantitative value of monetary media used as tender.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO.Key

symbol

String

National symbol for the main unit of currency, e.g. £, $, etc

translationList

List of ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

List of translations for the currency.

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.

isocurrencyName

String

A name of the currency, i.e. pounds sterling, US dollars, Canadian dollars, etc.

isocountryCode

String

The ISO code of the country issuing the currency.

isocurrencyNumber

String

Numeric code assigned by ISO to identify national currencies.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.41. ComGkSoftwareGkrApiServerMdCurrencyDtoDomCurrencyDOKey

CurrencyDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

The unique identifier of the business unit group.

isocurrencyCode

X

String

Currency code designated by ISO to identify national currency. The unique identifier of the currency.

3.42. ComGkSoftwareGkrApiServerMdCurrencyRoundingRuleDtoDomCurrencyRoundingRuleDO

CurrencyRoundingRuleDO RoundingRules contains fields for rounding rules for specific BUG.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.currency_rounding_rule.dto.dom.CurrencyRoundingRuleDO.Key

roundMethodCode

String

Defines how the result is to be rounded:

  • NO_ROUNDING(00) = no rounding

  • ROUND_HALF_UP(01) = round half up (round up for >= 0.5, else round down),

  • ROUND_DOWN(02) = round down

  • ROUND_UP(03) = round up

  • ROUND_HALF_DOWN(04) = round half down (round up for > 0.5, else round down)

Enum: NO_ROUNDING, ROUND_HALF_UP, ROUND_DOWN, ROUND_UP, ROUND_HALF_DOWN,

roundDecimalCount

Integer

Count of decimals which the result should have

int32

roundDestinationValue

Integer

Additional information for rounding, possible values:

  • null / 1: no additional treatment of the rounded result necessary

  • 5: the rounded result is to be adjusted to the next resp. previous multiple of 5

int32

roundPaymentAmount

Double

Defines the denomination value that is used for rounding payment amounts on POS.

double

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.43. ComGkSoftwareGkrApiServerMdCurrencyRoundingRuleDtoDomCurrencyRoundingRuleDOKey

CurrencyRoundingRuleDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

The unique identifier of the business unit group.

isocurrencyCode

X

String

Currency code designated by ISO to identify national currency.

3.44. ComGkSoftwareGkrApiServerMdCustomerDtoDomCreditCard

CreditCard Credit card.

Field Name Required Type Description Format

cardNumber

X

String

The card number (Identifier).

externalPartyIdentificationProviderID

String

A retailer assigned code denoting the official body that issued the PartyIdentification to the Party.

lockingTypeCode

String

Defines why this identifier is locked.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.45. ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerCard

CustomerCard Customer card

Field Name Required Type Description Format

cardType

X

String

The card type

cardNumber

X

String

The card number (Identifier).

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.46. ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerContactFilter

CustomerContactFilter A customer is a person or individual who purchases, may purchase, or did purchase goods or services from a retail store.

Field Name Required Type Description Format

customerID

String

name

String

organizationName

String

firstName

String

lastName

String

street

String

city

String

postalCode

String

isoCountryCode

String

territoryName

String

completeTelephoneNumber

String

emailAddress

String

3.47. ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerContactView

CustomerContactView View for displaying customer contact

Field Name Required Type Description Format

businessUnitGroupID

String

The identifier for a group of business units.

customerID

String

The identifier for the customer.

salutation

String

name

String

A customer name.

street

String

The street name and number

city

String

The city, town or village component of the address.

postalCode

String

The postal or zip code of the address. Used also for postalCodeOfPOBox.

isoCountryCode

String

The ISO country code

territoryName

String

Name of the region. Used also for district.

completeTelephoneNumber

String

The complete telephone number including the country code, area code, telephone number and extension number.

customerType

String

  • PERSON - if table person is filled

  • ORGANIZATION - if table orgabnization is filled

Enum: PERSON, ORGANIZATION,

emailAddress

String

Email address

dataProtectCode

String

The data protection code being used for the evaluation of the data protection requirements.

xxcustom03

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom02

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom05

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom04

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom01

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom06

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom07

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom08

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom09

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom10

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom11

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom12

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom13

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom14

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom15

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom16

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom17

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom18

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom19

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom20

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom21

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom22

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom23

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom24

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom25

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom26

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom27

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom28

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom29

String

Additional field for custom development (filled from CustomerDO custom field).

xxcustom30

String

Additional field for custom development (filled from CustomerDO custom field).

3.48. ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerDO

CustomerDO A customer is a person or individual who purchases, may purchase, or did purchase goods or services from a retail store.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO.Key

externalBusinessUnitGroupID

String

An external unique identifier for a group of business units.

allowedTermsOfPayment

String

Denotes the group of allowed tenders.

creditLimit

Double

Credit limit of the customer.

double

personalID

String

The personal number, unique key for the employee identification. (The number of the Identification that identifies the Party).

prohibitedTermsOfPayment

String

Denotes the group of prohibited tenders.

remainingCreditLimit

Double

Remaining credit limit of the customer. (Total credit limit - amounts of invoices which haven’t been paid yet).

double

salesTaxLiableFlag

Boolean

Determines whether the customer is liable to tax on sales

statusCode

String

The current status code of the customer, e.g. active, blocked.

preferredReceiptPrintoutTypeCode

String

Default printout mode of the customer.

taxNumber

String

The company’s tax number given by the tax office (this is not the sales tax ID).

partyID

String

Party ID

creditCardList

List of ComGkSoftwareGkrApiServerMdCustomerDtoDomCreditCard

List of the customer credit cards.

customerCardList

List of ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerCard

List of the customer cards.

customerGroupIDList

List of [String]

List of CustomerGroupID’s.

partyIdentification

List of ComGkSoftwareGkrApiServerMdPartyDtoDomPartyIdentification

An official number that may be used to identify a Party. People and businesses have multiple forms of such identification: Drivers License number, Passport number, Credit / Debit Card number, Company Incorporation number, Tax number, etc…​

organization

com.gk_software.gkr.api.server.md.customer.dto.dom.Organization

contact

com.gk_software.gkr.api.server.md.contact.dto.dom.ContactDO

party

com.gk_software.gkr.api.server.md.party.dto.dom.PartyDO

person

com.gk_software.gkr.api.server.md.person.dto.dom.PersonDO

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

declarationAvailable

Boolean

Denotes if the customer declaration is available.

dateOfRecord

String

Date of the customer declaration. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

recordedBy

String

Identification of person who has recorded the customer declaration (e.g. ID of logged Operator).

statisticalUseAllowed

Boolean

Denotes if the customer data can be used for statistical purposes.

lastAccessDate

String

Timestamp of the last access to the data. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

dataProtectCode

String

The data protection code being used for the evaluation of the data protection requirements.

parentCustomerID

String

A unique system assigned identifier for the Customer.

partnerRoleList

List of ComGkSoftwareGkrApiServerMdCustomerDtoDomPartnerRole

List of the customer partner roles.

parentCustomerName1

String

First Name Line of the customer to which this buyer / contact person belongs.

parentCustomerName2

String

Second Name Line of the customer to which this buyer / contact person belongs.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.49. ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerDOKey

CustomerDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

customerID

X

String

A unique identifier for the customer.

3.50. ComGkSoftwareGkrApiServerMdCustomerDtoDomOrganization

Organization Additional data for the organization if the customer is a organization.

Field Name Required Type Description Format

name

String

An organization’s legal trade name.

legalStatusCode

String

Legal status code is a code which is used to define a tax classification of the customer. It specifies the kind of treatment for tax purpose.

3.51. ComGkSoftwareGkrApiServerMdCustomerDtoDomPartnerRole

PartnerRole PartnerRole.

Field Name Required Type Description Format

partnerParentCustomerID

X

String

A unique system assigned identifier for the Customer.

partnerRoleTypeCode

X

String

The type of the partner role.

defaultFlag

X

Boolean

Determines whether this partner role is the default one in case that multiple partner roles exist.

3.52. ComGkSoftwareGkrApiServerMdCustomerTenderRuleDtoDomCustomerTenderGroupDO

CustomerTenderGroupDO Customer tender rule is used for assigning 0..n tenders to a group which can be assigned to a customer. By this way customer-dependent tenders can be reached. This grouping has no relation with the already existing tender groups.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.customer_tender_rule.dto.dom.CustomerTenderGroupDO.Key

customerTenderGroupDescription

String

Description of the customer tender group

defaultFlag

X

Boolean

Determinates whether the customer tender group is to be used as default. (This flag must be set for exactly one row of the table.)

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.53. ComGkSoftwareGkrApiServerMdCustomerTenderRuleDtoDomCustomerTenderGroupDOKey

CustomerTenderGroupDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

customerTenderGroupCode

X

String

A unique identifier of the customer tender group

3.54. ComGkSoftwareGkrApiServerMdDenominationDtoDomDenominationDO

DenominationDO Specifies the quantitative value of the referenced CURRENCY media.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.denomination.dto.dom.DenominationDO.Key

description

X

String

A description of the quantitative value of a specific currency.

pieceValue

X

Double

The quantitative value of a specific currency.

double

typeCode

X

String

Type code of denomination:

  • COIN(COIN)

  • NOTE(NOTE)

  • AMOUNT(AMOU)

Enum: COIN, NOTE, AMOUNT,

rollAvailableFlag

X

Boolean

Determines whether rolls are available.

rollCapacity

X

Integer

Count of coins in the roll.

int32

translationList

List of ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

List of translations for the denomination.

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.55. ComGkSoftwareGkrApiServerMdDenominationDtoDomDenominationDOKey

DenominationDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

denominationID

X

String

An identifier which uniquely identifies the quantitative value of a specific currency, e.g. $100, £50, etc.

currencyCode

X

String

Currency code designated by ISO to identify national currency

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

3.56. ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomDynamicTableauItemListUpdateView

DynamicTableauItemListUpdateView TODO

Field Name Required Type Description Format

itemListId

String

The qualifier for the name of the dynamic item list. E.g. 'Vegetable'.

lastUpdateTimestamp

String

The timestamp for the last change of the dynamic item list. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

3.57. ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomDynamicTableauItemListUpdateViewCriteria

DynamicTableauItemListUpdateViewCriteria Search criteria

Field Name Required Type Description Format

businessUnitGroupId

X

String

A unique system assigned identifier for a group of BusinessUnits.

itemListIdList

List of [String]

The list of qualifiers for the name of the dynamic item list. E.g. 'Vegetable'.

3.58. ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomDynamicTableauItemListView

DynamicTableauItemListView View object

Field Name Required Type Description Format

itemListId

String

The qualifier for the name of the dynamic item list. E.g. 'Vegetable'.

lastUpdateTimestamp

String

The timestamp for the last change of the dynamic item list. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

posUomItemList

List of ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomPosUomItemView

The list of pos uom item views for a given tableau

xxcustom03

String

Customizable information for DynamicTableauItemListDO

xxcustom02

String

Customizable information for DynamicTableauItemListDO

xxcustom05

String

Customizable information for DynamicTableauItemListDO

xxcustom04

String

Customizable information for DynamicTableauItemListDO

xxcustom01

String

Customizable information for DynamicTableauItemListDO

xxcustom06

String

Customizable information for DynamicTableauItemListDO

xxcustom07

String

Customizable information for DynamicTableauItemListDO

xxcustom08

String

Customizable information for DynamicTableauItemListDO

xxcustom09

String

Customizable information for DynamicTableauItemListDO

xxcustom10

String

Customizable information for DynamicTableauItemListDO

xxcustom11

String

Customizable information for DynamicTableauItemListDO

xxcustom12

String

Customizable information for DynamicTableauItemListDO

xxcustom13

String

Customizable information for DynamicTableauItemListDO

xxcustom14

String

Customizable information for DynamicTableauItemListDO

xxcustom15

String

Customizable information for DynamicTableauItemListDO

xxcustom16

String

Customizable information for DynamicTableauItemListDO

xxcustom17

String

Customizable information for DynamicTableauItemListDO

xxcustom18

String

Customizable information for DynamicTableauItemListDO

xxcustom19

String

Customizable information for DynamicTableauItemListDO

xxcustom20

String

Customizable information for DynamicTableauItemListDO

xxcustom21

String

Customizable information for DynamicTableauItemListDO

xxcustom22

String

Customizable information for DynamicTableauItemListDO

xxcustom23

String

Customizable information for DynamicTableauItemListDO

xxcustom24

String

Customizable information for DynamicTableauItemListDO

xxcustom25

String

Customizable information for DynamicTableauItemListDO

xxcustom26

String

Customizable information for DynamicTableauItemListDO

xxcustom27

String

Customizable information for DynamicTableauItemListDO

xxcustom28

String

Customizable information for DynamicTableauItemListDO

xxcustom29

String

Customizable information for DynamicTableauItemListDO

xxcustom30

String

Customizable information for DynamicTableauItemListDO

3.59. ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomDynamicTableauItemListViewCriteria

DynamicTableauItemListViewCriteria Search criteria

Field Name Required Type Description Format

businessUnitGroupId

X

String

A unique system assigned identifier for a group of BusinessUnits.

itemListIdList

List of [String]

The list of qualifiers for the name of the dynamic item list. E.g. 'Vegetable'.

languageIdList

List of [String]

List of language ids.

textClassList

List of [String]

List of text classes.

optionLoadPrice

Boolean

Whether the item price should be loaded to particular fields in provided view. Note that enabling this option could have negative impact on the performance.

3.60. ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomPosUomItemTextView

PosUomItemTextView Pos uom item text view.

Field Name Required Type Description Format

text

String

Translation text

textClass

String

Text class

languageId

String

Language id

textNumber

Integer

text number

int32

3.61. ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomPosUomItemView

PosUomItemView Pos uom item view.

Field Name Required Type Description Format

posItemId

String

The ID used to identify the item.

itemId

String

Item number. Alphanumeric key that identifies the item uniquely.

mainPosItemId

String

Main POS item id.

uomItemTextList

List of ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomPosUomItemTextView

The UOM Item text list.

uomItemName

String

The UOM Item name.

uomCode

String

The UOM code.

unitOfMeasureName

String

The translated name of the UOM code.

priceAmount

Double

The current valid price of the UOM Item.

double

packagePriceQuantity

Integer

The quantity the price refers to (Eg: 3 for $1.00).

int32

uomItemXXCustom14

String

Customizable information for UomItemSO

uomItemXXCustom15

String

Customizable information for UomItemSO

uomItemXXCustom16

String

Customizable information for UomItemSO

uomItemXXCustom17

String

Customizable information for UomItemSO

uomItemXXCustom18

String

Customizable information for UomItemSO

uomItemXXCustom19

String

Customizable information for UomItemSO

uomItemXXCustom20

String

Customizable information for UomItemSO

uomItemXXCustom21

String

Customizable information for UomItemSO

uomItemXXCustom22

String

Customizable information for UomItemSO

uomItemXXCustom23

String

Customizable information for UomItemSO

uomItemXXCustom24

String

Customizable information for UomItemSO

uomItemXXCustom25

String

Customizable information for UomItemSO

uomItemXXCustom26

String

Customizable information for UomItemSO

uomItemXXCustom27

String

Customizable information for UomItemSO

uomItemXXCustom28

String

Customizable information for UomItemSO

uomItemXXCustom29

String

Customizable information for UomItemSO

uomItemXXCustom30

String

Customizable information for UomItemSO

itemListItemXXCustom01

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom02

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom03

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom04

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom05

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom06

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom07

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom08

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom09

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom10

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom11

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom12

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom13

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom14

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom15

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom16

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom17

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom18

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom19

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom20

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom21

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom22

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom23

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom24

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom25

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom26

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom27

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom28

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom29

String

Customizable information for DynamicTableauItemListItemDO

itemListItemXXCustom30

String

Customizable information for DynamicTableauItemListItemDO

itemXXCustom01

String

Customizable information for ItemSO

itemXXCustom02

String

Customizable information for ItemSO

itemXXCustom03

String

Customizable information for ItemSO

itemXXCustom04

String

Customizable information for ItemSO

itemXXCustom05

String

Customizable information for ItemSO

itemXXCustom06

String

Customizable information for ItemSO

itemXXCustom07

String

Customizable information for ItemSO

itemXXCustom08

String

Customizable information for ItemSO

itemXXCustom09

String

Customizable information for ItemSO

itemXXCustom10

String

Customizable information for ItemSO

itemXXCustom11

String

Customizable information for ItemSO

itemXXCustom12

String

Customizable information for ItemSO

itemXXCustom13

String

Customizable information for ItemSO

itemXXCustom14

String

Customizable information for ItemSO

itemXXCustom15

String

Customizable information for ItemSO

itemXXCustom16

String

Customizable information for ItemSO

itemXXCustom17

String

Customizable information for ItemSO

itemXXCustom18

String

Customizable information for ItemSO

itemXXCustom19

String

Customizable information for ItemSO

itemXXCustom20

String

Customizable information for ItemSO

itemXXCustom21

String

Customizable information for ItemSO

itemXXCustom22

String

Customizable information for ItemSO

itemXXCustom23

String

Customizable information for ItemSO

itemXXCustom24

String

Customizable information for ItemSO

itemXXCustom25

String

Customizable information for ItemSO

itemXXCustom26

String

Customizable information for ItemSO

itemXXCustom27

String

Customizable information for ItemSO

itemXXCustom28

String

Customizable information for ItemSO

itemXXCustom29

String

Customizable information for ItemSO

itemXXCustom30

String

Customizable information for ItemSO

uomItemXXCustom01

String

Customizable information for UomItemSO

uomItemXXCustom02

String

Customizable information for UomItemSO

uomItemXXCustom03

String

Customizable information for UomItemSO

uomItemXXCustom04

String

Customizable information for UomItemSO

uomItemXXCustom05

String

Customizable information for UomItemSO

uomItemXXCustom06

String

Customizable information for UomItemSO

uomItemXXCustom07

String

Customizable information for UomItemSO

uomItemXXCustom08

String

Customizable information for UomItemSO

uomItemXXCustom09

String

Customizable information for UomItemSO

uomItemXXCustom10

String

Customizable information for UomItemSO

uomItemXXCustom11

String

Customizable information for UomItemSO

uomItemXXCustom12

String

Customizable information for UomItemSO

uomItemXXCustom13

String

Customizable information for UomItemSO

3.62. ComGkSoftwareGkrApiServerMdExchangeRateDtoDomExchangeRateDO

ExchangeRateDO A exchange rate expresses the quantitative conversion factor between two kinds of currency, one which must be the store’s home currency.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.exchange_rate.dto.dom.ExchangeRateDO.Key

fromCurrencyID

X

String

The unique system assigned identifier of the source currency.

toCurrencyID

X

String

The unique system assigned identifier of the destination currency.

exchangeRateEffectiveDate

X

String

The date on which a specific exchange rate becomes effective. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

exchangeRateExpirationDate

X

String

Date on which the exchange rate expires and is no longer valid. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

toBuyAmount

X

Double

The buying rate of the tender type, based on the store’s local currency.

double

multiplyFlag

X

Boolean

Determines whether inside the calculation FromCurrencyCode -> ToCurrencyCode the amount is to be multiplied with (true) or divided by (false) the ToBuyAmount / ToSellAmount

origin

String

Type of origin. OriginCode: PARENT_COPY = '00' IMPORT = '01' MANUAL = '02'

Enum: PARENT_COPY, IMPORT, MANUAL,

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.63. ComGkSoftwareGkrApiServerMdExchangeRateDtoDomExchangeRateDOKey

ExchangeRateDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

The identifier for a group of business units.

fromCurrencyCode

X

String

The unique identifier of the source currency.

toCurrencyCode

X

String

The unique identifier of the destination currency.

sequenceNumber

X

Integer

A sequence number denoting the order in which Exchange rate records were created for this pairing of currencies.

int32

3.64. ComGkSoftwareGkrApiServerMdGiftCertificateClassDtoDomGiftCertificateClassDO

GiftCertificateClassDO Gift certificate class

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.gift_certificate_class.dto.dom.GiftCertificateClassDO.Key

typeDescription

String

Describes a gift certificate type

translationList

List of ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

List of translations.

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.

3.65. ComGkSoftwareGkrApiServerMdGiftCertificateClassDtoDomGiftCertificateClassDOKey

GiftCertificateClassDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

giftCertificateTypeCode

X

String

Identifies a gift certificate type.

businessUnitGroupID

X

String

ID of the business unit group

3.66. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemCharacteristic

PosUOMItemCharacteristic Reference to a characteristic of this item.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemCharacteristic.Key

characteristicValueName

String

The name of the characteristic value (e.g. 'black', '38').

3.67. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemCharacteristicKey

PosUOMItemCharacteristic.Key Inner class for composite key attributes

Field Name Required Type Description Format

characteristicId

X

String

The identifier of the characteristic (e.g. 'color', 'size').

characteristicValueId

X

String

The identifier of the characteristic value.

3.68. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemCollection

PosUOMItemCollection Structured items (e.g. display items) consist of other items (collection members). The item collection contains references to these members.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemCollection.Key

quantity

Double

The number of individual member items that are assembled into the collection

double

3.69. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemCollectionKey

PosUOMItemCollection.Key Inner class for composite key attributes

Field Name Required Type Description Format

memberItemId

X

String

Item ID of the collection member

memberUOMCode

X

String

Unit of measure of the collection member

3.70. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDO

PosUOMItemDO This object contains item data for one specific unit of measure. The object is a projection from the item domain object.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDO.Key

uomName

String

Localized Unit of measure name.

name

String

The name by which the item is known.

description

String

The textural description of the item.

classCode

String

Class code (eg. empties, fresh food). Usage example: Via customizing is possible to disable the registration of items with this class code.

taxGroupID

String

A tax group which links a tax authority to the merchandise to which the tax applies. If no taxGroupID is delivered, the taxGroup with 0% is to be searched out and used. If no taxGroup with 0% exists, the import of the item fails.

alternativeTaxGroupID

String

An alternative tax group which links a tax authority to the merchandise to which the tax applies.

taxGroupReceiptPrintCode

String

The Taxable Group Receipt Print Code.

itemUsageTypeCode

String

Specifies the category of the item (e.g. single item, item variant, display).

taxExemptCode

String

A code to denote the tax exemption status from sales and use tax. (00/null - normal, item is taxable, 01 - no tax).

Enum: NORMAL, NO_TAX,

warrantyPeriod

Double

The duration of the item’s warranty in months

double

tareId

String

Defines the number of weight units of measure for the tare.

tareUomCode

String

Tare UOM code.

posDepartmentID

String

Reference to the POSDepartment the item belongs to

mainPOSItemId

String

The main POS item identifier

mainMerchandiseHierarchyGroupID

String

References the default merchandise hierarchy group the item belongs to

mainMerchandiseHierarchyGroupName

String

Localized default merchandise hierarchy group name.

mainMerchandiseHierarchyGroupDescription

String

Localized default merchandise hierarchy group description.

depositTypeCode

String

Deposit type of the item.

Enum: NO_DEPOSIT, DEPOSIT_ON_NON_REFILLABLE_CONTAINERS, DEPOSIT_ON_REFILLABLE_CONTAINERS, PET_BOTTLE, BATTERY, GAS_BOTTLE,

itemSellingRule

com.gk_software.swee.ses.api.server.md.item_selling_rule.dto.so.ItemSellingRuleSO

statusCode

String

This code defines the current state of an item within the retail store. An item’s state limits what actions may be taken on an item in terms of ordering, receiving, selling, returns, transfers, counting and so on. Sample statuses include active, inactive, discontinued, pending, etc.

itemCollectionList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemCollection

List of item collections

relatedItemAssociationList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemRelatedItemAssociation

List of the item associations

itemCharacteristicList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemCharacteristic

List of item characteristics with values

itemFeatureList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemFeature

posIdentityList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemPosIdentity

List of POS item ID’s (EANs)

sellingPriceList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSellingPriceDO

List of selling prices

itemDepositCollectionList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDepositCollection

List of deposits

uomItemTextList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemText

List of text to UOMItem

itemMHGList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemMHG

List of merchandise hierarchy groups

salesRestrictionList

List of ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoSalesRestrictionSO

Sales restriction for this item

updateStockFlag

Boolean

Determines whether the item is inventory-tracked

baseUOMCode

String

Code of the base unit of measure. The base unit of measure is automatically selected if the item is registered by ItemID.

prohibitedForPhysicalInventoryFlag

Boolean

Determines whether this item cannot be considered within physical inventories

minimumShelfLifeDayCount

Integer

The number of business days the SHELF ITEM may be displayed for sale to customers and after which must be removed. This attribute is used for perishable produce items, drugs, and other time sensitive items (like newspapers).

int32

labelType

String

Type of the label

discountTypeCode

String

A code which is used by the loyalty engine in order to determine whether the item can get rebate/points. Possible values: 0..9

globalLifeDayCount

Integer

Time range (count of days) between production date and best-before date

int32

shelfLifeDayCountPercent

Double

Percentage for calculating the shelf life day count

double

dayCountUOMCode

String

The unit of measure of the 'day count' elements (day or week)

defaultReceivingLocation

String

Default receiving place

concessionItemFlag

Boolean

Defines whether the item is a concession item. Concession items are not maintained by the retailer, but by a vendor itself. E.g. snacks and food in vending machines.

costItemFlag

Boolean

Defines whether the item is a cost item

merchandisePlanningTypeCode

String

Determines the merchandise planning - the way, how the item is ordered (automatically, manually, not orderable, ..).

mainSupplierId

String

Reference to the main supplier of this item

venSafeFlag

Boolean

Determines whether this item is sold via VENSAFE.

baseUOMConsumerPackageGrossContent

Double

Consumer package gross content of the base UOM of the item * e.g. can of peaches * gross content = 500 * net content = 385 * contents UOM = ml

double

baseUOMConsumerPackageNetContent

Double

The consumer package content, as claimed on the label. e.g. Evian Water 750ml - net content = '750 MLT' 20 count pack of diapers, net content = '20 ea.'

double

baseUOMConsumerPackageContentsUOMCode

String

Net/gross contents uom

baseUOMConsumerPackageBasePriceContent

Double

Quantity measured in ConsumerPackageBasePriceUOMCode units for which the base price is to be determinedExample: * base price UOM = g * base price content = 100 * base price = 2,99 * ==> base price = 2,99 per 100 g

double

baseUOMConsumerPackageBasePriceContentsUOMCode

String

Base price contents unit of measure

distributingWarehouseID

String

Identifier of the distributing warehouse (used in the purchase order process)

distributionMethodID

String

Identifier of the distribution method (used in the purchase order process)

assortmentID

String

Identifier of the assortment (used e.g. in the purchase order process)

thirdPartyAssortmentID

String

Identifier of the 3rd party assortment (used in the purchase order process)

transportAssociationID

String

Identifier of the transport association (used in the purchase order process)

concessionItemSupplierID

String

If the item is a concession item, this is the reference to its supplier

defaultSellingUOMCode

String

The default selling unit of measure of the item

conversionNumerator

Integer

Numerator for the conversion into base unit of measure

int32

conversionDenominator

Integer

Denominator for the conversion into base unit of measure

int32

consumerPackageGrossWeight

Double

The weight of the consumer package, including packaging

double

consumerPackageNetWeight

Double

The weight of the consumer package, excluding packaging

double

consumerPackageWeightUOMCode

String

Weight unit of measure

consumerPackageVolume

Double

The consumer package volume

double

consumerPackageVolumeUOMCode

String

Volume unit of measure

consumerPackageDepth

Double

The dimension from front to back of the consumer package

double

consumerPackageWidth

Double

The dimension from left to right of the consumer package

double

consumerPackageHeight

Double

The dimension from top to bottom of the consumer package

double

consumerPackageSizeUOMCode

String

The code used to specify the units in which a value is being expressed, or manner in which a measurement has been taken.

outerPackageTypeCode

String

Typecode of the outer package of the item, is used for label printing

headOfficeCarryRequirementTypeCode

String

Typecode of the outer package of the item, is used for label printing

handlingTypeCode

String

Handling typecode

statusEffectiveDate

String

Date when the status becomes effective Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

maximumStockQuantity

Double

Maximum stock quantity

double

minimumStockQuantity

Double

Minimum stock quantity

double

listingEffectiveDate

String

Date when the listing becomes effective Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

listingExpirationDate

String

Last date when the item is available for ordering Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

priceContractReadList

List of ComGkSoftwareGkrApiServerMdPriceContractDtoDomPriceContractReadDO

List of all Customer Specific Prices for this item.

selectedPriceContractRead

com.gk_software.gkr.api.server.md.price_contract.dto.dom.PriceContractReadDO

uom_ITEM_XX_CUSTOM_01

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_02

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_03

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_04

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_05

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_06

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_07

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_08

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_09

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_10

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_11

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_12

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_13

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_14

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_15

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_16

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_17

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_18

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_19

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_20

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_21

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_22

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_23

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_24

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_25

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_26

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_27

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_28

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_29

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_30

String

Additional field for custom development.

hsncode

String

HSN (Harmonized System of Nomenclature) is an international classification system of commodities. HSN code ensures that commodities of similar nature are classified properly.

rfidflag

Boolean

Denotes if RFID method is called and stock is updated.

  • true: The RFID method is called.

  • false: The RFID method is not called.

item_XX_CUSTOM_01

String

Additional field for custom development.

item_XX_CUSTOM_02

String

Additional field for custom development.

item_XX_CUSTOM_03

String

Additional field for custom development.

item_XX_CUSTOM_04

String

Additional field for custom development.

item_XX_CUSTOM_05

String

Additional field for custom development.

item_XX_CUSTOM_06

String

Additional field for custom development.

item_XX_CUSTOM_07

String

Additional field for custom development.

item_XX_CUSTOM_08

String

Additional field for custom development.

item_XX_CUSTOM_09

String

Additional field for custom development.

item_XX_CUSTOM_10

String

Additional field for custom development.

item_XX_CUSTOM_11

String

Additional field for custom development.

item_XX_CUSTOM_12

String

Additional field for custom development.

item_XX_CUSTOM_13

String

Additional field for custom development.

item_XX_CUSTOM_14

String

Additional field for custom development.

item_XX_CUSTOM_15

String

Additional field for custom development.

item_XX_CUSTOM_16

String

Additional field for custom development.

item_XX_CUSTOM_17

String

Additional field for custom development.

item_XX_CUSTOM_18

String

Additional field for custom development.

item_XX_CUSTOM_19

String

Additional field for custom development.

item_XX_CUSTOM_20

String

Additional field for custom development.

item_XX_CUSTOM_21

String

Additional field for custom development.

item_XX_CUSTOM_22

String

Additional field for custom development.

item_XX_CUSTOM_23

String

Additional field for custom development.

item_XX_CUSTOM_24

String

Additional field for custom development.

item_XX_CUSTOM_25

String

Additional field for custom development.

item_XX_CUSTOM_26

String

Additional field for custom development.

item_XX_CUSTOM_27

String

Additional field for custom development.

item_XX_CUSTOM_28

String

Additional field for custom development.

item_XX_CUSTOM_29

String

Additional field for custom development.

item_XX_CUSTOM_30

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_01

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_02

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_03

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_04

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_05

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_06

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_07

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_08

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_09

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_10

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_11

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_12

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_13

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_14

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_15

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_16

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_17

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_18

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_19

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_20

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_21

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_22

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_23

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_24

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_25

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_26

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_27

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_28

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_29

String

Additional field for custom development.

bulk_ITEM_XX_CUSTOM_30

String

Additional field for custom development.

3.71. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDOKey

PosUOMItemDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique retailer assigned identifier for the business unit group

itemID

X

String

Item number. Alphanumeric key that identifies the item uniquely.

uomCode

X

String

Unit of measure code

3.72. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDepositCollection

PosUOMItemDepositCollection Item deposit collection contains a reference to the deposit item connected to this item (e.g. reference to the bottle for a beer).

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDepositCollection.Key

perAssemblyCount

Double

The number of individual member items that are assembled in this deposit collection.

double

3.73. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemDepositCollectionKey

PosUOMItemDepositCollection.Key Inner class for composite key attributes

Field Name Required Type Description Format

memberItemId

X

String

Reference to the member of the deposit collection

memberUOMCode

X

String

The unit of measure of the member item

3.74. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemFeature

PosUOMItemFeature undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemFeature.Key

featureValue

String

3.75. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemFeatureKey

PosUOMItemFeature.Key Inner class for composite key attributes

Field Name Required Type Description Format

featureCode

X

String

3.76. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemMHG

PosUOMItemMHG Relation of this item to a merchandise hierarchy group

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemMHG.Key

merchandiseHierarchyGroupIDQualifier

String

Qualifier which is used to differ between MerchandiseHierarchyGroup’s belonging to different functions but having the same id

xx_CUSTOM_01

String

Additional field for custom development.

xx_CUSTOM_02

String

Additional field for custom development.

xx_CUSTOM_03

String

Additional field for custom development.

xx_CUSTOM_04

String

Additional field for custom development.

xx_CUSTOM_05

String

Additional field for custom development.

xx_CUSTOM_06

String

Additional field for custom development.

xx_CUSTOM_07

String

Additional field for custom development.

xx_CUSTOM_08

String

Additional field for custom development.

xx_CUSTOM_09

String

Additional field for custom development.

xx_CUSTOM_10

String

Additional field for custom development.

xx_CUSTOM_11

String

Additional field for custom development.

xx_CUSTOM_12

String

Additional field for custom development.

xx_CUSTOM_13

String

Additional field for custom development.

xx_CUSTOM_14

String

Additional field for custom development.

xx_CUSTOM_15

String

Additional field for custom development.

xx_CUSTOM_16

String

Additional field for custom development.

xx_CUSTOM_17

String

Additional field for custom development.

xx_CUSTOM_18

String

Additional field for custom development.

xx_CUSTOM_19

String

Additional field for custom development.

xx_CUSTOM_20

String

Additional field for custom development.

xx_CUSTOM_21

String

Additional field for custom development.

xx_CUSTOM_22

String

Additional field for custom development.

xx_CUSTOM_23

String

Additional field for custom development.

xx_CUSTOM_24

String

Additional field for custom development.

xx_CUSTOM_25

String

Additional field for custom development.

xx_CUSTOM_26

String

Additional field for custom development.

xx_CUSTOM_27

String

Additional field for custom development.

xx_CUSTOM_28

String

Additional field for custom development.

xx_CUSTOM_29

String

Additional field for custom development.

xx_CUSTOM_30

String

Additional field for custom development.

3.77. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemMHGKey

PosUOMItemMHG.Key Inner class for composite key attributes

Field Name Required Type Description Format

merchandiseHierarchyGroupId

X

String

Unique system assigned identifier for a group or class of merchandise.

3.78. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemPosIdentity

PosUOMItemPosIdentity POS identity used for the item registration

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemPosIdentity.Key

posIdentityTypeCode

String

type code of the POS identity * ('10' for internally generated POS identity with POSItemID = itemID )

xx_CUSTOM_01

String

Additional field for custom development.

xx_CUSTOM_02

String

Additional field for custom development.

xx_CUSTOM_03

String

Additional field for custom development.

xx_CUSTOM_04

String

Additional field for custom development.

xx_CUSTOM_05

String

Additional field for custom development.

xx_CUSTOM_06

String

Additional field for custom development.

xx_CUSTOM_07

String

Additional field for custom development.

xx_CUSTOM_08

String

Additional field for custom development.

xx_CUSTOM_09

String

Additional field for custom development.

xx_CUSTOM_10

String

Additional field for custom development.

xx_CUSTOM_11

String

Additional field for custom development.

xx_CUSTOM_12

String

Additional field for custom development.

xx_CUSTOM_13

String

Additional field for custom development.

xx_CUSTOM_14

String

Additional field for custom development.

xx_CUSTOM_15

String

Additional field for custom development.

xx_CUSTOM_16

String

Additional field for custom development.

xx_CUSTOM_17

String

Additional field for custom development.

xx_CUSTOM_18

String

Additional field for custom development.

xx_CUSTOM_19

String

Additional field for custom development.

xx_CUSTOM_20

String

Additional field for custom development.

xx_CUSTOM_21

String

Additional field for custom development.

xx_CUSTOM_22

String

Additional field for custom development.

xx_CUSTOM_23

String

Additional field for custom development.

xx_CUSTOM_24

String

Additional field for custom development.

xx_CUSTOM_25

String

Additional field for custom development.

xx_CUSTOM_26

String

Additional field for custom development.

xx_CUSTOM_27

String

Additional field for custom development.

xx_CUSTOM_28

String

Additional field for custom development.

xx_CUSTOM_29

String

Additional field for custom development.

xx_CUSTOM_30

String

Additional field for custom development.

3.79. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemPosIdentityKey

PosUOMItemPosIdentity.Key Inner class for composite key attributes

Field Name Required Type Description Format

posItemId

X

String

POS item id is a token identifier to facilitate price lookup and does not contain any descriptive information.

3.80. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemRelatedItemAssociation

PosUOMItemRelatedItemAssociation Association to a related item

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemRelatedItemAssociation.Key

subTypeCode

String

rootItemId

String

xx_CUSTOM_01

String

xx_CUSTOM_02

String

xx_CUSTOM_03

String

xx_CUSTOM_04

String

xx_CUSTOM_05

String

xx_CUSTOM_06

String

xx_CUSTOM_07

String

xx_CUSTOM_08

String

xx_CUSTOM_09

String

xx_CUSTOM_10

String

xx_CUSTOM_11

String

xx_CUSTOM_12

String

xx_CUSTOM_13

String

xx_CUSTOM_14

String

xx_CUSTOM_15

String

xx_CUSTOM_16

String

xx_CUSTOM_17

String

xx_CUSTOM_18

String

xx_CUSTOM_19

String

xx_CUSTOM_20

String

xx_CUSTOM_21

String

xx_CUSTOM_22

String

xx_CUSTOM_23

String

xx_CUSTOM_24

String

xx_CUSTOM_25

String

xx_CUSTOM_26

String

xx_CUSTOM_27

String

xx_CUSTOM_28

String

xx_CUSTOM_29

String

xx_CUSTOM_30

String

3.81. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemRelatedItemAssociationKey

PosUOMItemRelatedItemAssociation.Key Inner class for composite key attributes

Field Name Required Type Description Format

relatedItemId

X

String

Reference to the related item.

associationTypeCode

X

String

Type of the association, e.g. 'VARIANT' for item variant association.

3.82. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSearchCharacteristicFilter

PosUOMItemSearchCharacteristicFilter Filter for Characteristics.

Field Name Required Type Description Format

characteristicId

X

String

ID of the characteristic to be used for filtering (e.g. 'COLOR'). Wildcards are supported. The search is case insensitive.

characteristicValueName

X

String

Value name of the characteristic to be used for filtering (e.g. 'red'). Wildcards are supported. The search is case insensitive.

3.83. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSearchCharacteristicView

PosUOMItemSearchCharacteristicView Characteristic view.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemSearchCharacteristicView.Key

characteristicValueName

String

Value name of the characteristic.

3.84. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSearchCharacteristicViewKey

PosUOMItemSearchCharacteristicView.Key Inner class for composite key attributes

Field Name Required Type Description Format

characteristicId

X

String

ID of the characteristic.

characteristicValueId

X

String

Value ID of the characteristic.

3.85. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSearchFilter

PosUOMItemSearchFilter Filter for search view.

Field Name Required Type Description Format

itemID

String

Item number. Alphanumeric key that identifies the item uniquely.

name

String

Item name which is searched in GK_BUG_ITEM_I8N_ITEM_TEXT.TEXT if exists, otherwise (if it is allowed by configuration) in AS_BSNGP_ITM.NM_ITM_GK.

uomCode

String

Localized Unit of measure name.

merchandiseHierarchyGroupName

String

Merchandise Hierarchy Group Name which is searched in GK_I18N_TEXT.LOCALIZED_TEXT if exists, otherwise in CO_MRHRC_GP.NM_MRHRC_GP.

priceAmount

Double

Amount of the price.

double

authorisedForSaleFlag

Boolean

If true only items authorized for sale are searched (RU_ITM_SL.FL_AZN_FR_SLS is true).

itemCollectionSet

Boolean

For filtering items with Item Collections. If true only items with Item Collection are searched.

itemIDCaseSensitive

Boolean

For enabling/disabling case sensitivity for search in ItemID <strong>Example</strong> - in DB are items where AS_BSNGP_ITM.ID_ITM = { A001, a001 }

  • caseSensitive=true: => only one: A001

  • caseSensitive=false: => returns both of them: A001, a001

scaleDomainID

String

posIdentityTypeCode

String

For filtering according to the code of the POS identity.

optionLoadPosIdentity

Boolean

Search option whether the POS item identifier should be loaded and filled to provided view. If this flag is set to false the {@link PosUOMItemSearchView#posItemId} field in the view is always null.

optionLoadCharacteristics

Boolean

Search option whether the Characteristics should be loaded and filled to provided view. If this flag is set to false the {@link PosUOMItemSearchView#characteristicViewList} field in the view is always null.

characteristicFilterList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSearchCharacteristicFilter

Filter for Characteristics.

searchItemIdInRootItemId

Boolean

Search option whether the {@link #itemID} should be used also for searching by Root Item ID in associations. It means that it searches all item with this root, in other words all child items for requested item.

offset

String

limit

Integer

int32

uom_ITEM_XX_CUSTOM_01

Object

uom_ITEM_XX_CUSTOM_02

Object

uom_ITEM_XX_CUSTOM_03

Object

uom_ITEM_XX_CUSTOM_04

Object

uom_ITEM_XX_CUSTOM_05

Object

uom_ITEM_XX_CUSTOM_06

Object

uom_ITEM_XX_CUSTOM_07

Object

uom_ITEM_XX_CUSTOM_08

Object

uom_ITEM_XX_CUSTOM_09

Object

uom_ITEM_XX_CUSTOM_10

Object

uom_ITEM_XX_CUSTOM_11

Object

uom_ITEM_XX_CUSTOM_12

Object

uom_ITEM_XX_CUSTOM_13

Object

uom_ITEM_XX_CUSTOM_14

Object

uom_ITEM_XX_CUSTOM_15

Object

uom_ITEM_XX_CUSTOM_16

Object

uom_ITEM_XX_CUSTOM_17

Object

uom_ITEM_XX_CUSTOM_18

Object

uom_ITEM_XX_CUSTOM_19

Object

uom_ITEM_XX_CUSTOM_20

Object

uom_ITEM_XX_CUSTOM_21

Object

uom_ITEM_XX_CUSTOM_22

Object

uom_ITEM_XX_CUSTOM_23

Object

uom_ITEM_XX_CUSTOM_24

Object

uom_ITEM_XX_CUSTOM_25

Object

uom_ITEM_XX_CUSTOM_26

Object

uom_ITEM_XX_CUSTOM_27

Object

uom_ITEM_XX_CUSTOM_28

Object

uom_ITEM_XX_CUSTOM_29

Object

uom_ITEM_XX_CUSTOM_30

Object

item_XX_CUSTOM_01

Object

item_XX_CUSTOM_02

Object

item_XX_CUSTOM_03

Object

item_XX_CUSTOM_04

Object

item_XX_CUSTOM_05

Object

item_XX_CUSTOM_06

Object

item_XX_CUSTOM_07

Object

item_XX_CUSTOM_08

Object

item_XX_CUSTOM_09

Object

item_XX_CUSTOM_10

Object

item_XX_CUSTOM_11

Object

item_XX_CUSTOM_12

Object

item_XX_CUSTOM_13

Object

item_XX_CUSTOM_14

Object

item_XX_CUSTOM_15

Object

item_XX_CUSTOM_16

Object

item_XX_CUSTOM_17

Object

item_XX_CUSTOM_18

Object

item_XX_CUSTOM_19

Object

item_XX_CUSTOM_20

Object

item_XX_CUSTOM_21

Object

item_XX_CUSTOM_22

Object

item_XX_CUSTOM_23

Object

item_XX_CUSTOM_24

Object

item_XX_CUSTOM_25

Object

item_XX_CUSTOM_26

Object

item_XX_CUSTOM_27

Object

item_XX_CUSTOM_28

Object

item_XX_CUSTOM_29

Object

item_XX_CUSTOM_30

Object

3.86. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSearchView

PosUOMItemSearchView Simplified view for PosUOMItem.

Field Name Required Type Description Format

businessUnitGroupID

String

A unique retailer assigned identifier for the business unit group

itemID

String

Item number. Alphanumeric key that identifies the item uniquely.

uomCode

String

Unit of measure code

name

String

The name by which the item is known.

mainPOSItemId

String

The main POS item identifier

unitOfMeasureName

String

Unit of measure code

merchandiseHierarchyGroupName

String

Merchandise Hierarchy Group Name

priceAmount

Double

Amount of the price

double

formattedPriceAmount

String

Formatted price amount. To be filled by clients, not filled by server

packagePriceQuantity

Integer

int32

priceGroupId

String

itemCollectionSet

Boolean

True if the item has an Item Collection.

defaultSellingUnitOfMeasureCode

String

posItemId

String

The POS item identifier. Filled only when the {@link com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemSearchFilter#optionLoadPosIdentity} is set to true.

characteristicViewList

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSearchCharacteristicView

List of characteristic views.

uom_ITEM_XX_CUSTOM_01

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_02

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_03

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_04

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_05

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_06

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_07

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_08

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_09

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_10

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_11

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_12

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_13

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_14

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_15

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_16

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_17

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_18

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_19

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_20

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_21

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_22

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_23

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_24

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_25

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_26

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_27

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_28

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_29

String

Additional field for custom development.

uom_ITEM_XX_CUSTOM_30

String

Additional field for custom development.

item_XX_CUSTOM_01

String

Additional field for custom development.

item_XX_CUSTOM_02

String

Additional field for custom development.

item_XX_CUSTOM_03

String

Additional field for custom development.

item_XX_CUSTOM_04

String

Additional field for custom development.

item_XX_CUSTOM_05

String

Additional field for custom development.

item_XX_CUSTOM_06

String

Additional field for custom development.

item_XX_CUSTOM_07

String

Additional field for custom development.

item_XX_CUSTOM_08

String

Additional field for custom development.

item_XX_CUSTOM_09

String

Additional field for custom development.

item_XX_CUSTOM_10

String

Additional field for custom development.

item_XX_CUSTOM_11

String

Additional field for custom development.

item_XX_CUSTOM_12

String

Additional field for custom development.

item_XX_CUSTOM_13

String

Additional field for custom development.

item_XX_CUSTOM_14

String

Additional field for custom development.

item_XX_CUSTOM_15

String

Additional field for custom development.

item_XX_CUSTOM_16

String

Additional field for custom development.

item_XX_CUSTOM_17

String

Additional field for custom development.

item_XX_CUSTOM_18

String

Additional field for custom development.

item_XX_CUSTOM_19

String

Additional field for custom development.

item_XX_CUSTOM_20

String

Additional field for custom development.

item_XX_CUSTOM_21

String

Additional field for custom development.

item_XX_CUSTOM_22

String

Additional field for custom development.

item_XX_CUSTOM_23

String

Additional field for custom development.

item_XX_CUSTOM_24

String

Additional field for custom development.

item_XX_CUSTOM_25

String

Additional field for custom development.

item_XX_CUSTOM_26

String

Additional field for custom development.

item_XX_CUSTOM_27

String

Additional field for custom development.

item_XX_CUSTOM_28

String

Additional field for custom development.

item_XX_CUSTOM_29

String

Additional field for custom development.

item_XX_CUSTOM_30

String

Additional field for custom development.

3.87. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSellingPriceDO

PosUOMItemSellingPriceDO Selling price

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemSellingPriceDO.Key

priceExpirationDate

String

Expiration (end) time stamp of the price Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

priceAmount

Double

Amount of the price

double

packagePriceQuantity

Integer

int32

priceGroupId

String

description

String

Additional information concerning the price (e.g. campaign number)

xx_CUSTOM_01

String

Additional field for custom development.

xx_CUSTOM_02

String

Additional field for custom development.

xx_CUSTOM_03

String

Additional field for custom development.

xx_CUSTOM_04

String

Additional field for custom development.

xx_CUSTOM_05

String

Additional field for custom development.

xx_CUSTOM_06

String

Additional field for custom development.

xx_CUSTOM_07

String

Additional field for custom development.

xx_CUSTOM_08

String

Additional field for custom development.

xx_CUSTOM_09

String

Additional field for custom development.

xx_CUSTOM_10

String

Additional field for custom development.

xx_CUSTOM_11

String

Additional field for custom development.

xx_CUSTOM_12

String

Additional field for custom development.

xx_CUSTOM_13

String

Additional field for custom development.

xx_CUSTOM_14

String

Additional field for custom development.

xx_CUSTOM_15

String

Additional field for custom development.

xx_CUSTOM_16

String

Additional field for custom development.

xx_CUSTOM_17

String

Additional field for custom development.

xx_CUSTOM_18

String

Additional field for custom development.

xx_CUSTOM_19

String

Additional field for custom development.

xx_CUSTOM_20

String

Additional field for custom development.

xx_CUSTOM_21

String

Additional field for custom development.

xx_CUSTOM_22

String

Additional field for custom development.

xx_CUSTOM_23

String

Additional field for custom development.

xx_CUSTOM_24

String

Additional field for custom development.

xx_CUSTOM_25

String

Additional field for custom development.

xx_CUSTOM_26

String

Additional field for custom development.

xx_CUSTOM_27

String

Additional field for custom development.

xx_CUSTOM_28

String

Additional field for custom development.

xx_CUSTOM_29

String

Additional field for custom development.

xx_CUSTOM_30

String

Additional field for custom development.

3.88. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSellingPriceDOKey

PosUOMItemSellingPriceDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique retailer assigned identifier for the business unit group

itemID

X

String

Item number. Alphanumeric key that identifies the item uniquely.

uomCode

X

String

Unit of measure code

priceTypeCode

X

String

Type code of price (00 = default price, 01 = special price, PG = group price)

Enum: DEFAULT_PRICE, SPECIAL_PRICE, PRICE_GROUP, HISTORICAL_PRICE,

priceEffectiveDate

X

String

Effective (start) time stamp of the price Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

3.89. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemText

PosUOMItemText Item text for the specific unit of measure

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemText.Key

text

String

Text in the nominated language

pictureFlag

Boolean

A flag to indicate if the text contains a link to the picture file for this item.

xx_CUSTOM_01

String

Additional field for custom development.

xx_CUSTOM_02

String

Additional field for custom development.

xx_CUSTOM_03

String

Additional field for custom development.

xx_CUSTOM_04

String

Additional field for custom development.

xx_CUSTOM_05

String

Additional field for custom development.

xx_CUSTOM_06

String

Additional field for custom development.

xx_CUSTOM_07

String

Additional field for custom development.

xx_CUSTOM_08

String

Additional field for custom development.

xx_CUSTOM_09

String

Additional field for custom development.

xx_CUSTOM_10

String

Additional field for custom development.

xx_CUSTOM_11

String

Additional field for custom development.

xx_CUSTOM_12

String

Additional field for custom development.

xx_CUSTOM_13

String

Additional field for custom development.

xx_CUSTOM_14

String

Additional field for custom development.

xx_CUSTOM_15

String

Additional field for custom development.

xx_CUSTOM_16

String

Additional field for custom development.

xx_CUSTOM_17

String

Additional field for custom development.

xx_CUSTOM_18

String

Additional field for custom development.

xx_CUSTOM_19

String

Additional field for custom development.

xx_CUSTOM_20

String

Additional field for custom development.

xx_CUSTOM_21

String

Additional field for custom development.

xx_CUSTOM_22

String

Additional field for custom development.

xx_CUSTOM_23

String

Additional field for custom development.

xx_CUSTOM_24

String

Additional field for custom development.

xx_CUSTOM_25

String

Additional field for custom development.

xx_CUSTOM_26

String

Additional field for custom development.

xx_CUSTOM_27

String

Additional field for custom development.

xx_CUSTOM_28

String

Additional field for custom development.

xx_CUSTOM_29

String

Additional field for custom development.

xx_CUSTOM_30

String

Additional field for custom development.

3.90. ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemTextKey

PosUOMItemText.Key Inner class for composite key attributes

Field Name Required Type Description Format

textNumber

X

Integer

Text number (number of the row)

int32

textClass

X

String

Text class (as part of the reference to the text)

languageId

X

String

A combination of ISO-639-1 and ISO-3661-1 or an own identifier to denote the language

3.91. ComGkSoftwareGkrApiServerMdItemDtoDomPosRelatedItemView

RelatedItemView undocumented

Field Name Required Type Description Format

itemID

String

uomCode

String

mainPOSItemId

String

uomItemName

String

currentPrice

Double

double

uom_ITEM_XX_CUSTOM_01

String

uom_ITEM_XX_CUSTOM_02

String

uom_ITEM_XX_CUSTOM_03

String

uom_ITEM_XX_CUSTOM_04

String

uom_ITEM_XX_CUSTOM_05

String

uom_ITEM_XX_CUSTOM_06

String

uom_ITEM_XX_CUSTOM_07

String

uom_ITEM_XX_CUSTOM_08

String

uom_ITEM_XX_CUSTOM_09

String

uom_ITEM_XX_CUSTOM_10

String

uom_ITEM_XX_CUSTOM_11

String

uom_ITEM_XX_CUSTOM_12

String

uom_ITEM_XX_CUSTOM_13

String

uom_ITEM_XX_CUSTOM_14

String

uom_ITEM_XX_CUSTOM_15

String

uom_ITEM_XX_CUSTOM_16

String

uom_ITEM_XX_CUSTOM_17

String

uom_ITEM_XX_CUSTOM_18

String

uom_ITEM_XX_CUSTOM_19

String

uom_ITEM_XX_CUSTOM_20

String

uom_ITEM_XX_CUSTOM_21

String

uom_ITEM_XX_CUSTOM_22

String

uom_ITEM_XX_CUSTOM_23

String

uom_ITEM_XX_CUSTOM_24

String

uom_ITEM_XX_CUSTOM_25

String

uom_ITEM_XX_CUSTOM_26

String

uom_ITEM_XX_CUSTOM_27

String

uom_ITEM_XX_CUSTOM_28

String

uom_ITEM_XX_CUSTOM_29

String

uom_ITEM_XX_CUSTOM_30

String

3.92. ComGkSoftwareGkrApiServerMdItemWicDtoDomWicCategoryDO

WicCategoryDO Represents one Wic Category.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.item_wic.dto.dom.WicCategoryDO.Key

wicCategoryDescription

String

Category descriptor.

wicSubcategoryDescription

String

Subcategory descriptor.

wicUomDescription

String

Descriptor for the UOM of the Benefit.

3.93. ComGkSoftwareGkrApiServerMdItemWicDtoDomWicCategoryDOKey

WicCategoryDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

wicCategory

X

String

Code indicating the eWic Category.

wicSubcategory

X

String

Code indicating the Sub Category of the eWic Category.

stateId

X

String

State Identifier.

3.94. ComGkSoftwareGkrApiServerMdPartyDtoDomPartyBankAccount

PartyBankAccount Information about bank account.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.party.dto.dom.PartyBankAccount.Key

bankDescription

String

Bank description.

bankAccountNumber

String

Bank account number in a national format, not international.

nationalBankIdentificationCode

String

Bank identification code in a national format.

internationalBankAccountNumber

String

International bank account number (IBAN). A standard number standardized in accordance with the ECBS (European Commitee for Banking Standards) to represent bank details.

bankIdentificationCode

String

Bank identification code in the international format (BIC). Uniquely identifies a bank throughout the world.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.95. ComGkSoftwareGkrApiServerMdPartyDtoDomPartyBankAccountKey

PartyBankAccount.Key Inner class for composite key attributes

Field Name Required Type Description Format

partyID

X

String

A unique, system assigned identity for a Party.

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

bankAccountTypeCode

X

String

This type code is used to differ between multiple bank accounts. Optional - if not provided then filled in the import.

3.96. ComGkSoftwareGkrApiServerMdPartyDtoDomPartyDO

PartyDO An individual or firm that exchanges information and/or goods and services with the store.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.party.dto.dom.PartyDO.Key

organizationTypeCode

String

The type code of the organization.

partyTypeCode

String

The type code of the party.

businessDescription1

String

The 1st line of the description of the business of the customer; this information is e.g. to be printed on invoices in Greece due to tax law requirements.

businessDescription2

String

The 2nd line of the description of the business of the customer; this information is e.g. to be printed on invoices in Greece due to tax law requirements.

partyRoleAssignmentList

List of ComGkSoftwareGkrApiServerMdPartyDtoDomPartyRoleAssignment

List of PartyRoleAssignment

partyIdentificationList

List of ComGkSoftwareGkrApiServerMdPartyDtoDomPartyIdentification

List of PartyIdentification

partyBankAccountList

List of ComGkSoftwareGkrApiServerMdPartyDtoDomPartyBankAccount

List of PartyBankAccount

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.97. ComGkSoftwareGkrApiServerMdPartyDtoDomPartyDOKey

PartyDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

partyID

X

String

A unique, system assigned identity for the party.

businessUnitGroupID

X

String

A unique system assigned identifier for a business unit group.

3.98. ComGkSoftwareGkrApiServerMdPartyDtoDomPartyIdentification

PartyIdentification An official number that may be used to identify the Party. People have multiple forms of such identification: Drivers License number , Passport number, Credit / Debit Card number, Social Security number, Tax number, etc…​ Businesses may also have multiple identifiers to prove that they are a legal entity: Company Incorporation number, Tax number, etc…​

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.party.dto.dom.PartyIdentification.Key

identifier

String

The number on the Identification that identifies the Party, e. g. BusinessNumber, SalesTaxNumber..

externalPartyIdentificationProviderID

String

A retailer assigned code denoting the official body that issued the PartyIdentification to the Party. Used for information about customer cards.

lockingTypeCode

String

Defines why this identifier is locked. Used for information about customer cards.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.99. ComGkSoftwareGkrApiServerMdPartyDtoDomPartyIdentificationKey

PartyIdentification.Key Inner class for composite key attributes

Field Name Required Type Description Format

partyID

X

String

A unique, system assigned identity for the party.

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

partyIdentificationTypeCode

X

String

A code denoting a form of identification, e. g. BusinessTypeCode, TaxTypeCode.

3.100. ComGkSoftwareGkrApiServerMdPartyDtoDomPartyRoleAssignment

PartyRoleAssignment Temporal record of when the Party became (and ceased to be) related to the Retail Enterprise via the PartyRole.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.party.dto.dom.PartyRoleAssignment.Key

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.101. ComGkSoftwareGkrApiServerMdPartyDtoDomPartyRoleAssignmentKey

PartyRoleAssignment.Key Inner class for composite key attributes

Field Name Required Type Description Format

partyID

X

String

A unique, system assigned identity for the party.

businessUnitGroupID

X

String

A unique system assigned identifier for the business unit group.

partyRoleTypeCode

X

String

A code that identifies a group of PARTY ROLES. This is used for subtyping the PARTY ROLEs.

sequenceNumber

X

Integer

A unique system assigned identifier for the particular assignment of Party to the PartyRole.

int32

3.102. ComGkSoftwareGkrApiServerMdPersonDtoDomPersonDO

PersonDO A individual of interest to the retail store or retail enterprise.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.person.dto.dom.PersonDO.Key

languageID

String

A combination of ISO-639-1 and ISO-3661-1 to denote a language as spoken in a particular country.

salutation

String

Extra words that don’t form part of the person’s name but are normally printed before the FirstName as a courtesy title. For instance, Mr. Ms., Miss, Dr., Prof. etc. This represents the primary salutation for this Person.

firstName

X

String

A person’s first name. In western cultures, this is the given name, in other cultures it may be the family name.

lastName

X

String

A person’s last name. In western cultures, this is the family (or patronymic) name, in other cultures it may be the given name.

birthYearNumber

Integer

The year part of the Person’s date of birth.

int32

birthMonthNumber

Integer

A number in the range 1-12 denoting the month part of the Person’s date of birth.

int32

birthDayNumber

Integer

A number in the range 1-31denoting the day of the month part of the Person’s date of birth.

int32

genderType

String

A code for specifying a person’s gender.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.103. ComGkSoftwareGkrApiServerMdPersonDtoDomPersonDOKey

PersonDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

partyID

X

String

A unique, system assigned identity for a Party.

3.104. ComGkSoftwareGkrApiServerMdPetrolDtoDomFuellingPointDO

FuellingPointDO A device used to deliver fuel.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.petrol.dto.dom.FuellingPointDO.Key

protocolTypeCode

X

String

The type of protocol this FuellingPoint uses.

protocolVersionCode

String

The version of the protocol this FuellingPoint uses.

fuellingPointParameterList

List of ComGkSoftwareGkrApiServerMdPetrolDtoDomFuellingPointParameterDO

Additional parameters for fuelling point

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.105. ComGkSoftwareGkrApiServerMdPetrolDtoDomFuellingPointDOKey

FuellingPointDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

fuellingPointID

X

String

A unique identifier for the FuelingPoint at a particular BusinessUnitGroup

3.106. ComGkSoftwareGkrApiServerMdPetrolDtoDomFuellingPointParameterDO

FuellingPointParameterDO Additional parameters for fuelling point

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.petrol.dto.dom.FuellingPointParameterDO.Key

fuellingPointParameterCode

String

Code of fueling point parameter.

fuellingPointParameterName

String

Name of a fueling point parameter.

fuellingPointParameterValue

String

Value of a fueling point parameter.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.107. ComGkSoftwareGkrApiServerMdPetrolDtoDomFuellingPointParameterDOKey

FuellingPointParameterDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

fuellingPointParameterID

X

String

A unique identifier for the FuelingPoint at a particular BusinessUnitGroup

3.108. ComGkSoftwareGkrApiServerMdPetrolDtoDomGradeDO

GradeDO Grade of a fuel.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.petrol.dto.dom.GradeDO.Key

posItemID

X

String

The barcode, point of sale scan code or other keyed identifying number used at POS and the internal stock keping ItemID for the item.

firstTankID

X

String

A unique identifier for this Tank

secondTankID

String

A unique identifier for this Tank

blendPercentage

X

Double

The percentage of the final blend that the given BULK ITEM constitutes. This ratio refers to the first tank. Meaning that the ratio for the 2nd tank in case of blended grades is 100 - BlendPercentage.

double

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.109. ComGkSoftwareGkrApiServerMdPetrolDtoDomGradeDOKey

GradeDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

fuelGradeID

X

String

The identifier of the fuel grade.

3.110. ComGkSoftwareGkrApiServerMdPetrolDtoDomNozzleDO

NozzleDO That part of the FUELING POINT that blends and measures the volume of fuel dispensed during a FUELING TRANSACTION.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.petrol.dto.dom.NozzleDO.Key

tankID

X

String

A unique identifier for this Tank

rfTagNo

String

For RFID Tags which are connected to the nozzle to identify grade, car and customer.

fuelGradeID

X

String

The identifier of the fuel grade.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.111. ComGkSoftwareGkrApiServerMdPetrolDtoDomNozzleDOKey

NozzleDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

nozzleID

X

String

A unique identifier for the Nozzle

fuellingPointID

X

String

A unique identifier for the FuelingPoint at a particular BusinessUnitGroup

3.112. ComGkSoftwareGkrApiServerMdPetrolDtoDomTankDO

TankDO A kind of Location used to store a FuelItem that is measured & dispensed by one or more FuelingPoints

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.petrol.dto.dom.TankDO.Key

fuelGradeID

X

String

Generated ID of a fuel grade.

maximumSafeFillCapacity

Double

The largest capacity that the tank safely holds, taking temperature effects into consideration.

double

lowCapacity

Double

The volume to which a tank may be emptied without prumping vapour into the line. The amount of product that just reaches the entrance of the suction pipe.

double

tankDiameter

Double

The diameter of the tank

double

highWaterSetPoint

Double

The level at which the TankLevelGuage will set off the 'High Water Alarm'

double

itemID

String

Reference to BusinessUnitGroupItem

unitOfMeasureCode

String

The UOM of the Item

fuelProductID

Integer

int32

fuelName

String

tankGroupID

Integer

int32

tankLevelGaugeID

Integer

int32

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

xxcustom06

String

xxcustom07

String

xxcustom08

String

xxcustom09

String

xxcustom10

String

xxcustom11

String

xxcustom12

String

xxcustom13

String

xxcustom14

String

xxcustom15

String

xxcustom16

String

xxcustom17

String

xxcustom18

String

xxcustom19

String

xxcustom20

String

xxcustom21

String

xxcustom22

String

xxcustom23

String

xxcustom24

String

xxcustom25

String

xxcustom26

String

xxcustom27

String

xxcustom28

String

xxcustom29

String

xxcustom30

String

3.113. ComGkSoftwareGkrApiServerMdPetrolDtoDomTankDOKey

TankDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

tankID

X

String

A unique identifier for this Tank

3.114. ComGkSoftwareGkrApiServerMdPriceContractDtoDomPriceContractReadDO

PriceContractReadDO The view object which consolidates data from Price Contract tables.

Field Name Required Type Description Format

priceContractID

String

The identifier of a contract which was created for a customer or customer group

itemID

String

Reference to the Item.

posItemID

String

The POS Item ID.

unitOfMeasureCode

String

The UOM of the Item.

effectiveDateTime

String

Effective (start) Time Stamp of that price. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

expirationDateTime

String

Expiration (end) Time Stamp of that price. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

saleUnitRetailPriceAmount

Double

The agreed sales unit price for the item.

double

customerID

String

A unique system assigned identifier for the Customer.

customerGroupID

String

Customer group ID.

3.115. ComGkSoftwareGkrApiServerMdRelatedItemAssociationTypeDtoDomRelatedItemAssociationTypeDO

RelatedItemAssociationTypeDO undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.related_item_association_type.dto.dom.RelatedItemAssociationTypeDO.Key

name

String

The name of the association type

sortSequence

Integer

A sequential number that indicates the order being used when displaying the association types in the launchpad function.

int32

purposeTypeCode

String

The type of the purpose of the item association. Values: * null - default, used for e.g. Variant, Bundle, Subtype, Ingredient * Meal - Component without Alternative items * MealAlternative - Component with Alternative items * Condiment - Condiment component

translationList

List of ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

List of translations

packageID

String

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.Generated, not imported.

xxcustom06

String

Additional field for custom development.

xxcustom07

String

Additional field for custom development.

xxcustom08

String

Additional field for custom development.

xxcustom09

String

Additional field for custom development.

xxcustom10

String

Additional field for custom development.

xxcustom11

String

Additional field for custom development.

xxcustom12

String

Additional field for custom development.

xxcustom13

String

Additional field for custom development.

xxcustom14

String

Additional field for custom development.

xxcustom15

String

Additional field for custom development.

xxcustom16

String

Additional field for custom development.

xxcustom17

String

Additional field for custom development.

xxcustom18

String

Additional field for custom development.

xxcustom19

String

Additional field for custom development.

xxcustom20

String

Additional field for custom development.

xxcustom21

String

Additional field for custom development.

xxcustom22

String

Additional field for custom development.

xxcustom23

String

Additional field for custom development.

xxcustom24

String

Additional field for custom development.

xxcustom25

String

Additional field for custom development.

xxcustom26

String

Additional field for custom development.

xxcustom27

String

Additional field for custom development.

xxcustom28

String

Additional field for custom development.

xxcustom29

String

Additional field for custom development.

xxcustom30

String

Additional field for custom development.

3.116. ComGkSoftwareGkrApiServerMdRelatedItemAssociationTypeDtoDomRelatedItemAssociationTypeDOKey

RelatedItemAssociationTypeDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

relatedItemAssociationTypeCode

X

String

The type of the association

3.117. ComGkSoftwareGkrApiServerMdScaleDomainDtoDomScaleDomainDO

ScaleDomainDO Scale domains are used for grouping scale items, e.g. meat, cheese, sausages.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.scale_domain.dto.dom.ScaleDomainDO.Key

description

String

Scales domain description

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.118. ComGkSoftwareGkrApiServerMdScaleDomainDtoDomScaleDomainDOKey

ScaleDomainDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

The unique identifier of the business unit group.

scaleDomainID

X

String

Scales domain identifier

3.119. ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

TenderDO Tender includes all the forms of payment that are accepted by the retail store in settling sales and other transactions.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO.Key

tenderClassCode

X

String

A code to denote a group of tenders with common characteristics, e.g. payment cards, certificates, etc.

description

String

Description of the tender type.

minimumAcceptAmount

Double

The minimum value that can be accepted for an individual tender. For example, certain retailers will not accept card payments below $5.

double

maximumAcceptAmount

Double

The maximum amount that can be accepted for a specific tender type.

double

itemRestrictionsApplyFlag

Boolean

A flag to signify that specific groups of items cannot be purchased using certain tender types. For example, food stamps cannot be used to purchase alcohol or tobacco items.

openCashDrawerRequiredFlag

Boolean

A flag that signifies that the cash drawer opens if a certain specific tender type is offered by the customer. For example, cash.

changeThresholdAmount

Double

The maximum change that can be offered to a customer for a specific tender type.

double

tillCountFlag

Boolean

Determines whether the tender should be shown in accounting functions for tills.

denominationFlag

Boolean

Determines whether denomination is applicable for the tender.

pickupTypeCode

String

Defines type of tender pickup:

  • NOT_ALLOWED(01) - Not allowed

  • ALLOWED(02) - Allowed

Enum: NOT_ALLOWED, ALLOWED,

changeAllowedFlag

Boolean

Determines whether change is possible.

unitCountRequiredFlag

Boolean

Defines if the tender count is registered in accounting functions.

amountCountRequiredFlag

Boolean

Defines if the tender amount is registered in accounting functions.

voidingAllowedFlag

Boolean

Defines whether a sales transaction which contains this tender can be voided later.

depositAllowedFlag

Boolean

Determines whether this tender is allowed for deposit.

blockingFlag

Boolean

Determines whether this tender can be used for payment and accounting.

deliveryTypeCode

String

A typecode to define how a tender is picked up from safe / delivered to bank:

  • NO_DELIVERY(00) - no delivery

  • MANUAL_DELIVERY(01) - manual delivery

  • AUTOMATIC_DELIVERY(02) - automatic delivery

Enum: NO_DELIVERY, MANUAL_DELIVERY, AUTOMATIC_DELIVERY, BANK_PAYMENT_ONLY, SAFEBAG_PACKING_ONLY, SAFE_PAYOUT_ONLY,

controlledBySafeFlag

Boolean

Determines whether the tender should be shown in safe accounting functions.

inputAmountConstraint

String

Defines whether payment amount should be entered.

  • REQUIRED(01) - required

  • OPTIONAL(02) - optional

  • PROHIBITED(03) - prohibited

  • CONFIRM(04) - confirm

Enum: REQUIRED, OPTIONAL, PROHIBITED, CONFIRM,

allowedAmountTypeCode

String

Defines what amount is allowed.

  • EXACTLY(01) - EXACTLY

  • EXACTLY_AND_LESS(02) - EXACTLY_AND_LESS

  • EXACTLY_AND_MORE(03) - EXACTLY_AND_MORE

  • ALL(04) - ALL

Enum: EXACTLY, EXACTLY_AND_LESS, EXACTLY_AND_MORE, ALL,

tenderGroupCode

String

Defines the tender group used by POS payment functions:

  • CASH,

  • TERMINAL,

  • GIFT_CERT,

  • COUPON,

  • CHEQUE,

  • CREDIT,

  • PROMOTION,

  • POINTS,

  • CASHENGINE

Enum: CASH, TERMINAL, GIFT_CERT, COUPON, CHEQUE, CREDIT, PROMOTION, POINTS, CASHENGINE,

checkAvailableAmountFlag

Boolean

This flag determines whether the current value of the tender in the till is checked.

pickupWarningFlag

Boolean

If this flag is set to true, a warning is shown on POS in the case that the actual amount of the till for that tender is equal or larger than the PickupWarningLimit

pickupWarningLimit

Double

Defines the limit for a tender pickup from the till, see also PickupWarningFlag

double

immediateVoidingAllowedFlag

Boolean

Defines whether this tender can be voided during the tender registration process (i.e. while the transaction is not finished yet)

receiptPrinterName

String

Additional tender description which is used on POS side.

exclusiveFlag

Boolean

Defines whether this tender can be used only exclusively, i.e. no other tenders can be combined with it in one transaction.

saleReturnTypeCode

String

Determines whether the tender can be used only for sales, only for returns, or for both:

  • SALES_AND_RETURNS(00) - for sales and returns

  • SALES(01) - only for sales

  • RETURNS(02) - only for returns

Enum: SALES_AND_RETURNS, SALES, RETURNS,

sortSequence

Integer

Sort sequence for tenders in reports and backoffice functions.

int32

safeCountFlag

Boolean

Determines whether this tender will be counted for safe.

receiptPrintoutTypeCode

String

Determines whether for this tender will be printed sales receipt:

  • AUTOMATIC_PRINTOUT(00) - automatic printout of sales receipt

  • OPTIONAL_PRINTOUT(01) - optional printout (decision by user)

  • NO_AUTOMATIC_PRINTOUT(02) - no automatic printout

  • RECEIPT_AS_EMAIL(03) - receipt as email

Enum: AUTOMATIC_PRINTOUT, OPTIONAL_PRINTOUT, NO_AUTOMATIC_PRINTOUT, RECEIPT_AS_EMAIL,

negativeValueAllowedFlag

Boolean

Determines whether negative values can be input; is used in the context of foreign turnover registration.

itemRestrictApplyTypeCode

String

A typecode to signify that only a specific group of items can be purchased using this tender. Possible values:

  • WIC - tender is allowed only for items with WICFlag

  • FOST- tender is allowed only for items with AllowFoodStampFlag

Enum: WIC, FOST,

roundingRequiredFlag

Boolean

Determines whether the tender amount has to be rounded according to the rounding rules of the main currency

tenderHandlingRuleID

String

Reference to the tender handling rule (tender fields additional to ARTS)

tenderRestrictionRuleList

List of ComGkSoftwareGkrApiServerMdTenderDtoDomTenderRestrictionRule

List of tender restriction rules.

translationList

List of ComGkSoftwareGkrApiServerCommonTranslationsDtoDomTranslationDO

List of translations for the tender.

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

origin

String

Type of origin. OriginCode: PARENT_COPY = '00' IMPORT = '01' MANUAL = '02'

Enum: PARENT_COPY, IMPORT, MANUAL,

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.

isocurrencyCode

X

String

The identifier of the currency used for the tender.

3.120. ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDOKey

TenderDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

tenderTypeCode

X

String

A code which uniquely identifies the type of tender, e.g. cash, check, payment card, etc.

3.121. ComGkSoftwareGkrApiServerMdTenderDtoDomTenderRestrictionRule

TenderRestrictionRule Describes in which situations which tenders are forbidden

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderRestrictionRule.Key

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.122. ComGkSoftwareGkrApiServerMdTenderDtoDomTenderRestrictionRuleKey

TenderRestrictionRule.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

tenderTypeCode

X

String

A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.

forbiddenTransactionTypeCode

X

String

Transaction type; 0 = irrelevant (tender is forbidden for any transaction type)

forbiddenLineItemTypeCode

X

String

Position type; 0 = irrelevant (tender is forbidden for any position type)

3.123. ComGkSoftwareGkrApiServerMdTenderRuleDtoDomTenderAdjustmentRuleDO

TenderAdjustmentRuleDO Possible transformations from one tender to another.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.tender_rule.dto.dom.TenderAdjustmentRuleDO.Key

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

origin

String

Type of origin. OriginCode: PARENT_COPY = '00' IMPORT = '01' MANUAL = '02'

Enum: PARENT_COPY, IMPORT, MANUAL,

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.124. ComGkSoftwareGkrApiServerMdTenderRuleDtoDomTenderAdjustmentRuleDOKey

TenderAdjustmentRuleDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

originalTenderTypeCode

X

String

Tender from which is to be transformed.

newTenderTypeCode

X

String

Tender to which is to be transformed.

3.125. ComGkSoftwareGkrApiServerMdTillDtoDomTillDO

TillDO Tills

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.till.dto.dom.TillDO.Key

defaultOpeningCashBalanceAmount

X

Double

The opening Tender balance with which the Till will typically start.

double

loanCalculationRequiredFlag

Boolean

Determines whether function 'loan' requires counting the cash money and registering the counted amount, or whether counting is skipped and the default amount is used

loanRequiredFlag

Boolean

Determines whether the loan function should be used

blockingFlag

Boolean

Determines whether the till is locked

tillBarcode

String

The barcode of the till

assignmentTypeCode

X

String

The assignment mode which is used for that till

  • DRAWER_FOR_ONLY_ONE_CASHIER01(01)

  • JOINT_DRAWER_FOR_SEVERAL_CASHIERS(02)

  • DRAWER_FOR_ONLY_ONE_CASH_REGISTER(03)

  • DRAWER_FOR_ONLY_ONE_CASH_RECYCLER(04)

Enum: DRAWER_FOR_ONLY_ONE_CASHIER, JOINT_DRAWER_FOR_SEVERAL_CASHIERS, DRAWER_FOR_ONLY_ONE_CASH_REGISTER, DRAWER_FOR_ONLY_ONE_CASH_RECYCLER, DRAWER_WITHOUT_ASSIGNMENT,

workstationID

String

ID of the workstation. It is only filled if till is assigned to workstation.

tillOperatorList

List of ComGkSoftwareGkrApiServerMdTillDtoDomTillOperatorDO

The list operators that are allowed to use the till.

tillClearingTypeCode

X

String

Determines how the till is to be cleared

  • VARIABLE_CHANGE(01)

  • FIXED_CHANGE_AMOUNT(02)

  • COMPLETE_PICKUP(03)

  • MANUAL_CHANGE(04)

  • COMPLETE_PICKUP_TARGET(13)

Enum: VARIABLE_CHANGE, FIXED_CHANGE_AMOUNT, COMPLETE_PICKUP, MANUAL_CHANGE, COMPLETE_PICKUP_TARGET,

settlementTypeCode

X

String

Defines the settlement mode

  • CONTINUOUS_USE(01)

  • ON_A_DAILY_BASIS(02)

Enum: CONTINUOUS_USE, ON_A_DAILY_BASIS,

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

trainingModeFlag

X

Boolean

Determines whether the till is used for education.

statusDateTimeStamp

String

date and time of the till status Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

tillEnabled

Boolean

TODO

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.126. ComGkSoftwareGkrApiServerMdTillDtoDomTillDOKey

TillDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

tillID

X

String

The unique identifier for the till.

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

3.127. ComGkSoftwareGkrApiServerMdTillDtoDomTillOperatorDO

TillOperatorDO Allowed operators

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.till.dto.dom.TillOperatorDO.Key

modificationTimestamp

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.128. ComGkSoftwareGkrApiServerMdTillDtoDomTillOperatorDOKey

TillOperatorDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

operatorID

X

String

Identifier of the operator

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

tillID

X

String

The unique identifier for the till.

3.129. ComGkSoftwareGkrApiServerMdTimeGroupDtoDomTimePeriod

TimePeriod Time periods.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.time_group.dto.dom.TimePeriod.Key

dayOfWeek

String

A 2 character code denoting the day of the week that the time period falls on.

Enum: MO, TU, WE, TH, FR, SA, SU,

startTime

String

The time of day that the time period commences. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

duration

Integer

The duration included in the time period from the start time.

int32

timeRestriction

String

The time restriction in cron format.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.130. ComGkSoftwareGkrApiServerMdTimeGroupDtoDomTimePeriodKey

TimePeriod.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

internalTimePeriodID

X

String

Internal generated ID for time period.

3.131. ComGkSoftwareGkrApiServerMdWorkerDtoDomWorkerDO

WorkerDO A person who provides services to a retail store. May be either an employee or a contractor.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.worker.dto.dom.WorkerDO.Key

partyID

String

A unique, system assigned identity for a party.

person

com.gk_software.gkr.api.server.md.person.dto.dom.PersonDO

contact

com.gk_software.gkr.api.server.md.contact.dto.dom.ContactDO

workerDiscountGroupAssignmentList

List of ComGkSoftwareGkrApiServerMdWorkerDtoDomWorkerDiscountGroupAssignment

List of the discount groups assigned to the employee.

origin

String

Origin of the import

  • 00 - IMPORT

  • 01 - MANUAL

Enum: IMPORT, MANUAL,

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.

taxNumber

String

TaxID of the sales representative

workerLevel

Integer

The worker level in worker hierarchy. Used for security purposes - if a worker can maintain or see (GDPR) another user.

int32

dataProtectCode

String

The data protection code being used for the evaluation of the data protection requirements.

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.132. ComGkSoftwareGkrApiServerMdWorkerDtoDomWorkerDOKey

WorkerDO.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of business units.

workerID

X

String

A unique system-assigned identifier for the person who is a particular worker.

3.133. ComGkSoftwareGkrApiServerMdWorkerDtoDomWorkerDiscountGroupAssignment

WorkerDiscountGroupAssignment A group of employees who share the same employee discount privilege.

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.server.md.worker.dto.dom.WorkerDiscountGroupAssignment.Key

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.134. ComGkSoftwareGkrApiServerMdWorkerDtoDomWorkerDiscountGroupAssignmentKey

WorkerDiscountGroupAssignment.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

The unique identifier of the business unit group.

employeeDiscountGroupID

X

String

The identifier for a specific employee discount group.

workerID

X

String

A unique system-assigned identifier for the person who is a particular worker.

3.135. ComGkSoftwareGkrApiTcoDtoTillCopyObject

TillCopyObject undocumented

Field Name Required Type Description Format

loanRequired

X

Boolean

Defines if loan must be entered.

localValuesOnly

X

Boolean

In certain conditions server is not able to provide reliable Server TCO. If such situation occur then this flag is set to true. And values are computed only locally.

entryList

List of ComGkSoftwareGkrApiTcoDtoTillCopyObjectEntry

List of group-by-tender values

xxcustom03

String

Standard extension pattern for extending object in project

xxcustom02

String

Standard extension pattern for extending object in project

xxcustom05

String

Standard extension pattern for extending object in project

xxcustom04

String

Standard extension pattern for extending object in project

xxcustom01

String

Standard extension pattern for extending object in project

3.136. ComGkSoftwareGkrApiTcoDtoTillCopyObjectEntry

TillCopyObjectEntry undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.tco.dto.TillCopyObjectEntry.Key

foreignCurrencyAmount

Double

Target value of the tender

double

amount

Double

Target value of the tender in main currency

double

mediaUnitQuantity

Integer

Target value of the tender

int32

xxcustom03

String

Standard extension pattern for extending object in project

xxcustom02

String

Standard extension pattern for extending object in project

xxcustom05

String

Standard extension pattern for extending object in project

xxcustom04

String

Standard extension pattern for extending object in project

xxcustom01

String

Standard extension pattern for extending object in project

3.137. ComGkSoftwareGkrApiTcoDtoTillCopyObjectEntryKey

TillCopyObjectEntry.Key Inner class for composite key attributes

Field Name Required Type Description Format

tenderTypeCode

X

String

TenderTypeCode of the tender

3.138. ComGkSoftwareGkrApiTxpoolDtoAdditionalBonusDiscountLineItem

AdditionalBonusDiscountLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.AdditionalBonusDiscountLineItem.Key

promotionID

String

The unique identifier for a promotion.

priceDerivationRuleID

String

A identifier for a specific price derivation rule.

priceDerivationRuleEligibilityID

String

A unique identifier for a Price Derivation Rule Eligibility.

additionalBonusID

X

String

The ident of the additional bonus. This is needed by PCE in order to establish a relationship between additional bonus items being provided to it in the request as additional bonus line items on the one hand and the corresponding promotion price derivation rules of type 'additional bonus' on the other hand.

itemID

String

Reference to BusinessUnitGroupItem

unitOfMeasureCode

String

The UOM of the Item

merchandiseHierarchyGroupIDQualifier

String

Qualifier which is used to differ between MerchandiseHierarchyGroup’s belonging to different functions but having the same id

merchandiseHierarchyGroupID

String

Unique system assigned identifier for a group or class of merchandise.

merchandiseSetGroupID

String

System-generated unique identifier for a merchandise set (group of mechandise set elements). This is needed for technical reasons.

merchandiseSetID

String

Unique (within the context of the merchandise set) system-generated identifier of the mechandise set element

totalAdditionalBonusQuantity

X

Double

Denotes the total additional bonus quantity that should be granted. Is 0 in case the AdditionalBonusDiscountLineItem does not belong to any applied promotion.

double

quantityDifference

X

Double

Denotes the difference between TotalAdditionalBonusQuantity and the additional bonus items being present in the transaction (total quantity of sale return line items of type 'additional bonus' with concerning AdditionalBonusLineItem.AdditionalBonusID).positive value - there are not enough additional bonus items in the transaction providednegative value - there are too many additional bonus items in transaction provided0 value - match

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.139. ComGkSoftwareGkrApiTxpoolDtoAdditionalBonusDiscountLineItemKey

AdditionalBonusDiscountLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.140. ComGkSoftwareGkrApiTxpoolDtoAdditionalBonusLineItem

AdditionalBonusLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.AdditionalBonusLineItem.Key

additionalBonusID

X

String

The ident of the additional bonus. This is needed by PCE in order to find the corresponding promotion price derivation rules of type 'additional bonus'.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.141. ComGkSoftwareGkrApiTxpoolDtoAdditionalBonusLineItemKey

AdditionalBonusLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction.

int32

3.142. ComGkSoftwareGkrApiTxpoolDtoCheckTenderLineItem

CheckTenderLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.CheckTenderLineItem.Key

fullMICR

String

The complete string of characters read from the MICR (Magnetic Ink Character Recognition) strip.Content varies by Country and/or Financial Institution but it usually contains BankID, CheckAccountNumber and CheckSequenceNumber - but there may be more data encoded in the MICR.

checkSequenceNumber

Integer

A unique sequence number relating to a particular check authorization.

int32

adjudicationCode

String

A code to denote that approval has been received from the authorization center.

checkCardNumber

String

The number from a bank issued card guaranteeing checks up to a certain value.

bankID

String

The unique identifier of the bank or third party authorization center.

checkAccountNumber

String

The check account number

bankIdentifierCode

String

Bank Identifier Code. Also known as SWIFT Code.

internationalBankAccountNumber

String

International Bank Account Number

checkNumber

String

A unique sequence number relating to a particular check authorization.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.143. ComGkSoftwareGkrApiTxpoolDtoCheckTenderLineItemKey

CheckTenderLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.144. ComGkSoftwareGkrApiTxpoolDtoCompleteTransaction

CompleteTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.CompleteTransaction.Key

correlatedToList

List of ComGkSoftwareGkrApiTxpoolDtoTransaction

List of transactions that influence meaning of of the transaction

onlineChecked

X

Boolean

True if this transaction state was checked against central service.False means that the state might not be quite right, but we optimisticallyallow client to continue.

checksum

X

String

Checksum of correlated transactions, to be used while construction correlation attributes

3.145. ComGkSoftwareGkrApiTxpoolDtoCompleteTransactionKey

CompleteTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

transaction

X

com.gk_software.gkr.api.txpool.dto.Transaction

3.146. ComGkSoftwareGkrApiTxpoolDtoControlTransaction

ControlTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.ControlTransaction.Key

typeCode

String

A code that describes the type of control transaction.

fuelingTransaction

com.gk_software.gkr.api.txpool.dto.FuelingTransaction

posnoSaleTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoPOSNoSaleTransaction

data for no sale transactions

signOnTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoSignOnTransaction

data for sign on transactons

signOffTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoSignOffTransaction

data for sign off transactons

tillTenderSettlementTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoTillTenderSettlementTransaction

data for till tender settlements

storeSafeSettlementTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTransaction

data for store safe tender settlements

depositBagTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoDepositBagTransaction

data for safebag status changes

depositBagSettlementTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTransaction

data for safebag settlements

taxRefundTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoTaxRefundTransaction

data for tax refund

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.147. ComGkSoftwareGkrApiTxpoolDtoControlTransactionKey

ControlTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.148. ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTenderDenomination

DepositBagSettlementTenderDenomination undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.DepositBagSettlementTenderDenomination.Key

typeCode

String

The denomination type code

pieceValue

X

Double

Piece value 

double

rollFlag

X

Boolean

Determines whether the DenominationCount value is expressed in coin rolls (true) or single coins/notes (false)

rollCapacity

X

Double

Count of coins in the roll 

double

denominationCount

X

Double

The count of the denomination

double

denominationAmount

X

Double

The total amount of the denomination

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.149. ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTenderDenominationKey

DepositBagSettlementTenderDenomination.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderTypeCode

X

String

A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.

denominationSequenceNumber

X

Integer

Line number (incremental counter) of the denomination 

int32

3.150. ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTenderDetail

DepositBagSettlementTenderDetail undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.DepositBagSettlementTenderDetail.Key

tenderDescription

String

Description of the tender

tenderClassCode

String

The tender class code from master data

currencySymbol

String

The currency symbol

exchangeRate

Double

The quantitative conversion factor between foreign currency and local currency. 
Fixed decimal precision expected, definition of used precision: double(14, 9). Be aware of this and round value!

double

exchangeRateMultiplyFlag

X

Boolean

Determines whether inside the calculation foreign currency → local currency the amount is to be multiplied with (true) or divided by (false) the ExchangeRate factor 

unitCountRequiredFlag

X

Boolean

A flag to signify that specific tender type units need to be counted and recorded by the operator prior to a pickup. 

amountCountRequiredFlag

X

Boolean

A flag to signify that a specific tender type amount needs to be counted and recorded by the operator prior to a pickup. 

openBalanceAmount

X

Double

The opening tender balance

double

openMediaUnitQuantity

Integer

The opening number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)

int32

closeBalanceAmount

X

Double

The closing tender balance in main currencyCorresponds to the target values.

double

foreignCurrencyCloseBalanceAmount

Double

The closing tender balance expressed in the currency of the tender
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

closeMediaUnitQuantity

Integer

The closing number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)

int32

countedBalanceAmount

X

Double

The counted tender balance in main currency

double

foreignCurrencyCountedBalanceAmount

Double

The counted tender balance expressed in the currency of the tender
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

countedMediaUnitQuantity

Integer

The counted number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)

int32

overUnderBalanceAmount

X

Double

The variance between closing balance amount and counted balance amount by subtracting the CloseBalanceAmount from the CountedBalanceAmount

double

overUnderMediaUnitQuantity

Integer

The variance between closing media unit quantity and counted media unit quantity by subtracting the CloseMediaUnitQuantity from the CountedMediaUnitQuantity.

int32

depositBagSettlementTenderDenominationList

List of ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTenderDenomination

denomination list for counted values

xxcustom03

String

Customizable information 

xxcustom02

String

Customizable information 

xxcustom05

String

Customizable information 

xxcustom04

String

Customizable information 

xxcustom01

String

Customizable information 

isocurrencyCode

String

The currency code of the tender

3.151. ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTenderDetailKey

DepositBagSettlementTenderDetail.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderTypeCode

X

String

A code which uniquely identifies the tender

3.152. ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTransaction

DepositBagSettlementTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.DepositBagSettlementTransaction.Key

depositBagID

X

String

Automatically generated (with another algorithm like reference number in bank payment) unique Safebag ID.

depositBagNumber

X

String

Safe bag number entered by operator that was used to transport the Tender from the Safe to the ExternalDepository.

depositBagSettlementTenderDetailList

List of ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTenderDetail

tender details

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.153. ComGkSoftwareGkrApiTxpoolDtoDepositBagSettlementTransactionKey

DepositBagSettlementTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.154. ComGkSoftwareGkrApiTxpoolDtoDepositBagTransaction

DepositBagTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.DepositBagTransaction.Key

depositBagID

X

String

automatically generated (with another algorithm like reference number in bank payment) unique Safebag ID

depositBagNumber

X

String

Safe bag number entered by operator that was used to transport the Tender from the Safe to the ExternalDepository.

safeID

String

The unique identifier of the safe

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.155. ComGkSoftwareGkrApiTxpoolDtoDepositBagTransactionKey

DepositBagTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.156. ComGkSoftwareGkrApiTxpoolDtoFrequentShopperPointsModifier

FrequentShopperPointsModifier undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.FrequentShopperPointsModifier.Key

promotionID

String

The unique identifier of the promotion.

priceDerivationRuleID

String

The unique identifier of the price derivation rule. 

priceDerivationRuleEligibilityID

String

The unique identifier of the root eligibility.

triggerSequenceNumber

Integer

The ident of the manual trigger (because one line item can have more than one trigger) 

int32

eligibilityTypeCode

String

The type code of the root eligibility

frequentShopperPointsEarnedCount

X

Double

The number of frequent shopper points earned 

double

frequentShopperPointsEarnedAmount

X

Double

The money equivalent (expressed in local currency) to the number of frequent shopper points earned 

double

appliedQuantity

X

Double

The quantity the points' modifier applies to 

double

computationBaseAmount

X

Double

The amount which was used as base for the points' calculation

double

externalSystemOriginatorFlag

X

Boolean

Determines whether this entry was created by an external system - if yes, it must not be changed, but own price modifications with higher sequence may be applied 

prorateFrom

Integer

The sequence number of the LoyaltyRewardLineItem.Only filled for point shares of transaction related points discounts.

int32

pointsPercentage

Double

The points calculation rule to be applied, expressed as a percentage of the calculation base. Corresponds to ItemPriceDerivationRule.PriceModificationPercent if available.
Fixed decimal precision expected, definition of used precision: double(13, 4). Be aware of this and round value!

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.157. ComGkSoftwareGkrApiTxpoolDtoFrequentShopperPointsModifierKey

FrequentShopperPointsModifier.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

frequentShopperPointsModifierSequenceNumber

X

Integer

The sequence number for this FrequentShopperPointsModifier allowing more than one points' modification to occur on each retail transaction line item. 

int32

3.158. ComGkSoftwareGkrApiTxpoolDtoFuelSalesLineItem

FuelSalesLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.FuelSalesLineItem.Key

fuelSaleStatusCode

X

String

A status code denoting the mode of the Fuel Sale. Possible values are:Prepay: Where the FuelSaleLineItem happens before the FuelingTransactionPostPay: Where the FuelSaleLineItem happens after the Fueling TransactionPrepayRefund: Where the FuelSaleLineItem happens after a Prepay FuelSaleLineItem and the matching FuelingTransaction did not use all of the money

fuelGradeID

X

String

A unique system assigned identifier for the retailer’s itemID (values between 01-99)

unitPrice

X

Double

The price per volume unit charged by the FUELING POINT for the fuel delivered in the FUELING TRANSACTION

double

fuelingPointID

String

A unique identifier for the FuelingPoint at a particular business unit group

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.159. ComGkSoftwareGkrApiTxpoolDtoFuelSalesLineItemKey

FuelSalesLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members.

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction.

int32

3.160. ComGkSoftwareGkrApiTxpoolDtoFuelingTransaction

FuelingTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.FuelingTransaction.Key

itemID

X

String

Reference to the Item

fuelingPointID

String

A unique identifier for the FuelingPoint at a particular BusinessUnitGroup

nozzleID

String

A unique identifier for the Nozzle

typeCode

String

A two charcter code denoting the type of FuelingTransactionEvent being recorded.Possible values includePostPay: Where the FuelingTransaction is yet to be sold by a FuelSalesLineItem in a RetailTransactionPrePayCompletion: Where money has been collected for the FuelingTransaction in a previous FuelSalesLineItem and there is no refund required.PrePayRefund: Where too much money was collected for the FuelingTransaction in a previous FuelSalesLineItem, and a further FuelSalesLineItem in a RetailTransaction is required to deal with the refund.

timeStamp

X

String

The date & time of the completion of the fueling transaction; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

timeStampUTC0

Date

The date & time of the completion of the fueling transaction (UTC0); UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

volume

X

Double

The volume of fuel delivered in the fueling transaction.

double

unitPrice

X

Double

The price per volume unit charged by the FUELING POINT for the fuel delivered in the FUELING TRANSACTION

double

authorizationElapsedTime

Double

The number of milli-seconds elapsed between CUSTOMER lifting NOZZLE and FUELING TRANSACTION commencing
Fixed decimal precision expected, definition of used precision: double(18, 0). Be aware of this and round value!

double

deliveryElapsedTime

Double

The number of seconds between FUELING TRANSACTION commencing and completing. 
Fixed decimal precision expected, definition of used precision: double(18, 0). Be aware of this and round value!

double

saleElapsedTime

X

Double

The number of seconds elapsed between FUELING TRANSACTION completing and being sold at a point of sale.

double

fuelGradeID

X

String

A unique system assigned identifier for the retailer’s itemID (values between 01-99)

unitOfMeasureCode

X

String

The code used to specify the units in which a value is being expressed, or manner in which a measurement has been taken. This code relates to the UCC data element 355.

fleetCardPermissionTypeCode

String

Restricts the possibility of using the fleet card for paying to dedicated merchandise only. The code maintained for the merchandise and the code on the fleet card which is intended to be used for paying the transaction have to match in order that this merchandise can be paid by using the fleet card. Whether/for which line items of the transacttion the matching is given is determined by the external payment provider.

testDeliveryTypeCode

String

Records the clearing of a FUELING TRANSACTION without accepting payment because the fueling transaction was for testing or calibrating the FUELING POINT.

driveOffTypeCode

String

Records the clearing of a FUELING TRANSACTION without accepting payment because the customer simply drove off wthout paying.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.161. ComGkSoftwareGkrApiTxpoolDtoFuelingTransactionKey

FuelingTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

transactionID

X

String

A universally unique identifier for the Transaction. This may be assembled from alternate key members.

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits. 

3.162. ComGkSoftwareGkrApiTxpoolDtoGiftCertificateLineItem

GiftCertificateLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.GiftCertificateLineItem.Key

giftCertificateHandlingTypeCode

String

The type code of gift certificate that defines handling rules for it

giftCertificateTypeCode

String

Identifies a gift certificate type. Corresponds to GiftCertificateClass.GiftCertificateTypeCode 

bookingSuccessfulTypeCode

String

Determines whether the transaction amount was successfully posted to the Stored Value Server. Stays null in case that this information is not relevant for the current gift certificate line item 

bookingCancellationTypeCode

String

Determines whether a cancellation was successfully posted to the Stored Value Server.Stays null in case that this information is not relevant for the current gift certificate line item 

externalSystemAdapterName

String

The name of the adapter of the involved external system

expirationDate

String

The expiration date of the gift certificate ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

remainingBalance

X

Double

The remaining balance of the gift certificate 

double

giftCertificateSerialNumber

String

The serial number that uniquely identifies a GIFT CERTIFICATE.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

gcstransactionUUID

String

The gift certificate server transaction ID 

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.163. ComGkSoftwareGkrApiTxpoolDtoGiftCertificateLineItemKey

GiftCertificateLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.164. ComGkSoftwareGkrApiTxpoolDtoLineItemAssociate

LineItemAssociate undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.LineItemAssociate.Key

workerID

String

A unique system-assigned identifier for the Person who is a particular Worker. 

actionDatetime

X

String

The date and time that the associate performed the action for which a commission is payable. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

workerFirstName

String

The first name of the worker who served the customer 

workerLastName

String

The last name of the worker who served the customer 

actionDatetimeUTC0

X

Date

The UTC0 date and time that the associate performed the action for which a commission is payable. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.165. ComGkSoftwareGkrApiTxpoolDtoLineItemAssociateKey

LineItemAssociate.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.166. ComGkSoftwareGkrApiTxpoolDtoLoyaltyRewardLineItem

LoyaltyRewardLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.LoyaltyRewardLineItem.Key

pointsAwardedCount

Double

The number of loyalty points awarded. 
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

loyaltyRewardTypeCode

String

Describes the kind of loyalty reward, possible values include frequent shopper points, coupon, gift certificate 

promotionID

String

The unique identifier of the promotion.

priceDerivationRuleID

String

The unique identifier of the price derivation rule. 

priceDerivationRuleEligibilityID

String

The unique identifier of the root eligibility.

frequentShopperPointsEarnedAmount

X

Double

The money equivalent (expressed in local currency) to the number of frequent shopper points earned (PointsAwardedCount) 

double

triggerSequenceNumber

Integer

The ident of the manual trigger (because one line item can have more than one trigger) 

int32

computationBaseAmount

X

Double

The amount which was used as base for the points' calculation 

double

externalSystemOriginatorFlag

X

Boolean

Determines whether this entry was created by an external system - if yes, it must not be changed, but own price modifications with higher sequence may be applied 

couponNumber

String

The number of the coupon the customer gets 

couponAmount

X

Double

The monetary value of the coupon the customer gets 

double

giftCertificateFaceValueAmount

X

Double

The monetary value printed or embossed on the GIFT CERTIFICATE.

double

pointsPercentage

Double

The points calculation rule to be applied, expressed as a percentage of the calculation base. Corresponds to ItemPriceDerivationRule.PriceModificationPercent if available.
Fixed decimal precision expected, definition of used precision: double(13, 4). Be aware of this and round value!

double

loyaltyRewardLineItemCouponSerialList

List of ComGkSoftwareGkrApiTxpoolDtoLoyaltyRewardLineItemCouponSerial

list of coupon serials

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.167. ComGkSoftwareGkrApiTxpoolDtoLoyaltyRewardLineItemCouponSerial

LoyaltyRewardLineItemCouponSerial undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.LoyaltyRewardLineItemCouponSerial.Key

couponSerialNumber

X

String

The coupon serial number

bookingSuccessfulTypeCode

String

Determines whether the coupon redemption was successfully posted to the Couponing Service.Stays null in case that no Couponing Service is used. 

bookingTransactionUUID

String

The couponing service transaction ID 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.168. ComGkSoftwareGkrApiTxpoolDtoLoyaltyRewardLineItemCouponSerialKey

LoyaltyRewardLineItemCouponSerial.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

couponSerialSequenceNumber

X

Integer

The sequence number of the coupon serial.This is relevant if multiple coupon serials are issued for one loyalty reward.

int32

3.169. ComGkSoftwareGkrApiTxpoolDtoLoyaltyRewardLineItemKey

LoyaltyRewardLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.170. ComGkSoftwareGkrApiTxpoolDtoPOSNoSaleTransaction

POSNoSaleTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.POSNoSaleTransaction.Key

tillID

String

The unique identifier of the till

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.171. ComGkSoftwareGkrApiTxpoolDtoPOSNoSaleTransactionKey

POSNoSaleTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.172. ComGkSoftwareGkrApiTxpoolDtoPrepaidLineItem

PrepaidLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.PrepaidLineItem.Key

bookingSuccessfulTypeCode

String

Determines whether the prepaid transaction was confirmed. Stays null in case that this information is not relevant for the current prepaid line item 

prepaidProviderName

String

The name of the provider of the prepaid service 

prepaidTransactionID

String

The prepaid transaction ID 

externalSystemAdapterName

String

The name of the adapter of the involved external system

prepaidID

String

The ident of the prepaid PIN. The PIN itself must not be stored. The prepaid ident is needed for support purposes. 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.173. ComGkSoftwareGkrApiTxpoolDtoPrepaidLineItemKey

PrepaidLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.174. ComGkSoftwareGkrApiTxpoolDtoPriceModificationLineItem

PriceModificationLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.PriceModificationLineItem.Key

promotionID

String

The unique identifier of the promotion.

priceDerivationRuleID

String

The unique identifier of the price derivation rule. 

priceDerivationRuleEligibilityID

String

The unique identifier of the root eligibility.

percentage

Double

The percentage value in case of percentage price modifiers.
Fixed decimal precision expected, definition of used precision: double(13, 4). Be aware of this and round value!

double

roundingAmount

Double

The monetary amount that the price modification was adjusted by (after calculation from the percentage). 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

amount

X

Double

The monetary value of the price modification that was given. 

double

proRatedFlag

Boolean

Indicates if this price modification was pro-rated across all of the Items in the RetailTransaction.Always true.

triggerSequenceNumber

Integer

The ident of the manual trigger (because a transaction item can have more than one trigger) 

int32

extendedAmountBeforeModification

X

Double

The retail sale total price of the transaction before applying the current price modification line item 

double

extendedAmountAfterModification

X

Double

The retail sale total price of the transaction before applying the current price modification line item

double

extraAmount

X

Double

A monetary amount which results from applying a price modification line item but does not affect the transaction total 

double

externalSystemOriginatorFlag

X

Boolean

Determines whether this entry was created by an external system - if yes, it must not be changed, but own price modifications with higher sequence may be applied

calculationBaseAmount

X

Double

The amount which was used as base for calculation of the price modification

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.175. ComGkSoftwareGkrApiTxpoolDtoPriceModificationLineItemKey

PriceModificationLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.176. ComGkSoftwareGkrApiTxpoolDtoRetailPriceModifier

RetailPriceModifier undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailPriceModifier.Key

promotionID

String

The unique identifier of the promotion.

priceDerivationRuleID

String

The unique identifier of the price derivation rule. 

priceDerivationRuleEligibilityID

String

The unique identifier of the root eligibility.

reasonCode

String

The reason code for manual price overrides.

previousPrice

Double

The unit price that was valid before manual price override.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

percent

X

Double

The percentage value in case of percentage price modifiers.

double

amount

X

Double

The total amount of the retail price modifier.

double

calculationMethodCode

String

A type code used to identity manual price overrides.

adjustmentMethodCode

String

A mnemonic code denoting what kind of adjustment is being made to the retail price of the Item (Increase, Decrease).

newPrice

Double

The unit price that was the result of the price modification. 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

eligibilityTypeCode

String

The type code of the root eligibility

extendedAmountBeforeModification

X

Double

The retail sale total price of the line item before applying the current price modifier 

double

extendedAmountAfterModification

X

Double

The retail sale total price of the line item after applying the current price modifier 

double

appliedQuantity

X

Double

The quantity the price modifier applies to. Always positive.

double

triggerSequenceNumber

Integer

The ident of the manual trigger (because one line item can have more than one trigger) 

int32

reasonDescription

String

A narrative description describing the reason for manual price overrides.

extraAmount

X

Double

A monetary amount which results from applying a price modifier but does not affect the line item total 

double

roundingAmount

X

Double

The monetary amount that the price modifier was adjusted by. 

double

externalSystemOriginatorFlag

X

Boolean

Determines whether this entry was created by an external system - if yes, it must not be changed, but own price modifications with higher sequence may be applied 

prorateFrom

Integer

The sequence number of the PriceModificationLineItem.Only filled for discount shares of transaction related discounts.

int32

calculationBaseAmount

X

Double

The amount which was used as base for calculation of the price modification

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.177. ComGkSoftwareGkrApiTxpoolDtoRetailPriceModifierKey

RetailPriceModifier.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

retailPriceModifierSequenceNumber

X

Integer

The sequence number for this RetailPriceModifier allowing more than one price modification to occur on each retail transaction line item. 

int32

3.178. ComGkSoftwareGkrApiTxpoolDtoRetailTransaction

RetailTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransaction.Key

retailTransactionTypeCode

String

A retailer assigned code denoting a type of RetailTransaction. 

tillID

String

The unique identifier of the till

receiptDateTime

X

String

The date and time when the receipt for this transaction was printed. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

receiptPrintoutFlag

X

Boolean

Determines whether for this sales transaction a receipt was printed 

promotionTimestamp

String

The timestamp used for promotion validity checks and calculation ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

frequentShopperLostPointsCount

Double

The number of frequent shopper points that HAD been awarded for the purchase in case the customer HAD presented a loyalty card
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

retailTransactionLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

list of line items

retailTransactionTotalList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionTotal

list of total amounts

retailTransactionPromotionTriggerList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionTrigger

list of promotion triggers

retailTransactionExternalTriggerList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionExternalTrigger

list of external triggers

retailTransactionCustomerList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomer

list of customers

retailTransactionCouponSummaryList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCouponSummary

list of coupons

retailTransactionPromotionPriceDerivationRuleList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionPriceDerivationRule

list of conditions

retailTransactionModifierCouponList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionModifierCoupon

list of used coupons

tenderAuthorizationList

List of ComGkSoftwareGkrApiTxpoolDtoTenderAuthorization

terminal authorization list

retailTransactionManufacturerCouponSummaryList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionManufacturerCouponSummary

list of manufacturer coupons

emailRequestedFlag

X

Boolean

send receipt as mail is activated

emailAddressLocalPart

String

local part of entered e-mail address

emailAddressDomainPart

String

domain part of entered e-mail address

invoicePrintoutTypeCode

String

invoice printout is activated

invoiceNumber

String

number of the invoice

receiptDateTimeUTC0

X

Date

The UTC0 timestamp corresponding to the date and time that was printed on the receipt for this transaction. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

promotionTimestampUTC0

Date

The UTC0 timestamp used for promotion validity checks and calculation ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

tableName

String

The name (identifier) for a particular table, at which customers sit to eat food purchased in a RetailTransaction. It may be a table 'number' like '10' or '10.1' or the name of the customer party like 'Mr Mustermann'.

retailTransactionGenericAttributeList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionGenericAttribute

list of generic attributes being valid for the transaction

retailTransactionPromotionRecommendationGroup

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionRecommendationGroup

retailTransactionTaxExemptTriggerList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionTaxExemptTrigger

tax exempt data

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.179. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCouponSerialSummary

RetailTransactionCouponSerialSummary undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionCouponSerialSummary.Key

bookingSuccessfulTypeCode

String

Determines whether the coupon redemption was successfully posted to the Couponing Service.Stays null in case that no Couponing Service is used. 

bookingTransactionUUID

String

The couponing service transaction ID 

expirationTimestamp

String

The last date and time when the coupon is effective ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

expirationTimestampUTC0

Date

The last date and time in UTC0 format when the coupon is effective; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

appliedFlag

X

Boolean

Defines if the coupon serial triggered a promotion price derivation rule.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.180. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCouponSerialSummaryKey

RetailTransactionCouponSerialSummary.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

couponNumber

X

String

The coupon number 

couponSerialNumber

X

String

The coupon serial number

3.181. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCouponSummary

RetailTransactionCouponSummary undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionCouponSummary.Key

inputCount

X

Double

Count of registered coupons 

double

appliedCount

Double

Number of used coupons 
Fixed decimal precision expected, definition of used precision: double(10, 0). Be aware of this and round value!

double

privilegeType

String

Determines how the new price is to be calculated in case that rebate information is given by PrivilegeValue 

privilegeValue

Double

Reduction amount, reduction percent or new price amount – depending on the chosen PrivilegeType
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

customerID

String

A unique system assigned identifier for the Customer.

customerAddressTypeCode

String

The customer type code

retailTransactionCouponSerialSummaryList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCouponSerialSummary

list of coupon serials

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.182. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCouponSummaryKey

RetailTransactionCouponSummary.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

couponNumber

X

String

The coupon number 

3.183. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomer

RetailTransactionCustomer undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomer.Key

genderType

String

A code for specifying a persons gender. 

birthDayNumber

Integer

A number in the range 1-31denoting the day of the month part of the Person’s date of birth. 

int32

birthMonthNumber

Integer

A number in the range 1-12 denoting the month part of the Person’s date of birth. 

int32

birthYearNumber

Integer

The year part of the Person’s date of birth. 

int32

addressTypeDescription

String

The description of the customer type code

genericFlag

X

Boolean

If true, the customer is a dummy/unknown customer 

businessDescription

String

The description of the business of the customer; this information is e.g. to be printed on invoices in Greece due to tax law requirements 

customerIDEntryMethodCode

String

A code that describes how this customer’s identification is being entered (e.g. it is scanned, keyed, etc.) 

firstName

String

A person’s first name.

lastName

String

A person’s last name.

preferredReceiptPrintoutTypeCode

String

Defines the preferred printout settings for the customer

parentCustomerID

String

Number of the customer to which this buyer / contact person belongs.

parentCustomerName1

String

First name line of the customer to which this buyer / contact person belongs.

parentCustomerName2

String

Second name line of the customer to which this buyer / contact person belongs.

retailTransactionCustomerAccountList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerAccount

list of customer accounts

retailTransactionCustomerGroupAssignmentList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerGroupAssignment

list of customer groups

retailTransactionCustomerContactMethodList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerContactMethod

list of contact methods (address, phone, mail, …​)

retailTransactionCustomerIdentificationList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerIdentification

list of customer identitfication numbers

organizationName

String

An ORGANIZATION’s legal trade name.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.184. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerAccount

RetailTransactionCustomerAccount undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerAccount.Key

customerAccountID

String

The customer account number 

customerAccountTypeCode

X

String

Determines what kind of customer account this is.

customerAccountBalance

X

Double

The current balance of the customer account 

double

customerAccountQuerySuccessfulFlag

X

Boolean

Determines whether the request of customer account data was completed successfully 

customerAccountTransactionID

String

The external ident of the accounting transaction of the the customer account

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.185. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerAccountKey

RetailTransactionCustomerAccount.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

customerID

X

String

A unique system assigned identifier for the Customer. 

addressTypeCode

X

String

The customer type code

customerAccountSequenceNumber

X

Integer

Line number (incremental counter) 

int32

3.186. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerContactMethod

RetailTransactionCustomerContactMethod undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerContactMethod.Key

contactTypeCode

X

String

Describes the type of contact. Possible values include e-mail address, address, telephone, internet URL. 

emailAddressLocalPart

String

The local-part portion is a domain-dependent string. In addresses, it is simply interpreted on the particular host as a name of a particular mailbox. 

emailAddressDomainPart

String

The domain portion identifies the point to which the mail is delivered. In the dot-atom form, this is interpreted as an Internet domain name (either a host name or a mail exchanger name) as described in [RFC1034], [RFC1035], and [RFC1123]. In the domain-literal form, the domain is interpreted as the literal Internet address of the particular host. In both cases, how addressing is used and how messages are transported to a particular host is covered in separate documents, such as [RFC5321]. 

completePhoneNumber

String

The complete telephone number including the CountryCode, AreaCode, Telephone Number and ExtensionNumber. 

internetURL

String

The internet URL

addressLine1

String

The first line of the address, normally the street number and name. 

addressLine2

String

The second line of an address, normally the Flat or Building Suite number. 

addressLine3

String

The third line of the address. 

addressLine4

String

The fourth line of the address. 

addressLine5

String

The fifth line of the address. It is normally used for the salutation. 

city

String

The city, town or village component of the address 

subTerritoryName

String

This field is used to specify the territory or city more concrete, for example for storing the district or suburb of a certain city. 

postalCode

String

The postal or zip code of the address 

postalCodeExtension

String

The extension of the postal or zip code that further specifies a particular postal district. 

territory

String

The County, State, Province, Territory etc component of the address 

territoryName

String

The name of the County, State, Province, Territory etc. component of the address 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

isocountryCode

String

The ISO-3166-1 two letter code of the country

3.187. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerContactMethodKey

RetailTransactionCustomerContactMethod.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

customerID

X

String

A unique system assigned identifier for the Customer. 

addressTypeCode

X

String

The customer type code

contactPurposeTypeCode

X

String

A retailer defined code denoting a reason for contacting a Party. 

contactMethodTypeCode

X

String

A retailer assigned code denoting a method of contacting a Party.

3.188. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerGroupAssignment

RetailTransactionCustomerGroupAssignment undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerGroupAssignment.Key

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.189. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerGroupAssignmentKey

RetailTransactionCustomerGroupAssignment.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

customerID

X

String

A unique system assigned identifier for the Customer. 

addressTypeCode

X

String

The customer type code

customerGroupID

X

String

A unique identification number assigned to a customer group 

3.190. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerIdentification

RetailTransactionCustomerIdentification undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionCustomerIdentification.Key

identifier

X

String

The number or character sequence on the identification that identifies the party.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.191. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerIdentificationKey

RetailTransactionCustomerIdentification.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

customerID

X

String

A unique system assigned identifier for the Customer. 

addressTypeCode

X

String

The customer type code

partyIdentificationTypeCode

X

String

A code denoting a form of identification that the customer uses to identify themselves. 

3.192. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionCustomerKey

RetailTransactionCustomer.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

customerID

X

String

A unique system assigned identifier for the Customer. 

addressTypeCode

X

String

The customer type code

3.193. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionExternalTrigger

RetailTransactionExternalTrigger undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionExternalTrigger.Key

triggerAmount

X

Double

The value (amount). Its type is determined by TriggerTypeCode.

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.194. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionExternalTriggerKey

RetailTransactionExternalTrigger.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

triggerTypeCode

X

String

The type of the TriggerValue, e.g. 00 - turnover of the (current) year 01 - rebate amount which was granted during the (current) year 

3.195. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionGenericAttribute

RetailTransactionGenericAttribute undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionGenericAttribute.Key

genericAttributeKey

X

String

The key of the generic attribute.The key may not be unique in the scope of the transaction.

genericAttributeValue

String

The value of the generic attribute.

customFlag

X

Boolean

Indicates whether the generic attribute is custom (project-specific) or was added as an internal attribute for the product. This flag controls whether this generic attribute is considered in checking the configured limit (true) or not (false).

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.196. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionGenericAttributeKey

RetailTransactionGenericAttribute.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

genericAttributeSequenceNumber

X

Integer

The sequence number of generic attribute within the scope of the transaction.

int32

3.197. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionKey

RetailTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.198. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

RetailTransactionLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem.Key

externalCustomerOrderID

String

An external identifier for the related customer order.

customerOrderSequenceNumber

Integer

A unique system assigned identifier for the LineItem of the CustomerOrder. 

int32

beginDateTimestamp

String

The start time of the RETAIL TRANSACTION line item. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

voidFlag

Boolean

A boolean indicator that tells if this line item is VOIDED or not.

endDateTimestamp

String

The end time of the RETAIL TRANSACTION line item. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

entryMethodCode

String

A retailer assigned code to denote how the RetailTransactionLineItem was entered at the Workstation. It is filled just for retail transaction line item.

retailTransactionLineItemTypeCode

String

A code to denote the type of retail transaction line item, such as Sale/Return, Void, Tender …​

voidTypeCode

String

Describes whether the line item was voided immediately after registering it, voided by another line item or internally voided 

workstationID

String

id of the workstation where the line item was created

workstationTypeCode

String

type of the workstation where the line item was created

keyedOfflineCode

String

A code that indicates the online/offline state when transaction was completed.

beginDateTimestampUTC0

Date

The UTC0 start time of the RETAIL TRANSACTION line item. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

endDateTimestampUTC0

Date

The UTC0 end time of the RETAIL TRANSACTION line item. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

retailTransactionLineItemAssociationList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAssociation

list of line item associations

retailTransactionLineItemAdditionalParameterList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAdditionalParameter

list of additional parameters

retailTransactionLineItemBinaryDataList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemBinaryData

list of binary data

retailTransactionLineItemI18NTextList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemI18NText

list of translations for line item texts

retailTransactionLineItemResourceOverrideList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemResourceOverride

list of data for line item related authorizations

retailTransactionLineItemExtensionList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemExtension

list of line item extensions

retailTransactionLineItemAuditEventList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAuditEvent

list of line item audit events

saleReturnLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItem

sale return line item

retailTransactionLineItemFrequentShopperPointsRedemptionList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemFrequentShopperPointsRedemption

additional bonuspoints redemption data

roundingLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoRoundingLineItem

rounding line item

priceModificationLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoPriceModificationLineItem

transaction related discount

loyaltyRewardLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoLoyaltyRewardLineItem

transaction related bonuspoints

workerDiscountLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoWorkerDiscountLineItem

worker discount line item

additionalBonusDiscountLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoAdditionalBonusDiscountLineItem

data for additional bonus itemsA type of RETAIL TRANSACTION LINE ITEM that records PCE’s response for the application of a promotion price derivation rule of type 'additional bonus'.

taxLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoTaxLineItem

transaction related tax

giftCertificateLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoGiftCertificateLineItem

additional gift certificate data for SaleReturnLineItem, TenderLineItem or VoidsLineItem

prepaidLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoPrepaidLineItem

additional prepaid data for SaleReturnLineItem or VoidsLineItem

tenderLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoTenderLineItem

tender line item

voidsLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoVoidsLineItem

void line item

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

3.199. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAdditionalParameter

RetailTransactionLineItemAdditionalParameter undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAdditionalParameter.Key

parameterName

X

String

The name of the parameter, e.g. the name/title of an additional input field 

parameterValue

String

The value of the parameter, e.g. user input for an additional input field 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.200. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAdditionalParameterKey

RetailTransactionLineItemAdditionalParameter.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

externalParameterID

X

String

The external parameter ident (is needed for export), e.g. ident of an additional input field 

3.201. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAssociation

RetailTransactionLineItemAssociation undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAssociation.Key

toTransactionID

String

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.202. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAssociationKey

RetailTransactionLineItemAssociation.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction.

lineItemSequenceNumber

X

Integer

The sequence number of line item

int32

toTransactionID

X

String

The transaction id of the linked transaction.

toLineItemSequenceNumber

X

Integer

The sequence number of the linked line item.

int32

lineItemAssociationTypeCode

X

String

A retailer assigned code denoting the relationship between the two items.

toBusinessUnitGroupID

X

String

A unique system assigned identifier for the the business unit group of the linked transaction.

3.203. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAuditEvent

RetailTransactionLineItemAuditEvent undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemAuditEvent.Key

creationTimestamp

X

String

Creation timestamp of the audit event; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

creationTimestampUTC0

X

Date

Creation timestamp in UTC0; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

workstationID

String

ID of the workstation

workstationTypeCode

String

Type code of the workstation

eventTypeCode

X

String

Type code of the audit event

content

Object

Additional event content

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.204. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemAuditEventKey

RetailTransactionLineItemAuditEvent.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

ID of the business unit group

transactionID

X

String

ID of the transaction

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. Must be updated during retrieve.

int32

eventSequenceNumber

X

Integer

A unique identifier (within the context of the Transaction) for this event entry. 

int32

3.205. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemBinaryData

RetailTransactionLineItemBinaryData undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemBinaryData.Key

name

X

String

The name of the binary data entry 

content

X

Object

The binary object 

contentLength

X

Double

The length of the binary object

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.206. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemBinaryDataKey

RetailTransactionLineItemBinaryData.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

binaryDataSequenceNumber

X

Integer

A unique identifier (within the context of the Transaction) for this binary data entry. 

int32

3.207. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemExtension

RetailTransactionLineItemExtension undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemExtension.Key

extensionValue

String

The value of the key-value pair 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.208. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemExtensionKey

RetailTransactionLineItemExtension.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

extensionKey

X

String

The key of the key-value pair 

extensionSequenceNumber

X

Integer

Line number (incremental counter) - there may exist multiple rows per ExtensionKey

int32

3.209. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemFrequentShopperPointsRedemption

RetailTransactionLineItemFrequentShopperPointsRedemption undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemFrequentShopperPointsRedemption.Key

customerAccountID

X

String

The customer account number

redemptionTransactionID

X

String

A universally unique identifier (UUID) for the redemption transaction. This may be assembled from alternate key members

frequentShopperPointsRedeemedCount

X

Double

The number of frequent shopper points redeemed

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.210. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemFrequentShopperPointsRedemptionKey

RetailTransactionLineItemFrequentShopperPointsRedemption.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction.

int32

3.211. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemI18NText

RetailTransactionLineItemI18NText undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemI18NText.Key

text

String

The text in the nominated language 

pictureFlag

X

Boolean

Determines whether Text is a reference to a picture or whether Text is common text 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.212. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemI18NTextKey

RetailTransactionLineItemI18NText.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

textSequenceNumber

X

Integer

Line number (incremental counter) of the text 

int32

languageID

X

String

A combination of ISO-639-1 and ISO-3661-1 to denote a lanuage as spoken in a particular country. 

category

X

String

Category code of the text

3.213. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemKey

RetailTransactionLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.214. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemResourceOverride

RetailTransactionLineItemResourceOverride undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItemResourceOverride.Key

resourceID

String

A unqiue system assigned identifier for the action to which access may be granted to some Operators and Workstations.  

operatorID

X

String

A unique, automatically assigned number used to identify a workstation OPERATOR. 

overrideTimestamp

String

The date and time that a transaction line item is being overridden. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

entryMethodCode

String

A code denoting how the overriding Operator was entered. e.g. Keyed, Scanned, MCR, etc…​ 

approverName

String

The name of the person assigned to the WorkerID that was used to approve this LineItemResourceOverride 

approverFirstName

String

The first name of the person assigned to the WorkerID that was used to approve this line item resource override 

workGroupID

String

A unqiue system assigned identifier for a set of WorkerID with similar resource access control permissions. 

workerID

String

A unique system-assigned identifier for the Person who is a particular Worker.

overrideTimestampUTC0

Date

The UTC0 date and time that a transaction line item is being overridden. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.215. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItemResourceOverrideKey

RetailTransactionLineItemResourceOverride.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

resourceOverrideSequenceNumber

X

Integer

Line number (incremental counter) 

int32

3.216. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionManufacturerCouponSummary

RetailTransactionManufacturerCouponSummary undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionManufacturerCouponSummary.Key

manufacturerCompanyCode

X

String

The 6 to 12 digit GS1 Company Prefix of the manufacturer that is funding this offer. This information is derived from the ManufacturerCouponScanCode in case that the manufacturer coupon was scanned, or manually entered otherwise.

manufacturerOfferCode

X

String

A 6-digit number (assigned by the holder of the ManufacturerCompanyCode) that identifies this offer. This information is derived from the ManufacturerCouponScanCode in case that the manufacturer coupon was scanned, or manually entered otherwise.

keyEnteredFlag

X

Boolean

A flag to denote whether the manufacturer coupon was key entered or scanned

inputCount

X

Double

The number how often the manufacturer coupon was registered

double

appliedCount

X

Double

The number how often the manufacturer coupon was applied

double

appliedIntervalCount

X

Double

The number of intervals for which the manufacturer coupon was applied

double

totalAmount

X

Double

The total discount amount that is granted by applying the manufacturer coupon according to its AppliedCount

double

tenderLineItemSequenceNumber

Integer

The reference to the corresponding tender line item

int32

saleLineItemValidationList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionManufacturerCouponValidation

list of validating sale line items

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.217. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionManufacturerCouponSummaryKey

RetailTransactionManufacturerCouponSummary.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

manufacturerCouponScanCode

X

String

The barcode on the manufacturer coupon in GS1 interface format. In case that the manufacturer coupon was key entered this information is assembled by the entered information (ManufacturerCompanyCode, ManufacturerOfferCode, TotalAmount) by using the GS1 interface format.

3.218. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionManufacturerCouponValidation

RetailTransactionManufacturerCouponValidation undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionManufacturerCouponValidation.Key

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.219. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionManufacturerCouponValidationKey

RetailTransactionManufacturerCouponValidation.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

manufacturerCouponScanCode

X

String

Short description

saleLineItemSequenceNumber

X

Integer

Reference to the sale line item the manufacturer coupon was applied to

int32

3.220. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionModifierCoupon

RetailTransactionModifierCoupon undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionModifierCoupon.Key

couponNumber

X

String

The coupon number that was used to trigger the modifier

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.221. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionModifierCouponKey

RetailTransactionModifierCoupon.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier of the promotion.

priceDerivationRuleID

X

String

The unique identifier of the price derivation rule. 

priceDerivationRuleEligibilityID

X

String

The unique identifier of the root eligibility.

couponSequenceNumber

X

Integer

The sequential number of the coupon entry (starting with 1), in case there was more than one coupon registered for one modifier 

int32

3.222. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionExternalActionParameter

RetailTransactionPromotionExternalActionParameter undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionExternalActionParameter.Key

parameterValue

X

String

The parameter value

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.223. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionExternalActionParameterKey

RetailTransactionPromotionExternalActionParameter.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier of the promotion. 

priceDerivationRuleID

X

String

The unique identifier of the price derivation rule.  

priceDerivationRuleEligibilityID

X

String

The unique identifier of the root eligibility.

parameterID

X

String

The parameter ident

3.224. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionExternalActionText

RetailTransactionPromotionExternalActionText undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionExternalActionText.Key

text

X

String

The text itself

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.225. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionExternalActionTextKey

RetailTransactionPromotionExternalActionText.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier of the promotion. 

priceDerivationRuleID

X

String

The unique identifier of the price derivation rule.  

priceDerivationRuleEligibilityID

X

String

The unique identifier of the root eligibility.

textID

X

String

The text ident

languageID

X

String

A combination of  ISO-639-1 and ISO-3661-1  to denote a lanuage as spoken in a particular country.

3.226. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionPriceDerivationRule

RetailTransactionPromotionPriceDerivationRule undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionPriceDerivationRule.Key

promotionDescription

String

Short description of the promotion 

receiptPrinterName

String

Text to be printed on the receipt 

promotionPriceDerivationRuleSequence

String

Sequence - for collision handling 

promotionPriceDerivationRuleResolution

String

Resolution - for collision handling 

promotionPriceDerivationRuleTypeCode

String

The typecode of the promotion price derivation rule 

transactionControlBreakCode

String

This type code defines the base for applying the condition and it defines the calculation time.

priceModificationMethodCode

String

A code denoting the method of modifying the price that is being applied to the transaction resp. line item 

priceDerivationRuleDescription

String

Business description for this price derivation rule. 

promotionOriginatorTypeCode

String

The typecode of the originator of the promotion 

externalPromotionID

String

The external identifier of the promotion 

externalPriceDerivationRuleID

String

The external identifier of the price derivation rule 

triggerQuantity

X

Double

The quantity of items fulfilling the eligibility which is required to be purchased to trigger the price derivation rule. 

double

giftCertificateExpirationDate

String

End of the date range in which the gift certificate is valid ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

discountMethodCode

String

Determines how the discount influences the transaction.

frequentShopperPointsFlag

X

Boolean

Determines whether disocunt or frequent shopper points are awarded by the price derivation rule 

customerGroupLoyaltyPointsDefaultQuantity

X

Double

The count of default loyalty points assigned to the customer group 

double

prohibitPrintFlag

X

Boolean

Determines whether the result of the applied price derivation rule is to be suppressed on displays / not printed on the receipt; e.g. line item-related default points are not printed after each position, but only summarized at the end of the receipt 

tenderTypeCode

String

A code which uniquely identifies the tender in case of rebate as tender.

promotionTypeName

String

Promotion type name 

calculationBase

String

Defines the calculation base for transaction related discounts.

pointsConversionAmount

X

Double

Exchange rate for the conversion from points into local currency 

double

noEffectOnSubsequentPriceDerivationRulesFlag

X

Boolean

Determines whether applying this price derivation rule influences the calculation base of subsequent price derivation rules (false) or not (true).

prohibitTransactionRelatedPriceDerivationRulesFlag

X

Boolean

Determines whether applying this price derivation rule influences the calculation base of subsequent transaction-related price derivation rules (false) or not (true); is relevant for line item-related 'money' price derivation rules only 

couponPrintoutID

String

The number of the printout coupon 

couponPrintoutRule

String

The type code of the printout rule.

couponPrintoutText

Object

The formatted text of the printout coupon 

exclusiveFlag

X

Boolean

Determines whether this price derivation rule is an exclusive one 

requireUserInteractionFlag

X

Boolean

Determines whether an additional user interaction (pressing a button) is necessary in order to fulfill the eligibility for applying the price derivation rule 

considerPreviousPriceDerivationRulesFlag

X

Boolean

Indicates whether all price derivation rules which were applied before are to be considered (true) or not (false).

concurrenceControlVector

String

Determines how this price derivation rule works in relation to other applicable price derivation rules 

appliedCount

X

Double

Describes how often the current price derivation rule was applied 

double

printoutValidityPeriod

X

Double

Describes how long (how many days) the printed coupon/gift certificate is valid 

double

externalActionID

String

The ident of the action which is to be performed by the client which invoked the pricing engine

externalActionDescription

String

The description of the action which is to be performed by the client which invoked the pricing engine

externalActionTextList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionExternalActionText

The texts for the action which is to be performed by the client which invoked the pricing engine

externalActionParameterList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionExternalActionParameter

The parameters for the action which is to be performed by the client which invoked the pricing engine

calculationBaseSequence

String

Determines which one of the previously applied modifiers is to be considered as calculation base for the current modification. In detail, the calculation base for the current price derivation rule is to be determined as following:- In case that no price derivation rules were applied before, it is the original price/total.- Null: all price derivation rules which were applied before the current price derivation rule are to be considered, i.e. the calculation base for the current price derivation rule equals to the new price of the price derivation rule which was applied just before it = as latest. - Otherwise, the calculation base for the current price derivation rule equals to the new price of that price derivation rule which was applied one or more steps before it having the highest sequence ⇐ CalculationBaseSequence (or the original price if no such price derivation rule was applied).

externalOfferID

String

Another external ident of the promotion.It is needed by/known to the retailer.

additionalPriceTypeCode

String

The price type code of the additional price which got applied

bonusPointsTypeCode

String

The bonus points type code of the promotion price derivation rule which got applied.

benefitMultiplier

Double

The benefit multiplier value. Only integer values > 1 are supported by the application currently.
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.227. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionPriceDerivationRuleKey

RetailTransactionPromotionPriceDerivationRule.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier of the promotion. 

priceDerivationRuleID

X

String

The unique identifier of the price derivation rule.  

priceDerivationRuleEligibilityID

X

String

The unique identifier of the root eligibility.

3.228. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendation

RetailTransactionPromotionRecommendation undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionRecommendation.Key

externalPromotionID

X

String

The external identifier of the promotion

ruleTypeCode

X

String

Defines the type of price derivation rule.

transactionControlBreakCode

X

String

This is a special code that determines when, during the entry of a sale transaction, this rule will be applied. For example a price change rule may be applied on a line item by line item basis (which is DETAIL TIME), a price change rule may be triggered after a transaction is totaled — but before tax and tender entry (i.e. MERCHANDISE SUBTOTAL TIME).

promotionPriceDerivationRuleSequence

X

String

Sequence - for collision handling

promotionPriceDerivationRuleResolution

X

String

Resolution - for collision handling

retailTransactionPromotionRecommendationFulfilledTriggerList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationFulfilledTrigger

The list of eligibilities of the promotion being recommended for the transaction which are satisfied already

retailTransactionPromotionRecommendationMissingTriggerList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationMissingTrigger

The list of eligibilities of the promotion being recommended for the transaction which have not been fulfilled yet

retailTransactionPromotionRecommendationBenefitList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationBenefit

The list of benefits from the promotion being recommended for the transaction

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.229. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationBenefit

RetailTransactionPromotionRecommendationBenefit undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionRecommendationBenefit.Key

matchingItemID

String

The rule matching item id of the recommended promotion. Only relevant in case of mix and match, otherwise null.

benefitTypeCode

X

String

The type of the recommended promotion’s benefit.

priceDerivationItemTypeCode

String

A code that indicates the type of the matching item or bonus item. This is filled only in case of mix&match and additional bonus.

priceDerivationItemID

String

The matching item id or bonus item id. Only filled in case of mix&match and additional bonus.

priceDerivationItemIDQualifier

String

The qualifier for the matching item id or bonus item id. Only filled in case of mix&match and additional bonus.

priceModificationMethodCode

String

A code denoting the method of modifying the price that is being applied

priceModificationValue

Double

The price modification value. It is interpreted according to the PriceModificationMethodCode.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

toBeDiscountedQuantity

Double

Defines in case of BuyNGetM, how many items out of the triggering items within a single interval are taken into account for the calculation base. This parameter is used for subsequent discount as well.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

matchingItemRequiredQuantity

Double

The count of that mix & match item which is needed in the context of the mix & match rule.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

priceDerivationItemIDQualifier2

String

An additional qualifier for the matching item id or bonus item id. Only filled in case of mix&match and additional bonus. 

additionalBonusQuantity

Double

The count of that additional bonus item which can be granted for free by the client
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

bonusPointsTypeCode

String

The bonus points type code of the promotion price derivation rule which got applied.

benefitMultiplier

Double

The benefit multiplier value. Only integer values > 1 are supported by the application currently.
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.230. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationBenefitKey

RetailTransactionPromotionRecommendationBenefit.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier for the promotion.

priceDerivationRuleID

X

String

The unique identifier for the price derivation rule.

rootPriceDerivationRuleEligibilityID

X

String

The unique identifier for the root price derivation rule eligibility.

sequenceNumber

X

Integer

The sequence number of the benefit item. This ensures the unique identification in case of mix&match as well as for subsequent discounts.

int32

3.231. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationFulfilledTrigger

RetailTransactionPromotionRecommendationFulfilledTrigger undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionRecommendationFulfilledTrigger.Key

eligibilityTypeCode

X

String

A code that indicates the type of the price derivation rule eligibility.

triggerID

String

The trigger identifier (item id, merchandise hierarchy group id, merchandise set id, coupon number, etc.).

triggerIDQualifier

X

String

Further information regarding to the trigger (unit of measure code, merchandise hierarchy group id qualifier).

thresholdTypeCode

String

A code for the type of threshold which applies to the eligibility.

thresholdQuantity

Double

The quantity of the trigger item required to be purchased to trigger the price derivation rule.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

thresholdAmount

Double

A monetary amount of the trigger item required to be purchased to trigger the price derivation rule.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

intervalQuantity

Double

An interval quantity for which the price derivation rule is eligible.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

intervalAmount

Double

An interval monetary armount for which the price derivation rule is eligible.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

limitQuantity

Double

The maximum number of the trigger item for which the price derivation rule is eligible.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

limitAmount

Double

The maximum monetary amount of the trigger item for which the price derivation rule is eligible.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

retailTransactionPromotionRecommendationFulfilledTriggerReferenceList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationFulfilledTriggerReference

The list of references to the line items fulfilling the eligibility of the promotion being recommended for the transaction

triggerIDQualifier2

String

Further information regarding to the trigger.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.232. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationFulfilledTriggerKey

RetailTransactionPromotionRecommendationFulfilledTrigger.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier for the promotion.

priceDerivationRuleID

X

String

The unique identifier for the price derivation rule.

rootPriceDerivationRuleEligibilityID

X

String

The unique identifier for the root price derivation rule eligibility.

priceDerivationRuleEligibilityID

X

String

The unique identifier for the specific price derivation rule eligibility within the eligibility tree

3.233. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationFulfilledTriggerReference

RetailTransactionPromotionRecommendationFulfilledTriggerReference undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionRecommendationFulfilledTriggerReference.Key

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.234. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationFulfilledTriggerReferenceKey

RetailTransactionPromotionRecommendationFulfilledTriggerReference.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier for the promotion.

priceDerivationRuleID

X

String

The unique identifier for the price derivation rule.

rootPriceDerivationRuleEligibilityID

X

String

The unique identifier for the root price derivation rule eligibility.

priceDerivationRuleEligibilityID

X

String

The unique identifier for the specific price derivation rule eligibility within the eligibility tree

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this retail transaction.

int32

3.235. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationGroup

RetailTransactionPromotionRecommendationGroup undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionRecommendationGroup.Key

recommendationStatusCode

X

String

The status of the promotion recommendations evaluation.

retailTransactionPromotionRecommendationList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendation

A list of promotion recommendations.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.236. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationGroupKey

RetailTransactionPromotionRecommendationGroup.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.237. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationKey

RetailTransactionPromotionRecommendation.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier for the promotion.

priceDerivationRuleID

X

String

The unique identifier for the price derivation rule.

rootPriceDerivationRuleEligibilityID

X

String

The unique identifier for the root price derivation rule eligibility.

3.238. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationMissingTrigger

RetailTransactionPromotionRecommendationMissingTrigger undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionRecommendationMissingTrigger.Key

eligibilityTypeCode

X

String

A code that indicates the type of the price derivation rule eligibility.

triggerID

String

The trigger identifier (item id, merchandise hierarchy group id, merchandise set id, coupon number, etc.).

triggerIDQualifier

String

Further information regarding to the trigger (unit of measure code, merchandise hierarchy group id qualifier).

thresholdTypeCode

String

A code for the type of threshold which applies to the eligibility.

thresholdQuantity

Double

The quantity of the trigger item required to be purchased to trigger the price derivation rule.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

thresholdAmount

Double

A monetary amount of the trigger item required to be purchased to trigger the price derivation rule.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

intervalQuantity

Double

An interval quantity for which the price derivation rule is eligible.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

intervalAmount

Double

An interval monetary armount for which the price derivation rule is eligible.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

limitQuantity

Double

The maximum number of the trigger item for which the price derivation rule is eligible.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

limitAmount

Double

The maximum monetary amount of the trigger item for which the price derivation rule is eligible.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

missingQuantity

Double

The missing quantity to reach the threshold quantity. Only filled in case of quantity-related triggers.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

missingAmount

Double

The missing amount to reach the threshold amount. Only filled in case of amount-related triggers.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

triggerIDQualifier2

String

Further information regarding to the trigger.

retailTransactionPromotionRecommendationPartiallyFulfilledTriggerReferenceList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationPartiallyFulfilledTriggerReference

The list of references to the line items partially fulfilling the eligibility of the promotion being recommended for the transaction

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.239. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationMissingTriggerKey

RetailTransactionPromotionRecommendationMissingTrigger.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier for the promotion.

priceDerivationRuleID

X

String

The unique identifier for the price derivation rule.

rootPriceDerivationRuleEligibilityID

X

String

The unique identifier for the root price derivation rule eligibility.

priceDerivationRuleEligibilityID

X

String

The unique identifier for the specific price derivation rule eligibility within the eligibility tree

3.240. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationPartiallyFulfilledTriggerReference

RetailTransactionPromotionRecommendationPartiallyFulfilledTriggerReference undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionRecommendationPartiallyFulfilledTriggerReference.Key

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.241. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionRecommendationPartiallyFulfilledTriggerReferenceKey

RetailTransactionPromotionRecommendationPartiallyFulfilledTriggerReference.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier for the promotion.

priceDerivationRuleID

X

String

The unique identifier for the price derivation rule.

rootPriceDerivationRuleEligibilityID

X

String

The unique identifier for the root price derivation rule eligibility.

priceDerivationRuleEligibilityID

X

String

The unique identifier for the specific price derivation rule eligibility within the eligibility tree

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this retail transaction.

int32

3.242. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionTrigger

RetailTransactionPromotionTrigger undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionPromotionTrigger.Key

triggerType

X

String

The type of the trigger (referencing to POS configuration)

triggerValue

X

String

The value of the trigger (referencing to POS configuration)

privilegeType

X

String

Defines the method for price modification.

privilegeValue

X

Double

Reduction amount, reduction percent or new price amount

double

reasonCode

String

Reason code for the manual discount

reasonDescription

String

A narrative description describing the manual discount reason.

reference_

String

An additional information concerning the trigger 

triggerSequenceAddend

X

String

A value which is to be added to the sequence of the condition (which comes from the master data)

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.243. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionTriggerKey

RetailTransactionPromotionTrigger.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

triggerSequenceNumber

X

Integer

The ident of the trigger (because a transaction item can have more than one trigger) 

int32

3.244. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionTaxExemptTrigger

RetailTransactionTaxExemptTrigger undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionTaxExemptTrigger.Key

reasonCode

String

Tax exempt reason code

reasonDescription

String

A narrative description for the tax exempt reason code. 

taxCertificateID

String

The certificate number assigned to a purchaser by a tax authority exempting the purchaser from tax in that authority

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.245. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionTaxExemptTriggerKey

RetailTransactionTaxExemptTrigger.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.246. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionTotal

RetailTransactionTotal undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionTotal.Key

amount

Double

The monetary value of the transaction total.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.247. ComGkSoftwareGkrApiTxpoolDtoRetailTransactionTotalKey

RetailTransactionTotal.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

transactionTotalTypeCode

X

String

A unique assigned mnemonic identifier that identifies the TransactionTotalType 

3.248. ComGkSoftwareGkrApiTxpoolDtoReturnLineItem

ReturnLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.ReturnLineItem.Key

returnReasonCode

String

The code of the return reason

returnReasonDescription

String

A narrative description describing the use of the retailer assigned return reason code. 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.249. ComGkSoftwareGkrApiTxpoolDtoReturnLineItemKey

ReturnLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.250. ComGkSoftwareGkrApiTxpoolDtoRoundingLineItem

RoundingLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.RoundingLineItem.Key

roundUpFlag

Boolean

A flag denoting that the amount was rounded up.

amount

Double

The applied rounding difference
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

typeCode

X

String

Determines which part of the transaction the rounding applies to. Possible values include codes for change, subtotal 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.251. ComGkSoftwareGkrApiTxpoolDtoRoundingLineItemKey

RoundingLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.252. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItem

SaleReturnLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItem.Key

itemID

String

A unique identifier for the item

unitOfMeasureCode

String

The code used to specify the unit of the item

itemType

String

The type code of the line item

subItemType

String

The sub type code of the line item

regularUnitPrice

X

Double

The regular per-unit price

double

regularUnitPriceQuantity

Double

The number of items the regular price is defined for, i.e. 3 for $1.00
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

actualUnitPrice

Double

The actual per-unit price
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

actualUnitPriceQuantity

Double

The number of items the actual price is defined for, i.e. 3 for $1.00
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

quantity

X

Integer

The single quantity of a line itemPiece Item:3 * itemQuantity = 3Units = 1Weight item:3 * 1.234kg * itemQuantity = 3Units = 1.234Item with deposit:3 * six-pack (1 six-pack has 6 * deposit item)six-pack: Quantity = 3, Units = 1deposit: Quantity = 3, Units = 6

int32

units

Double

The units of the line itemPiece Item:3 * itemQuantity = 3Units = 1Weight item:3 * 1.234kg * itemQuantity = 3Units = 1.234Item with deposit:3 * six-pack (1 six-pack has 6 * deposit item)six-pack: Quantity = 3, Units = 1deposit: Quantity = 3, Units = 6
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

extendedAmount

X

Double

The product of multiplying Quantity, Units and ActualUnitPrice.Different calculation rule for ExtendedAmount in case of package prices (see Transaction Calculation Rules).

double

extendedDiscountAmount

Double

The monetary total of all line item discounts that were applied to this Item.
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

sellUnitRetailPriceEntryMethodCode

String

A code that describes how this line item’s retail selling unit price is being entered.

actionCode

String

A code denoting the sign of the line item.

reasonCode

String

A unique retailer defined reason code (e.g. reason for Pay In / Pay Out)

itemTraceableUnitID

String

A universally unique identifier used to identify an instance of a distinguishable instance of a retail item. The item traceable unit ID is similar to a serial number in that it allows each selling unit to be explicitly identified and distinguished from other selling units of the same Item.

quantityInputMethod

String

Determines how the input of quantity was done on POS.

length

Double

The registered length 
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

width

Double

The registered width 
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

height

Double

The registered height 
Fixed decimal precision expected, definition of used precision: double(11, 3). Be aware of this and round value!

double

manualWeightInputFlag

Boolean

Describes how the weight was registered 

receiptText

String

The receipt printout text 

receiptDescription

String

The item description

allowFoodStampFlag

X

Boolean

A flag to indicate whether food stamps can be tendered for this item. 

registrationNumber

String

The complete number which was registered on the POS originally 

negativeLineItemFlag

X

Boolean

If this flag is set to true, automatically a negative line item is created when registering this item. Corresponds to ItemSellingRule.NegativeLineItemFlag

discountFlag

X

Boolean

A flag to indicate whether this ITEM can be discounted. Corresponds to Item.DiscountFlag 

frequentShopperPointsEligibilityFlag

X

Boolean

A flag to denote that the Item is eligible for frequent shopper points. Corresponds to ItemSellingRule.FrequentShopperPointsEligibilityFlag 

discountTypeCode

String

A code which is used by the loyalty engine in order to determine whether the item can get rebate/points; possible values: 0..9 Corresponds to ItemSellingRule.DiscountTypeCode

priceChangeTypeCode

String

Describes how the price of the item can be changed on POS.Corresponds to ItemSellingRule.PriceChangeTypeCode

priceTypeCode

String

The price type code.

grandExtendedAmount

X

Double

The line item total including taxes and discounts 

double

reasonCodeGroupCode

String

A retailer assigned code denoting the family of related reason codes for classifying data and actions within the systems of the retail enterprise. 

reasonDescription

String

A narrative description describing the use of the retailer assigned reason code. 

notConsideredByLoyaltyEngineFlag

X

Boolean

Determines whether the loyalty engine should care about the line item as a trigger; this information is needed because it may happen that another process (e.g. a return regarding to an existing transaction) applies rules for the line item which the loyalty engine is not allowed to change 

merchandiseHierarchyGroupName

String

The business name for the merchandise structure. 

merchandiseHierarchyGroupDescription

String

A description of the merchandise structure. 

itemClassCode

String

Item class code 

prohibitTaxExemptFlag

X

Boolean

If this flag is set to true, no tax exemption is allowed for the line item 

prohibitReturnFlag

X

Boolean

A flag to denote whether or not this item may be returned.

warrantyDuration

Double

The duration of the item’s warranty (in months) 
Fixed decimal precision expected, definition of used precision: double(18, 0). Be aware of this and round value!

double

depositTypeCode

String

Deposit type of the item

taxExemptCode

String

A code to denote the tax exemption status from sales and use tax.

invoiceID

String

The ident of the invoice which is related to this line item 

mainPOSItemID

String

The main pos item id

mainMerchandiseHierarchyGroupIDQualifier

String

A qualifier which is used to differ between MerchandiseHierarchyGroup’s belonging to different functions but having the same id 

mainMerchandiseHierarchyGroupID

String

Unique system assigned identifier for the merchandise group.

taxReductionAmount

X

Double

The amount that reduces the taxable amount of a line item.

double

taxGroupID

String

The id of the taxable TaxableGroup

taxReceiptPrintCode

String

A short code that is printed on a receipt to denote items that are in this TaxableGroup.

tareCount

Double

The tare weight of the item.
Fixed decimal precision expected, definition of used precision: double(16, 3). Be aware of this and round value!

double

originalTaxGroupID

String

The original id of the taxable group.

manufacturerFamilyCode

String

The GS1 designated three digit coupon family code for the manufacturer item

manufacturerCompanyCode

String

The GS1 designated 6 through 12 digit company prefix for the manufacturer of the item

priceGroupID

String

The ident of the price group the item belongs to in terms of split pricing

fixedPriceFlag

X

Boolean

A flag to denote that the price of the line item was fixed/cannot be changed. One possible reason is that this price was calculated by a legally certified system such as a scale. Another possibility is that it was retrieved from a barcode.See also SellUnitRetailPriceEntryMethodCode.

rootItemID

String

reference to the root item

saleReturnLineItemExtensionList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemExtension

list of line item extensions

saleReturnLineItemCollectionList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemCollection

list of related set items

saleReturnLineItemPriceList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemPrice

list of prices

saleReturnTaxLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxLineItem

list of line item related taxes

retailPriceModifierList

List of ComGkSoftwareGkrApiTxpoolDtoRetailPriceModifier

list of line item discounts

frequentShopperPointsModifierList

List of ComGkSoftwareGkrApiTxpoolDtoFrequentShopperPointsModifier

list of line item points discounts

saleReturnLineItemPromotionTriggerList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemPromotionTrigger

line of line item promotion triggers

saleReturnLineItemCharacteristicList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemCharacteristic

list of characteristics

saleReturnLineItemModifierCouponList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemModifierCoupon

list of used coupons

saleReturnLineItemModifierReferenceList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemModifierReference

list of line items that caused a condition

saleReturnLineItemMerchandiseHierarchyGroupList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemMerchandiseHierarchyGroup

list of merchandise groups that are directly linked to the item

externalReferenceID

String

External reference number. In case of selling a fuel item, this is the FuelingTransactionID

fuelSalesLineItem

com.gk_software.gkr.api.txpool.dto.FuelSalesLineItem

saleReturnLineItemAdditionalPriceList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemAdditionalPrice

list of additional prices

saleReturnLineItemSplitPackageList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemSplitPackage

A list of prices used to calculate the line items extended amount out of a package price.i.e. 3 items with price 3/$1.00 will result in 1@ $0.34 and 2@ $0.33

saleReturnLineItemGenericAttributeList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemGenericAttribute

list of generic attributes being valid for the line item

positemID

String

The ID used to identify the item.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

posdepartmentID

String

A unique identifier for the POS department 

wicflag

X

Boolean

A flag denoting if this Item is allowed in a WIC transaction 

returnLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoReturnLineItem

additional return data

saleReturnLineItemSalesOrderList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemSalesOrder

additional data for sales order

serializedUnitModiferList

List of ComGkSoftwareGkrApiTxpoolDtoSerializedUnitModifer

serial number

lineItemAssociateList

List of ComGkSoftwareGkrApiTxpoolDtoLineItemAssociate

line item associate

saleReturnTaxExemptTriggerList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxExemptTrigger

tax exempt data

additionalBonusLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoAdditionalBonusLineItem

Data for additional bonus items which were added to the transaction by the client based on the recommendation of PCE (AdditionalBonusDiscountLineItem). PCE cannot use such line items nor as trigger neither for granting a benefit to it.

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

3.253. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemAdditionalPrice

SaleReturnLineItemAdditionalPrice undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemAdditionalPrice.Key

priceAmount

X

Double

The price 

double

packagePriceQuantity

Integer

The quantity the price is defined for, i.e. 3 for $1.00

int32

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.254. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemAdditionalPriceKey

SaleReturnLineItemAdditionalPrice.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

priceTypeCode

X

String

The price type code 

3.255. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemCharacteristic

SaleReturnLineItemCharacteristic undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemCharacteristic.Key

characteristicValueID

X

String

The ident of the characteristic’s value 

characteristicValueName

String

The name of the characteristic’s value

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.256. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemCharacteristicKey

SaleReturnLineItemCharacteristic.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

characteristicID

X

String

The identifier of the characteristic 

3.257. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemCollection

SaleReturnLineItemCollection undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemCollection.Key

quantity

X

Integer

The single quantity of the item

int32

units

X

Double

The units of the item

double

receiptText

String

The receipt printout text 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.258. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemCollectionKey

SaleReturnLineItemCollection.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

itemID

X

String

A unique identifier for the item

itemBaggingUnitOfMeasureCode

X

String

The code used to specify the units of the item

3.259. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemExtension

SaleReturnLineItemExtension undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemExtension.Key

extensionValue

String

The value of the key-value pair 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.260. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemExtensionKey

SaleReturnLineItemExtension.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

extensionKey

X

String

The key of the key-value pair 

extensionSequenceNumber

X

Integer

Line number (incremental counter) - there may exist multiple rows per ExtensionKey

int32

3.261. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemGenericAttribute

SaleReturnLineItemGenericAttribute undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemGenericAttribute.Key

genericAttributeKey

X

String

The key of the generic attribute.The key may not be unique in the scope of a single line item.

genericAttributeValue

String

The value of the generic attribute.

customFlag

X

Boolean

Indicates whether the generic attribute is custom (project-specific) or was added as an internal attribute for the product. This flag controls whether this generic attribute is considered in checking the configured limit (true) or not (false).

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.262. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemGenericAttributeKey

SaleReturnLineItemGenericAttribute.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

genericAttributeSequenceNumber

X

Integer

The sequence number of generic attribute within the scope of the line item.

int32

3.263. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemKey

SaleReturnLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.264. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemMerchandiseHierarchyGroup

SaleReturnLineItemMerchandiseHierarchyGroup undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemMerchandiseHierarchyGroup.Key

timeStampEffective

String

The timestamp when this assignment becomes active ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

timeStampExpiration

String

The last date and time when this assignment is effective ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

statusCode

String

Defines the current status for the assignment; examples of valid codes include: AC/null = Active, IA = Inactive

timeStampEffectiveUTC0

Date

The UTC0 timestamp when this assignment becomes active ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

timeStampExpirationUTC0

Date

The last UTC0 date and time when this assignment is effective ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.265. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemMerchandiseHierarchyGroupKey

SaleReturnLineItemMerchandiseHierarchyGroup.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

merchandiseHierarchyGroupIDQualifier

X

String

Qualifier which is used to differ between MerchandiseHierarchyGroup’s belonging to different functions but having the same id 

merchandiseHierarchyGroupID

X

String

Unique system assigned identifier for the merchandise group. 

3.266. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemModifierCoupon

SaleReturnLineItemModifierCoupon undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemModifierCoupon.Key

couponNumber

X

String

The coupon number that was used to trigger the modifier

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.267. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemModifierCouponKey

SaleReturnLineItemModifierCoupon.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

modifierSequenceNumber

X

Integer

The sequence number of the related FrequentShopperPointsModifier resp. RetailPriceModifier 

int32

promotionID

X

String

The unique identifier of the promotion.

priceDerivationRuleID

X

String

The unique identifier of the price derivation rule. 

priceDerivationRuleEligibilityID

X

String

The unique identifier of the root eligibility.

couponSequenceNumber

X

Integer

The sequential number of the coupon entry (starting with 1), in case there was more than one coupon registered for one modifier 

int32

3.268. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemModifierReference

SaleReturnLineItemModifierReference undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemModifierReference.Key

referenceQuantity

X

Double

The quantity share of that line item which was necessary for fulfilling the price derivation rule eligibilities

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.269. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemModifierReferenceKey

SaleReturnLineItemModifierReference.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

promotionID

X

String

The unique identifier of the promotion.

priceDerivationRuleID

X

String

The unique identifier of the price derivation rule. 

priceDerivationRuleEligibilityID

X

String

The unique identifier of the root eligibility.

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.270. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemPrice

SaleReturnLineItemPrice undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemPrice.Key

priceAmount

X

Double

The price 

double

description

String

An additional information concerning the price 

packagePriceQuantity

Integer

The quantity the price is defined for, i.e. 3 for $1.00

int32

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.271. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemPriceKey

SaleReturnLineItemPrice.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

priceTypeCode

X

String

The price type code 

3.272. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemPromotionTrigger

SaleReturnLineItemPromotionTrigger undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemPromotionTrigger.Key

triggerType

X

String

The type of the trigger (referencing to POS configuration)

triggerValue

X

String

The value of the trigger (referencing to POS configuration)

privilegeType

X

String

Defines the method for price modification.

privilegeValue

X

Double

Reduction amount, reduction percent or new price amount

double

reasonCode

String

Reason code for the manual discount

reasonDescription

String

A narrative description describing the manual discount reason.

reference_

String

An additional information concerning the trigger 

triggerSequenceAddend

X

String

A value which is to be added to the sequence of the condition (which comes from the master data) 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.273. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemPromotionTriggerKey

SaleReturnLineItemPromotionTrigger.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

triggerSequenceNumber

X

Integer

The ident of the trigger (because one line item can have more than one trigger) 

int32

3.274. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemSalesOrder

SaleReturnLineItemSalesOrder undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemSalesOrder.Key

salesOrderTypeCode

String

The type code of the related sales order 

salesOrderDeliveryTypeCode

String

The delivery type code of the related sales order 

requestedDeliveryDate

String

The delivery date that was requested by the customer; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.275. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemSalesOrderKey

SaleReturnLineItemSalesOrder.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.276. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemSplitPackage

SaleReturnLineItemSplitPackage undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemSplitPackage.Key

splitQuantity

X

Integer

The number of items this split price is applied to.see Transaction Calculation Rules

int32

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.277. ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemSplitPackageKey

SaleReturnLineItemSplitPackage.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

splitPrice

X

Double

The price rounded according to the algorithmsee Transaction Calculation Rules

double

3.278. ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxExemptTrigger

SaleReturnTaxExemptTrigger undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnTaxExemptTrigger.Key

reasonCode

String

Tax exempt reason code

reasonDescription

String

A narrative description for the tax exempt reason code. 

taxCertificateID

String

The certificate number assigned to a purchaser by a tax authority exempting the purchaser from tax in that authority.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.279. ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxExemptTriggerKey

SaleReturnTaxExemptTrigger.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.280. ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxLineItem

SaleReturnTaxLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnTaxLineItem.Key

taxGroupRuleID

String

System assigned unique identifier for the TaxGroupRule. 

taxIncludedInPricesFlag

Boolean

A flag denoting that all applicable taxes are included in the prices for this line item, and that therefore this SaleReturnTaxLineItem is merely a summary of those taxes, 

taxAtSourceFlag

Boolean

A flag denoting that the goods being sold and shipped have been taxed according to the TaxAuthorityShippingRule. 

taxableAmount

X

Double

The monetary amount for which tax is applicable. 

double

taxablePercent

Double

The percentage of the taxable amount that is liable for tax. Usually this is 100% but where an aggregate item contains taxed and non-taxed goods this value may be less than 100%. 
Fixed decimal precision expected, definition of used precision: double(7, 4). Be aware of this and round value!

double

taxPercent

Double

The percentage of the taxable portion of the taxable amount that is being collected as tax by this LineItem. 
Fixed decimal precision expected, definition of used precision: double(7, 4). Be aware of this and round value!

double

taxAmount

X

Double

The monetary value tax that is being collected by this LineItem.

double

taxAuthorityID

String

A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a government body. 

taxAuthorityName

String

The name of the tax authority. This is to be printed on the receipt in some cases 

receiptPrintCode

String

A short code that is printed on a receipt to denote items that are in this TaxableGroup.

saleReturnTaxOverrideModifierList

List of ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxOverrideModifier

tax override data

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.281. ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxLineItemKey

SaleReturnTaxLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

taxSequenceNumber

X

Integer

Line number (incremental counter) of the tax entry

int32

3.282. ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxOverrideModifier

SaleReturnTaxOverrideModifier undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SaleReturnTaxOverrideModifier.Key

taxGroupRuleID

X

String

System assigned unique identifier for the TaxGroupRule. 

taxableAmount

Double

The monetary amount for which tax is applicable at the new rate. 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

originalTaxAmount

Double

The original amount of Tax that should’ve been collected but wasn’t because of this TaxOverrideModifier. 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

newTaxAmount

Double

The new amount of Tax that is being collected because of this TaxOverrideModifier. 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

originalTaxPercent

Double

The original tax rate that should’ve been collected but wasn’t because of this TaxOverrideModifier. 
Fixed decimal precision expected, definition of used precision: double(7, 4). Be aware of this and round value!

double

newTaxPercent

Double

The new tax rate that is being collected because of this TaxOverrideModifier. 
Fixed decimal precision expected, definition of used precision: double(7, 4). Be aware of this and round value!

double

reasonCode

String

A retailer assigned reason code denoting why this TaxOverride is being granted.  

reasonDescription

String

A narrative description describing the use of the retailer assigned tax override reason code

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.283. ComGkSoftwareGkrApiTxpoolDtoSaleReturnTaxOverrideModifierKey

SaleReturnTaxOverrideModifier.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

taxSequenceNumber

X

Integer

Line number (incremental counter) of the tax entry 

int32

3.284. ComGkSoftwareGkrApiTxpoolDtoSerializedUnitModifer

SerializedUnitModifer undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SerializedUnitModifer.Key

serializedItemID

X

String

Fix 0

serialNumber

X

String

The serial number of the line item

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.285. ComGkSoftwareGkrApiTxpoolDtoSerializedUnitModiferKey

SerializedUnitModifer.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.286. ComGkSoftwareGkrApiTxpoolDtoSignOffTransaction

SignOffTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SignOffTransaction.Key

tillID

X

String

The unique identifier of the till

lastWorkstationID

String

Last workstation where the till was used. Only filled in case of forced log out.

lastWorkerID

String

Last worker logged on till. Only filled in case of forced log out.

lastWorkerFirstName

String

First name of last worker logged on till. Only filled in case of forced log out.

lastWorkerLastName

String

Last name of last worker logged on till. Only filled in case of forced log out.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.287. ComGkSoftwareGkrApiTxpoolDtoSignOffTransactionKey

SignOffTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.288. ComGkSoftwareGkrApiTxpoolDtoSignOnTransaction

SignOnTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.SignOnTransaction.Key

tillID

X

String

The unique identifier of the till

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.289. ComGkSoftwareGkrApiTxpoolDtoSignOnTransactionKey

SignOnTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.290. ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTenderDenomination

StoreSafeSettlementTenderDenomination undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.StoreSafeSettlementTenderDenomination.Key

typeCode

String

The denomination type code

pieceValue

X

Double

Piece value 

double

rollFlag

X

Boolean

Determines whether the DenominationCount value is expressed in coin rolls (true) or single coins/notes (false)

rollCapacity

X

Double

Count of coins in the roll 

double

denominationCount

X

Double

The count of the denomination

double

denominationAmount

X

Double

The total amount of the denomination

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.291. ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTenderDenominationKey

StoreSafeSettlementTenderDenomination.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderRepositoryID

X

String

The unique identifier for the TENDER REPOSITORY. 

tenderTypeCode

X

String

A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.

denominationSequenceNumber

X

Integer

Line number (incremental counter) of the denomination 

int32

3.292. ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTenderDetail

StoreSafeSettlementTenderDetail undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.StoreSafeSettlementTenderDetail.Key

openBalanceAmount

X

Double

The opening tender balance

double

openMediaUnitQuantity

Integer

The opening number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)

int32

closeBalanceAmount

X

Double

The closing tender balance in main currencyCorresponds to the target values.

double

closeMediaUnitQuantity

Integer

The closing number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)

int32

countedBalanceAmount

X

Double

The counted tender balance in main currencyCorresponds to the target values.

double

countedMediaUnitQuantity

Integer

The counted number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)

int32

overUnderBalanceAmount

X

Double

The variance between closing balance amount and counted balance amount by subtracting the CloseBalanceAmount from the CountedBalanceAmount.

double

overUnderMediaUnitQuantity

Integer

The variance between closing media unit quantity and counted media unit quantity by subtracting the CloseMediaUnitQuantity from the CountedMediaUnitQuantity.

int32

currencySymbol

String

The currency symbol

tenderDescription

String

Description of the tender

unitCountRequiredFlag

X

Boolean

A flag to signify that specific tender type units need to be counted and recorded by the operator prior to a pickup. 

amountCountRequiredFlag

X

Boolean

A flag to signify that a specific tender type amount needs to be counted and recorded by the operator prior to a pickup. 

tenderClassCode

String

The tender class code from master data

exchangeRate

Double

The quantitative conversion factor between foreign currency and local currency. 
Fixed decimal precision expected, definition of used precision: double(14, 9). Be aware of this and round value!

double

exchangeRateMultiplyFlag

X

Boolean

Determines whether inside the calculation foreign currency → local currency the amount is to be multiplied with (true) or divided by (false) the ExchangeRate factor 

foreignCurrencyCountedBalanceAmount

Double

The counted tender balance expressed in the currency of the tender
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

foreignCurrencyCloseBalanceAmount

Double

The closing tender balance expressed in the currency of the tender
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

storeSafeSettlementTenderDenominationList

List of ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTenderDenomination

denomination list for counted values

xxcustom03

String

Customizable information 

xxcustom02

String

Customizable information 

xxcustom05

String

Customizable information 

xxcustom04

String

Customizable information 

xxcustom01

String

Customizable information 

isocurrencyCode

String

The currency code of the tender

3.293. ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTenderDetailKey

StoreSafeSettlementTenderDetail.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderRepositoryID

X

String

The unique identifier for the TENDER REPOSITORY. 

tenderTypeCode

X

String

A code which uniquely identifies the tender

3.294. ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTransaction

StoreSafeSettlementTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.StoreSafeSettlementTransaction.Key

storeSafeSettlementTenderDetailList

List of ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTenderDetail

tender details

safeID

String

The unique identifier of the safe

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.295. ComGkSoftwareGkrApiTxpoolDtoStoreSafeSettlementTransactionKey

StoreSafeSettlementTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.296. ComGkSoftwareGkrApiTxpoolDtoTaxLineItem

TaxLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TaxLineItem.Key

taxIncludedInPricesFlag

Boolean

A flag denoting that all applicable taxes are included in the prices for this line item, and that therefore this SaleReturnTaxLineItem is merely a summary of those taxes, 

taxAtSourceFlag

Boolean

A flag denoting that the goods being sold and shipped have been taxed according to the TaxAuthorityShippingRule. 

taxablePercent

Double

The percentage of the taxable amount that is liable for tax. Usually this is 100% but where an aggregate item contains taxed and non-taxed goods this value may be less than 100%. 
Fixed decimal precision expected, definition of used precision: double(7, 4). Be aware of this and round value!

double

taxableAmount

X

Double

The monetary value of the transaction for which tax is being calculated. 

double

taxPercent

Double

The percentage of the taxable amount that should is tax. Derived by applying the appropriate TaxGroupRule and TaxRateRule. 
Fixed decimal precision expected, definition of used precision: double(7, 4). Be aware of this and round value!

double

taxAmount

Double

The monetary amount of sales Tax calculated by applying the appropriate TaxGroupRule and TaxRateRule. 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

taxGroupRuleID

String

System assigned unique identifier for the TaxGroupRule.

taxAuthorityID

String

A specific TAX AUTHORITY that establishes the tax rate. The TAX AUTHORITY is normally a government body. 

taxAuthorityName

String

The name of the tax authority. This is to be printed on the receipt in some cases 

taxGroupID

String

A tax group which links a TAX AUTHORITY to the merchandise to which the tax applies. 

receiptPrintCode

String

A short code that is printed on a receipt to denote items that are in this TaxableGroup.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.297. ComGkSoftwareGkrApiTxpoolDtoTaxLineItemKey

TaxLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.298. ComGkSoftwareGkrApiTxpoolDtoTaxRefundTransaction

TaxRefundTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TaxRefundTransaction.Key

taxRefundDocumentID

X

String

The unique identifier of the tax refund document. This is returned from tax refund service.

externalTransactionID

String

A universally unique identifier (UUID) for the transaction in the external system. Provided by the service provider.

storeInvoiceID

String

Fiscal invoice number for countries, where this is required.

totalGrossAmount

X

Double

The summarized gross amout for all sale transactions of this tax refund

double

totalTaxAmount

Double

The summarized gross amout for all sale transactions of this tax refund
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

totalRefundAmount

X

Double

The resulting tax refund amount

double

taxRefundServiceProviderName

X

String

The used tax refund service provider

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.299. ComGkSoftwareGkrApiTxpoolDtoTaxRefundTransactionKey

TaxRefundTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.300. ComGkSoftwareGkrApiTxpoolDtoTenderAmountAdjustmentTransaction

TenderAmountAdjustmentTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderAmountAdjustmentTransaction.Key

tillID

X

String

The unique identifier of the till

safeID

String

The unique identifier for the safe

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.301. ComGkSoftwareGkrApiTxpoolDtoTenderAmountAdjustmentTransactionKey

TenderAmountAdjustmentTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.302. ComGkSoftwareGkrApiTxpoolDtoTenderAuthorization

TenderAuthorization undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderAuthorization.Key

tenderLineItemSequenceNumber

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

cardType

String

A code denoting which kind of card is being accepted. 

accountNumber

String

The account number appearing on a debit/credit card and identifying the card issuer’s customer account to be charged or credited for the transaction. 

cardIssueSequenceNumber

String

The IssueSequence number of the credit card being used. 

cardExpirationDate

String

The expiration date of the Credit or Debit card, as taken from the card in MMYY format. 

referenceNumber

String

A unique identifier (which may be assigned by the external authorization agency) for this TenderAuthorization 

terminalTransactionStatus

Integer

The status of of the card transaction

int32

terminalTransactionErrorNumber

Integer

The last error message sent by the terminal 

int32

terminalTransactionType

Integer

The type of the terminal transaction 

int32

forceOnlineFlag

Boolean

Denotes that the Tender was authorized within the retail enterprise (usually because the connection to the host was down) and this TenderAuthorization must be approved by the host when it comes online. 

requestedAmount

Double

The monetary value of the purchases for which an authorization is being requested. 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

authorizationDatetime

String

The Date and Time the TenderAuthorization was made. This may be assigned by the external agency that is providing the TenderAuthorization. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

terminalTransactionEndTimestamp

String

The system time when the terminal transaction ended ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

relatedTenderAuthorizatonSequenceNumber

Integer

A unique sequence number for this TenderAuthorization. Required because a particular TenderLineItem may have more than one TenderAuthorization attempt. 

int32

terminalSequenceNumber

String

The transaction sequence number of the terminal 

requestedISOCurrencyNumber

String

Numeric code assigned by ISO to identify national currencies 

cardHolderVerificationTypeCode

String

A code denoting how a CardHolder was verified during a TenderAuthorization.

tenderAuthorizationTerminalID

Integer

A unique identifier (usually assigned by an external agency that provides TenderAuthorizations) that identifies the terminal performing the TenderAuthorization. 

int32

traceNumber

Integer

Unique identifier of terminal transaction 

int32

terminalType

String

Used terminal defined in POS configuration.(e.g. „REAECT“, „Thales“, „Secpos“, …​) If the payment is carried out without a terminal or the terminal is not connected to the cash register: 'OFFLINE' This information is necessary for later cancellation of the terminal payment. 

merchantNumber

String

A financial institution assigned identifier for ther Retail Enterprise or RetailStore that is conducting theTenderAuthorization. 

approvalCode

String

The terminal authorization number 

adjudicationCode

String

The adjudication code returned by the external agency to this TenderAuthorizationRequest 

adjudicationText

String

An error message in text form 

hostAuthorizedFlag

Boolean

A flag denoting that this TenderAuthorization was authorized by an external agency. 

activationSequenceNumber

Integer

The activation sequence number

int32

terminalTransactionReferenceNumber

String

The transaction reference number;is used in the context of purchase reservation and reservation adjustment

terminalTransactionTypeCode

X

String

The transaction type sent back by the terminal;possible transaction types are:DebitCreditAny

terminalTenderDescription

String

The tender description sent back by the terminal

applicationID

String

The application identifier sent back by the terminal

encryptedPAN

String

The (coded) application PAN sent back by the terminal

terminalTransactionCurrencyCode

String

The transaction currency code sent back by the terminal

authorizationDatetimeUTC0

Date

The UTC0 Date and Time the TenderAuthorization was made. This may be assigned by the external agency that is providing the TenderAuthorization. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

terminalTransactionEndTimestampUTC0

Date

The system time corresponding to UTC0 when the terminal transaction ended ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

terminalTransactionToken

String

The token is a unique number assigned by the payment processor to a card when a EFT transaction is processed. You can think of it like a replacement for the PAN that can be safely stored. This token needs to be retrieved from the terminal and stored in the DB (TenderAuthorization looks like the place to put it). The token is needed in order to do refunds/voids of previous EFT transactions without the need for the customer to swipe/insert their card on the terminal. In order for the terminal (T+) to do a void of an EFT transaction we need the token, reference number, approval code and amount. Currently only the approval code and amount is passed to the terminal for voids. The token and reference number are needed to be sent to the terminal for voids. The reference number is already stored in TenderAuthorization, it just needs to be passed to the terminal. Example: 0:AmEx:AX:997309203571006:0120

internationalBankAccountNumber

String

IBAN - International Bank Account Number for SEPA Direct Debit

bankIdentifierCode

String

BIC - Bank Identifier Code. Also known as SWIFT Code for SEPA Direct Debit.

creditorID

String

Creditor ID for SEPA Direct Debit (ELV)

mandateID

String

Mandate ID for SEPA Direct Debit (ELV)

prenotificationText

String

Pre-notification text for SEPA Direct Debit (ELV)

tenderAuthorizationTerminalID2

String

A unique identifier (usually assigned by an external agency that provides TenderAuthorizations) that identifies the terminal performing the TenderAuthorization. 

merchantTransactionReferenceID

String

The unique identifier for the terminal transaction (payment, refund) as created by POS client. This will be sent to the payment provider as part of request. By this, the terminal transaction could be identified later in case of problems (voiding in offline scenarios).

terminalVendorName

String

The name of the terminal vendor

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.303. ComGkSoftwareGkrApiTxpoolDtoTenderAuthorizationKey

TenderAuthorization.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderAuthorizationSequenceNumber

X

Integer

A unique sequence number for this TenderAuthorization. Required because a particular TenderLineItem may have more than one TenderAuthorization attempt. 

int32

3.304. ComGkSoftwareGkrApiTxpoolDtoTenderControlTransaction

TenderControlTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderControlTransaction.Key

tenderControlTypeCode

String

A code to denote the type of the tender control transaction.

tenderControlTransactionTenderLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoTenderControlTransactionTenderLineItem

list of tender line items

tenderPickupTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoTenderPickupTransaction

additional pickup data

tenderLoanTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoTenderLoanTransaction

additional loan data

tenderAmountAdjustmentTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoTenderAmountAdjustmentTransaction

additional data for tender amount adjustments

tenderDepositReceiptTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoTenderDepositReceiptTransaction

additional data for inbound/outbound safe transactions

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.305. ComGkSoftwareGkrApiTxpoolDtoTenderControlTransactionKey

TenderControlTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.306. ComGkSoftwareGkrApiTxpoolDtoTenderControlTransactionTenderLineItem

TenderControlTransactionTenderLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderControlTransactionTenderLineItem.Key

foreignCurrencyAmount

Double

The monetary value (in currency being moved) of the Tender being moved by the transaction. 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

amount

X

Double

The monetary value (in the default system currency) of the Tender being moved by the transaction. 

double

count

X

Integer

The number of tender units being moved.

int32

tenderControlTransactionTenderLineItemDenominationList

List of ComGkSoftwareGkrApiTxpoolDtoTenderControlTransactionTenderLineItemDenomination

list of denominations

currencySymbol

String

Currency symbol

tenderDescription

String

Description of the tender

unitCountRequiredFlag

X

Boolean

A flag to signify that specific tender type units need to be counted and recorded by the operator prior to a pickup. 

amountCountRequiredFlag

X

Boolean

A flag to signify that a specific tender type amount needs to be counted and recorded by the operator prior to a pickup. 

tenderClassCode

String

The tender class code from master data

exchangeRate

Double

The quantitative conversion factor between foreign currency and local currency. 
Fixed decimal precision expected, definition of used precision: double(14, 9). Be aware of this and round value!

double

exchangeRateMultiplyFlag

X

Boolean

Determines whether inside the calculation foreign currency → local currency the amount is to be multiplied with (true) or divided by (false) the ExchangeRate factor

closeBalanceAmount

Double

The closing tender balance for the pickup correction, expressed in main currency
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

closeMediaUnitQuantity

Integer

The closing number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.) for the pickup correction

int32

closeBalanceForeignCurrencyAmount

Double

The closing tender balance for the pickup correction, expressed in foreign currency
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

countedBalanceAmount

Double

The counted tender balance for the pickup correction, expressed in main currency
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

countedMediaUnitQuantity

Integer

The counted number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.) for the pickup correction

int32

countedBalanceForeignCurrencyAmount

Double

The counted tender balance for the pickup correction, expressed in foreign currency
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

isocurrencyCode

String

Currency code of the tender

3.307. ComGkSoftwareGkrApiTxpoolDtoTenderControlTransactionTenderLineItemDenomination

TenderControlTransactionTenderLineItemDenomination undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderControlTransactionTenderLineItemDenomination.Key

typeCode

String

The denomination type code

pieceValue

X

Double

Piece value 

double

rollFlag

X

Boolean

Determines whether the DenominationCount value is expressed in coin rolls (true) or single coins/notes (false)

rollCapacity

X

Double

Count of coins in the roll 

double

denominationCount

X

Double

The count of the denomination

double

denominationAmount

X

Double

The total amount of the denomination

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.308. ComGkSoftwareGkrApiTxpoolDtoTenderControlTransactionTenderLineItemDenominationKey

TenderControlTransactionTenderLineItemDenomination.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderTypeCode

X

String

A code which uniquely identifies the type of tender being moved in the TenderControlTransaction.  

denominationSequenceNumber

X

Integer

Line number (incremental counter) of the denomination 

int32

3.309. ComGkSoftwareGkrApiTxpoolDtoTenderControlTransactionTenderLineItemKey

TenderControlTransactionTenderLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderTypeCode

X

String

A code which uniquely identifies the type of tender being moved in the TenderControlTransaction.  

3.310. ComGkSoftwareGkrApiTxpoolDtoTenderDepositReceiptTransaction

TenderDepositReceiptTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderDepositReceiptTransaction.Key

outboundTenderRepositoryID

X

String

The unique identifier for the TENDER REPOSITORY. 

inboundTenderRepositoryID

X

String

The unique identifier for the TENDER REPOSITORY. 

depositBagID

String

Automatically generated (with another algorithm like reference number in bank payment) unique Safebag ID.

depositBagNumber

String

Safe bag number entered by operator that was used to transport the Tender from the Safe to the ExternalDepository. 

safeTenderMovementCode

String

A code that indicates the movement of tender with respect to a SAFE. It is used to clarify whether tender is being RECEIVED into a store safe from an external repository or DEPOSITED from a safe into an external depository.Additionally it is possible to TRANSFER tenders between safes.

doubleCheckingWorkerID

String

A unique system-assigned identifier for the Person who is a particular Worker.

xxcustom03

String

Customizable information 

xxcustom02

String

Customizable information 

xxcustom05

String

Customizable information 

xxcustom04

String

Customizable information 

xxcustom01

String

Customizable information 

3.311. ComGkSoftwareGkrApiTxpoolDtoTenderDepositReceiptTransactionKey

TenderDepositReceiptTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.312. ComGkSoftwareGkrApiTxpoolDtoTenderLineItem

TenderLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderLineItem.Key

isChangeFlag

Boolean

If true, denotes that the Tender is returned by the retailer to the Customer. 

tenderTypeCode

String

A code which uniquely identifies the tenderCorresponds to Tender.TenderTypeCode

tenderAccountNumber

String

The tender account number

foreignCurrencyAmount

X

Double

The monetary value (in the currency submitted by the Customer) of the tender submitted by the Customer. 

double

exchangeRate

Double

The exchange rate used to convert the tendered amount into the default currency of the retail enterprise. 
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

tenderAmount

X

Double

The monetary value (in the default currency of the retail enterprise) of the tender submitted by the Customer. 

double

tenderGroupCode

String

The grouping of tenders with similar (technical) handling on POS side. Corresponds to TenderHandlingRule.TenderGroupCode 

tenderCount

X

Integer

The count of the media for the given tender 

int32

tenderDescription

String

Text to be printed on the receipt.

cashbackFlag

X

Boolean

Boolean identifier for cash back

foreignISOCurrencyCode

String

Currency code designated by ISO to identify the currency of the tender

exchangeRateMultiplyFlag

X

Boolean

Determines whether inside the calculation FromCurrencyID → ToCurrencyID the amount is to be multiplied with (true) or divided by (false) the factor (ExchangeRate)

currencySymbol

String

Currency symbol of the tender

tipAmount

Double

The monetary amount (in the default currency of the retail enterprise) being collected as Tip for serving staff
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

tipForeignCurrencyAmount

Double

The monetary amount (in the tendered currency) being collected as Tip for serving staff
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

checkTenderLineItemList

List of ComGkSoftwareGkrApiTxpoolDtoCheckTenderLineItem

Check data for check tender line items

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

3.313. ComGkSoftwareGkrApiTxpoolDtoTenderLineItemKey

TenderLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.314. ComGkSoftwareGkrApiTxpoolDtoTenderLoanTransaction

TenderLoanTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderLoanTransaction.Key

outboundSafeID

X

String

The unique identifier for the TENDER REPOSITORY. 

inboundTillID

X

String

The unique identifier for the TENDER REPOSITORY. 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.315. ComGkSoftwareGkrApiTxpoolDtoTenderLoanTransactionKey

TenderLoanTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.316. ComGkSoftwareGkrApiTxpoolDtoTenderPickupTransaction

TenderPickupTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TenderPickupTransaction.Key

inboundSafeID

X

String

The unique identifier for the TENDER REPOSITORY. 

outboundTillID

String

The unique identifier of the till

envelopeID

String

The identifier of the Envelope that was used for this Pickup

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.317. ComGkSoftwareGkrApiTxpoolDtoTenderPickupTransactionKey

TenderPickupTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.318. ComGkSoftwareGkrApiTxpoolDtoTillSettlementDocument

TillSettlementDocument undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TillSettlementDocument.Key

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.319. ComGkSoftwareGkrApiTxpoolDtoTillSettlementDocumentKey

TillSettlementDocument.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderRepositoryID

X

String

The unique identifier for the TENDER REPOSITORY.

3.320. ComGkSoftwareGkrApiTxpoolDtoTillSettlementTenderDenomination

TillSettlementTenderDenomination undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TillSettlementTenderDenomination.Key

typeCode

String

The denomination type code

pieceValue

X

Double

Piece value 

double

rollFlag

X

Boolean

Determines whether the DenominationCount value is expressed in coin rolls (true) or single coins/notes (false)

rollCapacity

X

Double

Count of coins in the roll 

double

denominationCount

X

Double

The count of the denomination

double

denominationAmount

X

Double

The total amount of the denomination

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.321. ComGkSoftwareGkrApiTxpoolDtoTillSettlementTenderDenominationKey

TillSettlementTenderDenomination.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderRepositoryID

X

String

The unique identifier for the TENDER REPOSITORY. 

tenderTypeCode

X

String

A code which uniquely identifies the tender

denominationSequenceNumber

X

Integer

Line number (incremental counter) of the denomination 

int32

3.322. ComGkSoftwareGkrApiTxpoolDtoTillSettlementTenderDetail

TillSettlementTenderDetail undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TillSettlementTenderDetail.Key

openBalanceAmount

X

Double

The opening tender balance

double

openMediaUnitQuantity

Integer

The opening number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)

int32

closeBalanceAmount

X

Double

The closing tender balance in main currencyCorresponds to the target values.

double

closeMediaUnitQuantity

Integer

The closing number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)Corresponds to the target values.

int32

countedBalanceAmount

X

Double

The counted tender balance in main currency

double

countedMediaUnitQuantity

Integer

The counted number of discrete tender media (e.g. currency bills, coins, credit/debit card signed slips, etc.)

int32

overUnderBalanceAmount

X

Double

The variance between closing balance amount and counted balance amount by subtracting the CloseBalanceAmount from the CountedBalanceAmount

double

overUnderMediaUnitQuantity

Integer

The variance between closing media unit quantity and counted media unit quantity by subtracting the CloseMediaUnitQuantity from the CountedMediaUnitQuantity.

int32

currencySymbol

String

The currency symbol

tenderDescription

String

Description of the tender. 

unitCountRequiredFlag

X

Boolean

A flag to signify that specific tender type units need to be counted and recorded by the operator

amountCountRequiredFlag

X

Boolean

A flag to signify that a specific tender type amount needs to be counted and recorded by the operator

tenderClassCode

String

The tender class code from master data

exchangeRate

Double

The quantitative conversion factor between foreign currency and local currency. 
Fixed decimal precision expected, definition of used precision: double(14, 9). Be aware of this and round value!

double

exchangeRateMultiplyFlag

X

Boolean

Determines whether inside the calculation foreign currency → local currency the amount is to be multiplied with (true) or divided by (false) the ExchangeRate factor 

foreignCurrencyCountedBalanceAmount

Double

The counted tender balance expressed in the currency of the tender
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

foreignCurrencyCloseBalanceAmount

Double

The closing tender balance expressed in the currency of the tender
Fixed decimal precision expected, definition of used precision: double(16, 5). Be aware of this and round value!

double

tillSettlementTenderDenominationList

List of ComGkSoftwareGkrApiTxpoolDtoTillSettlementTenderDenomination

denomination list for counted values

xxcustom03

String

Customizable information 

xxcustom02

String

Customizable information 

xxcustom05

String

Customizable information 

xxcustom04

String

Customizable information 

xxcustom01

String

Customizable information 

isocurrencyCode

String

The currency code of the tender

3.323. ComGkSoftwareGkrApiTxpoolDtoTillSettlementTenderDetailKey

TillSettlementTenderDetail.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

tenderRepositoryID

X

String

The unique identifier for the TENDER REPOSITORY. 

tenderTypeCode

X

String

A code which uniquely identifies the tender

3.324. ComGkSoftwareGkrApiTxpoolDtoTillTenderSettlementTransaction

TillTenderSettlementTransaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TillTenderSettlementTransaction.Key

tillSettlementTenderDetailList

List of ComGkSoftwareGkrApiTxpoolDtoTillSettlementTenderDetail

settlement tender details

tillSettlementDocumentList

List of ComGkSoftwareGkrApiTxpoolDtoTillSettlementDocument

settlement details

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.325. ComGkSoftwareGkrApiTxpoolDtoTillTenderSettlementTransactionKey

TillTenderSettlementTransaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.326. ComGkSoftwareGkrApiTxpoolDtoTransaction

Transaction undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.Transaction.Key

operatorID

X

String

A unique, automatically assigned number used to identify a workstation OPERATOR. 

workstationID

X

String

The unique identifier for the WORKSTATION. 

businessUnitID

X

String

The store id

businessDayDate

X

String

The calendar date of the BusinessDay. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

sequenceNumber

X

Integer

The sequence number of the transaction (incremental number for each workstation). It is formatted according to minimum and maximum value and it could be reset every day to minimum value. So in comparison to InternalSequenceNumber it must not be unique for business unit and workstation.It is used for export, reporting, search and display.

int32

transactionTypeCode

X

String

A code to denote the type of Transaction.

beginDateTimestamp

String

The time and date a transaction is initiated. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

endDateTimestamp

String

The time and date stamp a transaction is completed. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

cancelledFlag

Boolean

A flag denoting that this entire transaction has been cancelled before it was completed at the POS. 

suspendedFlag

Boolean

Defines if the transaction was suspended.

trainingFlag

Boolean

A flag to signify whether the transaction was created in training mode.

keyedOfflineFlag

String

A code that indicates the online/offline state when transaction was completed.

reasonCode

String

A unique retailer defined reason code for an action that is taken (or not taken) at a Workstation.

reasonDescription

String

A narrative description describing the uses of the retailer assigned reason code. Corresponds to Reason.Description

workerID

String

A unique system-assigned identifier for the Worker.

workerFirstName

String

The worker’s first name

workerLastName

String

The worker’s last name

softwareVersion

String

The software version which was used in order to create the transaction.

suspendNumber

String

Number for suspending, can be used for multiple transactions

internalSequenceNumber

X

Integer

The sequence number of the transaction (incremental number for each workstation). It is unique for business unit and workstation.

int32

fiscalSequenceNumber

String

The sequence number being created either by the POS, the fiscal printer, or other device used for fiscalization

fiscalFlag

X

Boolean

Determines whether this is a fiscal transaction.

fiscalDayNumber

String

The fiscal day counter

fiscalPrinterID

String

The identifier of the fiscal printer

fiscalSignature

String

Fiscal signature of the transaction.

transactionTimestamp

String

The timestamp which is relevant for the transaction processing. Depending on configuration, this can be the BeginDateTimestamp or the EndDateTimestamp. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

beginDateTimestampUTC0

Date

The UTC0 time and date a transaction is initiated. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

endDateTimestampUTC0

Date

The UTC0 time and date stamp a transaction is completed. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

transactionTimestampUTC0

Date

The UTC0 timestamp which is relevant for the transaction processing. Depending on configuration, this can be the BeginDateTimestampUTC0 or the EndDateTimestampUTC0. UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

transactionAdditionalPrintoutList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionAdditionalPrintout

List of additional printouts

transactionAssociationList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionAssociation

List of associated transactions

transactionBinaryDataList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionBinaryData

List of binary data

transactionCategoryList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionCategory

List of transaction categories

transactionExtensionList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionExtension

List of transaction extensions

transactionResourceOverrideList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionResourceOverride

List of data for authorization related to transaction level

endWorkstationID

String

WorkstationID were the transaction was finalized.

transactionAuditEventList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionAuditEvent

List of audit events

transactionTimerList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionTimer

List of timer entries

languageID

String

The language code that applies to the transaction. It is a combination of  ISO-639-1 language code itself and ISO-3661-1 country code, e.g. en_US

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

retailTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransaction

retail transaction data

controlTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoControlTransaction

control transaction data

tenderControlTransactionList

List of ComGkSoftwareGkrApiTxpoolDtoTenderControlTransaction

tender control transaction data

transactionBusinessUnitList

List of ComGkSoftwareGkrApiTxpoolDtoTransactionBusinessUnit

business unit data

isocurrencyCode

X

String

Main currency of the store

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

3.327. ComGkSoftwareGkrApiTxpoolDtoTransactionAdditionalPrintout

TransactionAdditionalPrintout undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionAdditionalPrintout.Key

triggerID

X

String

The trigger type ident of the additional printout (e.g. customer group, user function, tender).

triggerValue

X

String

The trigger value for the additional printout (e.g. the number of the customer group, the number of user function, the tender class code).

reportName

X

String

The name of the report template 

printoutCount

X

Double

The count of printout copies 

double

printoutContent

String

Parameter / data for printout 

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.328. ComGkSoftwareGkrApiTxpoolDtoTransactionAdditionalPrintoutKey

TransactionAdditionalPrintout.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

printoutSequenceNumber

X

Integer

Line number (incremental counter) of the printout 

int32

3.329. ComGkSoftwareGkrApiTxpoolDtoTransactionAssociation

TransactionAssociation undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionAssociation.Key

toTransactionID

String

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.330. ComGkSoftwareGkrApiTxpoolDtoTransactionAssociationKey

TransactionAssociation.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

Business unit group id of the current transaction.

transactionID

X

String

Transaction ID of the current Transaction.

toTransactionID

X

String

Transaction ID of the referenced Transaction.

toBusinessUnitGroupID

X

String

Business unit group id of the referenced transaction.

transactionAssociationTypeCode

X

String

A retailer assigned code denoting the relationship between the two transactions.

3.331. ComGkSoftwareGkrApiTxpoolDtoTransactionAuditEvent

TransactionAuditEvent undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionAuditEvent.Key

creationTimestamp

X

String

Creation timestamp of the audit event; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

creationTimestampUTC0

X

Date

Creation timestamp in UTC0; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

workstationID

String

ID of the workstation

workstationTypeCode

String

Type code of the workstation

eventTypeCode

X

String

Type code of the audit event

content

Object

Additional event content

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.332. ComGkSoftwareGkrApiTxpoolDtoTransactionAuditEventKey

TransactionAuditEvent.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

ID of the business unit group

transactionID

X

String

ID of the transaction

eventSequenceNumber

X

Integer

A unique identifier (within the context of the Transaction) for this event entry. 

int32

3.333. ComGkSoftwareGkrApiTxpoolDtoTransactionBinaryData

TransactionBinaryData undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionBinaryData.Key

name

X

String

The name of the binary data entry 

content

X

Object

The binary object 

contentLength

X

Double

The length of the binary object

double

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.334. ComGkSoftwareGkrApiTxpoolDtoTransactionBinaryDataKey

TransactionBinaryData.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

binaryDataSequenceNumber

X

Integer

A unique identifier (within the context of the Transaction) for this binary data entry. 

int32

3.335. ComGkSoftwareGkrApiTxpoolDtoTransactionBusinessUnit

TransactionBusinessUnit undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionBusinessUnit.Key

name

String

The name of the business unit.

addressLine1

String

The first line of the address, normally the street number and name.

city

String

The city, town or village component of the address

postalCode

String

The postal or zip code of the address

territoryName

String

The name of the county, state, province, territory etc. component of the address 

completePhoneNumber

String

The complete telephone number including the country code, area code, telephone number and extension number.

internetURL

String

The link to the business unit’s website.

vatregistrationNumber

String

The VAT registration number of the business unit.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.336. ComGkSoftwareGkrApiTxpoolDtoTransactionBusinessUnitKey

TransactionBusinessUnit.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.337. ComGkSoftwareGkrApiTxpoolDtoTransactionCategory

TransactionCategory undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionCategory.Key

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.338. ComGkSoftwareGkrApiTxpoolDtoTransactionCategoryKey

TransactionCategory.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

transactionCategoryCode

X

String

The code representing the transaction category

TransactionCorrelationLink undocumented

3.340. ComGkSoftwareGkrApiTxpoolDtoTransactionCorrelationLinkKey

TransactionCorrelationLink.Key Inner class for composite key attributes

Field Name Required Type Description Format

parentTransactionID

X

String

An identifier of the correlation-parent transaction

childTransactionID

X

String

An identifier of the correlation-child transaction

3.341. ComGkSoftwareGkrApiTxpoolDtoTransactionExtension

TransactionExtension undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionExtension.Key

extensionValue

String

The value of the key-value pair

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.342. ComGkSoftwareGkrApiTxpoolDtoTransactionExtensionKey

TransactionExtension.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

extensionKey

X

String

The key of the key-value pair 

extensionSequenceNumber

X

Integer

Line number (incremental counter) - there may exist multiple rows per ExtensionKey

int32

3.343. ComGkSoftwareGkrApiTxpoolDtoTransactionKey

Transaction.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

3.344. ComGkSoftwareGkrApiTxpoolDtoTransactionResourceOverride

TransactionResourceOverride undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionResourceOverride.Key

resourceID

String

A unqiue system assigned identifier for the action to which access may be granted.  

operatorID

X

String

A unique, automatically assigned number used to identify a workstation OPERATOR. 

overrideTimestamp

String

The date and time that a transaction line item is being overridden. ; Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

entryMethodCode

String

A code denoting how the overriding Operator was entered. e.g. Keyed, Scanned, MCR, etc…​ 

approverName

String

The name of the person assigned to the WorkerID that was used to approve this TransactionResourceOverride 

approverFirstName

String

The first name of the person assigned to the WorkerID that was used to approve this transaction resource override 

workGroupID

String

A unqiue system assigned identifier for a set of Operators with similar resource access control permissions. 

workerID

String

A unique system-assigned identifier for the Person who is a particular Worker.

overrideTimestampUTC0

Date

The UTC0 date and time that a transaction line item is being overridden. ; UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.345. ComGkSoftwareGkrApiTxpoolDtoTransactionResourceOverrideKey

TransactionResourceOverride.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

overrideSequenceNumber

X

Integer

A unique identifier (within the context of the Transaction) for this ResourceOverride. 

int32

3.346. ComGkSoftwareGkrApiTxpoolDtoTransactionTimer

TransactionTimer undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.TransactionTimer.Key

timerID

X

String

The ident of the timer. Possible values include:1 …​ Registration timer2 …​ Payment timer

startTimestamp

X

String

The timestamp that the timer commences. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

startTimestampUTC0

X

Date

The timestamp that the timer commences in UTC0 format. UTC0 date format 'yyyy-MM-dd’T’HH:mm:ss.SSSZ' (with timezone)

date-time

duration

X

Double

The duration of the timer in milliseconds.

double

timerOriginTypeCode

String

The source of the timer. Possible values include:00/Null …​ Current transaction01 …​ Taken over from suspended transaction02 …​ Taken over from food order / table movement transaction03 …​ Taken over from scale transaction

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

xxcustom06

String

Customizable information

xxcustom07

String

Customizable information

xxcustom08

String

Customizable information

xxcustom09

String

Customizable information

xxcustom10

String

Customizable information

xxcustom11

String

Customizable information

xxcustom12

String

Customizable information

xxcustom13

String

Customizable information

xxcustom14

String

Customizable information

xxcustom15

String

Customizable information

xxcustom16

String

Customizable information

xxcustom17

String

Customizable information

xxcustom18

String

Customizable information

xxcustom19

String

Customizable information

xxcustom20

String

Customizable information

xxcustom21

String

Customizable information

xxcustom22

String

Customizable information

xxcustom23

String

Customizable information

xxcustom24

String

Customizable information

xxcustom25

String

Customizable information

xxcustom26

String

Customizable information

xxcustom27

String

Customizable information

xxcustom28

String

Customizable information

xxcustom29

String

Customizable information

xxcustom30

String

Customizable information

3.347. ComGkSoftwareGkrApiTxpoolDtoTransactionTimerKey

TransactionTimer.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

The ident of the business unit group.

transactionID

X

String

A universally unique identifier for the Transaction.

timerSequenceNumber

X

Integer

The sequence number of the timer within the context of this transaction.

int32

3.348. ComGkSoftwareGkrApiTxpoolDtoVoidsLineItem

VoidsLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.VoidsLineItem.Key

voidsLineItemSequenceNumber

Integer

Link to the sequence number of the voided line item. 

int32

reasonCode

String

A unique retailer defined reason code for the VoidsLineItem.

reasonCodeGroupCode

String

A retailer assigned code denoting the family of related reason codes for classifying data and actions within the systems of the retail enterprise. 

reasonDescription

String

A narrative description describing the uses of the retailer assigned reason code.

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.349. ComGkSoftwareGkrApiTxpoolDtoVoidsLineItemKey

VoidsLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.350. ComGkSoftwareGkrApiTxpoolDtoWorkerDiscountLineItem

WorkerDiscountLineItem undocumented

Field Name Required Type Description Format

key

X

com.gk_software.gkr.api.txpool.dto.WorkerDiscountLineItem.Key

workerID

String

A unique system-assigned identifier for the Person who is a particular Worker. 

workerFirstName

String

The worker’s first name 

workerLastName

String

The worker’s last name

xxcustom03

String

Customizable information

xxcustom02

String

Customizable information

xxcustom05

String

Customizable information

xxcustom04

String

Customizable information

xxcustom01

String

Customizable information

3.351. ComGkSoftwareGkrApiTxpoolDtoWorkerDiscountLineItemKey

WorkerDiscountLineItem.Key Inner class for composite key attributes

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction. This may be assembled from alternate key members. 

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction. 

int32

3.352. ComGkSoftwarePackagePricingPosApiCalculationPackagePricingSession

PackagePricingSession Session to store context of Package Pricing Engine calculation.

Field Name Required Type Description Format

sessionId

String

Session identifier for a given package pricing calculation context.

context

Object

The Package Pricing Context stores all data needed for the processing of package prices. This attribute can be used during recalculation of a Transaction on an already initialized session.

xXCustom03

String

Customizable information.

xXCustom02

String

Customizable information.

xXCustom05

String

Customizable information.

xXCustom04

String

Customizable information.

xXCustom01

String

Customizable information.

xXCustom06

String

Customizable information.

xXCustom07

String

Customizable information.

xXCustom08

String

Customizable information.

xXCustom09

String

Customizable information.

xXCustom10

String

Customizable information.

xXCustom11

String

Customizable information.

xXCustom12

String

Customizable information.

xXCustom13

String

Customizable information.

xXCustom14

String

Customizable information.

xXCustom15

String

Customizable information.

3.353. ComGkSoftwarePosApiModelConfigComponentServerPrepaidTypePrepaidType

PrepaidType Entity prepaid type

Field Name Required Type Description Format

smId

X

Integer

Entry ID

int32

itemId

X

String

Item number of the prepaid item

providerCode

X

String

Provider code of the prepaid item

resourceId

X

String

Resource key of the prepaid receipt

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.354. ComGkSoftwarePosApiModelConfigProcessActionEwicPaymentOperationConfig

EwicPaymentOperationConfig This configuration entity defines eWIC payment related operations.

Field Name Required Type Description Format

amount

Double

This parameter defines the payment amount which is used by the function (in the case of fixed amounts which are assigned to keys).

double

askForAmount

X

Boolean

This parameter specifies whether the operator should be asked to enter the amount (in an additional view). It is only taken into account if the amount input for the tender is 'optional' or 'required'.values: 01, 02

  • InputAmountConstraint = 'Required 01' or

  • InputAmountConstraint = 'Optional 02'

tenderClassCode

X

String

This parameter defines the assignment to a particular tender in the master data.

currencyCode

String

This parameter defines the code of the currency which is used. It overrides the currency selection.

confirmPartialPayment

X

Boolean

This parameter specifies whether the payment amount must be confirmed for partial payments. It is only taken into account if the amount input for the tender must be confirmed.value: 04

  • InputAmountConstraint = 'Confirm 04'

inputAmountConstraint

X

String

This parameter defines the input amount constraint.value: InputAmountConstraint [TENDER, REQUIRED, OPTIONAL, PROHIBITED, CONFIRM]

  • Tender as '',

  • Required as '01',

  • Optional as '02',

  • Prohibited as '03',

  • Confirm as '04'

Enum: Tender, Required, Optional, Prohibited, Confirm,

allowedAmountTypeCode

X

String

This parameter defines the allowed amount type code.value: AllowedAmountTypeCode [TENDER, EXACTLY, EXACTLYANDLESS, EXACTLYANDMORE, ALL]

  • Tender as '',

  • Exactly as '01',

  • ExactlyAndLess as '02',

  • ExactlyAndMore as '03',

  • All as '04'

Enum: Tender, Exactly, ExactlyAndLess, ExactlyAndMore, All,

ewicStore

X

Boolean

This parameter specifies whether the eWIC functionality is active for the store.values: true, false

ewicType

X

Integer

This parameter specifies whether the store takes 'WIC Online EBT Cards', 'WIC Smart Cards', or both.values: 1, 2, 3

int32

ewicPhone

X

String

This parameter specifies the telephone number to call for offline authorizations to State Agency.

ewicStraddled

X

Integer

This parameter specifies the number of items that may be split among a regular subcategory and a broad band subcategory in a transaction.

int32

ewicSplit

X

Integer

This parameter specifies the number of items that may be split tendered between an eWIC tender and a customer provided tender in a transaction.

int32

ewicMaxOnline

X

Integer

This parameter specifies the maximum number of items allowed to be paid for with eWIC tender in a transaction when WIC Online EBT Card is used.

int32

ewicMaxSmart

X

Integer

This parameter specifies the maximum number of items allowed to be paid for with eWIC tender in a transaction when WIC Smart Card is used.

int32

ewicMerchantID

X

String

This parameter specifies the eWIC Merchant Identification.

straddleSubcategory

X

String

This parameter specifies the straddle subcategory identification.

cvbUomCode

X

String

This parameter specifies the cash sign for CVB. The Cash Value Benefit (CVB) provides a cash amount of benefits instead of an UOM Code.

confirmCancelEwicPayment

X

Boolean

This parameter specifies whether the confirm dialog to confirm the cancellation of the eWIC payment should be displayed or not.values: true, false

limitExceededConfirmDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

previousTenderAllowed

X

List of [String]

This parameter specifies the list of allowed tenders before eWIC payment. If there is not restriction for previous tender the value should be null.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.355. ComGkSoftwarePosApiModelConfigProcessActionPositionOperationConfig

PositionOperationConfig This configuration entity defines position related operations.

Field Name Required Type Description Format

forceQuantityInput

X

Boolean

This parameter indicates whether the quantity input for each item is forced.values: true, false

pricePositionLimit

X

Double

This parameter defines the price position limit. Default set to 100,000.00. -1 means disabled.

double

pricePositionZeroAllowed

X

Boolean

This parameter defines whether positions with zero price are allowed.

priceTransactionLimit

X

Double

This parameter defines the price transaction limit. Default set to 100,000.00. -1 means disabled. @deprecated since 5.20.0 - is not longer used.

double

priceDifferencePercentPositionLimit

X

Double

This parameter defines the price difference limit in percent.

double

priceDifferenceAbsolutePositionLimit

X

Double

This parameter defines the price difference limit as an absolute value.

double

priceDifferenceLimitExceedAction

X

String

This parameter defines the price difference limit exceed action for positive items.value: LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED]

  • Warn as 'warn',

  • Authorize as 'authorize',

  • Forbid as 'forbid',

  • Unchecked as 'unchecked'

Enum: Warn, Authorize, Forbid, Unchecked,

priceNegDifferenceLimitExceedAction

X

String

This parameter defines the price difference limit exceed action for negative items.value: LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED]

  • Warn as 'warn',

  • Authorize as 'authorize',

  • Forbid as 'forbid',

  • Unchecked as 'unchecked'

Enum: Warn, Authorize, Forbid, Unchecked,

closeCurrent

X

String

This parameter defines the close current position.value: ClosePositionAction [REQUIRED, IFPOSSIBLE, DISABLED]

  • Required as 'required',

  • IfPossible as 'ifPossible',

  • Disabled as 'disabled'

Enum: Required, IfPossible, Disabled,

closePrevious

X

String

This parameter defines the close previous position.value: ClosePositionAction [REQUIRED, IFPOSSIBLE, DISABLED]

  • Required as 'required',

  • IfPossible as 'ifPossible',

  • Disabled as 'disabled'

Enum: Required, IfPossible, Disabled,

filterResult

X

Boolean

This parameter indicates whether results can be filtered.values: true, false

allowedWithWeight

X

Boolean

This parameter indicates whether the single quantity for a weight item is allowed. It has the flag 'ALLOWED_WITH_WEIGHT'.values: true, false

allowedWithLength

X

Boolean

This parameter indicates whether the single quantity for a length item is allowed. It has the flag 'ALLOWED_WITH_LENGTH'.values: true, false

allowedWithArea

X

Boolean

This parameter indicates whether the single quantity for an area item is allowed. It has the flag 'ALLOWED_WITH_AREA'.values: true, false

allowedWithVolume

X

Boolean

This parameter indicates whether the single quantity for a volume item is allowed. It has the flag 'ALLOWED_WITH_VOLUME'.values: true, false

allowedWithMeasure

X

Boolean

This parameter indicates whether the single quantity for a measure item is allowed. It has the flag 'ALLOWED_WITH_MEASURE'.values: true, false

maximumQuantity

X

Integer

This parameter defines the maximum single quantity.

int32

minimumQuantity

Integer

This parameter defines the minimum single quantity.

int32

quantityInputOrder

X

String

This parameter indicates the input order for quantities.value: InputOrder [BEFOREORAFTER, BEFORE, AFTER]

  • BeforeOrAfter as 'beforeOrAfter',

  • Before as 'before',

  • After as 'after'

Enum: BeforeOrAfter, Before, After,

priceInputOrder

X

String

This parameter indicates the input order for prices.value: InputOrder [BEFOREORAFTER, BEFORE, AFTER]

  • BeforeOrAfter as 'beforeOrAfter',

  • Before as 'before',

  • After as 'after'

Enum: BeforeOrAfter, Before, After,

quantityLimitExceedAction

X

String

This parameter defines the quantity limit exceed action.value: LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED]

  • Warn as 'warn',

  • Authorize as 'authorize',

  • Forbid as 'forbid',

  • Unchecked as 'unchecked'

Enum: Warn, Authorize, Forbid, Unchecked,

amountLimitExceedAction

X

String

This parameter defines the amount limit exceed action.value: LimitExceedAction [WARN, AUTHORIZE, FORBID, UNCHECKED]

  • Warn as 'warn',

  • Authorize as 'authorize',

  • Forbid as 'forbid',

  • Unchecked as 'unchecked'

Enum: Warn, Authorize, Forbid, Unchecked,

weightUnitFactor

Double

This parameter defines the multiplication factor for weight quantities.

double

measureUnitFactor

Double

This parameter defines the multiplication factor for dimensions quantities.

double

priceDeviationType

X

String

This parameter defines the deviation with respect to the previously valid price in case of sales line items.value: DeviationType [ALL, EQUALORLESS, EQUALORGREATER]

  • All as 'all',

  • EqualOrLess as 'equalOrLess',

  • EqualOrGreater as 'equalOrGreater'

Enum: All, EqualOrLess, EqualOrGreater,

priceNegDeviationType

X

String

This parameter defines the deviation with respect to the previously valid price in case of return line items.value: DeviationType [ALL, EQUALORLESS, EQUALORGREATER]

  • All as 'all',

  • EqualOrLess as 'equalOrLess',

  • EqualOrGreater as 'equalOrGreater'

Enum: All, EqualOrLess, EqualOrGreater,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.356. ComGkSoftwarePosApiModelConfigProcessActionPositionRepetitionConfig

PositionRepetitionConfig This Configuration entity defines position repetition related operations.

Field Name Required Type Description Format

repeatQuantity

X

Boolean

This parameter specifies whether the quantity input of the old line item is applied to the new line item in case of repetitions.values: true, false

  • True: The quantity input (single quantity) of the old line item is applied to the new line item.

  • False: The single quantity of the new line item will be 1.

repeatManualDiscounts

X

Boolean

This parameter specifies whether manual discounts are copied to the new line item in case of repetitions.values: true, false

  • True: Manual discounts are copied to the new line item.

  • False: Manual discounts are not copied to the new line item.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.357. ComGkSoftwarePosApiModelConfigProcessActionProcessBarcodeConfig

ProcessBarcodeConfig This configuration entity defines barcode processes.

Field Name Required Type Description Format

barcodeTypes

X

List of [String]

This parameter defines a list of barcode types for the evaluation of manual barcode inputs. For inputs by scanners the barcode type is provided by the scanner itself.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.358. ComGkSoftwarePosApiModelConfigProcessActionPromotionOperationConfig

PromotionOperationConfig This configuration entity defines promotion related operations.

Field Name Required Type Description Format

triggerType

X

String

This parameter defines the trigger type for the loyalty engine. (e.g. CO)

triggerValue

X

String

This parameter defines the trigger value for the loyalty engine.

privilegeType

X

String

This parameter defines the price modification type code.value: PromotionTriggerPrivilegeType [REBATESINGLE, REBATEPERCENT, NEWPRICE, REBATEAMOUNT]

  • RebateSingle as 'RS',

  • RebatePercent as 'RP',

  • NewPrice as 'PS',

  • RebateAmount as 'AM'

Enum: RebateSingle, RebatePercent, NewPrice, RebateAmount,

privilegeValue

Double

This parameter defines the predefined discount or reduction value.

double

sequenceType

X

String

This parameter defines the sequence handling type code.value: PromotionTriggerSequenceType [FIX, MAX, SAME]

  • FIX as 'FIX',

  • MAX as 'MAX',

  • SAME as 'SAME'

Enum: FIX, MAX, SAME,

startSequence

X

Integer

This parameter defines the start sequence number of promotions with the same trigger value.

int32

maxSequence

X

Integer

This parameter defines the maximum number of promotions with the same trigger value.

int32

maxLimitWarn

Double

This parameter defines the maximum percentage deviation from the unit price of the item. A warning message is displayed, if the defined maxLimitWarn is exceeded.

double

maxLimitAuthorize

Double

This parameter defines the maximum percentage deviation from the unit price of the item. An authorization is required, if the defined maxLimitAuthorize is exceeded.

double

maxLimitForbid

Double

This parameter defines the maximum percentage deviation from the unit price of the item. An error message is required, if the defined maxLimitForbid is exceeded. The operation will be canceled.

double

priceDeviationType

X

String

This parameter defines which price deviation type is allowed.value: PriceDeviationType [ALL, EQUAL_LESS, EQUAL_GREATER]

  • ALL as 'ALL',

  • EQUAL_LESS as 'EQUAL_LESS',

  • EQUAL_GREATER as 'EQUAL_GREATER'

Enum: ALL, EQUAL_LESS, EQUAL_GREATER,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.359. ComGkSoftwarePosApiModelConfigProcessFlowsAdditionalAttributes

AdditionalAttributes This entity defines the item related additional attributes to be assigned to sale return line item extensions during item registration

Field Name Required Type Description Format

hsnRequired

X

Boolean

Indicates whether hsn code should be added to sale return line item extension. HSN (Harmonized System of Nomenclature) is an international classification system of commodities. HSN code ensures that commodities of similar nature are classified properly.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.360. ComGkSoftwarePosApiModelConfigProcessFlowsAllowedTendersConfig

AllowedTendersConfig This configuration entity defines the allowed tenders process.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

checkReasonTender

X

Boolean

This parameter enables admissibility checks based on payin/payout reasons.

checkCustomerGroupTender

X

Boolean

This parameter enables admissibility checks based on a customer group assignment.

checkNegativeTotal

X

Boolean

This parameter enables additional admissibility checks in case of a negative receipt total. @deprecated - since 5.9.2 this is not longer used. Use instead: returnTenderRule false -> RETURN_TO_ANY true -> RETURN_TO_ANY_MAPPED

returnTenderRule

X

String

Type of additional allowed tender validation to perform for returns.

Enum: RETURN_TO_ANY, RETURN_TO_ANY_MAPPED, RETURN_ITEM_TOTAL_TO_MAPPED,

useTenderFromMasterData

X

Boolean

This parameter indicates whether tenders are used from the master data or taken from an existing collection for collection creation/updates.

filterRulesChain

X

List of [String]

This parameter defines the tender filter rules chain (filters are executed in order).

overrideAdmissibilityPossible

X

Boolean

This parameter specifies whether it is possible to override the admissibility of the selected tender for a customer temporary.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.361. ComGkSoftwarePosApiModelConfigProcessFlowsAlternativeTaxConfig

AlternativeTaxConfig Configuration for alternative tax process

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

alternativeTaxInfos

X

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.362. ComGkSoftwarePosApiModelConfigProcessFlowsAlternativeTaxInfos

AlternativeTaxInfos This configuration entity defines the AlternativeTaxInfos.

Field Name Required Type Description Format

alternativeTaxMerchandiseCategories

List of [String]

List of merchandise categories for which the alternative sales tax is to be used.

alternativeTaxMerchandiseCategoryList

String

The parameter defines a list of merchandise hierarchy groups IDs separated by semicolon. The alternative tax will be applied to all line items with the merchandise hierarchy group defined in this list.If filled then the parameter alternativeTaxMerchandiseCategories will be ignored.

checkMerchandiseCategory

X

Boolean

Controls whether the merchandise category assignment is checked.True: Assignment to merchandise category defined in alternativeTaxMerchandiseCategoryList/alternativeTaxMerchandiseCategories is checked. False: Assignment to merchandise category defined in alternativeTaxMerchandiseCategoryList/alternativeTaxMerchandiseCategories is not checked.

alternativeTaxGroupId

String

Alternative tax group

alternativeTaxMode

X

Boolean

false: The original tax group is used by default for each receipt. The toggle button is disabled. true: The alternative tax group is used by default for each receipt. The toggle button is enabled.

excludedTaxGroups

List of [String]

List of tax groups for which the alternative sales tax is not applied.

3.363. ComGkSoftwarePosApiModelConfigProcessFlowsAuthorizationConfig

AuthorizationConfig This configuration entity defines authorization related topics.

Field Name Required Type Description Format

authorizationRequired

X

Boolean

This parameter indicates whether an explicit authorization is needed or not.values: true, false

requiredRight

X

String

If the parameter authorizationRequired is enabled the operator permissions are checked against this right.

authorizationMode

X

String

This parameter defines the mode of authorization.value: AuthorizationMode [SINGLE, FOUREYES]

  • Single as 'SINGLE',

  • FourEyes as 'FOUR_EYES'

Enum: Single, FourEyes,

cancellationAllowed

X

Boolean

This parameter specifies whether a cancellation is allowed. If it is set to true the authorization is allowed to be cancelled.values: true, false

passwordRequired

X

Boolean

This parameter specifies whether the password is required to pass the authorization.values: true, false

dialogType

X

String

This parameter specifies the dialog type.value: AuthorizationDialogType [MANUAL, SCAN]

  • Manual as 'INPUT_FIELD': This setting allows both, manual input and authorization by barcode/msr scanner.

  • Scan as 'SCAN_EXPECT': Only the authorization by barcode/msr scanner is allowed (no manual input is possible).

Enum: Manual, Scan,

checkSecondUserRights

Boolean

This parameter is only relevant for the four eyes authorization.values: true, false

  • true - The second user must have rights to run the process.

  • false - The authorization succeeds if any of the users has rights to start process.

loginName

String

This parameter specifies the predefined login name.

authorizingProcessNameKey

String

This parameter defines the translation key for the name of the authorizing process.

authorizingReasonText

String

Prepared reason text of the authorizing process.

authorizingReasonTextKey

String

Translation key for the reason text of the authorizing process.

authorizingReasonTextParameters

List of [String]

Placeholder parameters for the reason text of the authorizing process.

askIfAlreadyAuthorized

X

Boolean

True - Regardless of whether an authorization has already been done in the current receipt, the authorization shall be carried out.False: Is already noted a sufficient authorization, then this is used.

lineItemRelevant

X

Boolean

True - resourceId will be stored to line Item.

retailTransactionRelevant

X

Boolean

False - resourceId will be not stored in RetailTransaction.

controlTransactionRelevant

X

Boolean

False - resourceId will be not stored in ControlTransaction.

tenderControlTransactionRelevant

X

Boolean

False - resourceId will be not stored in TenderControlTransaction.

activeOperatorRequired

Boolean

True: Error if no POS Group operator is active. Null/False: No activate POS Group operator check.

operatorSelectionAction

String

This parameter defines pos group operator selection action.

Enum: ASK_ALWAYS, ASK_IF_NOT_AVAILABLE, ASK_NEVER,

scaleVersionConfig

com.gk_software.pos.api.model.config.process.flows.ScaleVersionConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.364. ComGkSoftwarePosApiModelConfigProcessFlowsConditionSplitConfig

ConditionSplitConfig The condition split config.

Field Name Required Type Description Format

manualDiscountTypes

X

List of [String]

List of condition types for price reduction

discountRoundingConfig

X

com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig

manualDiscountRoundingConfig

X

com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig

finalPriceRoundingConfig

X

com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig

pointsRoundingConfig

X

com.gk_software.pos.api.model.config.process.flows.ConditionSplitRoundingConfig

finalRoundingDifferenceCorrectionEnabled

X

Boolean

It defines if the correction of rounding differences is processed.

roundingDifferenceCorrectionPerPromotionConditionEnabled

X

Boolean

It defines if the correction of rounding differences per promotion is enabled or not.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.365. ComGkSoftwarePosApiModelConfigProcessFlowsConditionSplitRoundingConfig

ConditionSplitRoundingConfig The condition split rounding config.

Field Name Required Type Description Format

roundingMethod

X

String

It defines the rounding method for money discounts.

  • Down = Round down

  • Up = Round up

  • Commercial = Commercial roundingOne value from the list.

Enum: Commercial, Down, Up,

decimalPlacesCount

X

Integer

Number of decimal places used for rounding of money discounts Possible values: 0 - 4

int32

destinationValue

X

Integer

It defines the rounding destination value for money discounts, which are used to round the value to the proper denomination. Additional rounding information:

  • 1 = There is no further handling of the rounding result.

  • 5 = The rounding result is adjusted to correspond to the preceding or subsequent multiple of 5.One value from the list.

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.366. ComGkSoftwarePosApiModelConfigProcessFlowsCreateLayawayConfig

CreateLayawayConfig This configuration entity defines the create layaway process.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

allowedItemNrEanList

String

The parameter defines a list of item numbers/ EANs (ItemID

POSItemID

MainPOSItemID) of the items, which are allowed to be part of the Layaway. If the list is empty, the value of this parameter is not checked. The defined items are separated by semicolons ';'.

allowedMhgList

String

The parameter defines a list of merchandise hierarchy groups IDs, which are allowed to be part of the Layaway. If the list is empty, the value of this parameter is not checked. The defined merchandise hierarchy groups IDs are separated by semicolons ';'.

initialDownPayment

X

Double

The parameter defines the initial down payment amount in %.

double

initialFixAmount

X

Double

The parameter defines the initial down payment amount as a fix amount in main currency.

double

layawayValidDays

X

Integer

The parameter defines the validation time of the Layaway in days to calculate the final payment date based on the current date.Example: Date of today = 13.02.2018, layawayValidDays = 28, final payment date = 13.03.2018

int32

layawayValidDate

String

The parameter defines the validation date of the Layaway independent from the creation date of the layaway. If this parameter <> null, the value of parameter layawayValidDays is not used. Format: YYYY-MM-DD, e.g.: 2019-09-27 Example: Date of today = 01.10.2019, layawayValidDate = 31.10.2019, final payment date = 31.10.2019 Date of today = 03.10.2019, layawayValidDate = 31.10.2019, final payment date = 31.10.2019

paymentDays

X

Integer

The parameter defines every how many days a payment should be done, e.g. every 7 days or every 14 days Example: Date of today = 13.02.2018, paymentDays=7, pament dates = 20.02.2018, 27.02.2018, 06.03.2018, 13.03.2018

int32

toleranceTime

X

Integer

The parameter defines how many days the final payment rate can be paid later than expected to calculate the latest final payment date. If the tolerance time is exceeded, the Layaway is canceled and the item goes back to the Store Stock.Example: final payment date = 13.03.2018, toleranceTime = 3, latest final payment date = 16.03.2018

int32

deletingTime

X

Integer

The parameter defines after how many days, beginning from the final expiration date (LatestFinalPaymentDate), the Layaway can be deleted. If the deleting time is exceeded, no actions (also no retrieving money from expired Layaway) can be performed.Example: final expiration date = 01.03.2018, deletingTime = 200, deleting date = 17.09.2018

int32

serviceFeePercent

X

Double

The parameter defines the Service Fee in %.

double

serviceFeeAmount

X

Double

The parameter defines the Amount of the Service Fee.

double

cancellationFeePercent

X

Double

The parameter defines the Cancellation Fee in % which is calculated, if the Layaway is voided.

double

cancellationFeeAmount

X

Double

The parameter defines the Amount of the Cancellation Fee which is calculated, if the Layaway is voided.

double

penaltyFeePercent

X

Double

The parameter defines the percentage from the total layaway amount which is calculated, if the calculated payment date (defined by parameter layawayValidDays) + the tolerance time (defined by parameter toleranceTime) have expired.

double

penaltyFeeAmount

X

Double

The parameter defines the fixed amount which is calculated, if the calculated payment date (defined by parameter layawayValidDays) + the tolerance time (defined by parameter toleranceTime) have expired.

double

feeTaxGroupId

String

The parameter defines the tax group of the several fees.

customerIdentificationConfig

X

com.gk_software.pos.api.model.config.process.flows.CustomerIdentificationConfig

positionOperationConfig

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

3.367. ComGkSoftwarePosApiModelConfigProcessFlowsCustomerIdentificationConfig

CustomerIdentificationConfig This config entity defines the CustomerIdentification process.

Field Name Required Type Description Format

customerCardType

String

This parameter defines the card type which has to be used for the customer identification (set only if a restriction is neccessary).

customerIdentificationFunction

String

This parameter defines the customer identification function to use.value: CustomerIdentificationFunction [CUSTOMERREGISTRATION, CUSTOMERSEARCH, CUSTOMERDATAENTRY]

  • CustomerRegistration as 'CustomerRegistration',

  • CustomerSearch as 'CustomerSearch',

  • CustomerDataEntry as 'CustomerDataEntry'

Enum: CustomerRegistration, CustomerSearch, CustomerDataEntry,

customerRequired

X

Boolean

This parameter controls whether it is mandatory to enter a customer.values: true, false

customerRequiredAudibleAlert

Boolean

This parameter controls if a missing customer identification will be signaled by an audible alert (it will work not before audible alerts can be implemented).values: true, false

customerRequiredMessage

String

This parameter controls if a message shall be triggered if the customer is required. At the same time there is a key for hinting a message.

customerDataMissingMessage

String

If one of the required conditions is not fulfilled then the warning customer data incomplete is displayed.

retrieveCustomerId

Boolean

This parameter controls if the customer identification process shall provide a customer ID of an identified customer for the use by calling the process.values: true, false

customerRegistrationConfigId

String

This parameter defines the config for the CustomerRegistration process. It is only in use if the customerIdentificationFunction is set to CustomerRegistration.

customerSearchConfigId

String

This parameter defines the config for the CustomerSearch process. It is only in use if the customerIdentificationFunction is set to CustomerSearch.

customerDataEntryConfigId

String

This parameter defines the config for the CustomerDataEntry process. It is only in use if the customerIdentificationFunction is set to CustomerDataEntry.

firstNameRequired

Boolean

It defines if the first name of the customer is required.

lastNameRequired

Boolean

It defines if the last name of the customer is required.

streetRequired

Boolean

It defines if the street of the default home address of the customer is required.

cityRequired

Boolean

It defines if the city of the default home address of the customer is required.

postalCodeRequired

Boolean

It defines if the postal code of the default home address of the customer is required.

federalStateRequired

Boolean

It defines if the federal state of the default home address of the customer is required.

countryRequired

Boolean

It defines if the country of the default home address of the customer is required.

taxIdRequired

Boolean

It defines if the tax id of the customer is required.

customerGroupId

String

It defines the required customer group id.

customerRequirementsNotFulfilledMessage

String

Message that is shown in case a customer is already registered with required card type but further conditions are not fulfilled.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.368. ComGkSoftwarePosApiModelConfigProcessFlowsCustomerOrderData

CustomerOrderData TODO: undocumented

Field Name Required Type Description Format

customerOrderId

String

customerOrderSequenceNumber

Integer

int32

salesOrderTypeCode

String

salesOrderDeliveryTypeCode

String

requestedDeliveryDate

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.369. ComGkSoftwarePosApiModelConfigProcessFlowsEmptiesReturnConfig

EmptiesReturnConfig This configuration entity defines the empties return process.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

onlyOneEmptiesReturnLineItem

X

Boolean

It specifies whether the empties return mode will be finished automatically after one empties return line item.values: true, false

toggleEmptiesReturnModeConfig

X

String

fixEmptiesReturnItem

String

It specifies an item for empties return.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.370. ComGkSoftwarePosApiModelConfigProcessFlowsFindTransactionConfig

FindTransactionConfig This configuration entity defines the find process for transactions.

Field Name Required Type Description Format

promptReceiptDataConfig

X

com.gk_software.pos.api.model.config.process.ui.PromptReceiptDataConfig

resultType

X

String

This parameter defines the data object which the parent process needs to get retrieved (either transaction id or transaction itself).value: FindTransactionResultType [TRANSACTION, TRANSACTION_ID]

  • TRANSACTION as 'TRANSACTION': Retrieve Transaction

  • TRANSACTION_ID as 'TRANSACTION_ID': Retrieve Transaction ID

Enum: TRANSACTION, TRANSACTION_ID,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.371. ComGkSoftwarePosApiModelConfigProcessFlowsGoodsReturnConfig

GoodsReturnConfig This configuration entity defines the goods return process.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

withOutOriginalSc

X

Boolean

This parameter specifies whether a return is performed without original receipt.values: true, false

registerCustomer

X

Boolean

This parameter specifies whether a customer must be assigned to the return.values: true, false

onlyOneReturnPosition

X

Boolean

This parameter specifies whether the return mode will be finished automatically after one return line item.values: true, false

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt is created. This receipt includes only return line items.values: true, false

customerIdentificationConfig

X

com.gk_software.pos.api.model.config.process.flows.CustomerIdentificationConfig

allowedTendersConfig

X

com.gk_software.pos.api.model.config.process.flows.AllowedTendersConfig

originalBusinessUnitIdRequired

X

Boolean

It defines if the original business unit id must be entered in case of return without receipt.

originalDateRequired

X

Boolean

It defines if the original date must be entered in case of return without receipt.

originalWorkstationIdRequired

X

Boolean

It defines if the original workstation id must be entered in case of return without receipt.

originalSequenceNumberRequired

X

Boolean

It defines if the original receipt number must be entered in case of return without receipt.

originalFiscalDeviceNumberRequired

X

Boolean

It defines if the original fiscal device number must be entered in case of return without receipt.

originalFiscalSequenceNumberRequired

X

Boolean

It defines if the original fiscal sequence number must be entered in case of return without receipt.

originalFiscalDayNumberRequired

X

Boolean

It defines if the original fiscal day number must be entered in case of return without receipt.

originalInvoiceNumberRequired

X

Boolean

It defines if the original invoice number must be entered in case of return without receipt.

requiredOriginalReceiptData

Map of [String]

Map of original receipt data to save in sale return line item extensions.

returnWithTransactionConfig

com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig

customerRegistrationConfigId

String

Config id for the loyalty CustomerRegistration sub process.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.372. ComGkSoftwarePosApiModelConfigProcessFlowsItemEntryConfig

ItemEntryConfig This configuration entity defines itemEntry processes.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

fixedItemNrEan

String

This parameter defines a fixed item number/ EAN for fixed item keys.

itemNrEan

String

This parameter defines the input for the item number/ EAN.

itemTraceableUnitID

String

Input parameter for item traceable unit id (used for EPC codes scanned by RFID, for example)

registrationNumber

String

Raw barcode used for registration.

textClassIds

List of [String]

This parameter defines text class IDs.

uomCode

String

This parameter defines the unit of measure code.

checkSalesRestrictions

Boolean

This parameter specifies whether sales restrictions are verified. The default is set at true.values: true, false

checkSalesRestrictionsForReturn

Boolean

This parameter specifies whether sales restrictions are verified for return items. The default is set at false.values: true, false

checkForVariants

Boolean

This parameter specifies whether a check is made for item variants. The default is set at false.values: true, false

checkTaxGroup

Boolean

This parameter specifies whether the tax group should be validated. This means that the tax group exists in master data and fulfills the following conditions: TaxGroupRule.EffectiveDateTime <= {current timestamp} and TaxGroupRule.ExpirationDateTime >= {current timestamp}. The default is set at true.values: true, false

askForQuantity

Boolean

This parameter specifies whether a quantity is requested. The default is set at false.values: true, false

ageVerificationRequired

X

Boolean

checkSellerAgeRestrictions

Boolean

This parameter specifies whether seller age should be checked.

confirmDialogAgeVerifacation

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

positionAmount

Double

This parameter defines the line item amount.

double

itemPrice

Double

This parameter defines the unit price.

double

factor

Double

This parameter defines the packaging quantity of an item.

double

itemQuantity

Integer

The parameter defines the single quantity in case of piece items.

int32

weight

Double

The parameter defines the manual weight in case of weight items.

double

units

Double

The parameter defines the units in case of quantity with decimal places items (e.g. fuel items).

double

serialNumber

String

This parameter defines the serial number.

saleableWithoutPrice

Boolean

This parameter specifies whether an item is salable even if no price exists. The default is set at true.values: true, false

switchToItemSearch

X

Boolean

This parameter specifies whether the system switches to Item Search if no search term exists. The default is set at true.values: true, false

askForReceiptText

X

Boolean

This parameter specifies whether the receipt text of the item is requested. The default is set at false.values: true, false

mode

Integer

This parameter defines the mode. The default is set at 0.values: 0, 1, 2

  • 0 - The standard item entry is set.

  • 1 - The set component entry is set.

  • 2 - The Bulk Registration is set.

int32

callPackageSelection

Boolean

itemPackageSelectionId

String

returnManualPositionAmountForWeightItemsRequired

Boolean

This parameter specifies whether the total price entry is requested in case of return of weighing items. The value is set by Goods Return.values: true, false

returnReasonRequired

Boolean

This parameter specifies whether the reason is requested in case of returns. The value is set by Goods Return.values: true, false

returnManualPriceRequired

X

Boolean

This parameter specifies whether a manual price entry is requested in case of returns. The value is set by Goods Return.values: true, false

promptForReceiptTextConfig

X

com.gk_software.pos.api.model.config.process.ui.PromptUserDialogConfig

promptForSerialNumberConfig

X

com.gk_software.pos.api.model.config.process.ui.PromptUserDialogConfig

positionOperationConfig

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

priceDifferenceLimitExceedAuthConfig

X

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

promotionOperationConfig

X

com.gk_software.pos.api.model.config.process.action.PromotionOperationConfig

forceManualWeight

X

Boolean

quantityAccumulation

X

Boolean

It defines if the quantity of line items with the same item should be accumulated.values: true, false

itemRegistrationConfig

X

com.gk_software.pos.api.model.config.process.flows.ItemRegistrationConfig

itemIDCaseSensitive

X

Boolean

manualPriceAcousticSignalConfigId

X

String

It references the acoustic signal configuration identifier for manual price input

quantityAcousticSignalConfigId

X

String

It references the acoustic signal configuration identifier for quantity input

serialNumberAcousticSignalConfigId

X

String

It references the acoustic signal configuration identifier for serial number input

setQuantityForLineItemConfigId

X

String

It references the SetQuantityForLineItemConfig identifier for the SetQuantityForLineItem sub process call.

negativePositionProhibited

X

Boolean

customerOrderData

com.gk_software.pos.api.model.config.process.flows.CustomerOrderData

registerLineItemAddOnData

com.gk_software.pos.api.model.config.process.flows.RegisterLineItemAddonData

additionalAttributes

com.gk_software.pos.api.model.config.process.flows.AdditionalAttributes

registerFuelLineItem

com.gk_software.pos.api.model.config.process.flows.RegisterFuelLineItem

removeOpenLineItemOnError

Boolean

It defines if an open line item (without item) will be removed if item entry fails with error. It should be set to true for barcode rules with multiple actions where second action is the item entry process. Default: null/false

itemNotFoundAuthorizationConfig

X

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

remoteServiceNotAvailableAuthorizationConfig

X

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

itemProvider

String

The parameter defines the provider for the item data. Default Local.

Enum: Local, LocalAndRemote,

skipSalesRestrictionDialogs

Boolean

If true any forbidden dialogs for sales restrictions will be skipped.

skipQuantityErrorDialogs

Boolean

If true any error dialogs triggered while setting quantity for line item will be skipped.

salesRestrictionConfigID

String

It defines the specific SalesRestriction configID for ItemEntryConfig, which will be overridden into sales restriction process (empty by default).

itemNotFoundAction

String

It defines the action after confirmation of item not found error.

merchandiseCategorySaleConfigId

String

It defines the specific MerchandiseCategorySale config id for ItemEntryConfig, which will be overridden into merchandise category sale process (empty by default).

expiryDate

String

It defines the expiry date of the article. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

returnReasonGroupCode

String

It defines the returnReasonGroupCode for returns without transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.373. ComGkSoftwarePosApiModelConfigProcessFlowsItemRegistrationConfig

ItemRegistrationConfig This configuration entity defines the item registration process.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

processBarcodeConfig

X

com.gk_software.pos.api.model.config.process.action.ProcessBarcodeConfig

transactionPreviewContextConfig

X

com.gk_software.pos.api.model.config.process.ui.TransactionPreviewContextConfig

transactionPreviewContextConfigs

Map of ComGkSoftwarePosApiModelConfigProcessUiTransactionPreviewContextConfig

This contains a map of potential TransactionPreviewContextConfigs for specific context id’s, with context id’s being used as map key.

transactionPreviewShowMessage

X

com.gk_software.pos.api.model.config.process.ui.TransactionPreviewContextConfig

subtotalPositionOperationConfig

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

promptReceiptDataConfig

X

com.gk_software.pos.api.model.config.process.ui.PromptReceiptDataConfig

payTowerErrorDialog

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

goodsReturnConfig

X

com.gk_software.pos.api.model.config.process.flows.GoodsReturnConfig

emptiesReturnConfig

X

com.gk_software.pos.api.model.config.process.flows.EmptiesReturnConfig

alternativeTaxConfig

X

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxConfig

defaultTareConfig

X

com.gk_software.pos.api.model.config.process.flows.SetDefaultTareConfig

toggleTareFixConfig

X

com.gk_software.pos.api.model.config.process.flows.ToggleTareFixConfig

permanentCustomerInformationConfig

com.gk_software.pos.api.model.config.process.flows.PermanentCustomerInformationConfig

createLayawayConfig

X

com.gk_software.pos.api.model.config.process.flows.CreateLayawayConfig

rescanConfig

X

com.gk_software.pos.api.model.config.process.flows.RescanConfig

manualLineItemDiscountConfig

X

com.gk_software.pos.api.model.config.process.flows.ManualLineItemDiscountConfig

discountInfoEnabled

X

Boolean

It defines if the discount info should be displayed in transaction preview.

itemInfoEnabled

X

Boolean

It defines if the item info should be displayed in transaction preview.

itemImageEnabled

X

Boolean

It defines if the item image should be displayed in transaction preview.

iconSalesInfoTextTypeCodes

List of [String]

It defines a list of text type codes that should be displayed as icon sales info.

textSalesInfoTextTypeCodes

List of [String]

It defines a list of text type codes that should be displayed as text sales info.

salesInfoTextLimit

Integer

int32

terminalDisplayLinesConfigId

String

removeCustomerConfigId

String

This configuration entity defines remove customer process.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.374. ComGkSoftwarePosApiModelConfigProcessFlowsManualLineItemDiscountConfig

ManualLineItemDiscountConfig This configuration entity defines applying promotions (rebates) processes.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

positionOperationConfig

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

promotionOperationConfig

X

com.gk_software.pos.api.model.config.process.action.PromotionOperationConfig

promptUserConfig

X

com.gk_software.pos.api.model.config.process.ui.PromptUserDialogConfig

itemRequired

X

Boolean

This parameter indicates whether an line item is required.values: true, false

reasonRequired

X

Boolean

This parameter indicates whether a reason for price changes is required.values: true, false

reasonCode

String

This parameter specifies a predefined reason code.

reasonGroupCode

X

String

This parameter filters reasons with the following reason group code.

inputOrder

X

String

This parameter specifies whether a promotion value must be known before/after a process starts.value: InputOrderType [BEFORE, AFTER, BEFORE_OR_AFTER]

  • BEFORE as 'BEFORE',

  • AFTER as 'AFTER',

  • BEFORE_OR_AFTER as 'BEFORE_OR_AFTER'

Enum: BEFORE, AFTER, BEFORE_OR_AFTER,

maxQuantity

Double

This parameter defines the maximal line item quantity when a promotion trigger is allowed.

double

limitExceededAuthorizationConfig

X

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

limitExceededWarnMessageDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

limitExceededForbidMessageDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

discountNotPossibleMessageDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

lineItemNotRebatableDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

higherPriceForbidMessageDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

lowerPriceForbidMessageDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

zeroPriceForbidMessageDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

priceChangeForbidMessageDialogConfig

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

validationMode

X

Boolean

This parameter defines the process usage in the validation mode which validates already created triggers.values: true, false

referenceValue

String

This parameter defines a reference as an additional information.

checkIfRebateWasApplied

X

Boolean

This parameter specifies whether a condition which relates to a trigger will be checked.values: true, false

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.375. ComGkSoftwarePosApiModelConfigProcessFlowsMerchandiseHierarchyGroupPrinterAssignmentConfig

MerchandiseHierarchyGroupPrinterAssignmentConfig The configuration entity defines the MHG to printer assignment.

Field Name Required Type Description Format

merchandiseHierarchyGroupIdSet

String

The parameter defines a list of merchandise hierarchy groups IDs separated by semicolon. All line items of the order with the merchandise hierarchy group defined in this list, are printed on the printer which has a reference to this parameter.

merchandiseHierarchyGroupIdQualifier

String

The parameter defines the qualifier of the merchandise hierarchy group.

reportId

String

The parameter defined the report ID which should be used for the printout.

externalMerchandiseHierarchyGroupId

String

The parameter defines an external merchandise hierarchy group ID list as integer, which is used on the KDS system to display the ordered items on the corresponding screens (e.g. food items on kitchen display, drinks on the bar display).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.376. ComGkSoftwarePosApiModelConfigProcessFlowsPermanentCustomerInformationConfig

PermanentCustomerInformationConfig This configuration entity defines the permanent customer information panel.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

displayCustomerNumber

X

Boolean

This parameter specifies whether the customer number is displayed permanently in the Permanent Customer Information Panel.values: true, false

displayCustomerName

X

Boolean

This parameter specifies whether the customer name is displayed permanently in the Permanent Customer Information Panel.values: true, false

displayBuyerNumber

X

Boolean

This parameter specifies whether the buyer number is displayed permanently in the Permanent Customer Information Panel.values: true, false

displayBuyerName

X

Boolean

This parameter specifies whether the buyer name is displayed permanently in the Permanent Customer Information Panel.values: true, false

displayAllowedTenderGroup

X

Boolean

This parameter specifies whether the allowed tender group is displayed permanently in the Permanent Customer Information Panel. The allowed tender group is the CustomerTenderGroup.CustomerTenderGroupDescription of the Customer.AllowedTermsOfPayment.values: true, false

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.377. ComGkSoftwarePosApiModelConfigProcessFlowsPrintOrderConfig

PrintOrderConfig This configuration entity defines the print order process.

Field Name Required Type Description Format

merchandiseHierarchyGroupPrinterAssignmentConfigs

X

List of ComGkSoftwarePosApiModelConfigProcessFlowsMerchandiseHierarchyGroupPrinterAssignmentConfig

It defines a set of printing rules.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.378. ComGkSoftwarePosApiModelConfigProcessFlowsRegisterFuelLineItem

RegisterFuelLineItem This entity defines fuel data from app enablement to be assigned to fuel sale return line item during item registration

Field Name Required Type Description Format

fuelingPointId

String

Defines the Fueling Point Id (pump) where the transaction started

gradeId

String

Defines grade Id of the fuel product

stackPosition

Integer

Defines internal transaction number for the fuel services

int32

fuelSaleStatusCode

String

This parameter defines fuel sale status code (transaction type).

presetAmount

Double

Defines the preset amount in case of prepay transactions

double

fuelPrepayItem

String

Defines the pos item id for the generic prepay item

fuelPrepayItemUOMCode

String

Defines the pos item UOM code for the generic prepay item

actualAmount

Double

Defines the actual amount for the fuel line item.

double

fuelDiscount

Double

Defines the discount for the fuel line item.

double

3.379. ComGkSoftwarePosApiModelConfigProcessFlowsRegisterLineItemAddonData

RegisterLineItemAddonData TODO: undocumented

Field Name Required Type Description Format

language

String

isoCurrencyCode

String

actualUnitPrice

Double

double

itemType

String

retailPriceModifierList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionExternalRetailPriceModifier

lineItemExtensionList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionLineItemExtension

printAdditionalLineItemTextLineList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionPrintAdditionalLineItemTextLine

3.380. ComGkSoftwarePosApiModelConfigProcessFlowsRescanConfig

RescanConfig The configuration entity defines global configurations of the rescan processes.

Field Name Required Type Description Format

rescanEnabled

X

Boolean

Specifies whether the rescan feature is enabled or not.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.381. ComGkSoftwarePosApiModelConfigProcessFlowsReturnWithTransactionConfig

ReturnWithTransactionConfig This configuration entity defines the return process with an available transaction.

Field Name Required Type Description Format

returnTransaction

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

returnLineItem

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

promptUserConfig

X

com.gk_software.pos.api.model.config.process.ui.PromptUserDialogConfig

transactionPreview

X

com.gk_software.pos.api.model.config.process.ui.TransactionPreviewContextConfig

returnReasonRequired

X

Boolean

This parameter specifies whether the reason is requested in case of returns.values: true, false

returnPrepaidAllowed

X

Boolean

This parameter specifies whether it is allowed to return prepaid line items in case of a return with receipt data.values: true, false

differentStoreAllowed

X

Boolean

This parameter specifies whether it is allowed to perform a return with a original receipt for receipts from other stores.values: true, false

takeOverCustomersFromOriginalSc

X

Boolean

This parameter specifies whether the customer data is transferred from the original receipt.values: true, false

returnReasonCode

String

This parameter defines the reason for the return.

returnReasonGroupCode

X

String

This parameter filters reasons with the following reason group code.

findTransactionConfig

X

com.gk_software.pos.api.model.config.process.flows.FindTransactionConfig

checkIfItemsExistInMasterData

X

Boolean

It defines if the items must exist in master data for return with transaction.

conditionSplitConfig

X

com.gk_software.pos.api.model.config.process.flows.ConditionSplitConfig

manualDiscountTypes

List of [String]

This parameter defines the list of condition types for price reduction. @deprecated as of 5.6.0. Use instead: conditionSplitConfig.manualDiscountTypes

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.382. ComGkSoftwarePosApiModelConfigProcessFlowsScaleVersionConfig

ScaleVersionConfig TODO: undocumented

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

deviceId

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.383. ComGkSoftwarePosApiModelConfigProcessFlowsSetDefaultTareConfig

SetDefaultTareConfig TODO: undocumented

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

deviceId

String

defaultTare

Integer

int32

defaultTareNotificationOnOperatorChange

X

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.384. ComGkSoftwarePosApiModelConfigProcessFlowsToggleTareFixConfig

ToggleTareFixConfig TODO: undocumented

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

mainProcess

Boolean

Defines, whether the process should be treated as a main process or a shared helper process. This is relevant for context restriction checks, e.g. during barcode processing. Defaults to true. If false the related process will not be considered as main process.

authorizationConfig

com.gk_software.pos.api.model.config.process.flows.AuthorizationConfig

operatorTokenRequired

Boolean

Defines whether the process requires an operator token (e.g. JWT) for execution.

deviceId

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.385. ComGkSoftwarePosApiModelConfigProcessUiMessageDialogConfig

MessageDialogConfig TODO: undocumented

Field Name Required Type Description Format

titleKey

X

String

This parameter defines the translation key for the title.

signalConfigId

String

This parameter defines the configuration identifier for a SignalConfig instance. The resolved configuration will be used for an acoustic signal performed in combination with the message dialog.

messageType

X

String

This parameter defines the type of the message to display.value: DialogMessageType [INFO, CONFIRMATION, WARNING, ERROR]

  • Info as 'Info',

  • Confirmation as 'Confirmation',

  • Warning as 'Warning',

  • Error as 'Error'

Enum: Info, Confirmation, Warning, Error,

messageKey

X

String

This parameter defines the translation for the message.

okButtonKey

X

String

This parameter defines the translation of the OK button.

cancelButtonKey

X

String

This parameter defines the translation of the cancel button.

isTimeControlled

Boolean

This parameter specifies whether a dialog is time-controlled.values: true, false

duration

Integer

This parameter defines the duration in msec for the time-controlled dialog.

int32

leaveAfterError

Boolean

if true the process will be left, after an error was handled, otherwise the main step will be reentered.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.386. ComGkSoftwarePosApiModelConfigProcessUiPromptReceiptDataConfig

PromptReceiptDataConfig This configuration entity defines the PromptReceiptData process.

Field Name Required Type Description Format

processId

X

String

This parameter defines the unique process ID.

dialogTitleKey

String

This parameter defines the key value for the prompt receipt data dialog title.

forceManualInput

Boolean

Force manual input. The input dialog will shown even all predefined values are filled

businessUnitIdRequired

X

Boolean

This parameter specifies whether a business unit ID will be returned and whether a business unit ID field will be visible in a dialog.values: true, false

businessUnitIdEditable

X

Boolean

This parameter specifies whether a business unit ID field is editable.values: true, false

businessUnitIdPredefined

String

This parameter specifies a predefined business unit ID.

businessUnitIdUseCurrent

X

Boolean

This parameter specifies whether a current business unit ID shall be used if no predefined business unit ID is given.values: true, false

businessDayDateRequired

X

Boolean

This parameter specifies whether a business day date will be returned and whether a business day date field will be visible in a dialog.values: true, false

businessDayDateEditable

X

Boolean

This parameter specifies whether a business day date field is editable.values: true, false

businessDayDatePredefined

String

This parameter specifies whether a predefined value is used for the business day date. Example value: 2015-01-22 Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

businessDayDateUseCurrent

X

Boolean

This parameter specifies whether a current business day date shall be used if no predefined business day date is given.values: true, false

workstationIdRequired

X

Boolean

This parameter specifies whether a workstation ID will be returned and whether a workstation ID field will be visible in a dialog.values: true, false

workstationIdEditable

X

Boolean

This parameter specifies whether a workstation ID field is editable.values: true, false

workstationIdPredefined

String

This parameter specifies whether a predefined value is used for the workstation ID.

workstationIdUseCurrent

X

Boolean

This parameter specifies whether a current workstation ID shall be used if no predefined workstation ID is given.values: true, false

receiptNumberRequired

X

Boolean

This parameter specifies whether a transaction sequence number will be returned and whether a transaction sequence number field will be visible in a dialog.values: true, false

receiptNumberEditable

X

Boolean

This parameter specifies whether a transaction sequence number field will be editable.values: true, false

receiptNumberPredefined

String

This parameter specifies whether a predefined transaction sequence number is used.

receiptNumberUseCurrent

X

Boolean

This parameter specifies whether a current transaction sequence number shall be used if no predefined transaction sequence number is given.values: true, false

useLastNonVoidedReceiptNumber

Boolean

This parameter specifies, whether only non voided retail transaction receipts should be considered?

warnDialogNoReceiptAvailable

X

com.gk_software.pos.api.model.config.process.ui.MessageDialogConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.387. ComGkSoftwarePosApiModelConfigProcessUiPromptUserDialogConfig

PromptUserDialogConfig This configuration entity defines the process for prompting the user.

Field Name Required Type Description Format

titleKey

X

String

This parameter defines the translation key for the title.

signalConfigId

String

This parameter defines the configuration identifier for a SignalConfig instance. The resolved configuration will be used for an acoustic signal performed in combination with the message dialog.

inputDomain

X

String

This parameter defines the input domain for the input field.

inputMandatory

X

Boolean

This parameter specifies whether an input is mandatory.values: true, false

cancelAllowed

X

Boolean

This parameter specifies whether the cancellation of the dialog is allowed.values: true, false

labelTextKey

String

This parameter defines an optional translation key for the label text.

maxLengthOfTitleToSplit

Integer

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.388. ComGkSoftwarePosApiModelConfigProcessUiTransactionPreviewContextConfig

TransactionPreviewContextConfig This configuration entity defines the transaction preview. The config parameters will be passed to the transaction preview component, controller, report and datasource.

Field Name Required Type Description Format

templateName

X

String

Name of the report template.

languageScope

String

The language scope for the transaction preview report translations. Leave empty (null) to set the Transaction scope (with the system default locale) as default.

Enum: Operator, Customer, Transaction, MasterData,

horizontalPositioningType

X

String

Enum: Char, Pixel,

verticalLinePadding

Integer

int32

verticalLineSpacing

Integer

int32

considerScopeTransactions

X

Boolean

showHeader

X

Boolean

This parameter specifies whether the header should be displayed or not.values: true, false

showTotals

X

List of [String]

This parameter specifies whether the total should be displayed or not.

rowSelectionAllowed

X

Boolean

This parameter specifies whether a row selection is allowed in general.values: true, false

cellEditAllowed

X

Boolean

This parameter specifies whether inline cell editing is allowed in general.values: true, false

showReturnableQuantity

X

Boolean

Not supported. @deprecated - never implemented in any release. This parameter specifies whether the returnable quantity for a line item should be displayed or not.values: true, false

showLastChangedRow

X

Boolean

This parameter specifies whether the last changed row should be made visible.values: true, false

selectLastChangedRow

X

Boolean

editLastChangedRow

X

Boolean

This parameter specifies whether the last changed row should be edited.values: true, false

clearSelectionsForLastChangedRow

X

Boolean

advancedSelectionMode

X

Boolean

showVoidedLineItems

X

Boolean

showSubtotalRounding

X

Boolean

This parameter specifies whether the sub total rounding should be displayed or not.values: true, false

showChangeRounding

X

Boolean

This parameter specifies whether the change rounding should be displayed or not.values: true, false

showInlinePanel

X

Boolean

showLineItems

X

List of [String]

This parameter specifies whether the line items for the given type codes should be displayed or not.

selectableLineItems

List of [String]

This parameter specifies whether line items for the given type codes are selectable or not.

selectableSaleReturnLineItems

List of [String]

This parameter specifies whether sale return line items for the given type codes are selectable or not. Has no effect if selectableLineItems does not include sale return line items.

saleReturnLineItemReturnTypes

List of [String]

editableLineItems

List of [String]

This parameter specifies whether line items for the given type codes are inline editable (cell editors) or not.

showFooter

Boolean

Set whether the footer should be displayed or not. Default value is false.values: true, false

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.389. ComGkSoftwarePosApiModelDomAppAmountAmount

Amount A data object which encapsulates a monetary amount value for a certain currency.

Field Name Required Type Description Format

amount

Double

The monetary amount value.

double

currency

com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO

3.390. ComGkSoftwarePosApiModelDomAppGiftCertificateServiceAttributeValue

AttributeValue An additional attribute for gift certificates with a name and a value.

Field Name Required Type Description Format

name

String

Attribute name.

value

String

Attribute value

3.391. ComGkSoftwarePosApiModelDomAppGiftCertificateServiceGiftCertInfo

GiftCertInfo Contains gift certificate attributes returned by the stored value server.

Field Name Required Type Description Format

gcId

Integer

Gift certificate id.

int32

gcNumber

String

Gift certificate number.

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

state

String

Gift certificate status: SELLABLE, REDEEMABLE, LOCKED, INVALID.

validFrom

String

Start of gift certificate validity period. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

validTo

String

End of gift certificate validity period Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

uuid

String

An unique transaction ID for the requested operation.

overpaymentType

String

Defines the handling of over payments (NOT_ACCEPTED, NO_CHANGE, GIFT_CERTIFICATE_CHANGE, CASH_CHANGE).

blacklistedItems

List of [String]

Items that are not included when comparing the receipt total with the minimum transaction amount (MinSale).

blacklistedArticleGroupNumbers

List of [String]

Merchandise categories that are not included when comparing the receipt total with the minimum transaction amount (MinSale).

includeDiscountedArticlesToMinimumSale

Boolean

Defines if discounted items will be included into minimum sale check.

minimumTransactionAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

additionalInfo

List of ComGkSoftwarePosApiModelDomAppGiftCertificateServiceAttributeValue

Additional attributes for gift certificates sent by stored value server.

track2

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.392. ComGkSoftwarePosApiModelDomAppGiftCertificateServiceGiftCertServiceResult

GiftCertServiceResult A data object which is returned as a result of gift certificate operations.

Field Name Required Type Description Format

gcNumber

String

Gift certificate number.

oldAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

newAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

validFrom

String

Start of gift certificate validity period. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

validTo

String

End of gift certificate validity period Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

additionalInfo

List of ComGkSoftwarePosApiModelDomAppGiftCertificateServiceAttributeValue

List of additional attributes of the gift certificate.

uuid

String

An unique transaction ID for the requested operation.

track2

String

Gift certificate track2 data.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.393. ComGkSoftwarePosApiModelDomAppItemInformationItemInformation

ItemInformation Object to consolidate item information (e.g. master data, stock details, etc.).

Field Name Required Type Description Format

businessUnitGroupID

String

The business unit group ID

itemID

String

The item ID

uomCode

String

The unit of measure code

uomName

String

The unit of measure name

name

String

Name of the item

brand

String

Brand of the item

mainPOSItemId

String

The main pos item id

merchandiseHierarchyGroupName

String

Name of assigned merchandise hierarchy group.

validPriceAmount

Double

Amount of the actual price.

double

regularPriceAmount

Double

Amount of the regular price.

double

validPriceExpiryDate

String

Expiration (end) time stamp of the actual price. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

deposit

Double

Amount of the deposit

double

color

String

Specifies the color of the item. Item characteristics entry with id COLOR is used to fill this value.

size

String

Specifies the size, e.g. in case of fashion the dress size. Item characteristics entry with id SIZE is used to fill this value.

taxGroupID

String

Code of related tax group.

imageSrcIds

String

Item image url.

authorisedForSale

Boolean

A flag to indicate that the retail store is authorized to stock this particular item.

internalStock

com.gk_software.pos.api.model.dom.app.ItemInformation.StockAmountDetail

externalStocks

List of ComGkSoftwarePosApiModelDomAppItemInformationStockAmountDetail

List of stock details from surrounding stores.

itemView

com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformationView

uomItemTextList

List of ComGkSoftwarePosApiModelDomAppItemInformationUomItemText

It contains extended item information. The content is a filtered view on uom item text list. Filtering is done by text class ids defined in configuration.

prices

List of ComGkSoftwarePosApiModelDomAppItemInformationPrice

List of aviable price entries.

itemInfoIcons

List of ComGkSoftwarePosApiModelDomAppItemInformationUomItemText

It contains details about item info icons. The content is a filtered view on uom item text list. Filtering is done by text class ids defined in configuration.

discountInfoIcons

List of ComGkSoftwarePosFlowLibsTransactionDiscountIconList

It contains details about available promotions - e.g. Pay 2 get 3, 10% off…​

variantsAvailable

Boolean

It contains info about variants available for this item

variantItems

List of ComGkSoftwarePosApiModelDomAppItemInformationItemVariantView

webshopItemInfoData

com.gk_software.pos.api.model.dom.app.ItemInformation.WebshopItemInfoData

ePriceTypeCode

String

Type code of the actual price (00 = default price, 01 = special price)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.394. ComGkSoftwarePosApiModelDomAppItemInformationItemInformationView

ItemInformationView TODO: undocumented

Field Name Required Type Description Format

validPriceAmount

String

Amount of the actual price.

regularPriceAmount

String

Amount of the regular price.

deposit

String

Amount of the deposit

freeStock

String

Number of available items

reservedStock

String

Number of reserved items.

transferStock

String

Number of items with stock state TRANSFER

inTransitStock

String

Number of items with stock state IN-TRANSIT.

validPriceExpiryDate

String

Expiration (end) time stamp of the actual price.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.395. ComGkSoftwarePosApiModelDomAppItemInformationItemVariantCharacteristicView

ItemVariantCharacteristicView Object to consolidate item variant characteristic.

Field Name Required Type Description Format

id

String

The id of this item variant characteristic.

name

String

The name of this item variant characteristic.

description

String

The description of this item variant characteristic.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.396. ComGkSoftwarePosApiModelDomAppItemInformationItemVariantView

ItemVariantView Object to consolidate item variant.

Field Name Required Type Description Format

itemId

String

The item id.

mainPosItemId

String

The main pos item id.

size

com.gk_software.pos.api.model.dom.app.ItemInformation.ItemVariantCharacteristicView

color

com.gk_software.pos.api.model.dom.app.ItemInformation.ItemVariantCharacteristicView

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.397. ComGkSoftwarePosApiModelDomAppItemInformationPrice

Price List of prices / price modifications. It contains entries for regular and actual price plus entries for each price modifier.

Field Name Required Type Description Format

sequenceNumber

Integer

The price entry sequence number. It defines the order (ascending)

int32

description

String

The description of the price.

unitPrice

Double

The price for the unit.

double

discountAmount

Double

In case of price modification this contains the discount amount.

double

newPrice

Double

It contains the price after price modification or in case of regular/actual price the amount.

double

priceQuantity

Integer

The price quantity (the number of items the price is defined for, i.e. 3 for $1.00).

int32

quantity

Integer

The item quantity which was used to calculate some value for this price entity.

int32

unitPriceWithCurrency

String

The unit price with currency attached. Price.PriceQuantity '/' Price.UnitPrice, if Price.PriceQuantity <> 1 Price.UnitPrice otherwise

discountWithCurrency

String

The discount amount with currency attached. As existing field is a double type, this one was added to accommodate currency.

newPriceWithCurrency

String

The new price amount with currency attached. As existing field is a double type, this one was added to accommodate currency.

priceGroupId

String

The price group id if exists.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.398. ComGkSoftwarePosApiModelDomAppItemInformationStockAmountDetail

StockAmountDetail Entity which contains stock details for one location.

Field Name Required Type Description Format

itemID

String

The item id

uomCode

String

The unit of mesaure code.

mainPOSItemId

String

The main pos item ID.

storeId

String

The business unit id.

storeDescription

String

Store description

address

String

Store address

phoneNumber

String

Store phone number

distance

Double

Distance between that and the local store.

double

name

String

Name of the item

stock

Double

Number of item with stock state DEFAULT.

double

inTransitStock

Double

Number of items with stock state IN-TRANSIT.

double

reservedStock

Double

Number of reserved items.

double

transferStock

Double

Number of items with stock state TRANSFER

double

freeStock

Double

Number of items with stock state FREE

double

inFlow

Double

Sum of items in TRANSFER and IN-TRANSIT state.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.399. ComGkSoftwarePosApiModelDomAppItemInformationUomItemText

UomItemText Object representing an instance of an UOM item text element.

Field Name Required Type Description Format

index

Integer

The index of the entry.

int32

text

String

The value.

3.400. ComGkSoftwarePosApiModelDomAppItemInformationWebshopItemInfoData

WebshopItemInfoData Item informations from web shop. @deprecated - as of 5.23.3. Related (Hybris) implementation was deleted, because it was never finished and released.

Field Name Required Type Description Format

description

String

The description of the item.

name

String

The item name.

averageRating

Double

The average rating.

double

imageUrl

String

The image url

stock

String

Number of item with stock state.

code

String

The uom code

manufacturer

String

The manufacturer.

price

String

The item price

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.401. ComGkSoftwarePosApiModelDomAppPromotionInputRequestPromotionInputRequest

PromotionInputRequest A data object for request from promotion service to set additional input

Field Name Required Type Description Format

promotionDescription

String

The promotion description.

triggerValue

String

The promotion trigger value.

thresholdValue

Double

The promotion threshold value.

double

intervalValue

Double

The promotion interval value.

double

limitValue

Double

The promotion limit value.

double

privilegeType

String

The promotion privilege type.

pointsFlag

Boolean

A flag to indicate promotion points.

lineItemSequenceNumber

Integer

The line item sequence number.

int32

privilegeValue

Double

The promotion privilege value.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.402. ComGkSoftwarePosApiModelDomAppServicesTransactionExternalRetailPriceModifier

ExternalRetailPriceModifier External retail price modifier object.

Field Name Required Type Description Format

retailPriceModifierSequenceNumber

Integer

Retail price modifier line item sequence number.

int32

percent

Double

The percentage value in case of percentage price modifiers.

double

amount

Double

The monetary value of the price modification that was given.

double

extendedAmountBeforeModification

Double

The retail sale total price of the transaction before applying the current price modification line item.

double

extendedAmountAfterModification

Double

The retail sale total price of the line item after applying the current price modifier.

double

appliedQuantity

Double

The quantity the price modifier applies to.

double

triggerSequenceNumber

Integer

The identification of the manual trigger (because one line item can have more than one trigger).

int32

extraAmount

Double

A monetary amount which results from applying a price modifier but does not affect the line item total.

double

roundingAmount

Double

The monetary amount that the price modifier was adjusted by.

double

calculationBaseAmount

Double

The amount which was used as base for calculation of the price modification.

double

retailTransactionPriceDerivationRule

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionPriceDerivationRule

saleReturnLineItemPromotionTriggerList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionSaleReturnLineItemPromotionTrigger

List of sale return line item promotion triggers.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.403. ComGkSoftwarePosApiModelDomAppServicesTransactionLineItemExtension

LineItemExtension Line item extension entity. Line item extensions is used for providing additional information in retail transaction line items.

Field Name Required Type Description Format

ExtensionKey

X

String

Key identifier for line item extension.

ExtensionValue

X

String

Value containing additional information for line item.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.404. ComGkSoftwarePosApiModelDomAppServicesTransactionPosUOMItemDoKey

PosUOMItemDoKey Key identifier for POS item unit of measure object.

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

itemID

X

String

Item identifier.

uomCode

X

String

The code used to specify the unit of measure in which a value is being expressed, or manner in which a measurement has been taken.

3.405. ComGkSoftwarePosApiModelDomAppServicesTransactionPrintAdditionalLineItemTextLine

PrintAdditionalLineItemTextLine Request object for printing additional text lines on receipts. This request object is used for instance in the processing of additional printout documents requested through app enablement feature.

Field Name Required Type Description Format

text

String

Text value to be printed.

sortOrder

String

Defines whether the text is printed before or after the line item. Possible values: 'afterLineItem', 'beforeLineItem' and 'beforeSubtotalLine'.

styleID

String

Style identifier for a text printout. Possible values: 'NormalPlain' and 'NormalBold'

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.406. ComGkSoftwarePosApiModelDomAppServicesTransactionRetailTransactionLineItemKey

RetailTransactionLineItemKey Key identifier for retail transaction line items.

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction.

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of this RetailTransaction.

int32

3.407. ComGkSoftwarePosApiModelDomAppServicesTransactionRetailTransactionPriceDerivationRule

RetailTransactionPriceDerivationRule Retail transaction price derivation rule describes a promotion rule.

Field Name Required Type Description Format

promotionID

X

String

The unique identifier of the promotion.

priceDerivationRuleID

String

The unique identifier of the price derivation rule.

priceDerivationRuleEligibilityID

String

The unique identifier of the root eligibility.

promotionDescription

String

Short description of the promotion.

receiptPrinterName

String

Text to be printed on the receipt.

promotionPriceDerivationRuleSequence

String

Promotion price derivation rule Sequence used for collision handling (multiple possible promotions applied to same transaction/line item). Used in combination with promotionPriceDerivationRuleResolution.

promotionPriceDerivationRuleResolution

String

Promotion price derivation resolution used for collision handling (multiple possible promotions applied to same transaction/line item). Used in combination with promotionPriceDerivationRuleSequence.

promotionPriceDerivationRuleTypeCode

String

The type code of the promotion price derivation rule.

priceModificationMethodCode

String

A code denoting the method of modifying the price that is being applied to the transaction line item.

priceDerivationRuleDescription

String

Business description for this price derivation rule.

promotionOriginatorTypeCode

String

The type code of the originator of the promotion.

externalPromotionID

String

The external identifier of the promotion.

externalPriceDerivationRuleID

String

The external identifier of the price derivation rule.

triggerQuantity

Double

The quantity of items fulfilling the eligibility which is required in order to trigger the price derivation rule.

double

giftCertificateExpirationDate

String

End of the date range in which the gift certificate is valid. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

discountMethodCode

String

Determines how the discount influences the transaction.

prohibitPrintFlag

X

Boolean

Determines whether the result of the applied price derivation rule is to be suppressed on displays / not printed on the receipt; e.g. line item-related default points are not printed after each position, but only summarized at the end of the receipt.

tenderTypeCode

String

A code which uniquely identifies the tender in case of rebate as tender.

promotionTypeName

String

Promotion type name

calculationBase

String

noEffectOnSubsequentPriceDerivationRulesFlag

X

Boolean

Determines whether applying this price derivation rule influences the calculation base of subsequent price derivation rules (false) or not (true).

prohibitTransactionRelatedPriceDerivationRulesFlag

X

Boolean

Determines whether applying this price derivation rule influences the calculation base of subsequent transaction-related price derivation rules (false) or not (true); is relevant for line item-related 'money' price derivation rules only.

couponPrintoutID

String

The number of the printout coupon.

couponPrintoutRule

String

The type code of the printout rule.

couponPrintoutText

String

The formatted text of the printout coupon.

exclusiveFlag

X

Boolean

Determines whether this price derivation rule is an exclusive one.

concurrenceControlVector

String

Determines how this price derivation rule works in relation to other applicable price derivation rules.

appliedCount

Double

Describes how often the current price derivation rule was applied.

double

printoutValidityPeriod

X

Double

Describes how long (how many days) the printed coupon/gift certificate is valid.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.408. ComGkSoftwarePosApiModelDomAppServicesTransactionSaleReturnLineItemPromotionTrigger

SaleReturnLineItemPromotionTrigger Promotion trigger for a sale return line item.

Field Name Required Type Description Format

triggerSequenceNumber

X

Integer

The identification of the manual trigger (because one line item can have more than one trigger).

int32

TriggerType

X

String

The type of the trigger (referencing to POS configuration).

TriggerValue

X

String

The value of the trigger (referencing to POS configuration).

PrivilegeType

X

String

Defines the method for price modification.

PrivilegeValue

X

Double

Reduction amount, reduction percent or new price amount.

double

ReasonCode

String

Reason code for the manual discount.

ReasonDescription

String

A narrative description describing the manual discount reason.

TriggerSequenceAddend

String

A value which is to be added to the sequence of the condition (which comes from the master data).

3.409. ComGkSoftwarePosApiModelDomAppServicesTransactionSaleReturnTaxLineItemKey

SaleReturnTaxLineItemKey Key identifier for sale return tax line items.

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction.

retailTransactionLineItemSequenceNumber

X

Integer

The sequence number of line item within the context of a retail transaction.

int32

taxSequenceNumber

X

Integer

Line item sequence number of the tax entry.

int32

3.410. ComGkSoftwarePosApiModelDomAppServicesTransactionTenderAuthorizationKey

TenderAuthorizationKey Key identifier for tender authorization.

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction.

tenderAuthorizationSequenceNumber

X

Integer

A unique sequence number for this TenderAuthorization. Note: A particular TenderLineItem may have more than one TenderAuthorization attempt.

int32

3.411. ComGkSoftwarePosApiModelDomAppServicesTransactionTillDoKey

TillDoKey Key identifier for tills.

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

tillID

X

String

The unique identifier of a till.

3.412. ComGkSoftwarePosApiModelDomAppServicesTransactionTransactionAdditionalPrintoutKey

TransactionAdditionalPrintoutKey Key identifier for transaction additional printouts.

Field Name Required Type Description Format

businessUnitGroupID

X

String

A unique system assigned identifier for a group of BusinessUnits.

transactionID

X

String

A universally unique identifier (UUID) for the Transaction.

printoutSequenceNumber

X

Integer

Line item sequence number corresponding to the additional printout.

int32

3.413. ComGkSoftwarePosApiModelDomAppTenderTenderRegistration

TenderRegistration TODO: undocumented

Field Name Required Type Description Format

baseCurrencyNotesAmount

X

com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount

baseCurrencyCoinsAmount

X

com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount

baseCurrencyRollsAmount

X

com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount

baseCurrencyCashAmount

X

com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount

foreignCurrenciesCashAmount

X

com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount

otherTendersAmount

X

com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount

totalAmount

X

com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationFormattedAmount

defaultCurrencyAmount

X

com.gk_software.pos.api.model.dom.app.tender.TenderRegistrationDefaultCurrencyTenderAmount

foreignCurrencyAmounts

X

List of ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationTenderAmount

otherTenders

X

List of ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationTenderAmount

tenderAmounts

X

List of ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationTenderAmount

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.414. ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationCashTender

TenderRegistrationCashTender TODO: undocumented

Field Name Required Type Description Format

quantity

X

Integer

int32

denominationPieceValue

X

Double

double

denominationDescription

X

String

amount

X

Double

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.415. ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationDefaultCurrencyTenderAmount

TenderRegistrationDefaultCurrencyTenderAmount TODO: undocumented

Field Name Required Type Description Format

tender

X

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

tenderDescription

X

String

amount

X

Double

double

currencySymbol

X

String

foreignCurrencyAmount

X

Double

double

foreignCurrencyCode

X

String

foreignCurrencySymbol

X

String

formattedValue

X

String

notes

X

List of ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationCashTender

coins

X

List of ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationCashTender

rolls

X

List of ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationRoll

amounts

X

List of ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationTenderAmount

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.416. ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationFormattedAmount

TenderRegistrationFormattedAmount TODO: undocumented

Field Name Required Type Description Format

value

X

Double

double

formattedValue

X

String

currencyCode

X

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.417. ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationRoll

TenderRegistrationRoll TODO: undocumented

Field Name Required Type Description Format

quantity

X

Integer

int32

denominationPieceValue

X

Double

double

denominationDescription

X

String

amount

X

Double

double

rollCapacity

X

Integer

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.418. ComGkSoftwarePosApiModelDomAppTenderTenderRegistrationTenderAmount

TenderRegistrationTenderAmount TODO: undocumented

Field Name Required Type Description Format

tender

X

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

tenderDescription

X

String

amount

X

Double

double

currencySymbol

X

String

foreignCurrencyAmount

X

Double

double

foreignCurrencyCode

X

String

foreignCurrencySymbol

X

String

formattedValue

X

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.419. ComGkSoftwarePosApiModelDomAppViewsCustomerInfoTransactionData

CustomerInfoTransactionData TODO: undocumented

Field Name Required Type Description Format

timeStamp

String

transactionDate

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

transactionTime

String

lineItems

String

value

Double

double

storeId

String

city

String

id

String

suspended

Boolean

suspendNumber

String

totalAmount

Double

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.420. ComGkSoftwarePosApiModelDomAppViewsTransactionSearchView

TransactionSearchView Transaction search view entity.

Field Name Required Type Description Format

businessUnitGroupID

String

transactionID

String

operatorID

String

workstationID

String

businessUnitID

String

businessUnitAddress

String

sequenceNumber

Integer

int32

beginDateTimestamp

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

endDateTimestamp

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

transactionTimestamp

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

suspendedFlag

Boolean

suspendNumber

String

totalAmount

Double

double

totalLineItemCount

Integer

int32

canceledFlag

Boolean

workerID

String

workerFirstName

String

workerLastName

String

workerFullName

String

transactionTypeCode

String

transactionFactCriteriaTransactionTypeCode

String

tillID

String

The unique identifier of the till.

customerID

String

The unique system assigned identifier for the Customer(Buyer).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.421. ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitDOListByFilterResult

BusinessUnitDOListByFilterResult BusinessUnitDOListByFilterResult

Field Name Required Type Description Format

businessUnitDOs

List of ComGkSoftwareGkrApiServerMdBusinessUnitDtoDomBusinessUnitDO

businessUnitDOs

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.422. ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitListByFilterRequest

BusinessUnitListByFilterRequest BusinessUnitListByFilterRequest

Field Name Required Type Description Format

businessUnitContactFilter

com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitContactFilter

maxResultsCount

Integer

maxResultsCount

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.423. ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitView

BusinessUnitView BusinessUnitView

Field Name Required Type Description Format

businessUnitID

String

businessUnitGroupID

String

businessUnitGroupID.

name

String

name.

territoryName

String

territoryName.

city

String

city.

postalCode

String

postalCode

street

String

street

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.424. ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitViewListByFilterResult

BusinessUnitViewListByFilterResult BusinessUnitDOListByFilterResult

Field Name Required Type Description Format

businessUnitViews

List of ComGkSoftwarePosApiModelDomMdBusinessUnitBusinessUnitView

businessUnitViews

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.425. ComGkSoftwarePosApiServiceClientHardwareScaleWeightResult

WeightResult TODO: undocumented

Field Name Required Type Description Format

posItemId

String

weight

Double

double

totalPrice

Double

double

tare

Double

double

weightType

Integer

int32

dataHash

String

pricingCapableScale

X

Boolean

printoutDone

X

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.426. ComGkSoftwarePosApiServiceCommunicationWsBilldocBillDocRequest

BillDocRequest Request object for the BillDocWebService

Field Name Required Type Description Format

invoiceNumber

String

The invoice number

retailStoreId

String

The retailStore id

workStationId

String

The workStation id

trainingMode

Boolean

Indicates whether service is called on training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.427. ComGkSoftwarePosApiServiceCommunicationWsBilldocBillDocResponse

BillDocResponse Response object for the BillDocWebService

Field Name Required Type Description Format

returnCode

String

The return code

billType

String

The bill type

netValue

X

Double

The net value

double

taxAmount

X

Double

The tax amount

double

amountOpenNow

X

Double

The open amount

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.428. ComGkSoftwarePosApiServiceCommunicationWsCustomerByIdCustomerPhoneNumber

CustomerPhoneNumber Bean class for Customer By Id WebService results interface.

Field Name Required Type Description Format

areaID

String

The area id

subscriberID

String

The subscriber id

extensionID

String

The extension id

countryDiallingCode

String

The country dialling code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.429. ComGkSoftwarePosApiServiceCommunicationWsCustomerByIdCustomerWebServiceResultSAPERP

CustomerWebServiceResultSAPERP Bean class for Customer By Id WebService results interface.

Field Name Required Type Description Format

customerId

String

The customer id

customerName

String

The customer name

customerStreet

String

The customer street

customerPostalCode

String

The customer postal code

customerCity

String

The customer city

customerHouseId

String

The customer house id

emailAddress

String

The email address

phoneNumber

com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerPhoneNumber

cellPhoneNumber

com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerPhoneNumber

faxPhoneNumber

com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerPhoneNumber

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.430. ComGkSoftwarePosApiServiceCommunicationWsCustomerByIdCustomerWebserviceRequest

CustomerWebserviceRequest Request object for the CustomerByIdWebService

Field Name Required Type Description Format

customerId

String

The customer id

trainingMode

Boolean

Indicates whether service should be called in training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.431. ComGkSoftwarePosApiServiceCommunicationWsCustomerByIdCustomerWebserviceResult

CustomerWebserviceResult Result object for the CustomerByIdWebService

Field Name Required Type Description Format

usedWebservice

String

The used web service

sapErpResult

com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebServiceResultSAPERP

crmResponse

com.gk_software.pos.api.service.crm.types.CustomerQueryResponse

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.432. ComGkSoftwarePosApiServiceCommunicationWsCustomerSearchByCriteriaSearchCustomerRequest

SearchCustomerRequest TODO: undocumented

Field Name Required Type Description Format

customerId

String

customerName

String

customerStreet

String

customerCity

String

customerFederalState

String

customerPostalCode

String

customerCountry

String

maxSearchResult

Integer

int32

dataProvider

String

phoneNumber

String

eMail

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.433. ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerByIdRequest

FindCustomerByIdRequest Request object for the CustomerOperationService

Field Name Required Type Description Format

customerId

String

The customer id to search for.

dataProvider

String

ID of data provider.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.434. ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerByPartyIdentificationRequest

FindCustomerByPartyIdentificationRequest Request object for the CustomerOperationService

Field Name Required Type Description Format

partyIdentification

String

An official number that is used to identify the party.

dataProvider

String

ID of data provider.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.435. ComGkSoftwarePosApiServiceCommunicationWsOperationFindCustomerDataRequest

FindCustomerDataRequest Request object for the CustomerOperationService

Field Name Required Type Description Format

customerId

String

The customer id to search for.

dataProvider

String

ID of data provider.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.436. ComGkSoftwarePosApiServiceCommunicationWsOperationUpdateCustomerRequest

UpdateCustomerRequest Request object for the CustomerOperationService

Field Name Required Type Description Format

dataProvider

String

ID of data provider.

customerData

com.gk_software.pos.flow.libs.customer.CustomerData

reason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

oldCustomer

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO

customerDeclarationRequired

Boolean

Defines if the customer declaration is necessary for permanent storage of the customer data.

eTag

String

ETag header value from getCustomer or editCustomer detail call (CPS).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.437. ComGkSoftwarePosApiServiceCommunicationWsPayablesAccountAccountBalanceRequest

AccountBalanceRequest Request object for querying customer’s account balance.

Field Name Required Type Description Format

customerID

String

The customer id.

accountingArea

String

The accounting area.

trainingMode

Boolean

Indicates whether service is called in training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.438. ComGkSoftwarePosApiServiceCommunicationWsPayablesAccountAccountBalanceResult

AccountBalanceResult Result object for customer’s account balance request.

Field Name Required Type Description Format

balanceEntries

List of [Double]

The balance entry list.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.439. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderBasicSalesOrdersRequest

SalesOrdersRequest Request object for the SalesOrderBasicWebService.

Field Name Required Type Description Format

customerIds

List of [String]

List of customer numbers used for sales orders search.

onlyOpen

X

Boolean

Specifies whether only open orders are searched.

numberOfResults

X

Integer

Maximum number of search results.

int32

trainingMode

Boolean

Indicates whether the service should be called in training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.440. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderBasicSalesOrdersResult

SalesOrdersResult Result object containing sales order details for sales order search.

Field Name Required Type Description Format

salesOrderBasicResults

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderWrapperSalesOrderBasicResult

The sales order basic result list.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.441. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderByIdSalesOrderByIdV3Request

SalesOrderByIdV3Request Request object for retrieving sales order details by its id.

Field Name Required Type Description Format

orderNumber

String

The sales order number.

trainingMode

Boolean

Indicates whether service should be called in training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.442. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderByIdSalesOrderByIdV3Result

SalesOrderByIdV3Result The sales order details returned froma sales order search by id.

Field Name Required Type Description Format

id

String

The sales order id.

date

String

The sales order date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

totalValuesGrossAmount

Double

The total gross amount.

double

totalValuesNetAmount

Double

The total net amount.

double

totalValuesTaxAmount

Double

The total tax amount.

double

statusCustomerOrderLifeCycleStatusCode

String

The customer order life cycle status code.

processingTypeCode

String

Processing type code of sales order based on delivery type.

  • Pick up at another store: 'ZTA2',

  • Immediate pickup: 'SO',

  • Delivery from warehouse: 'TA',

  • Pickup from store: 'TA'

customerId

String

The customer id.

priceComponents

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderWrapperSalesOrderPriceComponentV3

The price component list.

items

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderByIdSalesOrderExtendedItemDataV3

The item list.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.443. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderByIdSalesOrderExtendedItemDataV3

SalesOrderExtendedItemDataV3 Sales order extended item data based on sales order common data.

Field Name Required Type Description Format

id

String

The id

description

String

The description

productInternalId

String

The productInternalId

productSalesMeasureUnitCode

String

The productSalesMeasureUnitCode

requestDate

String

The requestDate Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

deliveryTermsDeliveryPlantId

String

The deliveryTermsDeliveryPlantId

requestedQuantity

X

Double

The requestedQuantity

double

receivingPointId

String

The receivingPointId

productStandardId

String

The product standard id

productRejectionReasonCode

String

The product rejection reason code.

itemPriceComponents

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderWrapperSalesOrderPriceComponentV3

The item price component list.

totalValuesRequestedQuantity

Double

The requested quantity.

double

totalValuesConfirmedQuantity

Double

The confirmed quantity.

double

totalValuesDeliveredQuantity

Double

The delivered quantity.

double

totalValuesNetAmount

Double

The total net amount.

double

totalValuesNetPrice

Double

The total net price.

double

totalValuesTaxAmount

Double

The total tax amount.

double

scheduleLines

List of ComGkSoftwarePosApiServiceTransactionSalesOrderCommonScheduleLine

The schedule line list.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.444. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesChangeConfirmationRequestItem

ChangeConfirmationRequestItem Request object of the Change Confirmation Item

Field Name Required Type Description Format

id

String

The item id.

description

String

The item receipt text description.

product_internalId

String

The product internal id.

product_salesMeasureUnitCode

String

The product sales measure unit code.

dateTerms_requestDate

String

The delivery date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

deliveryTerms_deliveryPlantId

String

The id of plant where items will be delivered to. E.g.: store id.

totalValues_requestedQuantity

Double

The requested quantity.

double

salesTerms_rejectionReasonCode

String

Rejection reason (Token 0-2) for reversal of sales orders or order items.

receivingPointParty_internalId

String

Pick up destination. This field describes the receiving point party for the items. For example, it is the current store id if it is an immediate pickup, or another store’s id if the sales order will be retrieved in a different store.

priceComponents

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesChangeConfirmationRequestItemPriceComponent

Price component condition data for the item.

buyerDocument_Id

String

Buyer document id (Token 1-35). Format: ffffddddddkkkbbbbbb

  • ffff – store id with leading zeros

  • dddddd – date in format ddmmyy (each with leading zeros)

  • kkk – pos/workstation number with leading zeros

  • bbbbbb – transaction sequence number with leading zeros

actionCode

String

Action code for the request (Token 2). Possible values:

  • 01 – insert record

  • 02 – update record

  • 03 – delete record

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.445. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesChangeConfirmationRequestItemPriceComponent

ChangeConfirmationRequestItemPriceComponent Request object of the Change Confirmation Item Price Component

Field Name Required Type Description Format

priceSpecificationElementTypeCode

String

It defines the price condition type in the SAP ERP system (eg.: 'VKP0').

rate_DecimalValue

Double

Price condition value.

double

rate_BaseDecimalValue

Double

The rate base decimal value.

double

actionCode

String

Action code for the request (Token 2). Possible values:

  • 01 – insert record

  • 02 – update record

  • 03 – delete record

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.446. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesChangeConfirmationRequestPriceComponent

ChangeConfirmationRequestPriceComponent Request object of the Change Confirmation Price Component.

Field Name Required Type Description Format

priceSpecificationElementTypeCode

String

It defines the price condition type in the SAP ERP system (eg.: 'VKP0').

rate_DecimalValue

Double

Price condition value.

double

actionCode

String

Action code for the request (Token 2). Possible values:

  • 01 – insert record

  • 02 – update record

  • 03 – delete record

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.447. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesSalesOrderChangeConfirmationRequest

SalesOrderChangeConfirmationRequest Request object for creating a sales order change confirmation.

Field Name Required Type Description Format

storeId

String

The store id.

date

String

The date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

posId

String

The POS id.

sequenceNumber

Integer

Sales order sequence number. This number is used for assembling a header uui for a sales order operation.

int32

deliveryBlockingReasonCode

String

The delivery blocking reason code.

salesOrderId

String

Sales order number (Token of length 1-10).

priceComponents

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesChangeConfirmationRequestPriceComponent

Price components containing condition data of the sales order.

items

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesChangeConfirmationRequestItem

Sales order items.

trainingMode

Boolean

Indicates whether service is called on training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.448. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderChangeRequestConfirmationEntitiesSalesOrderChangeConfirmationResult

SalesOrderChangeConfirmationResult Result object of the Sales Order Change Confirmation.

Field Name Required Type Description Format

id

String

Sales order number (Token of length 1-10).

3.449. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateCheckSalesOrderCreateCheckRequest

SalesOrderCreateCheckRequest Request object for the SalesOrderCreateCheckWebService.

Field Name Required Type Description Format

buyerDocument_Id

String

The buyer document id. Format: ffffddddddkkkbbbbbb

  • ffff – store id with leading zeros

  • dddddd – date in format ddmmyy (each with leading zeros)

  • kkk – pos/workstation number with leading zeros

  • bbbbbb – transaction sequence number with leading zeros

processingTypecode

String

Processing type code of sales order based on delivery type.

  • Pick up at another store: 'ZTA2',

  • Immediate pickup: 'SO',

  • Delivery from warehouse: 'TA',

  • Pickup from store: 'TA'

salesOrganisationID

String

Store number (Token of length 1-20).

distributionChannelCode

String

It defines the code of the distribution channel in the SAP ERP system (Token of length 1-2). E.g.: 'V1'.

divisionCode

String

It defines the division/section in the SAP ERP system (Token of length 1-2). E.g.: 'R1'.

customerAdrType

String

The customer address type (e.g.: the customer card type from customer identification configuration is used in the POS client).

customerId

String

The customer id.

storeId

String

The store id.

items

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderWrapperSalesOrderCommonRequestItemData

The item list.

trainingMode

Boolean

Indicates whether the service call should be performed in training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.450. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesCreateConfirmationRequestItem

CreateConfirmationRequestItem Request object for a sales order item creation.

Field Name Required Type Description Format

id

String

The item id.

description

String

The item receipt text description.

product_internalId

String

The product internal id.

product_salesMeasureUnitCode

String

The product sales measure unit code.

dateTerms_requestDate

String

The delivery date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

deliveryTerms_deliveryPlantId

String

The id of plant where items will be delivered to. E.g.: store id.

totalValues_requestedQuantity

Double

The requested quantity.

double

receivingPointParty_internalId

String

Id of receiving point party (Token of length 1-32). E.g.: store id.

priceComponents

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesCreateConfirmationRequestItemPriceComponent

Line item condition data.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.451. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesCreateConfirmationRequestItemPriceComponent

CreateConfirmationRequestItemPriceComponent Request object for the line item price component.

Field Name Required Type Description Format

priceSpecificationElementTypeCode

String

It defines the price condition type in the SAP ERP system (eg.: 'VKP0').

rate_DecimalValue

Double

Price condition value.

double

rate_BaseDecimalValue

Double

The rate base decimal value.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.452. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesCreateConfirmationRequestPriceComponent

CreateConfirmationRequestPriceComponent Request object for the sales order price component creation.

Field Name Required Type Description Format

priceSpecificationElementTypeCode

String

It defines the price condition type in the SAP ERP system (eg.: 'VKP0').

rate_DecimalValue

Double

Price condition value.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.453. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesSalesOrderCreateConfirmationRequest

SalesOrderCreateConfirmationRequest Request object for a sales order creation.

Field Name Required Type Description Format

storeId

String

The store id.

date

String

The date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

posId

String

The POS id.

sequenceNumber

Integer

Sales order sequence number. This number is used for assembling a header uui for a sales order operation.

int32

deliveryBlockingReasonCode

String

The delivery blocking reason code.

processingTypecode

String

Processing type code of sales order based on delivery type.

  • Pick up at another store: 'ZTA2',

  • Immediate pickup: 'SO',

  • Delivery from warehouse: 'TA',

  • Pickup from store: 'TA'

buyerDocument_Id

String

Buyer document id (Token of length 1-35). Format: ffffddddddkkkbbbbbb ffff – store id with leading zeros dddddd – date in format ddmmyy (each with leading zeros) kkk – pos/workstation number with leading zeros bbbbbb – transaction sequence number with leading zeros

salesOrganisationID

String

Store number (Token of length 1-20).

distributionChannelCode

String

It defines the code of the distribution channel in the SAP ERP system (Token of length 1-2). E.g.: 'V1'.

divisionCode

String

It defines the division/section in the SAP ERP system (Token of length 1-2). E.g.: 'R1'.

buyerParty_InternalId

String

Customer number (Token of length 1-12).

priceComponents

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesCreateConfirmationRequestPriceComponent

Customer order condition data.

items

List of ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesCreateConfirmationRequestItem

The item list.

trainingMode

Boolean

Indicates whether the service should be called in training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.454. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderCreateRequestConfirmationEntitiesSalesOrderCreateConfirmationResult

SalesOrderCreateConfirmationResult Result object for the sales order creation.

Field Name Required Type Description Format

id

String

Sales order number (Token of length 1-10).

uuid

String

Unique transaction ID.

3.455. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderSalesDocReadSalesOrderSalesDocReadRequest

SalesOrderSalesDocReadRequest Request object for reading an existing sales order.

Field Name Required Type Description Format

orderNumber

String

The order number of a sales order to be retrieved.

storeId

String

The store id performing the request.

workstationId

String

The workstation id performing the request.

trainingMode

Boolean

Indicates whether service is called on training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.456. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderSalesDocReadSalesOrderSalesDocReadResult

SalesOrderSalesDocReadResult The result of a sales order read operation.

Field Name Required Type Description Format

originalPrepayment

Double

The original prepayment.

double

openPrepayment

Double

The open prepayment.

double

actualPayment

Double

The actual payment.

double

payedOpen

Double

The open payed amount.

double

salesDocItems

List of ComGkSoftwarePosApiServiceTransactionSalesOrderSalesDocItem

The sales order document item list.

currency

String

The currency.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.457. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderWrapperSalesOrderBasicResult

SalesOrderBasicResult The result object of a sales order search request.

Field Name Required Type Description Format

id

String

The sales order number.

date

String

The date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

creationDate

String

The creation date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

total

Double

The total net value.

double

formattedCreationDate

String

The formatted creation date.

status

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.458. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderWrapperSalesOrderCommonRequestItemData

SalesOrderCommonRequestItemData Bean class for Sales Order common request item data.

Field Name Required Type Description Format

id

String

The id

description

String

The description

productInternalId

String

The productInternalId

productSalesMeasureUnitCode

String

The productSalesMeasureUnitCode

requestDate

String

The requestDate Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

deliveryTermsDeliveryPlantId

String

The deliveryTermsDeliveryPlantId

requestedQuantity

X

Double

The requestedQuantity

double

receivingPointId

String

The receivingPointId

priceComponentList

List of ComGkSoftwarePosApiServiceTransactionSalesOrderCommonPriceComponent

The price component list.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.459. ComGkSoftwarePosApiServiceCommunicationWsSalesOrderWrapperSalesOrderPriceComponentV3

SalesOrderPriceComponentV3 Sales order price component object.

Field Name Required Type Description Format

priceSpecificationElementTypeCode

String

The price specification element type code.

rateDecimalValue

Double

The rate decimal value.

double

rateBaseDecimalValue

Double

The rate base decimal value.

double

calculatedAmount

Double

The calculated amount.

double

effectiveIndicator

Boolean

The effective indicator.

inactivityReasonCode

String

The inactivity reason code.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.460. ComGkSoftwarePosApiServiceCouponCheckCouponRequestData

CheckCouponRequestData Entity for the coupon data in the request.

Field Name Required Type Description Format

couponSerialNumber

X

String

The coupon identifier

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.461. ComGkSoftwarePosApiServiceCouponCheckCouponsRequest

CheckCouponsRequest Request entity for 'Check Coupons' service.

Field Name Required Type Description Format

header

X

com.gk_software.pos.api.service.coupon.CouponingRequestHeaderData

uuid

X

String

The uuid of the request.

coupons

X

List of ComGkSoftwarePosApiServiceCouponCheckCouponRequestData

The coupon data of the request.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.462. ComGkSoftwarePosApiServiceCouponCheckCouponsResponse

CheckCouponsResponse Response entity for 'Check Coupons' service.

Field Name Required Type Description Format

status

X

com.gk_software.pos.api.service.coupon.CouponingResponseStatus

coupons

List of ComGkSoftwarePosApiServiceCouponCheckCouponsResultData

The coupon data of the response

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.463. ComGkSoftwarePosApiServiceCouponCheckCouponsResultData

CheckCouponsResultData Entity for the coupon data in the response.

Field Name Required Type Description Format

couponSerialNumber

String

The coupon identifier

status

String

The state of the coupon

Enum: VALID, REDEEMED, EXPIRED, INVALID, BLOCKED,

offerNumber

String

The offer number of the coupon

remainingUseCount

Integer

The remaining useable count of the coupon

int32

expirationTimestamp

String

The expiry date of the coupon Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.464. ComGkSoftwarePosApiServiceCouponCouponingRequestHeaderData

CouponingRequestHeaderData Entity for the request header data.

Field Name Required Type Description Format

businessUnitId

String

Business unit of the requesting client

workstationId

String

Workstation id of the requesting client

transactionId

String

Transaction id of the client transaction

softwareVersion

String

Software version of the requesting client

clientAddress

String

Address of the requesting client

iSOCountryCode

X

String

Country code where requesting client is located

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.465. ComGkSoftwarePosApiServiceCouponCouponingResponseError

CouponingResponseError The entity of the request execution error in the response.

Field Name Required Type Description Format

code

String

The error code which occurred.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.466. ComGkSoftwarePosApiServiceCouponCouponingResponseStatus

CouponingResponseStatus The entity of the status in the response.

Field Name Required Type Description Format

code

X

String

The status code of the response

Enum: OK, ERROR, OFFLINE,

error

com.gk_software.pos.api.service.coupon.CouponingResponseError

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.467. ComGkSoftwarePosApiServiceCouponReturnCouponsRequest

ReturnCouponsRequest Request entity for 'Return/Redeem Coupons' service.

Field Name Required Type Description Format

header

X

com.gk_software.pos.api.service.coupon.CouponingRequestHeaderData

markAppliedCouponSerials

Boolean

Flag if coupon serials should be marked as 'applied' on the transaction during return/redeem of coupons

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.468. ComGkSoftwarePosApiServiceCouponReturnCouponsResponse

ReturnCouponsResponse Response entity for 'Return/Redeem Coupons' service.

Field Name Required Type Description Format

status

X

com.gk_software.pos.api.service.coupon.CouponingResponseStatus

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

coupons

List of ComGkSoftwarePosApiServiceCouponReturnCouponsResultData

The coupon result data of the response

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.469. ComGkSoftwarePosApiServiceCouponReturnCouponsResultData

ReturnCouponsResultData Entity for the coupon result data in the response.

Field Name Required Type Description Format

couponSerialNumber

String

The coupon identifier

resultCode

String

The result code of the coupon return

Enum: SUCCESSFUL, ALREADY_REDEEMED, INVALID, EXPIRED, FAILED, BLOCKED,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.470. ComGkSoftwarePosApiServiceCrmTypesAddress

Address Object for address data

Field Name Required Type Description Format

addressLine1

String

String: The first line of the address, normally the street number and name.

addressLine2

String

String: The second line of an address, normally the Flat or Building Suite number.

addressLine3

String

String: The third line of the address.

addressLine4

String

String: The fourth line of the address.

addressLine5

String

String: The fifth line of the address.It is normally used for the salutation.

city

String

String: The city, town or village component of the address.

territory

String

String: The County, State, Province, Territory etc component of the address.

territoryName

String

String: The name of the County, State, Province, Territory etc. component of the address.

subTerritoryName

String

String: This field is used to specify the territory or city more concrete, for example for storing the district or suburb of a certain city.

postalCode

String

String: The postal or zip code of the address.

postalCodeExtension

String

String: The extension of the postal or zip code that further specifies a particular postal district.

isoCountryCode

String

String: The ISO country code of the address.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.471. ComGkSoftwarePosApiServiceCrmTypesContactMethod

ContactMethod Data object for contact method

Field Name Required Type Description Format

contactPurposeTypeCode

String

String: contact purpose DEFAULT – Default INVOICE – Invoice DELIVERY – Delivery

contactMethodTypeCode

String

String: contact method Address: HOME - home address HOMEPOSTALBOX - home postal box WORK - work address WORKPOSTALBOX - work postal box CONTACT - contact address Telephone: HOMETELEPHONE – home telephone HOMEMOBILEPHONE – home mobile phone HOMEFAX – home fax WORKTELEPHONE – work telephone WORKMOBILEPHONE – work mobile phone WORKFAX – work fax Email: HOMEEMAIL - home WORKEMAIL

address

com.gk_software.pos.api.service.crm.types.Address

telephone

com.gk_software.pos.api.service.crm.types.Telephone

eMailAddress

String

String: e-mail address

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.472. ComGkSoftwarePosApiServiceCrmTypesCustomerAccount

CustomerAccount Data object customer account

Field Name Required Type Description Format

accountID

String

String: customer account number

accountTypeCode

String

String: account type 00 - turnover of current year 01 - discount of current year 02 - points

balance

com.gk_software.pos.api.service.crm.types.Money

accountQueryReturnCode

String

String: return code for the customer account request

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.473. ComGkSoftwarePosApiServiceCrmTypesCustomerGroup

CustomerGroup Data object CustomerGroup

Field Name Required Type Description Format

customerGroupID

String

String: customer group ID

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.474. ComGkSoftwarePosApiServiceCrmTypesCustomerIdentification

CustomerIdentification Entity for customer identification

Field Name Required Type Description Format

identifier

String

Identification number

partyIdentificationTypeCode

String

Type of the identification number

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.475. ComGkSoftwarePosApiServiceCrmTypesCustomerQueryResponse

CustomerQueryResponse response object customer query

Field Name Required Type Description Format

customerID

String

String: customer ID

accountID

String

String: account ID

person

com.gk_software.pos.api.service.crm.types.EntityInformation_Person

contactMethodList

List of ComGkSoftwarePosApiServiceCrmTypesContactMethod

ContactMethod: contact method list

customerGroupList

List of ComGkSoftwarePosApiServiceCrmTypesCustomerGroup

CustomerGroup: customer group list

customerAccountList

List of ComGkSoftwarePosApiServiceCrmTypesCustomerAccount

CustomerAccount: customer account list

customerIdentificationList

List of ComGkSoftwarePosApiServiceCrmTypesCustomerIdentification

CustomerIdentification: customer identifications list

crmOffline

X

Boolean

boolean: Indicates that CRM is offline

cardNumber

String

String: card number

preferredReceiptPrintoutTypeCode

String

String : preferredReceiptPrintoutTypeCode It defines the preferred printout type code of the customer: CLIENT - Printout depends on client settings. PRINTONLY - Customer wants to have a printed receipt. MAILONLY - Customer wants to have the receipt per mail. NOTHING - Customer wants to have nothing. PRINTANDMAIL - Customer wants to have a printed receipt and a mail.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.476. ComGkSoftwarePosApiServiceCrmTypesEntityInformationPerson

EntityInformation_Person Object for holding person entity information

Field Name Required Type Description Format

firstName

String

String: first name

lastName

String

String: last name

birthDate

String

Date: birth date Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

genderType

String

String: gender type

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.477. ComGkSoftwarePosApiServiceCrmTypesMoney

Money Data object Money

Field Name Required Type Description Format

amount

Double

Double: Amount with decimal places

double

currency

String

String: Currency of the amount

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.478. ComGkSoftwarePosApiServiceCrmTypesTelephone

Telephone Data object for telephone data

Field Name Required Type Description Format

countryDiallingCode

String

String: country dialling code

areaID

String

String: area

subscriberID

String

String: subscriber ID

extensionID

String

String: extension ID

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.479. ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataChangedDataEventRequest

StoreCustomerDataChangedDataEventRequest Request object for StoreCustomerDataChangedDataEvent

Field Name Required Type Description Format

oldCustomer

X

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO

newCustomer

X

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO

reason

X

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.480. ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataCreatedDataEventRequest

StoreCustomerDataCreatedDataEventRequest Request object for StoreCustomerDataCreatedDataEvent

Field Name Required Type Description Format

customer

X

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO

reason

X

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.481. ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerDataReadDataEventRequest

StoreCustomerDataReadDataEventRequest Request object for StoreCustomerDataReadDataEvent

Field Name Required Type Description Format

customer

X

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.482. ComGkSoftwarePosApiServiceDataPrivacyLogStoreCustomerSearchCriteriaEventRequest

StoreCustomerSearchCriteriaEventRequest Request object for StoreCustomerSearchCriteriaEvent

Field Name Required Type Description Format

customerContactFilter

X

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerContactFilter

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.483. ComGkSoftwarePosApiServiceDigitalReceiptProcessDigitalReceiptRequest

ProcessDigitalReceiptRequest Request entity for 'Add Digital Receipt' service.

Field Name Required Type Description Format

pdf

X

String

The pdf attachment that is the PDF base64 encoded combined receipts binary stream data

digitalReceiptAction

String

The action code which should be executed for the digital receipt (EMail / QRCode)

Enum: None, Email, QRCode,

digitalReceiptEmailAction

String

The action code for the email handling (Client / Backend)

Enum: Backend, Client,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.484. ComGkSoftwarePosApiServiceDigitalReceiptProcessDigitalReceiptResponse

ProcessDigitalReceiptResponse Response entity for 'Add Digital Receipt' service.

Field Name Required Type Description Format

statusCode

X

String

The status of the response.

Enum: OK, ERROR, OFFLINE,

transactionOperationResult

X

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.485. ComGkSoftwarePosApiServiceEwicEwicBasketRequest

EwicBasketRequest Request object for the EwicBasketRequest.

Field Name Required Type Description Format

transaction

com.gk_software.gkr.api.txpool.dto.Transaction

stateCode

String

String : State code for eWIC card

expirationDate

String

String : Expiration date for eWIC card

prescription

List of ComGkSoftwarePosApiServiceEwicEwicItemSubcategoryBenefitsResult

EwicItemSubcategoryBenefitsResult[] : Benefits, UOM and Item SubCategory Description

ewicPaymentOperationConfig

com.gk_software.pos.api.model.config.process.action.EwicPaymentOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.486. ComGkSoftwarePosApiServiceEwicEwicBasketResult

EwicBasketResult Result object for the EwicBasketResult.

Field Name Required Type Description Format

itemDescription

String

String : Item description from master data

quantity

Double

double : Quantity of item purchased

double

uomDesc

String

String : UOM description

itemPrice

Double

double : Item extended amount

double

categoryDesc

String

String : eWIC category description

subcategoryDesc

String

String : eWIC sub-category description

baseUOMCode

String

String : UOM code

category

String

String : eWIC category code

subcategory

String

String : eWIC sub-category code

upcPluNumber

String

String : Item number

lineNumber

Integer

short: Item index

int32

benefitQuantity

Double

double: Quantity that is eligible to receive benefits, as obtained from the eWIC prescription

double

ntePrice

Double

double: Not to exceed price

double

status

String

EwicItemStatusType: Whether to apply WIC benefits for this item

Enum: WIC, NO_WIC, VOID,

wicPurchaseIndicator

Boolean

boolean: Specifies whether the item can be straddled

splitEwicTender

Boolean

boolean: Specifies whether the item will be tendered partially with eWIC

regularUnitPrice

Double

double: Item regular unit price

double

extendedDiscountAmount

Double

double: Item extended discount amount

double

amount

Double

double: Item quantity multiply by item benefits quantity

double

itemDisplayPrice

Double

double: Item price for confirmation screen

double

itemVariance

Double

double: Item variance price for NTE

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.487. ComGkSoftwarePosApiServiceEwicEwicItemSubcategoryBenefitsRequest

EwicItemSubcategoryBenefitsRequest Request object for the EWicItemSubCategoryBenefits.

Field Name Required Type Description Format

categoryCode

String

String : Item Category Code

subcategoryCode

String

String : Item Sub Category Code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.488. ComGkSoftwarePosApiServiceEwicEwicItemSubcategoryBenefitsResult

EwicItemSubcategoryBenefitsResult Result object for the EwicItemSubCategoryLib.

Field Name Required Type Description Format

benefits

Double

double: Benefits

double

uom

String

subcategoryDesc

String

String : Item Sub Category Description

category

String

String : eWIC category code

subcategory

String

String : eWIC sub-category code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.489. ComGkSoftwarePosApiServiceEwicEwicMatchingPrescriptionResult

EwicMatchingPrescriptionResult TODO: undocumented

Field Name Required Type Description Format

ewicBasketresult

List of ComGkSoftwarePosApiServiceEwicEwicBasketResult

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.490. ComGkSoftwarePosApiServiceExternalCartExternalCartData

ExternalCartData Representation of an external cart provided by an external order service

Field Name Required Type Description Format

cartId

X

String

The cart ID.

customerId

String

The customer ID.

totalItems

Integer

The total item count of this cart.

int32

pickupItems

Integer

The count of items to pick up in a store.

int32

deliveryItems

Integer

The count of items to be delivered.

int32

totalPrice

com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice

deliveryCost

com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice

totalDiscounts

com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice

orderCalculated

Boolean

A flag signaling if the cart has been calculated and is ready for order.

totalPriceWithTax

com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice

entries

List of ComGkSoftwarePosApiServiceExternalCartExternalCartDataEntry

The line items of the cart.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.491. ComGkSoftwarePosApiServiceExternalCartExternalCartDataEntry

ExternalCartDataEntry A single line item entry in the external cart.

Field Name Required Type Description Format

entryNumber

X

Integer

The reference number of the entry (usually an index number)

int32

product

X

com.gk_software.pos.api.service.external.cart.ExternalCartDataProduct

quantity

X

Integer

The quantity of the product in the cart entry

int32

totalPrice

X

com.gk_software.pos.api.service.external.cart.ExternalCartDataPrice

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.492. ComGkSoftwarePosApiServiceExternalCartExternalCartDataPrice

ExternalCartDataPrice The pricing information type used in the ExternalCart

Field Name Required Type Description Format

currencyIso

X

String

the price currency expressed as ISO code

value

X

Double

the price value

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.493. ComGkSoftwarePosApiServiceExternalCartExternalCartDataProduct

ExternalCartDataProduct A single product representation.

Field Name Required Type Description Format

code

X

String

The product identifier

name

X

String

The name of the product

purchasable

Boolean

A flag signaling if product is currently purchasable or not

stock

Integer

The stock information, if available.

int32

url

String

A deeplink url to the product on the external service

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.494. ComGkSoftwarePosApiServiceExternalCartExternalCartLineItemRequest

ExternalCartLineItemRequest Add a lineitem to an external cart in external service

Field Name Required Type Description Format

cartID

X

String

The cart id.

customerID

X

String

The customer id.

itemID

X

String

The item id.

quantity

X

Integer

The quantity amount.

int32

pickupStore

String

Optional store identifier for pickups.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.495. ComGkSoftwarePosApiServiceExternalCartExternalCartRequest

ExternalCartRequest Lookup request object for external cart information

Field Name Required Type Description Format

cartID

X

String

The cart id.

customerID

X

String

The customer id.

anonymousCartGUID

X

String

The anonymous cart id. Note: some external services use different cart id schemes. See implementation for details

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.496. ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerAddressRequest

ExternalCustomerAddressRequest Create a new customer address in external repository

Field Name Required Type Description Format

customerID

X

String

The customer id.

city

X

String

Name of city.

postalCode

X

String

Postal code.

isoCountryCode

X

String

The ISO country code.

addressLine1

X

String

The address line 1

addressLine2

X

String

The address line 2

territory

X

String

Name of territory

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.497. ComGkSoftwarePosApiServiceExternalCustomerExternalCustomerDetailsRequest

ExternalCustomerDetailsRequest Lookup request object for external customer information

Field Name Required Type Description Format

customerID

X

String

The customer id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.498. ComGkSoftwarePosApiServiceExternalItemExternalItemInformationRequest

ExternalItemInformationRequest Lookup request object for external item information

Field Name Required Type Description Format

ItemID

X

String

The item id.

language

X

String

The language code used for I18N.

currency

X

String

The currency code.

getImages

Boolean

Specifies whether image urls should be resolved.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.499. ComGkSoftwarePosApiServiceExternalItemExternalItemSearchRequest

ExternalItemSearchRequest Search request object for external item information

Field Name Required Type Description Format

query

X

String

The query used for item search.

language

X

String

describe language

currency

X

String

The currency code.

recordCount

Integer

Specifies the max. record count to return.

int32

getImages

Boolean

Specifies whether image urls should be resolved.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.500. ComGkSoftwarePosApiServiceExternalOrderAddress

Address Address object for deliveries and invoices used by the external order service

Field Name Required Type Description Format

title

X

String

firstName

X

String

First name of the customer

lastName

X

String

Last name of the customer

line1

X

String

Address line 1

line2

String

Address line 2

town

X

String

The city

postalCode

X

String

The zipcode

country

X

String

The country to deliver to. Check the implementation for valid options.

region

String

The region to deliver to. Check the implementation for valid options.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.501. ComGkSoftwarePosApiServiceExternalOrderDeliveryAddressRequest

DeliveryAddressRequest Request object for creating a delivery address on the external order service

Field Name Required Type Description Format

customerID

X

String

The customers' ID

cartID

X

String

The cart ID to set the address to

firstName

X

String

First name of the customer

lastName

X

String

Last name of the customer

line1

X

String

Address line 1

line2

String

Address line 2

town

X

String

The city

postalCode

X

String

The zipcode

country

X

String

The country to deliver to. Check the implementation for valid options.

region

String

The region to deliver to. Check the implementation for valid options.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.502. ComGkSoftwarePosApiServiceExternalOrderDeliveryModeRequest

DeliveryModeRequest Request object for setting the delivery mode on the external order service

Field Name Required Type Description Format

customerID

X

String

The customers' ID

cartID

X

String

The cart ID to set the address to

mode

X

String

The mode how the order is delivered. Check the implementation for valid options.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.503. ComGkSoftwarePosApiServiceExternalOrderPaymentDetailsRequest

PaymentDetailsRequest Request object to set payment details for the external order Note: Some external services need credit card informations to satisfy their interfaces. See implementation for details.

Field Name Required Type Description Format

customerID

X

String

The customer’s ID

cartID

X

String

billingAddress

X

com.gk_software.pos.api.service.external_order.Address

accountHolderName

X

String

The account holder of the credit card

cardNumber

X

String

The credit card number

cardType

X

String

The credit card type.

expiryMonth

X

String

The cards' expiry month

expiryYear

X

String

The cards' expiry year

defaultPayment

X

String

A flag for setting this method as the future default payment

language

X

String

ISO language code

currency

X

String

ISO currency code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.504. ComGkSoftwarePosApiServiceFuelDispenserTotalRequest

DispenserTotalRequest Request entity for Dispenser Total.

Field Name Required Type Description Format

retailStoreId

String

The retail store id.

workstationId

String

The workstation id.

clientVersion

String

The client version.

operator

com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO

dispenserTotals

String

The dispenser totals.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.505. ComGkSoftwarePosApiServiceFuelDriveOffDataRequest

DriveOffDataRequest TODO: undocumented

Field Name Required Type Description Format

make

String

model

String

color

String

stateName

String

licensePlateNumber

String

personalDescription

String

additionalInformation

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.506. ComGkSoftwarePosApiServiceFuelFindPetrolItemRequest

FindPetrolItemRequest Request entity for Find Petrol Item Request.

Field Name Required Type Description Format

retailStoreId

String

The retail store id.

nozzleId

String

The Nozzle id.

fuellingPointId

String

The Fueling Point id.

gradeId

String

The Grade id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.507. ComGkSoftwarePosApiServiceFuelFuelPriceChangeRequest

FuelPriceChangeRequest Request entity for Fuel Price Change Request.

Field Name Required Type Description Format

retailStoreId

String

The retail store id.

workstationId

String

The workstation id.

clientVersion

String

The client version.

operator

com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO

fuelPriceChanges

String

The fuel price changes.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.508. ComGkSoftwarePosApiServiceHospitalityActivateHospitalityReceiptRequest

ActivateHospitalityReceiptRequest Request entity for 'activateHospitalityReceipt' service.

Field Name Required Type Description Format

activate

X

Boolean

Flag to activate or deactivate hospitality receipt print.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.509. ComGkSoftwarePosApiServiceHospitalityAddLineItemCourseNumberRequest

AddLineItemCourseNumberRequest Request entity for 'Add Line Item Course Number Request' service.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

quantityAccumulationEnabled

X

Boolean

Specifies whether quantity accumulation is enabled.

courseNumber

X

String

The course number for adding to selected line item.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.510. ComGkSoftwarePosApiServiceHospitalityBelatedVoidLineItemRequest

BelatedVoidLineItemRequest Request entity for 'BelatedVoidLineItem' service.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

tenderAuthorizationKey

com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey

voidTypeCode

String

Describes whether the line item was cancelled immediately after registering it, voided by another line item or internally voided.

copyVoidedLineItem

X

Boolean

Flag indicating whether to copy the line item.

giftCertCancellationId

String

A gift certificate service result, it is filled only if a gift certificate line item is canceled online

storeTransaction

X

Boolean

Indicates whether the transaction should be stored.

offlineMode

X

Boolean

The offline mode

keyedOnline

Boolean

The keyed on line state.

serviceScaleMode

Boolean

Indicates whether the POS is in service scale mode.

voidReason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

recalculateTransaction

Boolean

toVoidQuantity

X

Integer

The quantity which should be voided from the line item.

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.511. ComGkSoftwarePosApiServiceHospitalityBelatedVoidLineItemResponse

BelatedVoidLineItemResponse Response entity for 'BelatedVoidLineItem' service.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

tenderAuthorizationKey

com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey

voidTypeCode

String

Describes whether the line item was cancelled immediately after registering it, voided by another line item or internally voided.

copyVoidedLineItem

X

Boolean

Flag indicating whether to copy the line item.

giftCertCancellationId

String

A gift certificate service result, it is filled only if a gift certificate line item is canceled online

storeTransaction

X

Boolean

Indicates whether the transaction should be stored.

offlineMode

X

Boolean

The offline mode

keyedOnline

Boolean

The keyed on line state.

serviceScaleMode

Boolean

Indicates whether the POS is in service scale mode.

voidReason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

recalculateTransaction

Boolean

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.512. ComGkSoftwarePosApiServiceHospitalityChangeTableOwnerRequest

ChangeTableOwnerRequest Request entity for 'Change Table Owner' service.

Field Name Required Type Description Format

tableStatusList

List of ComGkSoftwarePosApiServiceHospitalityTableStatus

The list of 'Table Status' object which should b used to update the table owner.

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.513. ComGkSoftwarePosApiServiceHospitalityChangeTableOwnerResponse

ChangeTableOwnerResponse Response entity for 'Change Table Owner' service.

Field Name Required Type Description Format

transactionList

List of ComGkSoftwareGkrApiTxpoolDtoTransaction

The list of transaction objects which were created.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.514. ComGkSoftwarePosApiServiceHospitalityCreateBelatedTipTransactionRequest

CreateBelatedTipTransactionRequest Request entity for 'Create Belated Tip Transaction' service.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.515. ComGkSoftwarePosApiServiceHospitalityCreateBelatedTipTransactionResponse

CreateBelatedTipTransactionResponse Response entity for 'Create Belated Tip Transaction' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.516. ComGkSoftwarePosApiServiceHospitalityCreateOrRetrieveTransactionRequest

CreateOrRetrieveTransactionRequest Request entity for 'CreateOrRetrieveTransaction' service.

Field Name Required Type Description Format

tableName

String

Table name of a new table

lastTransactionId

String

TransactionId of the last transaction of the table

lastTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

transactionTypeCode

String

Transaction type code of the transaction which is created or retrieved.

Enum: FOOD_ORDER, SALE, MOVEMENT,

scopedTransaction

Boolean

Defines if the created or retrieved transaction should be a scoped transaction (default: false)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.517. ComGkSoftwarePosApiServiceHospitalityCreateOrRetrieveTransactionResponse

CreateOrRetrieveTransactionResponse Response entity for 'CreateOrRetrieveTransaction' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.518. ComGkSoftwarePosApiServiceHospitalityDeleteLineItemCourseNumberRequest

DeleteLineItemCourseNumberRequest Request entity for 'Delete Line Item Course Number Request' service.

Field Name Required Type Description Format

lineItemKey

X

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

operationConfiguration

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

quantityAccumulation

X

Boolean

It defines if the quantity of line items with the same item should be accumulated.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.519. ComGkSoftwarePosApiServiceHospitalityFinalizeMovementTransactionsRequest

FinalizeMovementTransactionsRequest Request entity for 'FinalizeMovementTransactions' service.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.520. ComGkSoftwarePosApiServiceHospitalityFinalizeMovementTransactionsResponse

FinalizeMovementTransactionsResponse Response entity for 'FinalizeMovementTransactions' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.521. ComGkSoftwarePosApiServiceHospitalityIsLineItemAddedOrVoidedRequest

IsLineItemAddedOrVoidedRequest Request entity for 'IsLineItemAddedOrVoided' service.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.522. ComGkSoftwarePosApiServiceHospitalityIsLineItemAddedOrVoidedResponse

IsLineItemAddedOrVoidedResponse Response entity for 'IsLineItemAddedOrVoided' service.

Field Name Required Type Description Format

lineItemAddedOrModified

X

Boolean

Flag that contains the result of the operation. It indicates if the transaction contains new or voided positions.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.523. ComGkSoftwarePosApiServiceHospitalityLoadComboMealItemsRequest

LoadComboMealItemsRequest Request entity for loading of 'ComboMeal' items

Field Name Required Type Description Format

businessUnitGroupId

X

String

The unique identifier of the business unit group

itemId

X

String

The item id

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.524. ComGkSoftwarePosApiServiceHospitalityLoadComboMealItemsResponse

LoadComboMealItemsResponse Response entity for loading of 'ComboMeal' items

Field Name Required Type Description Format

comboMealItem

com.gk_software.pos.api.service.hospitality.PosComboMealItem

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.525. ComGkSoftwarePosApiServiceHospitalityLoadCondimentsRequest

LoadCondimentsRequest Request entity for loading of condiments.

Field Name Required Type Description Format

businessUnitGroupId

X

String

The business unit group ID.

mainMerchandiseHierarchyGroupId

String

The main merchandise hierarchy group ID.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.526. ComGkSoftwarePosApiServiceHospitalityLoadCondimentsResponse

LoadCondimentsResponse Response entity for loading of condiments.

Field Name Required Type Description Format

relatedComponents

List of ComGkSoftwarePosApiServiceHospitalityPosCondimentComponent

List of condiment components.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.527. ComGkSoftwarePosApiServiceHospitalityLoadTableStatusRequest

LoadTableStatusRequest Request entity for 'Load Table Status' service.

Field Name Required Type Description Format

businessUnitId

String

The business unit ID (Retail Store ID).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.528. ComGkSoftwarePosApiServiceHospitalityLoadTableStatusResponse

LoadTableStatusResponse Response entity for 'Load Table Status' service.

Field Name Required Type Description Format

tableStatusList

List of ComGkSoftwarePosApiServiceHospitalityTableStatus

List of tables in the response.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.529. ComGkSoftwarePosApiServiceHospitalityMoveLineItem

MoveLineItem Entity with information of the line item which should be moved.

Field Name Required Type Description Format

lineItemKey

X

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

toMoveQuantity

X

Integer

The quantity of the line item in source transaction which should be moved to targetTransaction.

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.530. ComGkSoftwarePosApiServiceHospitalityMoveLineItemsRequest

MoveLineItemsRequest Request entity for 'MoveLineItems' service.

Field Name Required Type Description Format

sourceTransactionKey

String

The identifier for the source transaction.

targetTransactionKey

String

The identifier for the target transaction.

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

moveAllLineItems

Boolean

Flag is all line items should be moved.

lineItemList

List of ComGkSoftwarePosApiServiceHospitalityMoveLineItem

List of line items which should be moved.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.531. ComGkSoftwarePosApiServiceHospitalityMoveLineItemsResponse

MoveLineItemsResponse Response entity for 'MoveLineItems' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.532. ComGkSoftwarePosApiServiceHospitalityPosComboMealComponent

PosComboMealComponent Entity for a combo meal item component

Field Name Required Type Description Format

relatedItemAssociationType

com.gk_software.gkr.api.server.md.related_item_association_type.dto.dom.RelatedItemAssociationTypeDO

relatedItems

List of ComGkSoftwarePosApiServiceHospitalityPosRelatedItem

List of related items (standard items)

relatedItemsMaxPrice

Double

The max price of all standard items of the component.

double

alternativeRelatedItems

List of ComGkSoftwarePosApiServiceHospitalityPosRelatedItem

List of alternative related items (alternative items)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.533. ComGkSoftwarePosApiServiceHospitalityPosComboMealItem

PosComboMealItem Entity for the Combo meal item (main item)

Field Name Required Type Description Format

name

String

Name of the combo meal item

relatedComponents

List of ComGkSoftwarePosApiServiceHospitalityPosComboMealComponent

List of components of the combo meal item

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.534. ComGkSoftwarePosApiServiceHospitalityPosCondimentComponent

PosCondimentComponent Entity for a condiment item component

Field Name Required Type Description Format

relatedItemAssociationType

com.gk_software.gkr.api.server.md.related_item_association_type.dto.dom.RelatedItemAssociationTypeDO

relatedItems

List of ComGkSoftwarePosApiServiceHospitalityPosRelatedItem

List of related items.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.535. ComGkSoftwarePosApiServiceHospitalityPosRelatedItem

PosRelatedItem Entity for a related items.

Field Name Required Type Description Format

quantity

X

Integer

The quantity.

int32

itemView

com.gk_software.gkr.api.server.md.item.dto.dom.pos.RelatedItemView

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.536. ComGkSoftwarePosApiServiceHospitalityPreparePrintOrderDataRequest

PreparePrintOrderDataRequest Request entity for 'PreparePrintOrderData' service.

Field Name Required Type Description Format

printOrderConfig

com.gk_software.pos.api.model.config.process.flows.PrintOrderConfig

transaction

com.gk_software.gkr.api.txpool.dto.Transaction

lineItemList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

List of line items to use. The is used as provided, no filter is applied.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.537. ComGkSoftwarePosApiServiceHospitalityPreparePrintOrderDataResponse

PreparePrintOrderDataResponse Response entity for 'PreparePrintOrderData' service.

Field Name Required Type Description Format

printOrderDataList

List of ComGkSoftwarePosApiServiceHospitalityPrintOrderData

The result list contains the collected data that must be printed.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.538. ComGkSoftwarePosApiServiceHospitalityPrintOrderData

PrintOrderData Entity that describes printo order data. One instance consists of configuration plus list of related line items.

Field Name Required Type Description Format

config

com.gk_software.pos.api.model.config.process.flows.MerchandiseHierarchyGroupPrinterAssignmentConfig

courseNumber

String

The course number for the printer report

lineItemList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

List of line items that matches the corresponding configuration.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.539. ComGkSoftwarePosApiServiceHospitalityRecoverTransactionRequest

RecoverTransactionRequest Request entity for 'RecoverTransaction' service.

Field Name Required Type Description Format

tableStatus

com.gk_software.pos.api.service.hospitality.TableStatus

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.540. ComGkSoftwarePosApiServiceHospitalityRecoverTransactionResponse

RecoverTransactionResponse Response entity for 'RecoverTransaction' service.

Field Name Required Type Description Format

transaction

com.gk_software.gkr.api.txpool.dto.Transaction

recoveryAborted

X

Boolean

Indicates whether the recovery was aborted.

tableRelationCleared

X

Boolean

Indicates whether the table relation was cleared.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.541. ComGkSoftwarePosApiServiceHospitalityRegisterCondimentsRequest

RegisterCondimentsRequest The request entity of 'Enter Condiment' service.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

quantityAccumulationEnabled

X

Boolean

Specifies whether quantity accumulation is enabled.

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

relatedComponents

List of ComGkSoftwarePosApiServiceHospitalityPosCondimentComponent

List of components containing the selected condiments that should be registered.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.542. ComGkSoftwarePosApiServiceHospitalityResetToFoodOrderTransactionRequest

ResetToFoodOrderTransactionRequest Request entity for 'ResetToFoodOrderTransaction' service.

Field Name Required Type Description Format

storeTransaction

Boolean

Flag if transaction should be stored after the reset changes (default is true).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.543. ComGkSoftwarePosApiServiceHospitalityResetToFoodOrderTransactionResponse

ResetToFoodOrderTransactionResponse Response entity for 'ResetToFoodOrderTransaction' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.544. ComGkSoftwarePosApiServiceHospitalityTableStatus

TableStatus Entity which represents the status of a table.

Field Name Required Type Description Format

tableName

X

String

Number of the table (e.g. 10 or 10.1)

total

Double

Current total of all open/unpaid line items of the table

double

status

String

Status of the table

Enum: EMPTY, OPEN, IN_PROGRESS,

currentWorkstationId

String

Workstation where the table is currently in progress. Only filled if Status = InProgress

lastTransactionId

String

TransactionId of the last transaction of the table. The 'linked' transaction contains all relevant data of the table

lastTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

lastWorkstationId

String

Workstation of the last modification

tableOwnerId

String

Id of the table owner (opened the table or handover)

tableOwnerFirstName

String

First name of the table owner

tableOwnerLastName

String

Last name of the table owner

checksum

String

Checksum of the transaction

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.545. ComGkSoftwarePosApiServiceLayawayCreateCompleteVoidTransactionRequest

CreateCompleteVoidTransactionRequest The entity CreateCompleteVoidTransactionRequest

Field Name Required Type Description Format

layaway

X

com.gk_software.gkr.api.layaway.dto.LayawaySummary

downPaymentReceiptText

String

The receipt text for DownPayment LineItem.

cancellationFeeReceiptText

String

The receipt text for Fee LineItem.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.546. ComGkSoftwarePosApiServiceLayawayCreateCustomerTransactionRequest

CreateCustomerTransactionRequest The Entity CreateCustomerTransactionRequest

Field Name Required Type Description Format

layaway

X

com.gk_software.gkr.api.layaway.dto.LayawaySummary

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.547. ComGkSoftwarePosApiServiceLayawayCreateLayawayExtendTransactionRequest

CreateLayawayExtendTransactionRequest The entity CreateLayawayExtendTransactionRequest

Field Name Required Type Description Format

layaway

X

com.gk_software.gkr.api.layaway.dto.LayawaySummary

layawayValidDays

X

Integer

Count of valid days.

int32

paymentDays

X

Integer

Count of payment days.

int32

toleranceTime

X

Integer

Time after expiration Layway can shipped.

int32

deletingTime

X

Integer

Time when Layaway will be deleted if expired.

int32

newExpirationDate

X

String

Time when Layaway will be expired. Substitutes defined expiration date on Layaway creation. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.548. ComGkSoftwarePosApiServiceLayawayCreatePartialVoidTransactionRequest

CreatePartialVoidTransactionRequest The entity CreatePartialVoidTransactionRequest.

Field Name Required Type Description Format

layaway

X

com.gk_software.gkr.api.layaway.dto.LayawaySummary

lineItemInfoList

X

List of ComGkSoftwarePosApiServiceLayawayPartialVoidLineItemInfo

List of partial void line item information which holds the selection (quantity) data

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.549. ComGkSoftwarePosApiServiceLayawayCreateRetrieveMoneyTransactionRequest

CreateRetrieveMoneyTransactionRequest The entity CreateRetrieveMoneyTransactionRequest

Field Name Required Type Description Format

layaway

X

com.gk_software.gkr.api.layaway.dto.LayawaySummary

downPaymentReceiptText

String

The receipt text for DownPayment LineItem.

penaltyFeeReceiptText

String

The receipt text for Fee LineItem.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.550. ComGkSoftwarePosApiServiceLayawayDownPaymentAndFeeLineItemRequest

DownPaymentAndFeeLineItemRequest The entity DownPaymentAndFeeLineItemRequest

Field Name Required Type Description Format

downPaymentAmount

X

Double

initial down payment amount has to be paid.

double

serviceFeeAmount

X

Double

Service fee amount has to be paid.

double

serviceFeeReceiptText

X

String

The receipt text for service fee line item.

downPaymentReceiptText

X

String

The receipt text for down payment line item.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.551. ComGkSoftwarePosApiServiceLayawayDownPaymentTransactionRequest

DownPaymentTransactionRequest The entity DownPaymentTransactionRequest

Field Name Required Type Description Format

layaway

X

com.gk_software.gkr.api.layaway.dto.LayawaySummary

createDownpayment

X

Boolean

The parameter defines, if a negative or a positive down payment line item is created.

downPaymentAmount

X

Double

The down payment amount

double

downPaymentReceiptText

X

String

The receipt text for down payment line item.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.552. ComGkSoftwarePosApiServiceLayawayFinalPaymentTransactionRequest

FinalPaymentTransactionRequest The entity FinalPaymentTransactionRequest

Field Name Required Type Description Format

layaway

X

com.gk_software.gkr.api.layaway.dto.LayawaySummary

downPaymentReceiptText

X

String

The receipt text for down payment line item.

promotionHandling

String

The parameter controls the promotion behavior for the final payment of the layaway. Possible values are: BEST_PRICE, INITIAL_PRICE, FINAL_PRICE (Default is BEST_PRICE).

Enum: BEST_PRICE, INITIAL_PRICE, FINAL_PRICE,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.553. ComGkSoftwarePosApiServiceLayawayFindLayawayByCriteriaRequest

FindLayawayByCriteriaRequest The entity FindLayawayByCriteriaRequest

Field Name Required Type Description Format

businessUnitId

String

The criterion which is used to find the layaway summary

workstationId

String

The criterion which is used to find the layaway summary

endWorkstationId

String

aThe criterion which is used to find the layaway summary

businessDayDate

String

The criterion which is used to find the layaway summary Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

sequenceNumber

String

The criterion which is used to find the layaway summary

transactionId

String

The criterion which is used to find the layaway summary

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.554. ComGkSoftwarePosApiServiceLayawayFindLayawayByCriteriaResponse

FindLayawayByCriteriaResponse The entity FindLayawayByCriteriaResponse

Field Name Required Type Description Format

layawaySummary

com.gk_software.gkr.api.layaway.dto.LayawaySummary

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.555. ComGkSoftwarePosApiServiceLayawayFindLayawayListByCriteriaRequest

FindLayawayListByCriteriaRequest The entity FindLayawayListByCriteriaRequest

Field Name Required Type Description Format

businessUnitId

String

The business unit ID which is used to find the layaway summary

suspended

Boolean

Whether to include suspended layaways in the search

terminated

Boolean

Whether to include terminated layaways in the search

fulfilled

Boolean

Whether to include fulfilled layaways in the search

voided

Boolean

Whether to include voided layaways in the search

expired

Boolean

Whether to include expired layaways in the search

customerId

String

The customer ID which is used to find the layaway summary

customerAddressTypeCode

String

The address type code of the customer which is used to find the layaway summary

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.556. ComGkSoftwarePosApiServiceLayawayFindLayawayListByCriteriaResponse

FindLayawayListByCriteriaResponse The entity FindLayawayListByCriteriaResponse

Field Name Required Type Description Format

layawaySummaryList

List of ComGkSoftwareGkrApiLayawayDtoLayawaySummary

All matching layaway data objects holding attributes for layaway process

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.557. ComGkSoftwarePosApiServiceLayawayOpenScopedTxForLayawayRequest

OpenScopedTxForLayawayRequest The entity OpenScopedTxForLayawayRequest

Field Name Required Type Description Format

scope

X

String

The scope which should be used for the scoped transaction.

layaway

X

com.gk_software.gkr.api.layaway.dto.LayawaySummary

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.558. ComGkSoftwarePosApiServiceLayawayPartialVoidLineItemInfo

PartialVoidLineItemInfo The entity for holding information about the original line item from layaway (sequence number) and the selected 'for void' quantity

Field Name Required Type Description Format

lineItemSequenceNumber

X

Integer

Original sequence number of the line item in the layaway

int32

voidQuantity

X

Double

Selected quantity which should be voided vor the line item

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.559. ComGkSoftwarePosApiServiceLayawayPaymentPlanRequest

PaymentPlanRequest Request of a Calculation of Payment Plan

Field Name Required Type Description Format

layawayValidDays

Integer

Count of valid Days.

int32

paymentDays

Integer

Count of payment Days.

int32

toleranceTime

Integer

Time after expiration layway can shipped.

int32

deletingTime

Integer

Time when Layaway will be deleted if expired.

int32

cancellationFeePercent

Double

Fee Percent for cancellation a Layaway.

double

cancellationFeeAmount

Double

Fee Amount for cancellation a Layaway.

double

penaltyFeePercent

Double

penalty fee percent if layway expired or cancelled.

double

penaltyFeeAmount

Double

penalty fee amount if layway expired or cancelled.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.560. ComGkSoftwarePosApiServiceLayawayPaymentPlanResult

PaymentPlanResult empty Result, plan is inside transaction.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.561. ComGkSoftwarePosApiServiceLayawayValidateLayawayRequest

ValidateLayawayRequest The Entity ValidateLayawayRequest

Field Name Required Type Description Format

callingFunction

String

The process from which the validation is called

layawaySummary

com.gk_software.gkr.api.layaway.dto.LayawaySummary

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.562. ComGkSoftwarePosApiServiceLoyaltyTypesCustomerAccount

CustomerAccount The entity CustomerAccount

Field Name Required Type Description Format

accountID

String

String: customer account number.

accountTypeCode

String

String: account type 00 - turnover of current year 01 - discount of current year 02 - points

balance

Double

Double: account balance.

double

accountQueryReturnCode

String

String: return code for the customer account request.

loyaltyProgramID

String

String: loyalty program id.

tierID

String

String: tier id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.563. ComGkSoftwarePosApiServiceLoyaltyTypesCustomerLoyaltyAccountsRequest

CustomerLoyaltyAccountsRequest The entity CustomerLoyaltyAccountsRequest

Field Name Required Type Description Format

cardNumber

String

String: number of the customer card.

customerId

String

String: customer number.

adapter

String

String: defines the loyalty system adapter.

storeID

String

String: store ID.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.564. ComGkSoftwarePosApiServiceLoyaltyTypesCustomerLoyaltyAccountsResponse

CustomerLoyaltyAccountsResponse The entity CustomerLoyaltyAccountsResponse

Field Name Required Type Description Format

customerID

String

String: customer number.

customerAccountsList

List of ComGkSoftwarePosApiServiceLoyaltyTypesCustomerAccount

The list of customer accounts including balances.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.565. ComGkSoftwarePosApiServiceLoyaltyTypesLoyaltyProgramRequest

LoyaltyProgramRequest The entity LoyaltyProgramRequest

Field Name Required Type Description Format

loyaltyProgramID

String

String: loyalty program id.

adapter

String

String: defines the loyalty system adapter.

storeID

String

String: store ID.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.566. ComGkSoftwarePosApiServiceLoyaltyTypesLoyaltyProgramResponse

LoyaltyProgramResponse The entity LoyaltyProgramResponse

Field Name Required Type Description Format

loyaltyProgramID

String

String: loyalty program id.

promotionPointRedemptionFactor

Double

Double: promotion points redemption factor.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.567. ComGkSoftwarePosApiServiceLoyaltyTypesPointsRedemptionRequest

PointsRedemptionRequest The entity PointsRedemptionRequest

Field Name Required Type Description Format

accountID

String

String: account ID.

points

Double

double: points.

double

storeID

String

String: store ID.

transactionID

String

String: transaction ID.

loyaltyProgramID

String

String: loyalty program id.

trainingMode

Boolean

Indicates whether service should be called in training mode.

adapter

String

String: defines the loyalty system adapter.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.568. ComGkSoftwarePosApiServiceLoyaltyTypesPointsRedemptionResponse

PointsRedemptionResponse The entity PointsRedemptionResponse

Field Name Required Type Description Format

transactionID

String

String: transactionID.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.569. ComGkSoftwarePosApiServiceLoyaltyTypesPointsRefundRequest

PointsRefundRequest The entity PointsRefundRequest

Field Name Required Type Description Format

accountID

String

String: account ID.

points

Double

double: points.

double

storeID

String

String: store ID.

transactionID

String

String: transaction ID.

loyaltyProgramID

String

String: loyalty program id.

trainingMode

Boolean

Indicates whether service should be called in training mode.

redemptionTransactionID

String

String: transaction id of the redemption that should be refunded.

adapter

String

String: defines the loyalty system adapter.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.570. ComGkSoftwarePosApiServiceLoyaltyTypesPointsRefundResponse

PointsRefundResponse The entity PointsRefundResponse

Field Name Required Type Description Format

transactionID

String

String: transactionID.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.571. ComGkSoftwarePosApiServiceLoyaltyTypesPointsRequest

PointsRequest The entity PointsRequest

Field Name Required Type Description Format

accountID

String

String: account ID.

points

Double

double: points.

double

storeID

String

String: store ID.

transactionID

String

String: transaction ID.

loyaltyProgramID

String

String: loyalty program id.

trainingMode

Boolean

Indicates whether service should be called in training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.572. ComGkSoftwarePosApiServiceMasterdataBaseClientMasterDataRequest

BaseClientMasterDataRequest String: business unit iD BusinessUnitTextRequest: BusinessUnitTextRequest

Field Name Required Type Description Format

businessUnitId

String

businessUnitTextFooterLinesRequest

com.gk_software.pos.api.service.masterdata.BusinessUnitTextRequest

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.573. ComGkSoftwarePosApiServiceMasterdataBaseClientMasterDataResult

BaseClientMasterDataResult TODO: undocumented

Field Name Required Type Description Format

tenderDOs

List of ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

baseCurrency

com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO

currencies

List of ComGkSoftwareGkrApiServerMdCurrencyDtoDomCurrencyDO

availableCurrencyCodes

List of [String]

exchangeRates

Map of ComGkSoftwareGkrApiServerMdExchangeRateDtoDomExchangeRateDO

businessUnitTextFooterLines

List of ComGkSoftwareGkrApiServerMdBusinessUnitTextDtoDomBusinessUnitTextDO

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.574. ComGkSoftwarePosApiServiceMasterdataBusinessUnitTextRequest

BusinessUnitTextRequest Request object used by MasterDataService

Field Name Required Type Description Format

businessUnitID

String

String: business unit iD

receiptTextID

String

String: receipt text iD

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.575. ComGkSoftwarePosApiServiceMasterdataBusinessUnitTextResponse

BusinessUnitTextResponse Result object used by MasterDataService

Field Name Required Type Description Format

businessUnitTextList

List of ComGkSoftwareGkrApiServerMdBusinessUnitTextDtoDomBusinessUnitTextDO

List of BusinessUnitTextDO: businessUnitTextDOs

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.576. ComGkSoftwarePosApiServiceMasterdataCurrencyRoundingRuleRequest

CurrencyRoundingRuleRequest Request object used by MasterDataService

Field Name Required Type Description Format

businessUnitGroupId

String

long: business unit group id

isoCurrencyCode

String

String: iso currency code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.577. ComGkSoftwarePosApiServiceMasterdataCustomerContactViewRequest

CustomerContactViewRequest Request object used by MasterDataService

Field Name Required Type Description Format

customerContactFilter

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerContactFilter

maxResultsCount

X

Integer

int: max results count

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.578. ComGkSoftwarePosApiServiceMasterdataCustomerContactViewResult

CustomerContactViewResult Result object used by MasterDataService

Field Name Required Type Description Format

customerContactViews

List of ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerContactView

List of CustomerContactView: customerContactViews

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.579. ComGkSoftwarePosApiServiceMasterdataCustomerResult

CustomerResult Result object used by MasterDataService

Field Name Required Type Description Format

customerDOs

List of ComGkSoftwareGkrApiServerMdCustomerDtoDomCustomerDO

List of CustomerDO: customerDOs

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.580. ComGkSoftwarePosApiServiceMasterdataDenominationRequest

DenominationRequest Request object used by MasterDataService

Field Name Required Type Description Format

denominationTypeCode

String

String: denomination type code

currencyCode

String

String: currency code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.581. ComGkSoftwarePosApiServiceMasterdataDenominationResult

DenominationResult Result object used by MasterDataService

Field Name Required Type Description Format

denominationDOs

List of ComGkSoftwareGkrApiServerMdDenominationDtoDomDenominationDO

List of DenominationDO: denominationDOs

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.582. ComGkSoftwarePosApiServiceMasterdataItemBlItemSearchRequest

ItemSearchRequest Request object for searching specified item.

Field Name Required Type Description Format

businessUnitGroupId

X

String

long: The unique identifier of the business unit group (store number).

filter

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemSearchFilter

recordCount

X

Integer

int: Limits the search by number

int32

packageSelection

X

Boolean

boolean: It specifies whether search is limited to package items only.

requiredUomCode

String

String: It defines the required unit of measure code of the displayed package units.

skipEnteredItem

X

Boolean

boolean: Specifies whether the entered item is excluded from the selection.

textClassId

String

String: Specifies the text class Id.

cacheEnabled

X

Boolean

boolean: Specifies, whether the item search results should be cached globally (until replication data changes) in case global master data caching is activated via configuration. (check GlobalMasterDataCacheServiceConfig.cacheSize)

itemName

String

String: Specifies the text itemName.

itemId

String

String: Specifies the itemId.

itemMerchandiseHierarchyGroup

String

String: Specifies the itemMerchandiseHierarchyGroup.

itemUomCode

String

String: Specifies the itemUomCode.

itemNormalPrice

String

String: Specifies the itemNormalPrice.

setsOnly

Boolean

boolean: Specifies the setsOnly flag.

itemColor

String

String: Specifies the itemColor.

itemSize

String

String: Specifies the itemSize.

itemLength

String

String: Specifies the itemLength.

itemSeason

String

String: Specifies the itemSeason.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.583. ComGkSoftwarePosApiServiceMasterdataItemInformationStockInfoRequest

InformationStockInfoRequest Request object for requesting stock details for specified item.

Field Name Required Type Description Format

posItemIds

List of [String]

The pos item id.

buId

String

The business unit id (retail store id)

skipMasterDataResolution

Boolean

Specifies whether master data should be resolved or not. If it is set to false the related attributes in the reponse will be empty (item name, uom code, …​)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.584. ComGkSoftwarePosApiServiceMasterdataItemItemInformationLoadConfig

ItemInformationLoadConfig Config that defines what item info needs to be loaded.

Field Name Required Type Description Format

itemInformation

com.gk_software.pos.api.model.dom.app.ItemInformation.ItemInformation

loadItemInfo

Boolean

Defines whether general item info should be loaded.

loadStockInfo

Boolean

Defines whether stock info should be loaded.

loadAdditionalInfo

Boolean

Defines whether additional item info should be loaded.

loadVariants

Boolean

Defines whether item variants should be loaded.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.585. ComGkSoftwarePosApiServiceMasterdataItemItemInformationRequest

ItemInformationRequest Request object for item information

Field Name Required Type Description Format

posItemId

String

String: pos item id

additionalTextInfoTextTypeCodes

List of [String]

List String: additional text info text type codes

systemLanguage

String

String: system language

discountInfoEnabled

Boolean

It defines if the discount info should be displayed in transaction preview.

itemInfoEnabled

Boolean

It defines if the item info should be displayed in transaction preview.

iconSalesInfoTextTypeCodes

List of [String]

It defines a list of text type codes that should be displayed as icon sales info.

buId

String

the clients current buId

displayPromotionPrices

X

Boolean

Specifies that promotion prices should be calculated for the item. It is calculated based on actual basket.

displayGroupPrice

Boolean

It specifies whether the group price is additionally displayed if a single item price is valid.

itemIDCaseSensitive

X

Boolean

Specifies treating of posItemID for item look-up. If true then is checked the posItemID in case sensitive mode.

requestStock

X

Boolean

Specifies if item stock information should be requested from stock information system. Default value is true.

price

Double

It defines the unit price which should be used for the price calculation.

double

priceQuantity

Integer

It defines the unit price quantity which should be used for the price calculation (i.e. '3 for $1.00').

int32

quantity

Integer

It defines the quantity of the item.

int32

unit

Double

It defines the units of the item.

double

itemInformationLoadConfig

com.gk_software.pos.api.service.masterdata.item.ItemInformationLoadConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.586. ComGkSoftwarePosApiServiceMasterdataItemItemInformationStockInfoRequest

ItemInformationStockInfoRequest Request object for requesting stock details for specified item.

Field Name Required Type Description Format

posItemId

String

The pos item id.

buId

String

The business unit id (retail store id)

skipMasterDataResolution

Boolean

Specifies whether master data should be resolved or not. If it is set to false the related attributes in the reponse will be empty (item name, uom code, …​)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.587. ComGkSoftwarePosApiServiceMasterdataItemLoadItemDOByKeyRequest

LoadItemDOByKeyRequest Request object for loading item master data for specified POS UOM itemDO key.

Field Name Required Type Description Format

itemKey

com.gk_software.pos.api.model.dom.app.services.transaction.PosUOMItemDoKey

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.588. ComGkSoftwarePosApiServiceMasterdataItemSimplePosUomItemDO

SimplePosUomItemDO Data object SimplePosUomItemDO - Bean class for performant item operations

Field Name Required Type Description Format

mainPosItemId

String

String: main pos item id

posUOMItemPosIdentityTypeCode

String

String: pos UOM item pos identity type code

itemUOMCode

String

String: item UOM code

itemSellingRuleQuantityInputMethod

String

String: item selling rule quantity input method

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.589. ComGkSoftwarePosApiServiceMasterdataMHGroupRequest

MHGroupRequest Request object used by MasterDataService

Field Name Required Type Description Format

businessUntiGroupId

String

long: business unit group id

merchandiseHierarchyGroupId

String

String: merchandise hierarchy group id

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.590. ComGkSoftwarePosApiServiceMasterdataMHGroupResult

MHGroupResult Result object used by MasterDataService

Field Name Required Type Description Format

mhgSOs

List of ComGkSoftwareSweeSesApiServerMdMhgDtoSoMhgSO

List of MhgSO: mhgDOs

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.591. ComGkSoftwarePosApiServiceMasterdataPromotionItemRequest

PromotionItemRequest Request object used by MasterDataService

Field Name Required Type Description Format

businessUnitGroupId

String

long: business unit group id

promotionItemFilter

com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionItemFilterSO

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.592. ComGkSoftwarePosApiServiceMasterdataReasonResult

ReasonResult Result object used by MasterDataService

Field Name Required Type Description Format

reasonGroup

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonCodeGroupSO

reasons

List of ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonSO

List of ReasonSO: reasons

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.593. ComGkSoftwarePosApiServiceMasterdataScaleDomainRequest

ScaleDomainRequest Request object used by MasterDataService

Field Name Required Type Description Format

businessUnitGroupId

String

long: business unit group id

scaleDomainId

String

String: scale domain id

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.594. ComGkSoftwarePosApiServiceMasterdataScaleDomainResult

ScaleDomainResult Result object used by MasterDataService

Field Name Required Type Description Format

scaleDomainDO

com.gk_software.gkr.api.server.md.scale_domain.dto.dom.ScaleDomainDO

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.595. ComGkSoftwarePosApiServiceMasterdataSimpleTaxListResult

SimpleTaxListResult Result object used by MasterDataService

Field Name Required Type Description Format

simpleTaxList

Map of [Double]

Map with taxGroupId as key and the tax percent as value.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.596. ComGkSoftwarePosApiServiceMasterdataTenderAdjustmentRuleRequest

TenderAdjustmentRuleRequest Request object used by MasterDataService

Field Name Required Type Description Format

originalTenderTypeCode

String

originalTenderTypeCode

newTenderTypeCode

String

newTenderTypeCode

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.597. ComGkSoftwarePosApiServiceMasterdataTenderAdjustmentRuleResult

TenderAdjustmentRuleResult Result object used by MasterDataService

Field Name Required Type Description Format

tenderAdjustmentRuleDOs

List of ComGkSoftwareGkrApiServerMdTenderRuleDtoDomTenderAdjustmentRuleDO

List of TenderAdjustmentRuleDO: tenderAdjustmentRuleDOs

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.598. ComGkSoftwarePosApiServiceMasterdataTenderRequest

TenderRequest Request object for the MasterDataService

Field Name Required Type Description Format

businessUnitGroupId

String

long: business unit group id

reasonCode

String

String: reason code

reasonCodeGroupCode

String

String: reason code group code

isoCurrencyCode

String

String: iso currency code

tenderClassCode

String

String: tender class code

tenderGroupCode

String

TenderGroupCode: tender group code

Enum: CASH, TERMINAL, GIFT_CERT, COUPON, CHEQUE, CREDIT, PROMOTION, POINTS, CASHENGINE,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.599. ComGkSoftwarePosApiServiceMasterdataTenderResult

TenderResult Result object used by MasterDataService

Field Name Required Type Description Format

tenderDOs

List of ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

List of TenderDO: tenderDOs

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.600. ComGkSoftwarePosApiServiceMasterdataWorkerRequest

WorkerRequest Request object used by MasterDataService

Field Name Required Type Description Format

businessUnitGroupId

String

long: business unit group id

workerId

String

String: worker id

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.601. ComGkSoftwarePosApiServicePaymentAddTerminalPrintoutsToLineItemRequest

AddTerminalPrintoutsToLineItemRequest Request object to add terminal receipts that were printed to retail transaction line item as binary.

Field Name Required Type Description Format

tenderLineItem

X

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem

merchantReceipt

String

The merchant terminal receipt.

customerReceipt

String

The customer terminal receipt.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.602. ComGkSoftwarePosApiServicePaymentAmountValidationRequest

AmountValidationRequest A request wrapper for all informations required to validate and check a payment amount

Field Name Required Type Description Format

amount

X

Double

double : amount

double

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

isoCurrencyCode

String

String : iso currency code

currentTenderTotalPaymentAmount

X

Double

double : current tender total payment amount

double

paymentState

String

String : payment state

allowedAmountTypeCode

String

String : allowed amount type code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.603. ComGkSoftwarePosApiServicePaymentAmountValidationResult

AmountValidationResult A result wrapper for all informations after a validation and check of a payment amount

Field Name Required Type Description Format

isOkay

X

Boolean

boolean : is okay

isAmountInvalid

X

Boolean

boolean : is amount invalid

isAmountTooHigh

X

Boolean

boolean : is amount too high

isAmountTooSmall

X

Boolean

boolean : is amount too small

isAmountMinimumLimitExceeded

X

Boolean

boolean : is amount minimum limit exceeded

isAmountMaximumLimitExceeded

X

Boolean

boolean : is amount maximum limit exceeded

amountLimit

X

Double

double : amount limit

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.604. ComGkSoftwarePosApiServicePaymentCashPaymentRequest

CashPaymentRequest Request object used by cash payment operations.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

tipAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

baseIsoCurrencyCode

String

String: base iso currency code

foreignIsoCurrencyCode

String

String: foreign iso currency code

exchangeRate

X

Double

double: exchange rate

double

multiplyFlag

X

Boolean

boolean: multiply flag

tenderClassCode

String

String : tender class code

paymentDescription

String

String : payment description

keyedOnline

Boolean

tenderExchangeState

String

changeNotAllowedFlag

Boolean

boolean : change not allowed flag

changeAmountPaid

Boolean

flag to indicate whether the change amount was already paid (e.g. by cash recycler)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.605. ComGkSoftwarePosApiServicePaymentCheckPaymentRequest

CheckPaymentRequest Request object used by check payment operations.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

tipAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

baseIsoCurrencyCode

String

String: base iso currency code

foreignIsoCurrencyCode

String

String: foreign iso currency code

exchangeRate

X

Double

double: exchange rate

double

multiplyFlag

X

Boolean

boolean: multiply flag

tenderClassCode

String

String : tender class code

paymentDescription

String

String : payment description

keyedOnline

Boolean

tenderExchangeState

String

changeNotAllowedFlag

Boolean

boolean : change not allowed flag

success

X

Boolean

success

fullMicrData

String

fullMicrData

checkSequenceNumber

String

checkSequenceNumber

adjudicationCode

String

adjudicationCode

bankId

String

bankId

checkAccountNumber

String

checkAccountNumber

merchantPrintCache

String

merchantPrintCache

customerPrintCache

String

customerPrintCache

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.606. ComGkSoftwarePosApiServicePaymentCreditPaymentRequest

CreditPaymentRequest Request object used by credit payment operations.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

tipAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

baseIsoCurrencyCode

String

String: base iso currency code

foreignIsoCurrencyCode

String

String: foreign iso currency code

exchangeRate

X

Double

double: exchange rate

double

multiplyFlag

X

Boolean

boolean: multiply flag

tenderClassCode

String

String : tender class code

paymentDescription

String

String : payment description

keyedOnline

Boolean

tenderExchangeState

String

changeNotAllowedFlag

Boolean

boolean : change not allowed flag

documentNumber

String

long : document number

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.607. ComGkSoftwarePosApiServicePaymentFilterPerTenderRequest

FilterPerTenderRequest Request object used by PaymentService

Field Name Required Type Description Format

wicMode

X

Boolean

boolean : wic mode

baseCurrencyTotalPaymentAmount

X

Double

double : base currency total payment amount

double

baseCurrencyRemainingPaymentAmount

X

Double

double : base currency remaining payment amount

double

allowedTender

List of ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

List of TenderDO : allowed tender

forbiddenTender

List of ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

List of TenderDO : forbidden tender

allowedTendersConfig

com.gk_software.pos.api.model.config.process.flows.AllowedTendersConfig

lastTender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

lastTenderAmount

Double

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.608. ComGkSoftwarePosApiServicePaymentGiftCertificatePaymentRequest

GiftCertificatePaymentRequest A data structure holding all necessary parameters for creation of gift certificate tender line item.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

tipAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

baseIsoCurrencyCode

String

String: base iso currency code

foreignIsoCurrencyCode

String

String: foreign iso currency code

exchangeRate

X

Double

double: exchange rate

double

multiplyFlag

X

Boolean

boolean: multiply flag

tenderClassCode

String

String : tender class code

paymentDescription

String

String : payment description

keyedOnline

Boolean

tenderExchangeState

String

changeNotAllowedFlag

Boolean

boolean : change not allowed flag

gcNumber

String

String : gc number

gcType

String

String : gc type

gcsUsage

X

Boolean

boolean : gcs usage

bookingSuccessful

X

Boolean

boolean : booking successful

enableGiftCertificateChange

X

Boolean

boolean : enableGiftCertificateChange, default = false. It defines if a Paper Gift Certificate should be printed if the conditions match.

gcsTransactionUuid

String

String : gcs transaction uuid

externalSystemAdapterName

String

String : external system adapter name

remainingBalance

com.gk_software.pos.api.model.dom.app.amount.Amount

gcQuantity

Integer

int : gc quantity

int32

expiryDate

String

Date : gc expiration date Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

gcTrack2

String

String : Track two of the giftcard.

additionalInfo

List of ComGkSoftwarePosApiModelDomAppGiftCertificateServiceAttributeValue

List of additional attributes for gift certificates with a name and a value.

entryMethodCode

String

String : The current entry method code.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.609. ComGkSoftwarePosApiServicePaymentGiftCertificateSpvPaymentRequest

GiftCertificateSpvPaymentRequest A data structure holding all necessary parameters for creation of single purpose voucher sale return line item.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

tipAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

baseIsoCurrencyCode

String

String: base iso currency code

foreignIsoCurrencyCode

String

String: foreign iso currency code

exchangeRate

X

Double

double: exchange rate

double

multiplyFlag

X

Boolean

boolean: multiply flag

tenderClassCode

String

String : tender class code

paymentDescription

String

String : payment description

keyedOnline

Boolean

tenderExchangeState

String

changeNotAllowedFlag

Boolean

boolean : change not allowed flag

gcNumber

String

String : gc number

gcType

String

String : gc type

gcsUsage

X

Boolean

boolean : gcs usage

bookingSuccessful

X

Boolean

boolean : booking successful

enableGiftCertificateChange

X

Boolean

boolean : enableGiftCertificateChange, default = false. It defines if a Paper Gift Certificate should be printed if the conditions match.

gcsTransactionUuid

String

String : gcs transaction uuid

externalSystemAdapterName

String

String : external system adapter name

remainingBalance

com.gk_software.pos.api.model.dom.app.amount.Amount

gcQuantity

Integer

int : gc quantity

int32

expiryDate

String

Date : gc expiration date Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

gcTrack2

String

String : Track two of the giftcard.

additionalInfo

List of ComGkSoftwarePosApiModelDomAppGiftCertificateServiceAttributeValue

List of additional attributes for gift certificates with a name and a value.

entryMethodCode

String

String : The current entry method code.

gcItem

String

It defines the gift certificate item (e.g. for Single Purpose Vouchers). If filled then it will be used for sale return line item creation.

returnedAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.610. ComGkSoftwarePosApiServicePaymentPayableAmountResult

PayableAmountResult Result object of the PaymentService

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

changeAmount

X

Double

double : change amount

double

foreignCurrencyChangeAmount

X

Double

double : foreign currency change amount

double

grandTotalAmount

X

Double

double : grand total amount

double

foreignCurrencyGrandTotalAmount

X

Double

double : foreign currency grand total amount

double

payedAmount

X

Double

double : payed amount

double

foreignCurrencyPayedAmount

X

Double

double : foreign currency payed amount

double

tipAmount

X

Double

Amount: tip amount

double

baseCurrencyTenderPayableAmount

X

Double

double : base currency tender payable amount

double

foreignCurrencyTenderPayableAmount

X

Double

double : foreign currency tender payable amount

double

mghTenderPermissionRulesChecked

X

Boolean

boolean : mgh tender permission rules checked

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.611. ComGkSoftwarePosApiServicePaymentPaymentAmountsResult

PaymentAmountsResult Result object of the PaymentService

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

changeAmount

X

Double

double : change amount

double

foreignCurrencyChangeAmount

X

Double

double : foreign currency change amount

double

grandTotalAmount

X

Double

double : grand total amount

double

foreignCurrencyGrandTotalAmount

X

Double

double : foreign currency grand total amount

double

payedAmount

X

Double

double : payed amount

double

foreignCurrencyPayedAmount

X

Double

double : foreign currency payed amount

double

tipAmount

X

Double

Amount: tip amount

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.612. ComGkSoftwarePosApiServicePaymentPaymentRequest

PaymentRequest Basic request data structure for payment operation done on server. It is used mainly for tender line item creation. If you need to send some additional data for the operation, you should extend this request object

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

tipAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

baseIsoCurrencyCode

String

String: base iso currency code

foreignIsoCurrencyCode

String

String: foreign iso currency code

exchangeRate

X

Double

double: exchange rate

double

multiplyFlag

X

Boolean

boolean: multiply flag

tenderClassCode

String

String : tender class code

paymentDescription

String

String : payment description

keyedOnline

Boolean

tenderExchangeState

String

changeNotAllowedFlag

Boolean

boolean : change not allowed flag

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.613. ComGkSoftwarePosApiServicePaymentPaymentResult

PaymentResult Result object of the PaymentService

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

changeAmount

X

Double

double : change amount

double

foreignCurrencyChangeAmount

X

Double

double : foreign currency change amount

double

grandTotalAmount

X

Double

double : grand total amount

double

foreignCurrencyGrandTotalAmount

X

Double

double : foreign currency grand total amount

double

payedAmount

X

Double

double : payed amount

double

foreignCurrencyPayedAmount

X

Double

double : foreign currency payed amount

double

tipAmount

X

Double

Amount: tip amount

double

transactionPayed

X

Boolean

boolean : transaction payed

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.614. ComGkSoftwarePosApiServicePaymentPointsPaymentRequest

PointsPaymentRequest Request object used by points payment operations.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

tipAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

baseIsoCurrencyCode

String

String: base iso currency code

foreignIsoCurrencyCode

String

String: foreign iso currency code

exchangeRate

X

Double

double: exchange rate

double

multiplyFlag

X

Boolean

boolean: multiply flag

tenderClassCode

String

String : tender class code

paymentDescription

String

String : payment description

keyedOnline

Boolean

tenderExchangeState

String

changeNotAllowedFlag

Boolean

boolean : change not allowed flag

customerAccountId

String

String : customer account id

redemptionTransactionId

String

String : redemption transaction id

pointsRedemptionConversionFactor

Double

double : points redemption conversion factor

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.615. ComGkSoftwarePosApiServicePaymentReduceTaxableAmountRequest

ReduceTaxableAmountRequest Request object to reduce the taxable amount for the transaction.

Field Name Required Type Description Format

amount

X

Double

Tender amount applied to use when reducing taxable amounts.

double

ewicBasketResults

List of ComGkSoftwarePosApiServiceEwicEwicBasketResult

Selected eWIC items to apply benefits to.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.616. ComGkSoftwarePosApiServicePaymentSpecialReturnAmountLookupKeyRequest

SpecialReturnAmountLookupKeyRequest Request object to obtain a special return amount lookup key. Request must contain either the tender or both tenderTypeCode and itemRestrictionTypeCode.

Field Name Required Type Description Format

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

tenderTypeCode

String

String : tender type code to use to generate lookup key. Required if tender is null. If specified when tender is not null, this tender type code and the Tender’s item restriction typecode will be used to generate the lookup key.

itemRestrictionTypeCode

String

String : item restriction type code to use to generate lookup key. Optional; null should be passed in if not relevant. Only used if tender is null.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.617. ComGkSoftwarePosApiServicePaymentTerminalPaymentRequest

TerminalPaymentRequest Request object used by terminal payment operations.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

tender

com.gk_software.gkr.api.server.md.tender.dto.dom.TenderDO

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

tipAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

baseIsoCurrencyCode

String

String: base iso currency code

foreignIsoCurrencyCode

String

String: foreign iso currency code

exchangeRate

X

Double

double: exchange rate

double

multiplyFlag

X

Boolean

boolean: multiply flag

tenderClassCode

String

String : tender class code

paymentDescription

String

String : payment description

keyedOnline

Boolean

tenderExchangeState

String

changeNotAllowedFlag

Boolean

boolean : change not allowed flag

success

X

Boolean

boolean : success

autoCancellation

X

Boolean

boolean : auto cancellation

cancellation

X

Boolean

boolean : cancellation

cardType

String

String : card type

cardIssuerCode

String

String : card issue code

accountNumber

String

String : account number

cardEntryMethodCode

String

String : card entry method code

cashbackAmount

Double

double: cashbackAmount

double

entrySourceCode

String

String : entry source code

personalIDRequiredTypeCode

String

String : personal iD required type code

personalIDReferenceNumber

Integer

int : personal iD reference number

int32

authorizationMethodCode

String

String : authorization method code

adjudicationCode

String

String : adjudication code

cardExpirationDate

String

String : card expiration date

cardHolderName

String

String : card holder name

cardIssueSequenceNumber

String

String : card Issue sequence number

cardStartDate

String

String : card start date

serviceCode

String

String : service code

terminalTransactionID

String

String : terminal transaction iD

terminalID

String

String : terminal iD

terminalTransactionStatus

Integer

int : terminal transaction status

int32

terminalTransactionResult

String

String : terminal transaction status

terminalTransactionTypeCode

String

TerminalTransactionTypeCode: terminal transaction type code

Enum: Offline, Online,

cardNumber

String

String : card number

merchantPrintCache

String

String : merchant print cache

customerPrintCache

String

String : customer print cache

approvalCode

String

String : approval code

terminalType

String

String : terminal type

merchantNumber

String

String : merchant number

isoCurrencyNumber

String

String : iso currency number

currentDate

String

Date : current date Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

transactionStatus

Integer

int : transaction status

int32

forceOffline

Boolean

boolean : force offline

cardHolderVerificationTypeCode

String

String : card holder verification type code

hostAuthorizedFlag

Boolean

boolean : host authorized flag

traceNumber

Integer

int : trace number

int32

terminalTransactionErrorNumber

Integer

int : terminal transaction error number

int32

adjuctionText

String

String : adjuction text

currentTenderAuthorizationKey

com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey

recoveryValues

com.gk_software.pos.flow.libs.payment.TerminalTransactionRecoveryValues

requestType

String

Enum: CREATE_TENDER_AUTHORIZATION, REMOVE_RECOVERY_DATA, REGISTER_TERMINAL_PAYMENT, UPDATE_AFTER_IMMEDIATE_VOIDING, UPDATE_TO_INTERMEDIATE_RESULT, UPDATE_TO_FINAL_RESULT, UPDATE_TRANSACTION_STATE_ONLY, CUSTOM_01, CUSTOM_02, CUSTOM_03, CUSTOM_04, CUSTOM_05, CUSTOM_06, CUSTOM_07, CUSTOM_08, CUSTOM_09, CUSTOM_10,

origTenderAuthorizationNumber

Integer

int32

voidingLineItemSequenceNumber

Integer

int32

terminalReferenceNumber

String

String : terminal Reference Number

token

String

String : token that comes back from USA Payment servers. Used with T+

signatureFormat

String

String : format of the signature data ex. png, bmp

signatureData

String

String : signature data

internationalBankAccountNumber

String

bankIdentifierCode

String

creditorID

String

mandateID

String

prenotificationText

String

terminalTenderDescription

String

Tender description.

applicationID

String

Application identifier

encryptedPAN

String

Masked application PAN.

terminalTransactionCurrencyCode

String

Currency key (default 978).

purchaseRestriction

String

String : purchase restriction if any exists.

gradeRestriction

String

String : grade restriction value if any exists.

processMode

String

The mode of the payment (PAYMENT, CREDIT, VOIDING, RECOVERY).

storeTerminalReceipt

Boolean

Enables / disables the storing of terminal receipt data inside the tender line item of the transaction.

  • SHOULD ONLY BE SET FOR CERTIFIED TERMINALS!'.

isRecovery

Boolean

The flag used in TerminalPayment process to indicate that it is called from recovery.

terminalVendorName

String

Contains the name of the terminal vendor, e.g. for Adyen terminals 'AdyenWebService'. This value is obtained from the terminal implementation itself.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.618. ComGkSoftwarePosApiServicePosFrontendServiceCustomerLoyaltyAccount

CustomerLoyaltyAccount The entity CustomerLoyaltyAccount

Field Name Required Type Description Format

loyaltyProgramId

String

String: loyalty program id.

customerLoyaltyAccountId

String

String: customer loyalty account id.

balance

Double

Double: account balance.

double

accountTypeCode

String

String: account type 00 - turnover of current year 01 - discount of current year 02 - points

accountQueryReturnCode

String

String: return code for the customer account request.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.619. ComGkSoftwarePosApiServicePosFrontendServiceCustomerLoyaltyAccountsRequest

CustomerLoyaltyAccountsRequest The entity CustomerLoyaltyAccountsRequest

Field Name Required Type Description Format

customerId

String

String: customer id.

cardNumber

String

String: number of the customer card.

storeId

String

String: store id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.620. ComGkSoftwarePosApiServicePosFrontendServiceCustomerLoyaltyAccountsResponse

CustomerLoyaltyAccountsResponse The entity CustomerLoyaltyAccountsResponse

Field Name Required Type Description Format

customerId

String

String: customer id.

loyaltyAccounts

List of ComGkSoftwarePosApiServicePosFrontendServiceCustomerLoyaltyAccount

The list of loyalty accounts.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.621. ComGkSoftwarePosApiServicePosFrontendServiceExtendedCustomerLoyaltyAccount

ExtendedCustomerLoyaltyAccount The entity ExtendedCustomerLoyaltyAccount

Field Name Required Type Description Format

loyaltyProgramId

String

String: loyalty program id.

customerLoyaltyAccountId

String

String: customer loyalty account id.

balance

Double

Double: account balance.

double

accountTypeCode

String

String: account type 00 - turnover of current year 01 - discount of current year 02 - points

accountQueryReturnCode

String

String: return code for the customer account request.

loyaltyPromotions

List of ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionSO

The list of the loyalty promotions.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.622. ComGkSoftwarePosApiServicePosFrontendServiceLoyaltyProgramRequest

LoyaltyProgramRequest The entity LoyaltyProgramRequest

Field Name Required Type Description Format

loyaltyProgramId

String

String: loyalty program id.

storeId

String

String: store id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.623. ComGkSoftwarePosApiServicePosFrontendServiceLoyaltyProgramResponse

LoyaltyProgramResponse The entity LoyaltyProgramResponse

Field Name Required Type Description Format

loyaltyProgramId

String

String: loyalty program id.

pointRedemptionFactor

Double

String: point redemption factor.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.624. ComGkSoftwarePosApiServicePosFrontendServiceRedeemPointsRequest

RedeemPointsRequest The entity RedeemPointsRequest

Field Name Required Type Description Format

transactionId

String

String: transaction id.

customerAccountId

String

String: customer account id .

loyaltyProgramId

String

String: loyalty program id.

pointsCount

X

Double

double: points count.

double

storeId

String

String: store id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.625. ComGkSoftwarePosApiServicePosFrontendServiceStartCustomerSessionRequest

StartCustomerSessionRequest The entity StartCustomerSessionRequest

Field Name Required Type Description Format

businessUnitId

String

String: business unit id.

couponBookingId

String

String: coupon booking id.

customerId

String

String: customer id.

pointsCalculationMode

String

It defines the mode to calculate points.

  • LOCAL - Points are calculated real time by local PCE.

  • CENTRAL - Points are calculated during payment end by Points Calculation Service.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.626. ComGkSoftwarePosApiServicePosFrontendServiceStartCustomerSessionResponse

StartCustomerSessionResponse The entity StartCustomerSessionResponse

Field Name Required Type Description Format

loyaltyStatus

String

String: loyalty status.

couponingStatus

String

String: couponing status.

loyaltyAccounts

List of ComGkSoftwarePosApiServicePosFrontendServiceExtendedCustomerLoyaltyAccount

The list of the loyalty accounts.

coupons

List of ComGkSoftwarePosFlowLibsCouponCouponSummary

The list of the coupons.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.627. ComGkSoftwarePosApiServicePosFrontendServiceVoidPointsRedemptionRequest

VoidPointsRedemptionRequest The entity VoidPointsRedemptionRequest

Field Name Required Type Description Format

transactionId

String

String: transaction id.

redemptionTransactionId

String

String: redemption transaction id.

customerAccountId

String

String: customer account id .

loyaltyProgramId

String

String: loyalty program id.

pointsCount

X

Double

double: points count.

double

storeId

String

String: store id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.628. ComGkSoftwarePosApiServicePromotionLoyaltyRewardGiftCertificateRequest

LoyaltyRewardGiftCertificateRequest Request object for the gift certificate loyalty reward process.

Field Name Required Type Description Format

externalSystemAdapterName

String

String : external system adapter name

giftCertificateServerUse

Boolean

boolean : gift certificate server use

giftCertificatePrefix

String

String : gift certificate prefix

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.629. ComGkSoftwarePosApiServicePromotionPromotionRequest

PromotionRequest Request object for a promotion trigger process.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

promotionOperationConfig

com.gk_software.pos.api.model.config.process.action.PromotionOperationConfig

reason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

reference

String

An additional information concerning the promotion trigger (see {@link com.gk_software.gkr.api.txpool.dto.SaleReturnLineItemPromotionTrigger#reference_}).

promotionValue

X

Double

The promotion value. The meaning of this field depends on the privilege type present in the promotion configuration (promotionOperationConfig) as following:

  • PromotionTriggerPrivilegeType equals to 'RP': promotion percentage value.

  • PromotionTriggerPrivilegeType equals to 'PS': new unit price.

  • PromotionTriggerPrivilegeType equals to 'AM': rebate total amount.

  • PromotionTriggerPrivilegeType equals to 'RS': rebate amount for item unit.

double

checkIfRebateWasApplied

X

Boolean

This parameter specifies whether a condition which relates to a trigger will be checked.

maximumQuantity

Double

This parameter defines the maximal line item quantity when a promotion trigger is allowed.

double

activeCustomerOrderId

String

The active customer order id in the client context, if any is available.

customerSequenceNumber

Integer

A unique system assigned identifier for the LineItem of the CustomerOrder. That means, the sequence number of an active customer order.

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.630. ComGkSoftwarePosApiServicePromotionPromotionTriggerValidationRequest

PromotionTriggerValidationRequest Request object for validating line item promotion triggers.

Field Name Required Type Description Format

promotionOperationConfig

com.gk_software.pos.api.model.config.process.action.PromotionOperationConfig

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

promotionValue

X

Double

The promotion value. The meaning of this field depends on the privilege type present in the promotion configuration (promotionOperationConfig) as following:

  • PromotionTriggerPrivilegeType equals to 'RP': promotion percentage value.

  • PromotionTriggerPrivilegeType equals to 'PS': new unit price.

  • PromotionTriggerPrivilegeType equals to 'AM': rebate total amount.

  • PromotionTriggerPrivilegeType equals to 'RS': rebate amount for item unit.

double

validationMode

X

Boolean

Attribute currently not used.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.631. ComGkSoftwarePosApiServiceRescanCopyExternalTransactionLineItemsFullRescanRequest

CopyExternalTransactionLineItemsFullRescanRequest Request entity for 'copy external transaction line item' service.

Field Name Required Type Description Format

toAssociationTypeCode

X

String

The association type code to the line items of the external transaction

toTransactionID

X

String

The transaction ID to the line items of the external transaction

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.632. ComGkSoftwarePosApiServiceRescanCopyExternalTransactionLineItemsFullRescanResponse

CopyExternalTransactionLineItemsFullRescanResponse Response entity for 'copy external transaction line item' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.633. ComGkSoftwarePosApiServiceRescanCopyGiftCertificateLineItemFullRescanRequest

CopyGiftCertificateLineItemFullRescanRequest Request entity for 'copy gift certificate line item' service.

Field Name Required Type Description Format

giftCertificateSerialNumber

X

String

The giftCertificateSerialNumber of the gift certificate which should be copied.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.634. ComGkSoftwarePosApiServiceRescanCopyGiftCertificateLineItemFullRescanResponse

CopyGiftCertificateLineItemFullRescanResponse Response entity for 'copy gift certificate line item' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.635. ComGkSoftwarePosApiServiceRescanExecuteRescanAnalysisRequest

ExecuteRescanAnalysisRequest Request entity for 'Rescan Analysis' service.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.636. ComGkSoftwarePosApiServiceRescanExecuteRescanAnalysisResponse

ExecuteRescanAnalysisResponse Response entity for 'Rescan Analysis' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.637. ComGkSoftwarePosApiServiceRescanFinishFullRescanRequest

FinishFullRescanRequest Request entity for 'finish full rescan' service.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.638. ComGkSoftwarePosApiServiceRescanFinishFullRescanResponse

FinishFullRescanResponse Response entity for 'finish full rescan' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

differencesFound

Boolean

true if there is any difference in the relevant data between the customer scanned transaction and the rescan transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.639. ComGkSoftwarePosApiServiceRescanFinishPartialRescanRequest

FinishPartialRescanRequest Request entity for 'finish partial rescan' service.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.640. ComGkSoftwarePosApiServiceRescanFinishPartialRescanResponse

FinishPartialRescanResponse Response entity for 'finish partial rescan' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.641. ComGkSoftwarePosApiServiceRescanPrepareFullRescanRequest

PrepareFullRescanRequest Request entity for preparing 'Full Rescan' functionality.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.642. ComGkSoftwarePosApiServiceRescanPrepareFullRescanResponse

PrepareFullRescanResponse Response entity for preparing 'Full Rescan' functionality.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.643. ComGkSoftwarePosApiServiceRescanPreparePartialRescanRequest

PreparePartialRescanRequest Request entity for preparing 'Partial Rescan' functionality.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.644. ComGkSoftwarePosApiServiceRescanPreparePartialRescanResponse

PreparePartialRescanResponse Response entity for preparing 'Partial Rescan' functionality.

Field Name Required Type Description Format

numberToRescan

X

Integer

Contains number of items to rescan.

int32

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.645. ComGkSoftwarePosApiServiceRescanProcessBarcodePartialRescanRequest

ProcessBarcodePartialRescanRequest Request entity for 'process barcode partial rescan' service.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

barcode

String

Contains barcode of the scanned item.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.646. ComGkSoftwarePosApiServiceRescanProcessBarcodePartialRescanResponse

ProcessBarcodePartialRescanResponse Response entity for 'process barcode partial rescan' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.647. ComGkSoftwarePosApiServiceRescanSuspendAndRetrieveRescanTransactionRequest

SuspendAndRetrieveRescanTransactionRequest Request entity for 'Suspend and Retrieve Rescan Transaction' service.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.648. ComGkSoftwarePosApiServiceRescanSuspendAndRetrieveRescanTransactionResponse

SuspendAndRetrieveRescanTransactionResponse Response entity for 'Suspend and Retrieve Rescan Transaction' service.

Field Name Required Type Description Format

transactionOperationResult

com.gk_software.pos.api.service.transaction.TransactionOperationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.649. ComGkSoftwarePosApiServiceRescanValidateQuantityPartialRescanRequest

ValidateQuantityPartialRescanRequest Request entity for quantity validation of a specific item.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.650. ComGkSoftwarePosApiServiceSecurityAuthenticationRequest

AuthenticationRequest Request object for the AuthenticationService

Field Name Required Type Description Format

loginName

String

The operator login name

password

String

The operator password

businessUnitId

String

The business unit id.

passwordRequired

X

Boolean

boolean : password required

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.651. ComGkSoftwarePosApiServiceSecurityAuthenticationResult

AuthenticationResult Request object for the AuthenticationService

Field Name Required Type Description Format

resolvedOperator

com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO

realmId

String

expirationCountDays

Integer

If password is before expiration it contains the expiration count in days

int32

passwordBeforeExpiration

Boolean

Indicate whether the password is before expiration

passwordExceptionType

String

The passwordExceptionType.

Enum: PASSWORD_INITIAL, PASSWORD_EXPIRED,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.652. ComGkSoftwarePosApiServiceSecurityAuthorizationRequest

AuthorizationRequest Request object for the AuthorizationService

Field Name Required Type Description Format

originalOperatorLoginName

String

String : original operator login name

authorizingOperatorLoginName

String

String : authorizing operator login name

authorizingOperatorPassword

String

String : authorizing operator password

rightId

String

String : right id

EntryMethodCode

String

String : entry method code. It specifies how the action was triggered (keyed, scanned, …​)

lineItemRelevant

Boolean

Indicates that operation is related to line item.

retailTransactionRelevant

Boolean

Indicates that operation is related to retail transaction.

controlTransactionRelevant

Boolean

Indicates that operation is related to control transaction.

tenderControlTransactionRelevant

Boolean

Indicates that operation is related to tender control transaction.

authorizingOperatorMustHaveRights

X

Boolean

boolean : authorizing operator must have rights

skipPasswordCheck

X

Boolean

boolean : skip password check

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.653. ComGkSoftwarePosApiServiceSecurityAuthorizationResult

AuthorizationResult Result object used by AuthorizationService.

Field Name Required Type Description Format

operator

com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO

permittedResources

List of [String]

List of String : ids of permitted resources

authenticationResult

com.gk_software.pos.api.service.security.AuthenticationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.654. ComGkSoftwarePosApiServiceSecurityTransactionResourceOverrideData

TransactionResourceOverrideData TransactionResourceOverrideData

Field Name Required Type Description Format

businessUnitGroupID

String

Long : business unit group id.

operator

com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO

rightId

String

String : right id

entryMethodCode

String

String : entry method code. It specifies how the action was triggered (keyed, scanned, …​)

lineItemRelevant

Boolean

Indicates that operation is related to line item.

retailTransactionRelevant

Boolean

Indicates that operation is related to retail transaction.

controlTransactionRelevant

Boolean

Indicates that operation is related to control transaction.

tenderControlTransactionRelevant

Boolean

Indicates that operation is related to tender control transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.655. ComGkSoftwarePosApiServiceSecurityUpdatePasswordRequest

UpdatePasswordRequest Request object for the AuthenticationService

Field Name Required Type Description Format

loginName

String

The operator login name.

newPassword

String

New password.

oldPassword

String

Old password.

storeId

String

The retail store id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.656. ComGkSoftwarePosApiServiceSecurityUpdatePasswordResult

UpdatePasswordResult Result object used by AuthenticationService.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.657. ComGkSoftwarePosApiServiceSessionLanguageSettings

LanguageSettings Transport object for language dependent setting like active scope and hierarchies.

Field Name Required Type Description Format

activeLanguageScope

String

LanguageScope : active language scope

Enum: Operator, Customer, Transaction, MasterData,

hierarchyMap

Map of [String]

String array of LanguageScope : hierarchy map

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.658. ComGkSoftwarePosApiServiceSessionLoginRequest

LoginRequest Request object for the PosSessionService.

Field Name Required Type Description Format

retailStoreId

String

String : retail store id

workstationId

String

String : workstation id

workstationAddress

String

String : workstation address

workstationTypeCode

String

String : workstation type code

clientVersion

String

String : client version

loginName

String

String : login name

tillId

com.gk_software.pos.api.model.dom.app.services.transaction.TillDoKey

password

String

String : password

overrideData

com.gk_software.pos.api.service.security.TransactionResourceOverrideData

trainingMode

X

Boolean

finalizeControlTransactionFlag

Boolean

useLoginTypeTechnicalForLoginManager

Boolean

boolean: use login type TECHNICAL for login manager calls (default is false)

authorizerLoginName

String

Login name of an authorizing operator e.g. used for 'password forgotten' or other functionalities where the original user doesn’t have the required credentials.

authorizerPassword

String

Password of an authorizing operator e.g. used for 'password forgotten' or other functionalities where the original user doesn’t have the required credentials.

additionalSessionCriteria01

String

Additional data that can be set/used to identify a session.

additionalSessionCriteria02

String

Additional data that can be set/used to identify a session.

posServerLoginEnabled

Boolean

Flag indicating, if POS server login is performed.

signOnTransactionEnabled

Boolean

Flag indicating, if sign on transaction should be created.

online

Boolean

Flag indicating, if session is online

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.659. ComGkSoftwarePosApiServiceSessionLoginResult

LoginResult Result object for the PosSessionService.

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

posSessionId

com.gk_software.pos.api.session.PosSessionId

operator

com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO

permittedResources

List of [String]

List of String : permitted resources

businessUnit

com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO

businessUnitGroup

com.gk_software.gkr.api.server.md.business_unit_group.dto.dom.BusinessUnitGroupDO

dataPrivacyEnabled

X

Boolean

boolean: Flag to indicate data privacy logging is enabled (true) or not (false)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.660. ComGkSoftwarePosApiServiceSessionLogoutRequest

LogoutRequest Request object for the PosSessionService

Field Name Required Type Description Format

retailStoreId

String

String : retail store id

workstationId

String

String : workstation id

clientVersion

String

String : client version

password

String

Encrypted password used for logout

validatePassword

X

Boolean

Indicates whether password should be validated

overrideData

com.gk_software.pos.api.service.security.TransactionResourceOverrideData

posServerLogoutEnabled

Boolean

signOutTransactionEnabled

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.661. ComGkSoftwarePosApiServiceSessionLogoutResult

LogoutResult Result object for the PosSessionService.

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

success

X

Boolean

boolean : success

operator

com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO

businessUnit

com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO

workstationStatusToken

String

The new POS-Server login manager status token from POS-Server logout response.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.662. ComGkSoftwarePosApiServiceSessionPosgroupPosGroupOperatorLoginRequest

PosGroupOperatorLoginRequest Request object to perform a pos group operator login.

Field Name Required Type Description Format

retailStoreId

String

The retail store identifier.

workstationId

String

The workstation identifier.

workstationTypeCode

String

The workstation type code.

clientVersion

String

The client version.

loginName

String

The operator login name.

password

String

The operator password.

passwordRequired

Boolean

A flag to indicate whether the password is required or not.

tillId

com.gk_software.pos.api.model.dom.app.services.transaction.TillDoKey

requiredRight

String

If set the pos group operator permissions are checked against this right.

trainingMode

X

Boolean

A flag to indicate whether training mode is active or not.

persistedOperatorLogin

X

Boolean

A flag to indicate whether the login is for a persisted operator.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.663. ComGkSoftwarePosApiServiceSessionPosgroupPosGroupOperatorLoginResult

PosGroupOperatorLoginResult Result object for a pos group operator login.

Field Name Required Type Description Format

posSessionId

com.gk_software.pos.api.session.PosSessionId

operator

com.gk_software.swee.ses.api.server.um.operator.dto.so.AbstractOperatorSO

permittedResources

List of [String]

A list of permitted resources for the operator.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.664. ComGkSoftwarePosApiServiceSessionPosgroupPosGroupOperatorLogoutRequest

PosGroupOperatorLogoutRequest Request object to perform a pos group operator logout.

Field Name Required Type Description Format

posSessionId

com.gk_software.pos.api.session.PosSessionId

posGroupOperatorActive

X

Boolean

A flag to indicate whether the pos group operator to logout is currently activated (true) or deactivated (false) at the POS.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.665. ComGkSoftwarePosApiServiceSessionPosgroupPosGroupOperatorLogoutResult

PosGroupOperatorLogoutResult Result object for a pos group operator logout.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.666. ComGkSoftwarePosApiServiceSessionPosgroupPosGroupTransactionCleanUpResponse

PosGroupTransactionCleanUpResponse Response object for a clean up of transactions.

Field Name Required Type Description Format

status

X

String

The status.

Enum: DEACTIVATE_REQUIRED, FINISHED,

transactionList

X

List of ComGkSoftwareGkrApiTxpoolDtoTransaction

A list of transactions that need a clean up processing started from client side via pos group messages to also clean up the pos group cache.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.667. ComGkSoftwarePosApiServiceSessionPosgroupPosGroupUnfinishedTransactionCleanUpResponse

PosGroupUnfinishedTransactionCleanUpResponse Response object for a clean up of unfinished transactions. @deprecated as of 5.19.6 use instead PosGroupTransactionCleanUpResponse

Field Name Required Type Description Format

status

X

String

The status.

Enum: DeactivateRequired, Finished,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.668. ComGkSoftwarePosApiServiceSessionPosgroupSyncPosGroupSessionResult

SyncPosGroupSessionResult Result object for a synchronization of pos sessions within the pos group.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.669. ComGkSoftwarePosApiServiceSessionRemoveSessionRequest

RemoveSessionRequest Result object for the PosSessionService for remove session operation.

Field Name Required Type Description Format

posSessionId

X

com.gk_software.pos.api.session.PosSessionId

clearSessionHolder

Boolean

String : indicates that the SessionHolder should be cleared.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.670. ComGkSoftwarePosApiServiceSessionSwitchUserResult

SwitchUserResult Result object for the PosSessionService for switch user operations.

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

loginResult

com.gk_software.pos.api.service.session.LoginResult

logoutResult

com.gk_software.pos.api.service.session.LogoutResult

authenticationResult

com.gk_software.pos.api.service.security.AuthenticationResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.671. ComGkSoftwarePosApiServiceSessionUnlockSessionRequest

UnlockSessionRequest Request for workstation unlock.

Field Name Required Type Description Format

transactionResourceOverrideData

com.gk_software.pos.api.service.security.TransactionResourceOverrideData

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.672. ComGkSoftwarePosApiServiceSmartposCheckAvailabilityAndCleanupRequest

CheckAvailabilityAndCleanupRequest Request object for the checking service availability and cleaning up sessions and transactions on an active service instance. @deprecated as of 5.25.1. OneX-MPOS should be used instead of ThinPOS client.

Field Name Required Type Description Format

retailStoreId

String

The store identifier (business unit id).

workstationId

String

The workstation id.

clientVersion

String

The client application version.

mainTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

lastFinalizedTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

lastFinalizedRetailTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.673. ComGkSoftwarePosApiServiceSmartposMDReplicationEndEvent

MDReplicationEndEvent Event object for master data replication end. @deprecated as of 5.25.1. OneX-MPOS should be used instead of ThinPOS client.

Field Name Required Type Description Format

storeNumber

String

The store id (business unit id).

success

Boolean

Indicates if process ended without failure.

newPumpUsed

Boolean

Indicates if new pump was downloaded, data transfered to database and databases were switched.

newTransportObjectsSaved

Boolean

Indicates whether new transport objects were saved during master data replication.

lastChangedEntityId

String

Id of last changed entity during master data replication.

failKey

String

Message key of failure cause.

failCause

String

Localized message of failure cause.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.674. ComGkSoftwarePosApiServiceSmartposMDReplicationProgressEvent

MDReplicationProgressEvent Event object for master data replication progress. @deprecated as of 5.25.1. OneX-MPOS should be used instead of ThinPOS client.

Field Name Required Type Description Format

eventId

String

The event id.

type

String

The retail store id.

storeNumber

String

The retail store id.

currentStep

String

Returns current step (or count for count event) of action. Exact meaning of step may be different for different actions.

stepsCount

String

Returns steps count of action. Exact meaning of step may be different for different actions.

progress

Double

Translates progress to interval <0, 1> Values < 0 and > 1 indicates that this is before/after. For count event 1.0 is always returned.

double

beforeEvent

Boolean

Indicates if this is event called before the action started.

afterEvent

Boolean

Indicates if this is event called after the action was completed.

progressEvent

Boolean

Indicates that this event is progress event

countEvent

Boolean

Indicates that this event is count event (similar to progress, but with unknown stepsCount)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.675. ComGkSoftwarePosApiServiceSmartposTakeOverSessionRequest

TakeOverSessionRequest Request object for session take over during a service switch due to communication failure on other existing service instances. @deprecated as of 5.25.1. OneX-MPOS should be used instead of ThinPOS client.

Field Name Required Type Description Format

operatorId

String

The operator login id.

retailStoreId

String

The store identifier (business unit id).

workstationId

String

The workstation id.

clientVersion

String

The client application version.

tillId

com.gk_software.pos.api.model.dom.app.services.transaction.TillDoKey

mainTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

scopedTransactions

Map of ComGkSoftwareGkrApiTxpoolDtoTransaction

Scoped transactions currently present in client transaction context.

activatedTransactionId

String

The transaction id of the active transaction in client transaction context.

lastFinalizedTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

lastFinalizedRetailTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

posSessionData

com.gk_software.pos.api.session.PosSessionData

languageSettings

com.gk_software.pos.api.service.session.LanguageSettings

enforceTakeOver

Boolean

If true, the session take over will be enforced without further checks.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.676. ComGkSoftwarePosApiServiceStockStockServiceRequest

StockServiceRequest Request object for stock service.

Field Name Required Type Description Format

itemIds

List of [String]

Item identifiers for stock information request.

storeIds

List of [String]

Store identifiers requesting the stock information.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.677. ComGkSoftwarePosApiServiceStoredValueServerCancelGiftCertTransactionRequest

CancelGiftCertTransactionRequest Request object for canceling (voiding) a gift certificate.

Field Name Required Type Description Format

serviceId

String

Specific id of gift certificate service to use.

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

callingProcess

String

Calling process identifier.

storedValuesServiceId

String

Stored values service identifier.

transactionId

String

Transaction id for transaction containing the gift certificate to be canceled.

receiptNumber

String

Number of receipt of transaction canceling the gift certificate (transaction sequence number).

giftCertTransactionId

String

Transaction ID of the transaction to be canceled at stored value server (eg.: top up transaction id).

giftCertNumber

String

Gift certificate number.

Track2

String

Gift certificate track2 data.

giftCertAmount

Double

Gift certificate amount.

double

isoCurrencyCode

String

ISO currency code.

approvalCode

String

Approval code from terminal related to gift card transaction.

terminalReferenceNumber

String

The terminal reference number.

gcsTransactionUUID

String

The original transaction UUID from registration.

ignoreFailures

X

Boolean

Indicates whether failures should be ignored during the cancellation process and tries to cancel all gift certificates.

voidTenderLineItems

X

Boolean

Indicates whether tender line items should be voided during the cancellation process.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.678. ComGkSoftwarePosApiServiceStoredValueServerGiftCertificateRequest

GiftCertificateRequest Request object for the StoredValueServerService.

Field Name Required Type Description Format

serviceId

String

Service identifier.

giftCertificateType

String

Specifies the gift certificate type. Possible values are: gift certificate as '01' gift card as '02' foreign gift certificate as '03' promotion gift certificate as '04'

giftCertificateNumber

String

Gift certificate number.

giftTrack2

String

Gift certificate track2 data.

amount

com.gk_software.pos.api.model.dom.app.amount.Amount

expiryDate

String

Expiration date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

gcsTransactionUUID

String

Universally unique transaction ID.

openPaymentAmount

X

Double

The remaining payment amount for the base currency.

double

callingProcess

String

Calling process identifier.

additionalInfo

List of ComGkSoftwarePosApiModelDomAppGiftCertificateServiceAttributeValue

List of additional info attributes and values.

trainingMode

Boolean

Indicates whether service has been started on training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.679. ComGkSoftwarePosApiServiceSystemApplicationInfo

ApplicationInfo Data object for service application information.

Field Name Required Type Description Format

appVersion

String

Application version.

appRevision

String

Application revision number.

appBuildNumber

String

Application build number.

appFormattedDate

String

Application build date.

appJdkVersion

String

JDK version used in application build.

fiscalizationInfo

Map of [String]

A key-value pair map of strings for fiscalization information. Extension point for projects to load fiscalization specific information into this map.

weightAndMeasuresVersion

String

GK Drive weight and measures version, applicable for fuel mode.

appDateTimeStamp

String

Application build date timeStamp.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.680. ComGkSoftwarePosApiServiceSystemPingRequest

PingRequest Request object for the SystemService ping.

Field Name Required Type Description Format

businessUnitId

String

Business unit id.

workstationId

String

Workstation id.

workstationAddress

String

Workstation address.

workstationStatusToken

String

The POS-Server / Login-Manager workstation status token that was received in prev. call.

workstationTypeCode

String

The workstation type code.

updateStatus

String

Update Status depending on Error Codes sent by POS.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.681. ComGkSoftwarePosApiServiceSystemPingResponse

PingResponse Response object for the SystemService ping.

Field Name Required Type Description Format

workstationCommand

com.gk_software.gkr.api.login_manager.dto.WorkstationCommand

workstationStatusToken

String

The POS-Server / Login-Manager workstation status token. It must be stored and resend with next request.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.682. ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListUpdateViewsRequest

FindDynamicTableauItemListUpdateViewsRequest TODO: undocumented

Field Name Required Type Description Format

dynamicTableauItemListUpdateViewCriteria

X

com.gk_software.gkr.api.server.md.dynamic_tableau.dto.dom.DynamicTableauItemListUpdateViewCriteria

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.683. ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListUpdateViewsResponse

FindDynamicTableauItemListUpdateViewsResponse TODO: undocumented

Field Name Required Type Description Format

dynamicTableauItemListUpdateViews

List of ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomDynamicTableauItemListUpdateView

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.684. ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListViewsRequest

FindDynamicTableauItemListViewsRequest TODO: undocumented

Field Name Required Type Description Format

dynamicTableauItemListViewCriteria

X

com.gk_software.gkr.api.server.md.dynamic_tableau.dto.dom.DynamicTableauItemListViewCriteria

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.685. ComGkSoftwarePosApiServiceTableauFindDynamicTableauItemListViewsResponse

FindDynamicTableauItemListViewsResponse TODO: undocumented

Field Name Required Type Description Format

dynamicTableauItemListViews

List of ComGkSoftwareGkrApiServerMdDynamicTableauDtoDomDynamicTableauItemListView

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.686. ComGkSoftwarePosApiServiceTillTillRequest

TillRequest Request object for the TillService

Field Name Required Type Description Format

operatorId

String

The operator id used for till assignments.

workstationId

String

The workstation id used for till assignments.

businessUnitId

String

The business unit id used for till assignments.

tillIds

List of ComGkSoftwarePosApiModelDomAppServicesTransactionTillDoKey

Collection of till identifiers.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.687. ComGkSoftwarePosApiServiceTillTillResponse

TillResponse Response object for the TillService containing assigned tills for given request.

Field Name Required Type Description Format

tills

List of ComGkSoftwareGkrApiServerMdTillDtoDomTillDO

Collection of tills assigned to the given workstation or operator.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.688. ComGkSoftwarePosApiServiceTillTillTenderSummaryRequest

TillTenderSummaryRequest Request object for till tender summaries.

Field Name Required Type Description Format

businessUnitGroupId

X

String

Business unit group id used for till tender summary.

tillId

X

String

Till identifier.

workstationId

String

Workstation id.

trainingFlag

X

Boolean

Flag for indicating whether training mode is enabled.

refreshStrategy

String

Refresh strategy of till copy object (eg.: ForceRefresh, RefreshAndOfflineFallback and CachedOrInitialize).

Enum: ForceRefresh, RefreshAndOfflineFallback, CachedOrInitialize,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.689. ComGkSoftwarePosApiServiceTillTillTenderSummaryResponse

TillTenderSummaryResponse Response object for the TillService containing a summary of till tenders.

Field Name Required Type Description Format

tillCopyObject

com.gk_software.gkr.api.tco.dto.TillCopyObject

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.690. ComGkSoftwarePosApiServiceTransactionActivateTaxExemptRequest

ActivateTaxExemptRequest Request object for activating tax exemption.

Field Name Required Type Description Format

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

customerIdentifier

String

The customer id.

reason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.691. ComGkSoftwarePosApiServiceTransactionActivateTaxFreeSaleRequest

ActivateTaxFreeSaleRequest Request object to activate the tax free sale mode.

Field Name Required Type Description Format

taxFreeTaxGroupId

X

String

Tax group with zero percent that will be used for tax free sale.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.692. ComGkSoftwarePosApiServiceTransactionAddExternalTransactionAdditionalPrintoutRequest

AddExternalTransactionAdditionalPrintoutRequest Request object to add additional external printouts.

Field Name Required Type Description Format

reportId

String

The report identifier.

transactionId

String

content

List of ComGkSoftwarePosApiModelDomAppServicesTransactionPrintAdditionalLineItemTextLine

A list of print additional line item text lines.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.693. ComGkSoftwarePosApiServiceTransactionAddFiscalizationDataToTransactionRequest

AddFiscalizationDataToTransactionRequest Request object to add fiscalization data to a transaction.

Field Name Required Type Description Format

transactionId

String

The identifier of the transaction where the fiscalization data should be set.

fiscalDayNumber

String

The fiscalization day number.

fiscalPrinterId

String

The fiscalization printer identifier.

fiscalReceipt

Boolean

A flag to indicate if it is a fiscalization receipt/transaction.

fiscalReceiptNumber

String

The fiscalization receipt number.

fiscalSignature

String

The fiscalization signature.

fiscalReceiptText

String

The fiscalization receipt text.

fiscalEncodedBarcodeImage

String

The encoded fiscalization barcode image.

fiscalBarcodeReference

String

The fiscalization barcode reference.

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

fiscalSecurity

com.gk_software.pos.api.service.transaction.FiscalTagFieldResult

fiscalTaxId

com.gk_software.pos.api.service.transaction.FiscalTagFieldResult

fiscalCode

com.gk_software.pos.api.service.transaction.FiscalTagFieldResult

fiscalYear

Integer

The fiscalization year.

int32

keyVersion

String

The fiscalization signing key version.

signatureSumDaily

com.gk_software.pos.api.service.transaction.FiscalTagFieldResult

signatureSumPerpetual

com.gk_software.pos.api.service.transaction.FiscalTagFieldResult

timestamp

com.gk_software.pos.api.service.transaction.FiscalTagFieldResult

esdId

com.gk_software.pos.api.service.transaction.FiscalTagFieldResult

receiptPrinted

Boolean

deprecated: as of 5.5.0. Use instead proper service to set flag A flag to indicate that the receipt was printed.

extensions

List of ComGkSoftwarePosApiServiceTransactionExtension

Additional extensions

binaryDataExtensions

List of ComGkSoftwarePosApiServiceTransactionExtension

Additional binary data extensions

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.694. ComGkSoftwarePosApiServiceTransactionAddTerminalPrintoutsToTransactionRequest

AddTerminalPrintoutsToTransactionRequest Transport object to store a list of merchant and customer printouts .

Field Name Required Type Description Format

terminalPrintoutsLineRequests

List of ComGkSoftwarePosApiServiceTransactionTerminalPrintoutsLineItemEntry

Collection of printouts to store on a transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.695. ComGkSoftwarePosApiServiceTransactionAddTransactionAdditionalPrintoutsRequest

AddTransactionAdditionalPrintoutsRequest Request object to add additional printouts to a transaction.

Field Name Required Type Description Format

transactionId

String

transactionAdditionalPrintouts

List of ComGkSoftwareGkrApiTxpoolDtoTransactionAdditionalPrintout

A list of transaction additional printouts.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.696. ComGkSoftwarePosApiServiceTransactionAddTransactionExtensionRequest

AddTransactionExtensionRequest Request object for adding a transaction extension to the transaction.

Field Name Required Type Description Format

transactionId

String

The identifier of the transaction where the transaction extensions should be added.

extensionKey

String

The transaction extension key to be added to transaction.

extensionValue

String

The transaction extension value to be added to transaction.

storeTransaction

Boolean

A flag to indicate if the transaction should be stored. The default value is false.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.697. ComGkSoftwarePosApiServiceTransactionAddTransactionExtensionsRequest

AddTransactionExtensionsRequest Request object for adding a list of transaction extensions to the transaction.

Field Name Required Type Description Format

requests

List of ComGkSoftwarePosApiServiceTransactionAddTransactionExtensionRequest

A list of AddTransactionExtensionRequest objects. To add a single transaction extension for each request object in the list.

transactionId

String

The identifier of the transaction where the transaction extensions should be added.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.698. ComGkSoftwarePosApiServiceTransactionAddTransactionTimerRequest

AddTransactionTimerRequest Request object to add transaction timer to transaction.

Field Name Required Type Description Format

timerID

X

String

ID of the timer. 1 …​ Registration timer 2 …​ Payment timer

startTime

X

String

Start time of the timer.

stopTime

X

String

Stop time of the timer.

timerOriginTypeCode

X

String

Origin of the timer. 00 …​ Current transaction 01 …​ taken over from suspended transaction 02 …​ taken over from food order / table movement transaction 03 …​ taken over from scale transaction

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.699. ComGkSoftwarePosApiServiceTransactionAlternativeTaxRequest

AlternativeTaxRequest Request object for alternative tax.

Field Name Required Type Description Format

alternativeTaxInfos

X

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

calculateTax

X

Boolean

A flag to indicate the recalculation of taxes.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.700. ComGkSoftwarePosApiServiceTransactionCalculateReturnUnitPricesRequest

CalculateReturnUnitPricesRequest Request object to calculate return unit prices during payment end.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

conditionSplitConfig

com.gk_software.pos.api.model.config.process.flows.ConditionSplitConfig

manualDiscountTypes

List of [String]

This parameter defines the list of condition types for price reduction. @deprecated as of 5.6.0. Use instead: conditionSplitConfig.manualDiscountTypes

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.701. ComGkSoftwarePosApiServiceTransactionCancelAllExternalLineItemsRequest

CancelAllExternalLineItemsRequest Request object to cancel all external line items.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

callingProcess

String

The name of the calling process.

trainingMode

Boolean

Indicates whether service should be started in training mode.

couponingServiceHeader

com.gk_software.pos.api.service.coupon.CouponingRequestHeaderData

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.702. ComGkSoftwarePosApiServiceTransactionCancelAllExternalLineItemsResult

CancelAllExternalLineItemsResult Result object for service call to cancel all external line items.

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

atLeastOneLoyaltyPointsItemRefunded

Boolean

A flag to indicate that at least one loyalty points item was cancelled successful.

atLeastOneGiftCertCancelled

Boolean

A flag to indicate that at least one gift certificate was cancelled successful.

failedFrequentShopperPointsEarnedAmounts

X

Double

The amount of earned frequent shopper points that could not be cancelled successful.

double

atLeastOneCheckoutCouponCanceled

Boolean

A flag to indicate that at least one checkout coupon was canceled successful.

atLeastOneCouponRedemptionCanceled

Boolean

A flag to indicate that at least one coupon redemption was canceled successful.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.703. ComGkSoftwarePosApiServiceTransactionCancelGiftCertLineItemRequest

CancelGiftCertLineItemRequest The entity CancelGiftCertLineItemRequest

Field Name Required Type Description Format

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

transactionId

String

The transactionId

receiptNumber

String

The receiptNumber

callingProcess

String

The callingProcess

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.704. ComGkSoftwarePosApiServiceTransactionCancelTransactionRequest

CancelTransactionRequest Request object for cancelling a transaction.

Field Name Required Type Description Format

reason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

finalizeTransaction

X

Boolean

A flag to indicate if the transaction should be finalized. The default value is true.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.705. ComGkSoftwarePosApiServiceTransactionCashRefundRequest

CashRefundRequest Request object for cash refund.

Field Name Required Type Description Format

transactionId

String

The identifier of the transaction to refund.

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.706. ComGkSoftwarePosApiServiceTransactionCheckPriceLimitRequest

CheckPriceLimitRequest Request object for checking of price limits.

Field Name Required Type Description Format

absolutePositionLimit

Double

The absolute price position limit.

double

percentPositionLimit

Double

The percentage price position limit.

double

oldPrice

Double

The old price.

double

newPrice

Double

The new price.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.707. ComGkSoftwarePosApiServiceTransactionCheckQuantityInputProhibitedRequest

CheckQuantityInputProhibitedRequest The check quantity input prohibited request object

Field Name Required Type Description Format

posItemId

String

The pos item Id

businessUnitId

String

The business unit Id

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.708. ComGkSoftwarePosApiServiceTransactionCheckTransactionVoidableRequest

CheckTransactionVoidableRequest Request object to check if a transaction is voidable.

Field Name Required Type Description Format

transactionToVoidId

String

The identifier of transaction to void.

receiptAgeAllowedInDays

Integer

The allowed age of the transaction to void in days. If a receipt is older than allowed it is not voidable anymore.

int32

giftCertCancelAllowed

Boolean

Indicates if cancellation of gift certificates is allowed.

onlySamePosAllowed

Boolean

Indicates cancellation of receipts of other workstations is allowed or not. If only same workstation is allowed. The currentWorkstationId must match the workstation identifier in the transaction.

currentWorkstationId

String

The current workstation identifier.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.709. ComGkSoftwarePosApiServiceTransactionComboMealRegistrationRequest

ComboMealRegistrationRequest Domain object for ComboMealRegistration

Field Name Required Type Description Format

mainLineItem

X

Boolean

Flag if line item to register is the main line item of the 'Combo Meal'

mainLineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

relatedLineItemOriginalPrice

Double

The original price of the 'Combo Meal' related line item (max(ComponentItem.currentPrice) of all standard items of the component). This field should only be set for related item registration and if the related item is an alternative item.

double

calculateDiscountShares

Boolean

Flag if 'discount shares calculation' should be processed during registration.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.710. ComGkSoftwarePosApiServiceTransactionConvertSuspendCodesRequest

ConvertSuspendCodesRequest Request object to convert suspend codes to transaction.

Field Name Required Type Description Format

suspendCodes

List of [String]

List of suspend codes.

numberFormatPattern

String

The number format pattern for prices.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.711. ComGkSoftwarePosApiServiceTransactionConvertSuspendCodesResponse

ConvertSuspendCodesResponse Response object from convert suspend codes function.

Field Name Required Type Description Format

transactionFromConvertedSuspendCodes

com.gk_software.gkr.api.txpool.dto.Transaction

skippedItems

List of ComGkSoftwarePosFlowLibsTransactionSuspendCodeSkippedItem

List of skipped items.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.712. ComGkSoftwarePosApiServiceTransactionCreateDownpaymentLineItemRequest

CreateDownpaymentLineItemRequest Request object for creating a CreateDownpaymentLineItem

Field Name Required Type Description Format

externalCustomerOrderID

String

The external customerOrderID

salesOrderTypeCode

String

The salesOrder typeCode

receiptAmount

String

The receipt amount

documentInfos

List of ComGkSoftwarePosApiServiceTransactionSalesOrderSalesDocItem

The documentInfos

saleReturnLineItemDataRequest

com.gk_software.pos.api.service.transaction.SaleReturnLineItemDataRequest

languageDifferent

Boolean

The language different

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

recalculateTransaction

Boolean

Indicates whether the transaction should be recalculated. Default value is 'true'.

storeTransaction

Boolean

Indicates whether the transaction should be stored. Default value is 'true'.

entryMethodCode

String

Contains the method with which the item was registered (keyed in, scanned through bar code, etc).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.713. ComGkSoftwarePosApiServiceTransactionCreateDrawerAccountsRequest

CreateDrawerAccountsRequest TODO: undocumented

Field Name Required Type Description Format

tenderRegistration

com.gk_software.pos.api.model.dom.app.tender.TenderRegistration

manualChange

Double

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.714. ComGkSoftwarePosApiServiceTransactionCreateFailFiscalTransactionRequest

CreateFailFiscalTransactionRequest Request object to create a fiscal fail transaction.

Field Name Required Type Description Format

fiscalizationData

X

com.gk_software.pos.api.service.transaction.AddFiscalizationDataToTransactionRequest

originalTransactionID

String

The identifier of the original transaction for that the fiscal fail transaction should be created.

retailStoreId

String

The retail store identifier.

workstationId

String

The workstation identifier.

clientVersion

String

The client version.

operatorId

String

The operator identifier.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.715. ComGkSoftwarePosApiServiceTransactionCreateInvoicePaymentLineItemRequest

CreateInvoicePaymentLineItemRequest Request object for creating a InvoicePaymentLineItem

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

saleReturnLineItemDataRequest

com.gk_software.pos.api.service.transaction.SaleReturnLineItemDataRequest

customerReceiptText

String

The customer receipt text.

entryMethodCode

String

Contains the method with which the item was registered (keyed in, scanned through bar code, etc).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.716. ComGkSoftwarePosApiServiceTransactionCreateLineItemRequest

CreateLineItemRequest The entity CreateLineItemRequest

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

customerReceiptText

String

The customerReceiptText

saleReturnLineItemRequestData

com.gk_software.pos.api.service.transaction.SaleReturnLineItemDataRequest

tenderRequestData

com.gk_software.pos.api.service.transaction.TenderLineItemDataRequest

additionalParameterMap

Map of [String]

Map<String,String> map for additional parameters for retailLineItem

sellerId

String

String to store seller Id

sellerRelationMethod

String

sellerRelationMethod to store the currently defined seller assignment method

Enum: CurrentLineItemOnly, CurrentAndFollowingLineItemsOfCurrentTransaction, CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions, AllLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentAndFollowingTransactions,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.717. ComGkSoftwarePosApiServiceTransactionCreateSuspendCodeRequest

CreateSuspendCodeRequest Request object to create suspend code from transaction.

Field Name Required Type Description Format

transaction

com.gk_software.gkr.api.txpool.dto.Transaction

maxSizeOf2DCode

Integer

Max size of one created 2D code.

int32

codeVersion

String

Version of created code.

suspendNumber

String

Entered or generated suspend number.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.718. ComGkSoftwarePosApiServiceTransactionCreateTransactionLineItemAssociationRequest

CreateTransactionLineItemAssociationRequest Request object to create a retail transaction line item association.

Field Name Required Type Description Format

fromLineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

toLineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

lineItemAssociationTypeCode

String

The line item association type code.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.719. ComGkSoftwarePosApiServiceTransactionCreateTransactionLineItemAssociationsRequest

CreateTransactionLineItemAssociationsRequest Request object to create multiple retail transaction line item associations.

Field Name Required Type Description Format

requests

List of ComGkSoftwarePosApiServiceTransactionCreateTransactionLineItemAssociationRequest

The list of request objects to create a single retail line item association one by one.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.720. ComGkSoftwarePosApiServiceTransactionCreateVoidTransactionRequest

CreateVoidTransactionRequest Request object to create a void transaction.

Field Name Required Type Description Format

transactionToVoidId

String

The identifier of the transaction to void.

reasonCode

String

The reason code.

reasonDescription

String

The reason description.

giftCertCancellationAllowed

Boolean

A flag to indicate that gift certificate cancellation is allowed.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.721. ComGkSoftwarePosApiServiceTransactionCreateWorkerDiscountLineItemRequest

CreateWorkerDiscountLineItemRequest Request object for creating worker discounts.

Field Name Required Type Description Format

workerID

String

The worker id.

receiptText

String

The receipt text for a worker discount.

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.722. ComGkSoftwarePosApiServiceTransactionCustomerCustomerAssignmentRequest

CustomerAssignmentRequest Request object for operation which assign customer to active transaction

Field Name Required Type Description Format

customerId

String

String : customer id

customerCardType

String

String : customer card type

customerCardTypeDescription

String

String : customer card type description

customerGroupId

String

String : customer group id

customerDO

com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO

customerTenderGroup

com.gk_software.gkr.api.server.md.customer_tender_rule.dto.dom.CustomerTenderGroupDO

customerData

com.gk_software.pos.flow.libs.customer.CustomerData

customerWebServiceData

com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebserviceResult

searchForIdentificationNumber

Boolean

boolean : searchFor identification number

customerIDEntryMethodCode

String

String : customer iD entry method code

preferredReceiptPrintoutTypeCode

String

String : preferredReceiptPrintoutTypeCode It defines the preferred printout type code of the customer:

  • CLIENT - Printout depends on client settings.

  • PRINTONLY - Customer wants to have a printed receipt.

  • MAILONLY - Customer wants to have the receipt per mail.

  • NOTHING - Customer wants to have nothing.

  • PRINTANDMAIL - Customer wants to have a printed receipt and a mail.

organizationName

String

The organization name

dataProvider

String

The data provider id

genericFlag

Boolean

It specifies if the customer is a dummy/unknown customer It specifies if the customer is a dummy/unknown customer

useLoyaltyService

String

It defines if a loyalty service should be used and which loyalty service.

pointsCalculationMode

String

It defines the mode to calculate points.

  • LOCAL - Points are calculated real time by local PCE.

  • CENTRAL - Points are calculated during payment end by Points Calculation Service.

Enum: LOCAL, CENTRAL,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.723. ComGkSoftwarePosApiServiceTransactionCustomerCustomerRegistrationRequest

CustomerRegistrationRequest Request object for the CustomerTransactionService

Field Name Required Type Description Format

identifier

String

The customer identifier (customer id / party identification)

customerGroupId

String

The customer group id

customerCardType

String

The customer card type

customerCardNumber

String

The customer card number

customerCardTypeDescriptionKey

String

The customer card type description key

useWebService

String

In case that 'searchDatabase' setting is set to false the value of that property is used to determine where the search should be executed. Possible values are:

  • SAP_ERP (default)

  • SAP_CRM

  • VALUEPHONE

searchDatabase

X

Boolean

Indicates whether the customer should be searched in local MD database.

searchForIdentificationNumber

X

Boolean

This parameters works only in combination with searchDatabase=true, it specifies the type of customer identifier:

  • false: search by party identification is executed

  • true: search by customer id is executed

trainingMode

Boolean

Indicates if the service was started in training mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.724. ComGkSoftwarePosApiServiceTransactionCustomerCustomerRemovalRequest

CustomerRemovalRequest Request object for operation which removes customer from active transaction

Field Name Required Type Description Format

businessUnitGroupID

X

String

long : business unit group iD

transactionID

X

String

String : transaction iD

customerID

X

String

String : customer iD

addressTypeCode

X

String

String : address type code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.725. ComGkSoftwarePosApiServiceTransactionDeactivateTaxExemptRequest

DeactivateTaxExemptRequest Request object for deactivating tax exemption.

Field Name Required Type Description Format

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.726. ComGkSoftwarePosApiServiceTransactionDuplicatePrintOutTransactionsRequest

DuplicatePrintOutTransactionsRequest Request object to search for duplicate printout transactions.

Field Name Required Type Description Format

transactionIsNotVoided

Boolean

A flag to indicate that only transactions that are not voided should be searched.

CancelledFlag

Boolean

A flag to indicate that only transactions that are cancelled should be searched.

SuspendedFlag

Boolean

A flag to indicate that only transactions that are suspended should be searched.

workstationID

String

The workstation identifier.

businessUnitGroupID

String

The business unit group identifier.

businessUnitID

String

The business unit identifier.

maxReceiptCount

Integer

Limits the number of found receipts to the given value.

int32

originalTransactionId

String

The identifier for the original transaction (as part of the search criteria).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.727. ComGkSoftwarePosApiServiceTransactionEnterCouponRequest

EnterCouponRequest Request object for entering coupons.

Field Name Required Type Description Format

couponNumber

String

The coupon number.

privilegeType

String

The coupon privilege type.

Enum: DISCOUNT_PERCENT, DISCOUNT_ABSOLUTE, PRICE_ABSOLUTE,

privilegeValue

Double

The coupon privilege value.

double

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

couponSerialData

com.gk_software.pos.api.service.transaction.EnterCouponSerialData

customerId

String

The customer id

customerAddressTypeCode

String

The customer address type code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.728. ComGkSoftwarePosApiServiceTransactionEnterCouponSerialData

EnterCouponSerialData Request object for entering coupon serial data.

Field Name Required Type Description Format

couponSerialNumber

String

The copupon serial number

bookingSuccessfulTypeCode

String

The booking successful type code

bookingTransactionUuid

String

The booking transaction Uuid

expirationTimestamp

String

The expiration timestamp Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.729. ComGkSoftwarePosApiServiceTransactionExtension

Extension Extension object

Field Name Required Type Description Format

extensionKey

String

Extension key

extensionValue

String

Extension value

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.730. ComGkSoftwarePosApiServiceTransactionExternalItemRegistrationRequest

ExternalItemRegistrationRequest Domain object used for registration of external line items

Field Name Required Type Description Format

isoCurrencyCode

X

String

The ISO currency code.

locale

X

String

The locale.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.731. ComGkSoftwarePosApiServiceTransactionExternalLineItemData

ExternalLineItemData Manual line item creation with external data.

Field Name Required Type Description Format

posItemID

String

The pos item ID - IdentityAlphaNumeric40.

itemID

String

The item ID - IdentityUUID.

posDepartmentID

String

The pos department ID - IdentityAlphaNumeric40.

unitOfMeasureCode

String

The unit of measure code - Code4

itemType

String

The item type - Code4

regularUnitPrice

Double

The regular unit price - MoneyShortRetail

double

regularUnitPriceQuantity

Integer

The number of items the regular price is defined for, i.e. 3 for $1.00

int32

actualUnitPrice

X

Double

The actual unit price - MoneyShortRetail

double

actualUnitPriceQuantity

Integer

The number of items the actual price is defined for, i.e. 3 for $1.00

int32

quantity

X

Integer

The quantity - QuantityIntegerGK

int32

units

Double

The units - Quantity

double

quantityInputMethod

String

The quantity input method - Code2

length

Double

The length - Quantity

double

width

Double

The width - Quantity

double

height

Double

The height - Quantity

double

receiptText

X

String

The receipt text - NNameGK

receiptDescription

String

The receipt description - NDescriptionShortGK

wicFlag

Boolean

The wic flag - BIT

allowFoodStampFlag

Boolean

The allow food stamp flag -> BIT

registrationNumber

String

The registration number - DescriptionShort

discountFlag

Boolean

The discount flag - BIT

frequentShopperPointsEligibilityFlag

Boolean

The frequent shopper points eligibility flag - BIT

discountTypeCode

String

The discount type code - VARCHAR(1)

priceChangeTypeCode

String

The price change type code - Code2

priceTypeCode

String

The price type code - Code2

notConsideredByLoyaltyEngineFlag

Boolean

The not considered by loyalty engine flag - BIT

merchandiseHierarchyGroupName

String

The merchandise hierarchy group name - Name

merchandiseHierarchyGroupDescription

String

The merchandise hierarchy group description - DescriptionShort

itemClassCode

String

The PosUOMItemDO class code.

prohibitTaxExemptFlag

Boolean

The prohibit tax exempt flag - BIT

prohibitReturnFlag

Boolean

The prohibit return flag - BIT

warrantyDuration

Double

The warranty duration - QuantityTransactionCount

double

depositTypeCode

String

The deposit type code - Code2

taxExemptCode

String

The tax exempt code - Code2

mainPOSItemID

String

The main POS item ID - IdentityGTIN

mainMerchandiseHierarchyGroupIDQualifier

String

The main merchandise hierarchy group ID qualifier - Code4

mainMerchandiseHierarchyGroupID

String

The main merchandise hierarchy group ID - IdentityAlphaNumeric40

taxGroupID

String

The tax group ID - Code

tareCount

Double

The tare ount - Quantity16_3GK

double

saleReturnLineItemCharacteristicList

List of ComGkSoftwarePosApiServiceTransactionSaleReturnLineItemCharacteristic

The sale return line item characteristic list - SaleReturnLineItemCharacteristic[0..*]

saleReturnLineItemMerchandiseHierarchyGroupList

List of ComGkSoftwarePosApiServiceTransactionSaleReturnLineItemMerchandiseHierarchyGroup

The sale return line item merchandise hierarchy group list - SaleReturnLineItemMerchandiseHierarchyGroup[0..*]

retailTransactionLineItemI18NTextList

List of ComGkSoftwarePosApiServiceTransactionRetailTransactionLineItemI18NText

The retail transaction line item I18N text list - RetailTransactionLineItemI18NText[0..*]

serializedUnitModifer

com.gk_software.pos.api.service.transaction.SerializedUnitModifer

saleReturnLineItemSalesOrder

com.gk_software.pos.api.service.transaction.SaleReturnLineItemSalesOrder

reasonCode

String

The reason code

reasonCodeGroupCode

String

The reason code group code

reasonDescription

String

The reason description

retailTransactionLineItemAdditionalParameterList

List of ComGkSoftwarePosApiServiceTransactionRetailTransactionLineItemAdditionalParameter

The retail transaction line item additional parameter list

retailPriceModifierList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionExternalRetailPriceModifier

The retail price modifier list

lineItemExtensionList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionLineItemExtension

The line item extension list

printAdditionalLineItemTextLineList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionPrintAdditionalLineItemTextLine

The print additional line item text line list

3.732. ComGkSoftwarePosApiServiceTransactionFinalizeTransactionRequest

FinalizeTransactionRequest Request to finalize a transaction.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

ignoreParentOffline

X

Boolean

Indicates whether correlation checking should be ignored if parent pool is offline.

omitParentExport

Boolean

Indicates that the export of finalized transaction must be omit.

transactionId

String

The identifier for the transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.733. ComGkSoftwarePosApiServiceTransactionFiscalTagFieldResult

FiscalTagFieldResult Result of an single object that contains the tag field value related to each signature result.

Field Name Required Type Description Format

label

String

The label that must be printed on the receipt.

value

String

The fiscal value that must be printed on the receipt.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.734. ComGkSoftwarePosApiServiceTransactionGetEndDateTimestampExtensionRequest

GetEndDateTimestampExtensionRequest Request object to get the end date timestamp from transaction extensions of a transaction.

Field Name Required Type Description Format

transactionId

String

The transaction identifier for the transaction to get the end date timestamp from.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.735. ComGkSoftwarePosApiServiceTransactionGetOrCreateEndDateTimestampExtensionResult

GetOrCreateEndDateTimestampExtensionResult Result object for getting or creating the end date timestamp extension.

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

endDateTimestampExtension

com.gk_software.gkr.api.txpool.dto.TransactionExtension

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.736. ComGkSoftwarePosApiServiceTransactionGiftCertificateGiftCertificateRegistrationRequest

GiftCertificateRegistrationRequest Request object for operations which create a SaleReturnLineItem on active transaction.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

gcNumber

String

String : gift certificate number

gcItemNumber

String

String : gift certificate item number

gcAmount

com.gk_software.pos.api.model.dom.app.amount.Amount

serviceResult

com.gk_software.pos.api.model.dom.app.gift_certificate_service.GiftCertServiceResult

gcDescription

String

String : gift certificate description

online

X

Boolean

boolean : online

createReturnReceipt

X

Boolean

Specifies if a return receipt should be created.

externalSystemAdapterName

String

String : external system adapter name

gcClass

String

String : gc class

expiryDate

String

Date : expiry date Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

quantity

Integer

int : quantity

int32

actionCode

String

String : action code

gcType

String

String : gift certificate type

gcsUsage

X

Boolean

boolean : gcs usage

taxGroupID

String

String : tax group iD

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

track2

String

Track2 data.

additionalInfo

List of ComGkSoftwarePosApiModelDomAppGiftCertificateServiceAttributeValue

Contains additional information.

salesPersonNumberRequest

com.gk_software.pos.api.service.transaction.SalesPersonNumberRequest

takeAwaySaleMode

X

Boolean

Indicates whether the take away sale mode is active.

entryMethodCode

String

Contains the method with which the item was registered (keyed in, scanned through bar code, etc).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.737. ComGkSoftwarePosApiServiceTransactionInternalLineItemData

InternalLineItemData TODO: undocumented

Field Name Required Type Description Format

posItemID

String

Item identification.

itemID

String

Item identification.

amount

Double

Item amount.

double

taxGroupID

String

Item tax group id.

itemReceiptText

String

Item description

3.738. ComGkSoftwarePosApiServiceTransactionInvoiceNumberRequest

InvoiceNumberRequest Request object to create the invoice number and set it to transaction.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

invoicetransactionId

String

The invoice transaction identifier.

invoiceNumberFormat

String

The invoice number format pattern.

invoicePrefix

String

Prefix for invoices

creditNotePrefix

String

Prefix for credit notes

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.739. ComGkSoftwarePosApiServiceTransactionInvoicePrintoutTypeCodeRequest

InvoicePrintoutTypeCodeRequest Request object to set the invoice printout type code.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

invoicePrintoutTypeCode

String

The invoice printout type code.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.740. ComGkSoftwarePosApiServiceTransactionItemIdentificator

ItemIdentificator Domain object for ItemIdentificator.

Field Name Required Type Description Format

itemID

String

The id of the item to register.

uomCode

String

The id of the item to register.

3.741. ComGkSoftwarePosApiServiceTransactionLimitExceedResult

LimitExceedResult The limit exceed result

Field Name Required Type Description Format

limitExceedAction

X

String

The limit exceed action

oldPrice

X

Double

The old price

double

newPrice

X

Double

The new price

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.742. ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest

LineItemExtensionRequest Domain object for LineItemExtensionRequest.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

extensionKey

String

The extension Key.

extensionValue

String

The extension Value.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.743. ComGkSoftwarePosApiServiceTransactionLineItemExtensionsRequest

LineItemExtensionsRequest Domain object for LineItemExtensionsRequest.

Field Name Required Type Description Format

extensionRequests

List of ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest

The extensions request.

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.744. ComGkSoftwarePosApiServiceTransactionLineItemsReductionDetail

LineItemsReductionDetail Entity containing details for performing the item reduction.

Field Name Required Type Description Format

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

maximumReductionQuantity

Integer

Describes the maximum number of reductions to be performed on given line item.

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.745. ComGkSoftwarePosApiServiceTransactionLinkedItemRegistrationRequest

LinkedItemRegistrationRequest Request object for registering linked items.

Field Name Required Type Description Format

linkedItemId

String

The id of the linked item to be registered.

linkedItemUOMCode

String

the UOM code of the linked item to be registered.

mainItemId

String

The id of the main item linked to this linked item.

actionCode

String

The actionCode of this linked item.

units

Double

The units of this linked item.

double

quantity

Integer

The quantity of the mainitem.

int32

maintemSequenceNumber

Integer

linkedLineItemSequenceNumber of this linked item.

int32

mainLineItem

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.746. ComGkSoftwarePosApiServiceTransactionPKORKONumberRequest

PKORKONumberRequest Request object to retrieve new document number for PKO/RKO reports.

Field Name Required Type Description Format

invoicetransactionId

String

The identifier for the invoice transaction.

invoiceNumberFormat

String

The invoice number format pattern.

transactionType

String

The transaction type.

generatorName

String

The generator name.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.747. ComGkSoftwarePosApiServiceTransactionPayInOutLineItemRequest

PayInOutLineItemRequest Domain object for CreatePayInOutLineItem Request

Field Name Required Type Description Format

reason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

amount

Double

The amount

double

taxGroupId

String

The taxGroupId

itemType

String

The PayInOutType

Enum: PAY_IN_LINEITEM, PAY_IN_RECEIPT, PAY_OUT_LINEITEM, PAY_OUT_RECEIPT,

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

receiptText

String

The receiptText

customerReceiptText

String

The customerReceiptText

reasonParams

com.gk_software.pos.api.service.transaction.PayInOutReasonParam

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

sellerId

String

String to store seller Id

sellerRelationMethod

String

sellerRelationMethod to store the currently defined seller assignment method

Enum: CurrentLineItemOnly, CurrentAndFollowingLineItemsOfCurrentTransaction, CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions, AllLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentAndFollowingTransactions,

entryMethodCode

String

Contains the method with which the item was registered (keyed in, scanned through bar code, etc).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.748. ComGkSoftwarePosApiServiceTransactionPayInOutReasonParam

PayInOutReasonParam Domain object for PayInOutReasonParam

Field Name Required Type Description Format

input0_name

String

The input0_name.

input1_name

String

The input1_name.

input2_name

String

The input2_name.

input3_name

String

The input3_name.

input0_value

String

The input0_value.

input1_value

String

The input1_value.

input2_value

String

The input2_value.

input3_value

String

The input3_value.

input0_id

String

The input0_id.

input1_id

String

The input1_id.

input2_id

String

The input2_id.

input3_id

String

The input3_id.

3.749. ComGkSoftwarePosApiServiceTransactionPointsRefundBatchRequest

PointsRefundBatchRequest The entity for refunding batch of points line items.

Field Name Required Type Description Format

positionOperationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

retailTransactionLineItems

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

The retailTransactionLineItems

businessUnitId

String

The businessUnitId

trainingMode

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.750. ComGkSoftwarePosApiServiceTransactionPointsRefundRequest

PointsRefundRequest The entity PointsRefundRequest

Field Name Required Type Description Format

retailTransactionLineItem

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem

businessUnitId

String

The businessUnitId

ignoreFailures

X

Boolean

Indicates whether failures should be ignored during the cancellation process and tries to cancel all points.

voidTenderLineItems

X

Boolean

Indicates whether tender line items should be voided during the cancellation process.

trainingMode

Boolean

Indicates whether service call should be performed in training mode.

useLoyaltyService

String

It defines if a loyalty service should be used and which loyalty service.

loyaltyProgramId

String

It defines the id of the loyalty program.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.751. ComGkSoftwarePosApiServiceTransactionPosTransactionCRSCashExchangeRequest

PosTransactionCRSCashExchangeRequest Request object to create a cash recycler exchange transaction.

Field Name Required Type Description Format

operatorId

String

String: the operator ID

amountToPayOut

Double

Double: the amount that should be payed out

double

amountPayedOut

Double

Double: the amount that was payed out

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.752. ComGkSoftwarePosApiServiceTransactionPosTransactionRequest

PosTransactionRequest Request object for multiple PosTransactionService calls, e.g. to create special control transactions.

Field Name Required Type Description Format

retailStoreId

String

The retail store identifier.

workstationId

String

The workstation identifier.

clientVersion

String

The client version.

operatorId

String

The operator identifier.

terminalCache

String

The terminal cache.

reason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

taxCertificateId

String

The tax certificate identifier.

finalizeTransaction

X

Boolean

A flag to indicate if the transaction should be finalized. The default value is true.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.753. ComGkSoftwarePosApiServiceTransactionPrepaidPrepaidCreditRefundRequest

PrepaidCreditRefundRequest Request object for adding failed prepaid line items for refunding.

Field Name Required Type Description Format

refundReasonCode

String

The refund reason code

refundReasonGroupCode

String

The refund reason group code

invalidItems

List of ComGkSoftwarePosApiModelDomAppServicesTransactionRetailTransactionLineItemKey

List of line item keys for the invalid items

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.754. ComGkSoftwarePosApiServiceTransactionPrepaidPrepaidCreditSaleRegistrationRequest

PrepaidCreditSaleRegistrationRequest Request object for operations which create a SaleReturnLineItem for a prepaid credit sale on the active transaction.

Field Name Required Type Description Format

amount

Double

The amount value.

double

quantity

Integer

The quantity value.

int32

actionCode

String

The action code for the line item. The default value is 'SI'.

adapterType

String

The adapter type for the call to the external system for prepaid credit sales.

sm_id

Integer

The entry identifier from prepaidType configuration.

int32

item_id

String

The item identifier of the prepaid item

provider_code

String

The provider code of the prepaid item

resource_id

String

The resource key of the prepaid receipt

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

sellerId

String

String to store seller Id

sellerRelationMethod

String

sellerRelationMethod to store the currently defined seller assignment method

Enum: CurrentLineItemOnly, CurrentAndFollowingLineItemsOfCurrentTransaction, CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions, AllLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentAndFollowingTransactions,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.755. ComGkSoftwarePosApiServiceTransactionPrepaidPrepaidCreditSaleUpdateRequest

PrepaidCreditSaleUpdateRequest Request object for updating a SaleReturnLineItem of a prepaid credit sale.

Field Name Required Type Description Format

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnCode

String

The return code of the stored value server call.

serialNumber

String

The serial number of the prepaid card.

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.756. ComGkSoftwarePosApiServiceTransactionPrintOutTransactionsRequest

PrintOutTransactionsRequest Request object to search for printout transactions.

Field Name Required Type Description Format

onlySalesReprintable

Boolean

A flag to indicate that only transaction of type code 'RETAIL' and category code 'SALE' should be searched.

TransactionTypeCode

String

The transaction type code.

RetailTransactionTypeCode

String

The retail transaction type code.

transactionIsNotVoided

Boolean

A flag to indicate that only transactions that are not voided should be searched.

CancelledFlag

Boolean

A flag to indicate that only transactions that are cancelled should be searched.

SuspendedFlag

Boolean

A flag to indicate that only transactions that are suspended should be searched.

workstationID

String

The workstation identifier.

endWorkstationID

String

businessUnitGroupID

String

The business unit group identifier.

receiptIsPrintable

Boolean

A flag to indicate that only transactions that are printable should be searched.

maxReceiptCount

Integer

Limits the number of found receipts to the given value.

int32

beginDateTimestampGreaterOrEquals

String

The begin date timestamp greater or equals (as part of the search criteria). Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

parentCustomerIds

List of [String]

A list of parent customer identifiers.

customerIds

List of [String]

A list of customer identifiers.

customerAddressTypeCode

String

A card type which has to be used for the customer identification.

fuelingPointId

String

The fueling point id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.757. ComGkSoftwarePosApiServiceTransactionPrintoutRelatedAttributesRequest

PrintoutRelatedAttributesRequest Request object to set printout related attributes.

Field Name Required Type Description Format

transaction

com.gk_software.gkr.api.txpool.dto.Transaction

receiptPrintoutFlag

Boolean

A flag to indicate that for the transaction a receipt was printed.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.758. ComGkSoftwarePosApiServiceTransactionQuantityInput

QuantityInput Request object for quantity input.

Field Name Required Type Description Format

pieces

Integer

The pieces.

int32

length

Double

The length.

double

width

Double

The width.

double

height

Double

The height.

double

measure

Double

The measure.

double

weight

Double

The weight.

double

manualWeightInput

Boolean

The manual weight input.

units

Double

The units.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.759. ComGkSoftwarePosApiServiceTransactionRecalculateLineItemsRequest

RecalculateLineItemsRequest Request object for recalculation of line items PosTransactionService.

Field Name Required Type Description Format

items

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

A list of retail transaction line items for recalculation.

currencyCode

String

The currency code.

businessUnitGroupId

String

The business unit group identifier.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.760. ComGkSoftwarePosApiServiceTransactionReceiptAsEmailActivationRequest

ReceiptAsEmailActivationRequest Request object for receipt as email activation.

Field Name Required Type Description Format

emailRequestedFlag

X

Boolean

A flag to enable/disable receipt as email.

emailAddress

String

The user email address.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.761. ComGkSoftwarePosApiServiceTransactionRecoverTransactionRequest

RecoverTransactionRequest Request object to check for an open transaction in the persistence and if a transaction exits to load it and set as current active transaction.

Field Name Required Type Description Format

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.762. ComGkSoftwarePosApiServiceTransactionReduceLineItemsRequest

ReduceLineItemsRequest TODO: undocumented

Field Name Required Type Description Format

positionOperationConfiguration

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemsReductionDetail

List of ComGkSoftwarePosApiServiceTransactionLineItemsReductionDetail

List of entities containing details for performing the item reduction.

keyedOnline

Boolean

The keyed online state.

offlineMode

Boolean

A flag to indicate whether offline mode registration is active or not.

storeTransaction

Boolean

Indicates whether the transaction should be stored.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.763. ComGkSoftwarePosApiServiceTransactionRegisterCustomerAccountPaymentRequest

RegisterCustomerAccountPaymentRequest The entity RegisterCustomerAccountPaymentRequest

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

barcode

String

The barcode of the item to register. At least the barcode OR the itemIdentificator are mandatory request attributes.

itemIdentificator

com.gk_software.pos.api.service.transaction.ItemIdentificator

wicMode

X

Boolean

Wic mode flag.

takeOverSetItems

X

Boolean

Indicated whether set items should be registered individually or be added to head item.

orderMode

X

Boolean

The order mode.

layawayMode

X

Boolean

Indicates whether the layaway mode is active.

takeAwaySaleMode

X

Boolean

Indicates whether the take away sale mode is active.

fuelMaintenanceMode

X

Boolean

Indicates whether the fuel maintenance mode is active (GK Drive).

checkForVariants

X

Boolean

Indicates if variant check should be performed.

salesRestrictionsCheckNeeded

X

Boolean

Indicates if validation process should check sales restrictions.

returnReasonRequired

X

Boolean

indicates if variant check should be performed.

linkedEmptiesItem

X

Boolean

Indicates the request is for a linked empties deposit item.

closeLineItem

X

Boolean

Indicates whether line item should be closed during the registration (used for empties return using deposit collections).

getPromoIcons

X

Boolean

Indicates whether promo icons should be retrieved.

driveOffMode

X

Boolean

Indicates whether the GK Drive drive off mode is active.

measurementMode

X

Boolean

Indicates whether the GK Drive measurement mode is active.

emptiesReturnQuantity

Integer

Quantity to be overwritten for deposit item registered as empties during item registration.

int32

priceVariant

String

price variant to use.

Enum: Normal, Special, Actual, Group,

overridingPrice

Double

The overriding price.

double

overridingQuantity

com.gk_software.pos.api.service.transaction.QuantityInput

overridingPositionAmount

Double

The overriding position amount.

double

weightResult

com.gk_software.pos.api.service.client.hardware.scale.WeightResult

doPriceDifferenceLimitCheck

X

Boolean

Indicates whether the price difference limit checks should be done or not.

priceTypeCode

String

Price type code (for price change).

setPriceMode

String

Set price mode (for price change).

reasonCode

String

A reason code for this request (e.g. reason for returns).

reasonCodeGroupCode

String

A reason code group code for this request (e.g. reason for returns).

reasonDescription

String

A reason description for this request (e.g. reason for returns).

reasonParameter

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonParameterSO

priceChangeReasonCode

String

A price change reason code.

priceChangeReasonCodeGroupCode

String

A price change reason code group code.

priceChangeReasonDescription

String

A price change reason description.

serialNumber

String

Serial number to set.

itemTraceableUnitID

String

A universally unique identifier (min=0, max=32) used to identify an instance of a distinguishable instance of a retail item. The item traceable unit ID is similar to a serial number in that it allows each selling unit to be explicitly identified and distinguished from other selling units of the same Item.

receiptText

String

Receipt text to set.

linkedItemRegistrationRequest

com.gk_software.pos.api.service.transaction.LinkedItemRegistrationRequest

externalItemRegistrationRequest

com.gk_software.pos.api.service.transaction.ExternalItemRegistrationRequest

factor

Double

Double.

double

activeCustomerOrderId

String

The active customer order id.

customerSequenceNumber

Integer

The customer oder sequence number. @deprecated use customerOrderSequenceNumber instead.

int32

customerOrderSequenceNumber

Integer

The customer order sequence number.

int32

salesOrderTypeCode

String

The sales order type code.

salesOrderDeliveryTypeCode

String

The sales order delivery type code.

requestedDeliveryDate

String

The requested delivery date for the item. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

itemEntryConfig

com.gk_software.pos.api.model.config.process.flows.ItemEntryConfig

salesPersonNumberRequest

com.gk_software.pos.api.service.transaction.SalesPersonNumberRequest

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

entryMethodCode

String

The entry method code. It specifies how the action was triggered (keyed, scanned, …​).

scaleTransactionParams

com.gk_software.pos.api.service.transaction.ScaleTransactionParams

keyedOnline

Boolean

The keyed online state.

postValidationSalesRestrictionIds

X

List of [String]

The list of post validation sales restriction ids to add to SaleReturnLineItem.

promotionTriggerActive

Boolean

The promotion trigger active state.

lineItemItemType

String

The qualified line item type.

retailPriceModifierList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionExternalRetailPriceModifier

The list of external retail price modifier to add to transaction.

lineItemExtensionList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionLineItemExtension

The list of external retail price modifier to add to transaction.

printAdditionalLineItemTextLineList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionPrintAdditionalLineItemTextLine

The print list for additional line item text to print.

scaleMode

String

The current active scale mode.

Enum: SelfService, Prepackaging, Service,

scaleSellingMode

String

The current active scale selling mode.

Enum: Standard, Fast,

courseNumber

String

The course Number to be set on line item.

itemProvider

String

The parameter defines the provider for the item data.

Enum: Local, Remote,

comboMealRegistrationRequest

com.gk_software.pos.api.service.transaction.ComboMealRegistrationRequest

appEnablement

Boolean

itemType

String

The itemType

i18NTextPayOut

String

The i18NTextPayOut

i18NTextPayIn

String

The i18NTextPayIn

languageDifferent

Boolean

The languageDifferent

customerAccountText

String

The customerAccountText

customerId

String

The customerId

receiptTextPI

String

The receiptTextPI

receiptTextPO

String

The receiptTextPO

openAmount

Double

The openAmount

double

amount

Double

The amount

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.764. ComGkSoftwarePosApiServiceTransactionRegisterEmptiesTransactionRequest

RegisterEmptiesTransactionRequest Request object for the retrieve empties transaction process.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

returnMode

X

Boolean

A flag to indicate that return mode is active.

collectiveNumber

String

The collective number. When add as one line item is wanted or necessary the item with collective number is used for empties return transaction registration.

transactionIdentifier

String

The transaction identifier for the empties return transaction.

amount

Double

The amount. In case of collective item usage the unit price amount for the line item registration.

double

amount1

Double

The amount1. In case of collective item usage and amount is not used the unit price amount for the one-way and multi-way returnable deposit type 1 line item registration.

double

amount2

Double

The amount2. In case of collective item usage and amount is not used the unit price amount for the one-way and multi-way returnable deposit type 2 line item registration.

double

oneWayItemNumber

String

The one-way deposit item number.

multiWayItemNumber

String

The multi-way deposit item number.

depositType1

String

The deposit type 1.

Enum: RETURNABLE, NON_RETURNABLE,

depositType2

String

The deposit type 2.

Enum: RETURNABLE, NON_RETURNABLE,

addAsOneLineItem

X

Boolean

A flag to indicate that the empties return line items should be registered as one collective line item.

statusOfflineConfirmed

X

Boolean

A flag to indicate that the status 'offline' was confirmed.

statusRedeemedConfirmed

X

Boolean

A flag to indicate that the status 'redeemed' was confirmed.

statusNotFoundConfirmed

X

Boolean

A flag to indicate that the status 'not found' was confirmed.

emptiesTransaction

com.gk_software.gkr.api.txpool.dto.CompleteTransaction

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

storeId

String

The retail store identifier.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.765. ComGkSoftwarePosApiServiceTransactionRegisterEmptiesTransactionResult

RegisterEmptiesTransactionResult Result object for the retrieve empties transaction process.

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

statusOkay

X

Boolean

A flag to indicate whether the registration status is okay or not in a simple way.

statusResult

String

The status result (in detail).

Enum: Success, Offline, NotFound, Cancelled, Voided, Redeemed,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.766. ComGkSoftwarePosApiServiceTransactionRegisterRetrievedSalesOrderRequest

RegisterRetrievedSalesOrderRequest The entity RegisterRetrievedSalesOrderRequest

Field Name Required Type Description Format

externalCustomerOrderID

String

The externalCustomerOrderID

itemPositions

List of ComGkSoftwarePosApiServiceTransactionSalesOrderPosition

The itemPositions List

clearedDownpaymentPosition

String

The clearedDownpaymentPosition

dcActionCode

String

The dcActionCode

dcReceiptText

String

The dcReceiptText

dcRegularUnitPrice

Double

The dcRegularUnitPrice

double

dcQuantity

Integer

The dcQuantity

int32

languageDifferent

Boolean

The languageDifferent

dcI18NText

String

The dcI18NText

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.767. ComGkSoftwarePosApiServiceTransactionRegisterScaleTransactionRequest

RegisterScaleTransactionRequest Request object for the retrieve scale transaction process.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

returnMode

X

Boolean

A flag to indicate that return mode is active.

collectiveNumber

String

The collective number. When single item resolving is not wanted or possible the item with collective number is used for scale transaction registration.

transactionIdentifier

String

The transaction identifier for the scale transaction.

amount

Double

The amount. In case of collective item usage the unit price amount for the line item registration.

double

statusOfflineConfirmed

X

Boolean

A flag to indicate that the status 'offline' was confirmed.

statusRedeemedConfirmed

X

Boolean

A flag to indicate that the status 'redeemed' was confirmed.

statusNotFoundConfirmed

X

Boolean

A flag to indicate that the status 'not found' was confirmed.

scaleTransaction

com.gk_software.gkr.api.txpool.dto.CompleteTransaction

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

suspendCodeTransaction

com.gk_software.gkr.api.txpool.dto.Transaction

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.768. ComGkSoftwarePosApiServiceTransactionRegisterScaleTransactionResult

RegisterScaleTransactionResult Result object for the retrieve scale transaction process.

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

statusOkay

X

Boolean

A flag to indicate whether the registration status is okay or not in a simple way.

statusResult

String

The status result (in detail).

Enum: Success, Offline, NotFound, Cancelled, Voided, Redeemed,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.769. ComGkSoftwarePosApiServiceTransactionRegistrationExternalRequest

RegistrationExternalRequest Domain object for Registration External Request.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

externalLineItemData

com.gk_software.pos.api.service.transaction.ExternalLineItemData

salesPersonNumber

String

The seller id.

sellerRelationMethod

String

The seller relation method.

Enum: CurrentLineItemOnly, CurrentAndFollowingLineItemsOfCurrentTransaction, CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions, AllLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentAndFollowingTransactions,

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.770. ComGkSoftwarePosApiServiceTransactionRegistrationInternalRequest

RegistrationInternalRequest TODO: undocumented

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

internalLineItemData

com.gk_software.pos.api.service.transaction.InternalLineItemData

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.771. ComGkSoftwarePosApiServiceTransactionRegistrationRequest

RegistrationRequest Domain object for Registration Request.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

barcode

String

The barcode of the item to register. At least the barcode OR the itemIdentificator are mandatory request attributes.

itemIdentificator

com.gk_software.pos.api.service.transaction.ItemIdentificator

wicMode

X

Boolean

Wic mode flag.

takeOverSetItems

X

Boolean

Indicated whether set items should be registered individually or be added to head item.

orderMode

X

Boolean

The order mode.

layawayMode

X

Boolean

Indicates whether the layaway mode is active.

takeAwaySaleMode

X

Boolean

Indicates whether the take away sale mode is active.

fuelMaintenanceMode

X

Boolean

Indicates whether the fuel maintenance mode is active (GK Drive).

checkForVariants

X

Boolean

Indicates if variant check should be performed.

salesRestrictionsCheckNeeded

X

Boolean

Indicates if validation process should check sales restrictions.

returnReasonRequired

X

Boolean

indicates if variant check should be performed.

linkedEmptiesItem

X

Boolean

Indicates the request is for a linked empties deposit item.

closeLineItem

X

Boolean

Indicates whether line item should be closed during the registration (used for empties return using deposit collections).

getPromoIcons

X

Boolean

Indicates whether promo icons should be retrieved.

driveOffMode

X

Boolean

Indicates whether the GK Drive drive off mode is active.

measurementMode

X

Boolean

Indicates whether the GK Drive measurement mode is active.

emptiesReturnQuantity

Integer

Quantity to be overwritten for deposit item registered as empties during item registration.

int32

priceVariant

String

price variant to use.

Enum: Normal, Special, Actual, Group,

overridingPrice

Double

The overriding price.

double

overridingQuantity

com.gk_software.pos.api.service.transaction.QuantityInput

overridingPositionAmount

Double

The overriding position amount.

double

weightResult

com.gk_software.pos.api.service.client.hardware.scale.WeightResult

doPriceDifferenceLimitCheck

X

Boolean

Indicates whether the price difference limit checks should be done or not.

priceTypeCode

String

Price type code (for price change).

setPriceMode

String

Set price mode (for price change).

reasonCode

String

A reason code for this request (e.g. reason for returns).

reasonCodeGroupCode

String

A reason code group code for this request (e.g. reason for returns).

reasonDescription

String

A reason description for this request (e.g. reason for returns).

reasonParameter

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonParameterSO

priceChangeReasonCode

String

A price change reason code.

priceChangeReasonCodeGroupCode

String

A price change reason code group code.

priceChangeReasonDescription

String

A price change reason description.

serialNumber

String

Serial number to set.

itemTraceableUnitID

String

A universally unique identifier (min=0, max=32) used to identify an instance of a distinguishable instance of a retail item. The item traceable unit ID is similar to a serial number in that it allows each selling unit to be explicitly identified and distinguished from other selling units of the same Item.

receiptText

String

Receipt text to set.

linkedItemRegistrationRequest

com.gk_software.pos.api.service.transaction.LinkedItemRegistrationRequest

externalItemRegistrationRequest

com.gk_software.pos.api.service.transaction.ExternalItemRegistrationRequest

factor

Double

Double.

double

activeCustomerOrderId

String

The active customer order id.

customerSequenceNumber

Integer

The customer oder sequence number. @deprecated use customerOrderSequenceNumber instead.

int32

customerOrderSequenceNumber

Integer

The customer order sequence number.

int32

salesOrderTypeCode

String

The sales order type code.

salesOrderDeliveryTypeCode

String

The sales order delivery type code.

requestedDeliveryDate

String

The requested delivery date for the item. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

itemEntryConfig

com.gk_software.pos.api.model.config.process.flows.ItemEntryConfig

salesPersonNumberRequest

com.gk_software.pos.api.service.transaction.SalesPersonNumberRequest

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

entryMethodCode

String

The entry method code. It specifies how the action was triggered (keyed, scanned, …​).

scaleTransactionParams

com.gk_software.pos.api.service.transaction.ScaleTransactionParams

keyedOnline

Boolean

The keyed online state.

postValidationSalesRestrictionIds

X

List of [String]

The list of post validation sales restriction ids to add to SaleReturnLineItem.

promotionTriggerActive

Boolean

The promotion trigger active state.

lineItemItemType

String

The qualified line item type.

retailPriceModifierList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionExternalRetailPriceModifier

The list of external retail price modifier to add to transaction.

lineItemExtensionList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionLineItemExtension

The list of external retail price modifier to add to transaction.

printAdditionalLineItemTextLineList

List of ComGkSoftwarePosApiModelDomAppServicesTransactionPrintAdditionalLineItemTextLine

The print list for additional line item text to print.

scaleMode

String

The current active scale mode.

Enum: SelfService, Prepackaging, Service,

scaleSellingMode

String

The current active scale selling mode.

Enum: Standard, Fast,

courseNumber

String

The course Number to be set on line item.

itemProvider

String

The parameter defines the provider for the item data.

Enum: Local, Remote,

comboMealRegistrationRequest

com.gk_software.pos.api.service.transaction.ComboMealRegistrationRequest

appEnablement

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.772. ComGkSoftwarePosApiServiceTransactionRegistrationResult

RegistrationResult The entity RegistrationResult

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

statusOk

X

Boolean

indicates if the registration could be proceeded without error or callback

mainPOSItemId

String

the unique id of this item

posItemId

String

itemId

String

the item id (may be different than mainPOSItemId)

itemName

String

the item name

itemDescription

String

the item description

itemTare

Double

a tare value for this item

double

forcePriceInput

X

Boolean

The manually entered price

forceQuantityInput

X

Boolean

The manually entered quantity

priceInputSignal

X

Boolean

The price input signal

quantityInputSignal

X

Boolean

The quantity input signal

promotionTriggerSignal

X

Boolean

The promotion trigger signal

promotionTriggerSignalType

X

String

The promotion trigger signal type

Enum: OK, FORBIDDEN, AUTHORIZATION, WARNING, HIGHER_PRICE_FORBIDDEN, LOWER_PRICE_FORBIDDEN, ZERO_PRICE_FORBIDDEN, PRICE_CHANGE_FORBIDDEN, LINE_ITEM_NOT_REBATABLE, PROMOTION_TRIGGER_NOT_APPLIED,

salesRestrictions

List of [String]

list of sales restrictions

salesRestrictionList

List of ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoSalesRestrictionSO

The sales restriction list

prepaidItem

X

Boolean

not used atm

hasLinkedItems

X

Boolean

not used atm

reasonResult

com.gk_software.pos.api.service.masterdata.ReasonResult

forceReturnReasonInput

X

Boolean

ask for return reason

forceSerialNumberInput

X

Boolean

ask for serial number

variantItemsAvailable

X

Boolean

indicates if there exist variants and one must be selected

emptiesReturn

X

Boolean

The empties return object

accumulateExistingQuantity

X

Boolean

The accumulate existing quantity

price

X

Double

if price could be calculated it is stored in here

double

quantityInputMethod

String

quantity input method of this item

itemClassCode

String

preregisteredQuantity

Integer

quantity registered before item registration

int32

itemKey

com.gk_software.pos.api.model.dom.app.services.transaction.PosUOMItemDoKey

usedBarcode

String

String - he barcode originally used to register the item

limitExceedResult

com.gk_software.pos.api.service.transaction.LimitExceedResult

discountIconList

List of ComGkSoftwarePosFlowLibsTransactionDiscountIconList

A list of discount item icon info

prepaidType

com.gk_software.pos.api.model.config.component.server.prepaid_type.PrepaidType

hasInvalidQuantity

X

Boolean

The has invalid quantity flag

packagePriceQuantity

Integer

The quantity for which the unit price is applied to.

int32

comboMealItem

X

Boolean

The register combo meal flag

originalPositionAmount

Double

The position amount from the item barcode.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.773. ComGkSoftwarePosApiServiceTransactionRegistrationServiceFeeRequest

RegistrationServiceFeeRequest The entity RegistrationServiceFeeRequest

Field Name Required Type Description Format

operationConfiguration

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

preCommissioningThresholdList

X

List of [String]

This parameter defines a list of thresholds for pre-commissioning.

preCommissioningValue

X

List of [String]

This parameter defines a list of absolute values (PreCommissioningTypeCode = 'PS') or percentage rates (PreCommissioningTypeCode = 'TP').

preCommissioningTypeCode

X

String

This parameter defines whether a percentage of the total or an absolute value is set as price for the service item.values: PS, TP

  • 'PS' (= price single - for setting a single price depending on the threshold)

  • 'TP' (= total percent - for setting the price as a percentage of the total)

Enum: PS, TP,

preCommissioningRoundMethod

X

String

This parameter defines the rounding rule in case of PreCommissioningTypeCode = 'TP'.values: NO_ROUNDING, ROUND_HALF_UP, ROUND_DOWN, ROUND_UP, ROUND_HALF_DOWN

  • NO_ROUNDING (00)

  • ROUND_HALF_UP (01)

  • ROUND_DOWN (02)

  • ROUND_UP (03)

  • ROUND_HALF_DOWN (04)

Enum: NO_ROUNDING, ROUND_HALF_UP, ROUND_DOWN, ROUND_UP, ROUND_HALF_DOWN,

preCommissioningServiceTaxGroupID

String

This parameter defines the TaxGroupID for the service item, if needed.

receiptText

String

This parameter defines the receipt text.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.774. ComGkSoftwarePosApiServiceTransactionRemoveLineItemExtensionRequest

RemoveLineItemExtensionRequest Domain object for removing batch of line item extensions from one line item.

Field Name Required Type Description Format

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

extensionKey

String

The extension key used for the extension line items lookup.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.775. ComGkSoftwarePosApiServiceTransactionRemoveLineItemsExtensionsRequest

RemoveLineItemsExtensionsRequest Domain object for removing batch of line item extensions from one or more line items.

Field Name Required Type Description Format

removeExtensionRequests

List of ComGkSoftwarePosApiServiceTransactionRemoveLineItemExtensionRequest

The list of requests for removing extensions from one or more single line items.

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.776. ComGkSoftwarePosApiServiceTransactionRemoveSaleReturnLineItemExtensionsRequest

RemoveSaleReturnLineItemExtensionsRequest Request for removing sale return line item extensions from sale return line items.

Field Name Required Type Description Format

extensionKeys

X

List of [String]

Extension keys of sale return line item extensions.

storeTransaction

X

Boolean

Indicates whether transaction should be persisted after modifications.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.777. ComGkSoftwarePosApiServiceTransactionRemoveTransactionAdditionalPrintoutsRequest

RemoveTransactionAdditionalPrintoutsRequest Request object to remove additional printout contents from a transaction.

Field Name Required Type Description Format

transactionId

String

transactionAdditionalPrintoutKeys

List of ComGkSoftwarePosApiModelDomAppServicesTransactionTransactionAdditionalPrintoutKey

A list of transaction additional printout keys to be removed from transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.778. ComGkSoftwarePosApiServiceTransactionRemoveTransactionExtensionRequest

RemoveTransactionExtensionRequest Request object for removing a transaction extension from the transaction.

Field Name Required Type Description Format

extensionKey

String

The transaction extension key to be removed to transaction.

transactionId

String

The identifier of the transaction to remove the extension key from.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.779. ComGkSoftwarePosApiServiceTransactionRepeatLineItemRequest

RepeatLineItemRequest Domain object for RepeatLineItem Request

Field Name Required Type Description Format

lineItem

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem

mainlineItem

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem

positionOperationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

positionRepetitionConfig

com.gk_software.pos.api.model.config.process.action.PositionRepetitionConfig

accumulateQuantity

X

Boolean

Indicates whether the line item quantity should be accumulated.

quantity

com.gk_software.pos.api.service.transaction.QuantityInput

lineItemKey

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem

keyedOnline

Boolean

The keyed on line state.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.780. ComGkSoftwarePosApiServiceTransactionRetailTransactionLineItemAdditionalParameter

RetailTransactionLineItemAdditionalParameter The retail transaction line item additional parameter

Field Name Required Type Description Format

externalParameterID

String

The external Parameter ID

parameterName

String

The parameter Name

ParameterValue

String

The parameter value.

3.781. ComGkSoftwarePosApiServiceTransactionRetailTransactionLineItemI18NText

RetailTransactionLineItemI18NText The retail transaction lineItem I18N text

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

textSequenceNumber

Integer

The text sequence number

int32

languageID

String

The language ID

category

String

The category

text

String

The text

pictureFlag

Boolean

The picture flag

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.782. ComGkSoftwarePosApiServiceTransactionRetrieveOpenSSCTransactionRequest

RetrieveOpenSSCTransactionRequest Request object to retrieve open transactions with workstation type code for self scanning.

Field Name Required Type Description Format

storeId

String

The retail store identifier (as part of the search criteria).

workstationId

String

The workstation identifier (as part of the search criteria).

customerId

String

The customer identifier (as part of the search criteria).

customerCardType

String

The customer card type (as part of the search criteria).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.783. ComGkSoftwarePosApiServiceTransactionRetrieveSuspendedRetailTransactionsByIdsRequest

RetrieveSuspendedRetailTransactionsByIdsRequest Request object for retrieving suspended retail transactions

Field Name Required Type Description Format

transactionIds

List of [String]

A list of transaction identifiers.

onlySSCTransactions

Boolean

A flag to indicate that only suspended transaction with workstation type code for self scanning are wanted.

overtakeCustomerFromOriginalReceipt

Boolean

A flag to indicate that the customer assignment from the suspended transaction should be taken over to the current transaction.

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

allowOtherStores

Boolean

A flag to indicate whether transactions from other stores are allowed.

promotionHandling

String

The promotion handling. If set to 'OLDDISCOUNTS' the retail price modifier for the retrieved item gets the flag externalSystemOriginatorFlag set to true.

consolidateLineItemsRetrieve

Boolean

The parameter defines, if the consolidation of retrieving transactions should be executed.

consolidateReturnItems

Boolean

The parameter controls, whether items with SaleReturnLineItem.ActionCode = RI should be consolidated or not.

rescanEnabled

Boolean

The parameter defines, if rescan feature is enabled.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.784. ComGkSoftwarePosApiServiceTransactionRetrieveTransactionFromSuspendCodeRequest

RetrieveTransactionFromSuspendCodeRequest Request object to suspend transaction converted from suspend codes.

Field Name Required Type Description Format

transactionFromConvertedSuspendCodes

com.gk_software.gkr.api.txpool.dto.Transaction

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

consolidateLineItemsRetrieve

Boolean

The parameter defines, if the consolidation of retrieving transactions should be executed.

consolidateReturnItems

Boolean

The parameter controls, whether items with SaleReturnLineItem.ActionCode = RI should be consolidated or not.

rescanEnabled

Boolean

The parameter defines, if rescan feature is enabled.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.785. ComGkSoftwarePosApiServiceTransactionReturnLineItemBulkRequest

ReturnLineItemBulkRequest Request object for the the return line item operation.

Field Name Required Type Description Format

returnWithTransactionConfig

com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig

refundTransactionID

String

The identifier for the refund transaction.

reasonGroupCode

String

The reason group code.

salesPersonNumber

String

returnLineItemElementList

List of ComGkSoftwarePosApiServiceTransactionReturnLineItemElement

A list of return line items that should be returned.

createReturnReceipt

X

Boolean

It specifies whether a return receipt is created. This receipt includes return line items only.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.786. ComGkSoftwarePosApiServiceTransactionReturnLineItemElement

ReturnLineItemElement List element type for ReturnLineItemBulkRequest

Field Name Required Type Description Format

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

quantity

Integer

The line item quantity.

int32

units

X

Double

The line item units.

double

reasonCode

String

The reason code.

entryMethodCode

String

The entry method code of the return action.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.787. ComGkSoftwarePosApiServiceTransactionReturnLineItemRequest

ReturnLineItemRequest Request object for the the return line item operation.

Field Name Required Type Description Format

returnWithTransactionConfig

com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig

lineItemKeyToReturn

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

taxLineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.SaleReturnTaxLineItemKey

lineItem

com.gk_software.gkr.api.txpool.dto.RetailTransactionLineItem

taxPercent

Double

The tax percent

double

taxAmount

Double

The tax amount

double

reason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

quantity

X

Integer

Quantity to return.

int32

units

X

Double

Units to return.

double

reasonCode

String

The reason code

reasonGroupCode

String

The reason group Code

extensionKey

String

The extension key

extensionValue

String

The extension value

customerIdentifier

String

The customerIdentifier

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.788. ComGkSoftwarePosApiServiceTransactionReturnTransactionRequest

ReturnTransactionRequest Request object for the the return transaction operation.

Field Name Required Type Description Format

returnWithTransactionConfig

com.gk_software.pos.api.model.config.process.flows.ReturnWithTransactionConfig

transactionToReturn

String

The identifier for the transaction to return.

reasonCode

String

The reason code.

reasonGroupCode

String

The reason group code.

salesPersonNumber

String

createReturnReceipt

X

Boolean

It specifies whether a return receipt is created. This receipt includes return line items only.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.789. ComGkSoftwarePosApiServiceTransactionReturnTransactionWithTempSessionRequest

ReturnTransactionWithTempSessionRequest TODO: undocumented

Field Name Required Type Description Format

operatorId

String

storeId

String

workstationId

String

workstationTypeCode

String

clientVersion

String

trainingMode

Boolean

createReturnReceipt

Boolean

salesPersonNumber

String

transactionID

String

takeOverCustomersFromOriginalSc

Boolean

returnPrepaidAllowed

Boolean

reasonCode

String

reasonGroupCode

String

conditionSplitConfig

com.gk_software.pos.api.model.config.process.flows.ConditionSplitConfig

returnLineItemElementList

List of ComGkSoftwarePosApiServiceTransactionReturnLineItemElement

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.790. ComGkSoftwarePosApiServiceTransactionReturnableForRestrictionTypeCodesRequest

ReturnableForRestrictionTypeCodesRequest Request object used to determine whether the transaction is returnable, given a set of restriction type codes.

Field Name Required Type Description Format

transactionToReturnId

String

The identifier of the return transaction to interrogate.

restrictionTypeCodes

List of [String]

The restriction types codes of the tenders used in the original transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.791. ComGkSoftwarePosApiServiceTransactionSaleReturnLineItemCharacteristic

SaleReturnLineItemCharacteristic The sale return line item characteristic

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

characteristicID

String

The characteristic ID

characteristicValueID

String

The characteristic value ID

characteristicValueName

String

The characteristic value name

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.792. ComGkSoftwarePosApiServiceTransactionSaleReturnLineItemDataRequest

SaleReturnLineItemDataRequest Request object for the item registration process.

Field Name Required Type Description Format

itemType

String

The itemType.

subItemType

String

The subItemType

actionCode

String

The actionCode

units

Double

The units

double

quantity

Integer

The quantity

int32

quantityInputMethod

String

The quantityInputMethod

itemId

String

The itemId

mainPOSItemId

String

The mainPOSItemId

posItemId

String

The posItemId

registrationNumber

String

The registrationNumber

mainMerchandiseHierarchyGroupId

String

The mainMerchandiseHierarchyGroupId

mainMerchandiseHierarchyGroupIdQualifier

String

The mainMerchandiseHierarchyGroupIdQualifier

merchandiseHierarchyGroupName

String

The merchandiseHierarchyGroupName

merchandiseHierarchyGroupDescription

String

The merchandiseHierarchyGroupDescription

receiptText

String

The receiptText

receiptDescription

String

The receiptDescription

regularUnitPrice

Double

The regularUnitPrice

double

actualUnitPrice

Double

The actualUnitPrice

double

priceTypeCode

String

The priceTypeCode

taxGroupID

String

The taxGroupID

discountFlag

Boolean

The discountFlag

frequentShopperPointsEligibilityFlag

Boolean

The frequentShopperPointsEligibilityFlag

discountTypeCode

String

The discountTypeCode

invoiceId

String

The invoiceId

priceModifierList

List of ComGkSoftwareGkrApiTxpoolDtoRetailPriceModifier

The price modifier list.

promotion

com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionSO

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

priceChangeTypeCode

String

The price change type code

prohibitReturnFlag

Boolean

The prohibit return flag

notConsideredByLoyaltyEngineFlag

Boolean

The not considered by loyalty (pricing) engine flag

lineItemExtensioRequestList

List of ComGkSoftwarePosApiServiceTransactionLineItemExtensionRequest

The line item request extension list.

unknownItemFlag

X

Boolean

The unknown item flag.

reason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

returnMode

X

Boolean

The return mode.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.793. ComGkSoftwarePosApiServiceTransactionSaleReturnLineItemMerchandiseHierarchyGroup

SaleReturnLineItemMerchandiseHierarchyGroup The sale return line item merchandise hierarchy group

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

MerchandiseHierarchyGroupIDQualifier

String

The merchandise hierarchy group ID qualifier

MerchandiseHierarchyGroupID

String

The merchandise hierarchy group ID

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.794. ComGkSoftwarePosApiServiceTransactionSaleReturnLineItemSalesOrder

SaleReturnLineItemSalesOrder The sale return line item sales order.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

externalCustomerOrderID

String

The external customer order ID

customerOrderSequenceNumber

Integer

The customer order sequence number

int32

salesOrderTypeCode

String

The sales order type code

salesOrderDeliveryTypeCode

String

The sales order delivery type code

requestedDeliveryDate

String

The requested delivery date Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.795. ComGkSoftwarePosApiServiceTransactionSalesOrderCommonData

SalesOrderCommonData Entity describing common sales order data.

Field Name Required Type Description Format

resultCode

String

The result code for a ERP service call. If the result code is equal to 5, the call was not successful.

priceComponentList

List of ComGkSoftwarePosApiServiceTransactionSalesOrderExtendedPriceComponent

The customer order condition data.

totalGross

X

Double

The order amount (gross).

double

totalNet

X

Double

The order amount (net).

double

totalTax

X

Double

The total tax amount.

double

itemList

List of ComGkSoftwarePosApiServiceTransactionSalesOrderExtendedItemData

The order line items.

SAP_DUMMY_ORDER_ID

X

String

Dummy identifier for actual SAP sales order.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.796. ComGkSoftwarePosApiServiceTransactionSalesOrderCommonPriceComponent

SalesOrderCommonPriceComponent The entity SalesOrderCommonPriceComponent

Field Name Required Type Description Format

conditionTypeCode

String

conditionTypeCode

conditionRate

X

Double

conditionRate

double

conditionBase

X

Double

conditionBase

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.797. ComGkSoftwarePosApiServiceTransactionSalesOrderCommonScheduleLine

SalesOrderCommonScheduleLine The entity SalesOrderCommonScheduleLine

Field Name Required Type Description Format

deliveryDate

String

The deliveryDate Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

requestedQuantity

X

Double

The requestedQuantity

double

confirmedQuantity

X

Double

The confirmedQuantity

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.798. ComGkSoftwarePosApiServiceTransactionSalesOrderExtendedItemData

SalesOrderExtendedItemData The entity SalesOrderExtendedItemData

Field Name Required Type Description Format

id

String

The id

description

String

The description

productInternalId

String

The productInternalId

productSalesMeasureUnitCode

String

The productSalesMeasureUnitCode

requestDate

String

The requestDate Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

deliveryTermsDeliveryPlantId

String

The deliveryTermsDeliveryPlantId

requestedQuantity

X

Double

The requestedQuantity

double

receivingPointId

String

The receivingPointId

productStandardId

String

The productStandardId

itemPriceComponentList

List of ComGkSoftwarePosApiServiceTransactionSalesOrderExtendedPriceComponent

The itemPriceComponentList

confirmedQuantity

X

Double

The confirmedQuantity

double

deliveredQuantity

X

Double

The deliveredQuantity

double

rejectionReasonCode

String

The rejectionReasonCode

netAmount

X

Double

The netAmount

double

netPrice

X

Double

The netPrice

double

taxAmount

X

Double

The taxAmount

double

scheduleLineList

List of ComGkSoftwarePosApiServiceTransactionSalesOrderCommonScheduleLine

The scheduleLineList

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.799. ComGkSoftwarePosApiServiceTransactionSalesOrderExtendedPriceComponent

SalesOrderExtendedPriceComponent The entity SalesOrderExtendedPriceComponent

Field Name Required Type Description Format

conditionTypeCode

String

conditionTypeCode

conditionRate

X

Double

conditionRate

double

conditionBase

X

Double

conditionBase

double

total

X

Double

The total

double

conditionActive

X

Boolean

The condition active

inactivityReasonCode

String

The inactivity reasonCode

priceSpecificationElementTypeCode

String

The priceSpecificationElement typeCode

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.800. ComGkSoftwarePosApiServiceTransactionSalesOrderPosition

SalesOrderPosition The entity SalesOrderPosition

Field Name Required Type Description Format

canceledValue

Double

The canceled value

double

deliveryTypeCode

String

The delivery type code

quantity

Integer

The quantity

int32

units

Double

The units

double

regularPrice

Double

The regularPrice

double

receiptText

String

The receiptText

posItemId

String

The posItemId

itemTypeCode

String

The itemTypeCode

subItemTypeCode

String

The sub item type code

customerOrderSequenceNumber

Integer

The customerOrderSequenceNumber

int32

deliveryDate

String

The deliveryDate Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

orderId

String

The orderId

discountGP

Double

The discountGP

double

sapDebatesPromotionId

String

The sapDebatesPromotionId

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.801. ComGkSoftwarePosApiServiceTransactionSalesOrderSalesDocItem

SalesOrderSalesDocItem The SalesOrderSalesDocItem

Field Name Required Type Description Format

grossValue

Double

GrossValue of the item

double

description

String

description of the item

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.802. ComGkSoftwarePosApiServiceTransactionSalesPersonNumberRequest

SalesPersonNumberRequest Domain object for SalesPersonNumberRequest

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

salesPersonNumber

String

set sales Person Number (for Entered salesperson number).

sellerRelationMethod

String

The Seller Relation Method.

Enum: CurrentLineItemOnly, CurrentAndFollowingLineItemsOfCurrentTransaction, CurrentAndFollowingLineItemsOfCurrentAndFollowingTransactions, AllLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentTransaction, FollowingLineItemsOfCurrentAndFollowingTransactions,

sellerAssignmentNeeded

Boolean

Defines whether the input of a sellerId is needed.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.803. ComGkSoftwarePosApiServiceTransactionScaleTransactionParams

ScaleTransactionParams Wrapper object used for offline scale transaction registration.

Field Name Required Type Description Format

offlineMode

X

Boolean

A flag to indicate whether offline mode registration is active or not.

collectiveNumber

String

The collective number. When single item resolving is not wanted or possible the item with collective number is used for scale transaction registration.

transactionIdentifier

String

The transaction identifier for the scale transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.804. ComGkSoftwarePosApiServiceTransactionSearchAndRetrieveSuspendedRetailTransactionsRequest

SearchAndRetrieveSuspendedRetailTransactionsRequest Request object for searching and retrieving suspended retail transactions.

Field Name Required Type Description Format

businessUnitId

String

The business unit identifier.

suspendNumber

String

The suspend number.

parentCustomerIds

List of [String]

A list of parent customer identifiers.

customerIds

List of [String]

A list of customer identifiers.

customerRequired

Boolean

A flag to indicate if a customer assignment is required. If the list of customer identifiers is not used but this flag is set to true, then the customer assignment of the current active transaction is used (if there is one).

onlySSCTransactions

Boolean

A flag to indicate that only suspended transaction with workstation type code for self scanning are wanted.

overtakeCustomerFromOriginalReceipt

Boolean

A flag to indicate that the customer assignment from the suspended transaction should be taken over to the current transaction.

endDateTimestampFrom

String

The end date timestamp from. If set only suspended transactions with matching criteria are searched. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

customerAddressTypeCode

String

A card type which has to be used for the customer identification.

alternativeTaxInfos

com.gk_software.pos.api.model.config.process.flows.AlternativeTaxInfos

allowOtherStores

Boolean

A flag to indicate whether transactions from other stores are allowed.

promotionHandling

String

The promotion handling. If set to 'OLDDISCOUNTS' the retail price modifier for the retrieved item gets the flag externalSystemOriginatorFlag set to true.

consolidateLineItemsRetrieve

Boolean

The parameter defines, if the consolidation of retrieving transactions should be executed.

consolidateReturnItems

Boolean

The parameter controls, whether items with SaleReturnLineItem.ActionCode = RI should be consolidated or not.

rescanEnabled

Boolean

The parameter defines, if rescan feature is enabled.

iSOCurrencyCode

String

The ISO currency code. If set only suspended transactions with matching criteria are searched.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.805. ComGkSoftwarePosApiServiceTransactionSearchCustomerTransactionsRequest

SearchCustomerTransactionsRequest Request object for the search customer transactions operation.

Field Name Required Type Description Format

customerIds

List of [String]

A list of customer identifiers.

beginDateTimestampGreaterOrEquals

String

The begin date timestamp greater or equals (as part of the search criteria). Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

workstationTypeCode

String

The workstation type code.

maxReceiptCount

Integer

The maximum count of receipts. The search result will be limited to that number.

int32

suspendedFlag

Boolean

The suspended flag. If set to true only transactions with isSuspended flag true and isRetrieved flag false are searched.

iSOCurrencyCode

String

The ISO currency code. If set only suspended transactions with matching criteria are searched.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.806. ComGkSoftwarePosApiServiceTransactionSearchFiscalStartTransactionRequest

SearchFiscalStartTransactionRequest Request object to search fiscal start transaction.

Field Name Required Type Description Format

businessUnitId

String

The business unit identifier.

fiscalPrinterId

String

The identifier for the fiscal printer.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.807. ComGkSoftwarePosApiServiceTransactionSearchLastFinalizedRetailTransactionRequest

SearchLastFinalizedRetailTransactionRequest Request object for the the search last finalized retail transaction operation.

Field Name Required Type Description Format

businessUnitId

String

The business unit identifier.

workstationId

String

The workstation identifier.

operatorId

String

The operator identifier.

localSearchOnly

Boolean

If the search should be done only in the local database.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.808. ComGkSoftwarePosApiServiceTransactionSearchLastUnfinishedRetailTransactionRequest

SearchLastUnfinishedRetailTransactionRequest Request object for the the search last unfinished retail transaction operation.

Field Name Required Type Description Format

businessUnitId

String

The business unit identifier.

workstationId

String

The workstation identifier.

operatorId

String

The operator identifier.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.809. ComGkSoftwarePosApiServiceTransactionSearchRetailTransactionRequest

SearchRetailTransactionRequest Request object for the the search retail transaction operation.

Field Name Required Type Description Format

businessUnitId

String

The business unit identifier.

workstationId

String

The workstation identifier.

endWorkstationId

String

The end workstation identifier.

businessDayDate

String

The business day date. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

sequenceNumber

String

The sequence number.

operatorId

String

The operator identifier.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.810. ComGkSoftwarePosApiServiceTransactionSearchSuspendedTransactionsRequest

SearchSuspendedTransactionsRequest Request object for the search suspended transactions operation.

Field Name Required Type Description Format

businessUnitId

String

The business unit identifier.

suspendNumber

String

The suspend number.

parentCustomerIds

List of [String]

A list of parent customer identifiers.

customerIds

List of [String]

A list of customer identifiers.

customerRequired

Boolean

A flag to indicate if a customer assignment is required. If the list of customer identifiers is not used but this flag is set to true, then the customer assignment of the current active transaction is used (if there is one).

onlySSCTransactions

Boolean

A flag to indicate that only suspended transaction with workstation type code for self scanning are wanted.

overtakeCustomerFromOriginalReceipt

Boolean

A flag to indicate that the customer assignment from the suspended transaction should be taken over to the current transaction.

endDateTimestampFrom

String

The end date timestamp from. If set only suspended transactions with matching criteria are searched. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

customerAddressTypeCode

String

A card type which has to be used for the customer identification.

iSOCurrencyCode

String

The ISO currency code. If set only suspended transactions with matching criteria are searched.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.811. ComGkSoftwarePosApiServiceTransactionSerializedUnitModifer

SerializedUnitModifer The serialized unit modifer

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

serialNumber

String

The serial number

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.812. ComGkSoftwarePosApiServiceTransactionSetFiscalReceiptNumberRequest

SetFiscalReceiptNumberRequest The request object for setting a fiscal receipt number to the transaction.

Field Name Required Type Description Format

fiscalReceiptNumber

String

The fiscalization receipt number to set.

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.813. ComGkSoftwarePosApiServiceTransactionSetLineItemCustomFieldsRequest

SetLineItemCustomFieldsRequest The entity SetLineItemCustomFieldsRequest.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.814. ComGkSoftwarePosApiServiceTransactionSetQuantityRequest

SetQuantityRequest Domain object for SetQuantity Request

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

quantityInput

com.gk_software.pos.api.service.transaction.QuantityInput

activeCustomerOrderId

String

The active customer order id.

customerSequenceNumber

Integer

The customer sequence number.

int32

validate

X

Boolean

Set to false if validations should be skip. Default value is true.

exceededSingleQuantityAuthorized

X

Boolean

Set to true if single quantity limit was exceeded and successfully authorized

processTrigger

String

The trigger of the SetQuantityForLineItem process.

Enum: QUANTITY_BUTTON, ENTER_NEW_ITEM, REPEAT_DIVISIBLE_ITEM, REPEAT_SCALABLE_ITEM, MENU_TABLES, PLUS_BUTTON, MINUS_BUTTON, ENTER_NEW_QUANTITY, ENTER_SKIPPED_QUANTITY,

weightResult

com.gk_software.pos.api.service.client.hardware.scale.WeightResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.815. ComGkSoftwarePosApiServiceTransactionSetSerialNumberRequest

SetSerialNumberRequest A request for setting serial numbers.

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

returnMode

X

Boolean

Indicated whether the item should be returned or registered.

emptiesReturnMode

X

Boolean

Flag indicating client is in empties return mode.

createReturnReceipt

X

Boolean

This parameter specifies whether a return receipt should be created for returned items. This has only an impact in case returnMode=true.

serialNumber

String

Serial number to set.

reasonCode

String

A reason code for this request (e.g. reason for price change).

reasonCodeGroupCode

String

A reason code group code for this request (e.g. reason for price change).

reasonDescription

String

A reason description for this request (e.g. reason for price change).

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.816. ComGkSoftwarePosApiServiceTransactionSetTransactionCustomFieldsRequest

SetTransactionCustomFieldsRequest Request object to set custom field values for currently active transaction.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.817. ComGkSoftwarePosApiServiceTransactionSetTransactionEndAttributesRequest

SetTransactionEndAttributesRequest Request object to set transaction end attributes to a transaction.

Field Name Required Type Description Format

transactionId

String

The identifier of the transaction.

workstationId

String

The workstation identifier.

tillId

String

The till identifier.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.818. ComGkSoftwarePosApiServiceTransactionSetTransactionReasonRequest

SetTransactionReasonRequest Request object for setting a reason to a transaction.

Field Name Required Type Description Format

transactionId

String

The identifier of the transaction where the reason should be set.

reasonCode

String

The reason code.

reasonDescription

String

The reason description.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.819. ComGkSoftwarePosApiServiceTransactionStoreLineItemTaxGroupIdRequest

StoreLineItemTaxGroupIdRequest Request object to store the tax group id to the sales return line items

Field Name Required Type Description Format

taxGroupIdLineItem

X

List of ComGkSoftwarePosApiServiceTransactionTaxGroupIdLineItem

Tax group id line item object

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.820. ComGkSoftwarePosApiServiceTransactionSubtotalOperationResult

SubtotalOperationResult TODO: undocumented

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

allContractPricesLoaded

X

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.821. ComGkSoftwarePosApiServiceTransactionSuspendTransactionRequest

SuspendTransactionRequest Request object to suspend currently active transaction.

Field Name Required Type Description Format

suspendNumber

String

The suspend number for the transaction.

barCodePrefix

String

Specifies the barcode prefix of the suspended receipt

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

finalizeTransaction

X

Boolean

A flag to indicate whether the transaction should be finalized. The default value is true.

consolidateLineItemsSuspending

Boolean

consolidateReturnItems

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.822. ComGkSoftwarePosApiServiceTransactionSyncLineItemsTraceableUnitIDRequest

SyncLineItemsTraceableUnitIDRequest TODO: undocumented

Field Name Required Type Description Format

positionOperationConfiguration

X

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

keyedOnline

Boolean

The keyed online state.

offlineMode

Boolean

A flag to indicate whether offline mode registration is active or not.

eanByTraceableUnitIDMap

X

Map of [String]

The ean map.

isReturnMode

Boolean

Flag that tracks if POS is currently in goods return mode or not.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.823. ComGkSoftwarePosApiServiceTransactionTaxGroupIdLineItem

TaxGroupIdLineItem Simple object that contains the tax line item group id

Field Name Required Type Description Format

lineItemKey

X

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

taxGroupId

X

String

Tax group id

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.824. ComGkSoftwarePosApiServiceTransactionTenderLineItemDataRequest

TenderLineItemDataRequest The entity TenderLineItemDataRequest

Field Name Required Type Description Format

tenderAmount

Double

The tender amount.

double

tenderDescription

String

The tender description.

tenderGroupCode

String

The tender group code.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.825. ComGkSoftwarePosApiServiceTransactionTerminalPrintoutsLineItemEntry

TerminalPrintoutsLineItemEntry Request object to store a merchant and customer printout.

Field Name Required Type Description Format

tenderAuthorizationKey

com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey

merchantReceipt

String

The merchant printout copy to add to the tender.

customerReceipt

String

The customer printout copy to add to the tender.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.826. ComGkSoftwarePosApiServiceTransactionTerminalToRefundData

TerminalToRefundData Result object for terminal line items to refund during voiding of transaction.

Field Name Required Type Description Format

terminalTenderLineItems

X

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

A list of retail transaction line items, which contains all terminal tender line items.

tenderAuthorizations

X

List of ComGkSoftwareGkrApiTxpoolDtoTenderAuthorization

A list of all tender authorizations.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.827. ComGkSoftwarePosApiServiceTransactionTransactionBinaryDataRequest

TransactionBinaryDataRequest Request object to set transaction binary data to a transaction.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

name

String

The transaction binary data name.

data

String

The transaction binary data content.

transactionID

String

The transaction identifier.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.828. ComGkSoftwarePosApiServiceTransactionTransactionBinaryDataWithExtensionRequest

TransactionBinaryDataWithExtensionRequest Request object to set transaction binary data to a transaction and additionally an entry to transaction extension data.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

name

String

The transaction binary data name.

data

String

The transaction binary data content.

dataEncoded

Boolean

Defines that the data is already encoded. It means it should be decoded again to be stored correctly.

transactionID

String

The transaction identifier.

extensionValue

String

The value for the connected / referenced extension

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.829. ComGkSoftwarePosApiServiceTransactionTransactionIdsRequest

TransactionIdsRequest Request object for requesting views of transaction search data.

Field Name Required Type Description Format

transactionIds

List of [String]

A list of transaction identifiers.

onlySSCTransactions

Boolean

A flag to indicate that only suspended transaction with workstation type code for self scanning are wanted.

overtakeCustomerFromOriginalReceipt

Boolean

A flag to indicate that the customer assignment from the suspended transaction should be taken over to the current transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.830. ComGkSoftwarePosApiServiceTransactionTransactionIdsResult

TransactionIdsResult Result object for transaction searches, holding a list of transaction identifiers.

Field Name Required Type Description Format

transactionIds

List of [String]

A list of transaction identifiers.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.831. ComGkSoftwarePosApiServiceTransactionTransactionOperationFailureResult

TransactionOperationFailureResult The transaction operation failure result

Field Name Required Type Description Format

errorCode

String

The error code

errorMessage

String

The error message

messageKey

String

The message key

arguments

List of [String]

The arguments

3.832. ComGkSoftwarePosApiServiceTransactionTransactionOperationResult

TransactionOperationResult The entity TransactionOperationResult contains the result of a service execution and is used for providing transaction updates fields updates for service clients.

Field Name Required Type Description Format

primaryEntry

com.gk_software.pos.api.service.transaction.TransactionOperationResultEntry

additionalEntries

X

List of ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

Additional result entries.

filtered

Boolean

Indicates whether the transaction result is filtered. A filtered transaction does not contain the details of a retail transaction object in order to optimize service communication.

failure

com.gk_software.pos.api.service.transaction.TransactionOperationFailureResult

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.833. ComGkSoftwarePosApiServiceTransactionTransactionOperationResultEntry

TransactionOperationResultEntry An entity describing an operation result entry.

Field Name Required Type Description Format

transaction

com.gk_software.gkr.api.txpool.dto.Transaction

addedOrModifiedLineItems

X

Set of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

The line items added or modified by a service execution.

deletedLineItems

X

Set of ComGkSoftwarePosApiModelDomAppServicesTransactionRetailTransactionLineItemKey

The line items deleted by a service execution.

closedLineItems

X

Set of ComGkSoftwarePosApiModelDomAppServicesTransactionRetailTransactionLineItemKey

The line items closed during a service execution.

promotionInputRequests

X

List of ComGkSoftwarePosApiModelDomAppPromotionInputRequestPromotionInputRequest

The promotion input requests resulting from a service execution.

addedOrModifiedTransactionExtensions

X

List of ComGkSoftwareGkrApiTxpoolDtoTransactionExtension

The transaction extensions added or modified by a service execution.

addedTransactionAdditionalPrintouts

X

List of ComGkSoftwareGkrApiTxpoolDtoTransactionAdditionalPrintout

The transaction additional printouts added or modified by a service execution.

addedPriceDerivationRules

X

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionPromotionPriceDerivationRule

The price derivation rules added by a service execution.

addedOrModifiedSaleReturnLineItemPrices

X

Set of ComGkSoftwareGkrApiTxpoolDtoSaleReturnLineItemPrice

The sale return line item prices added or modified by a service execution.

deletedTransactionAdditionalPrintouts

X

Set of ComGkSoftwarePosApiModelDomAppServicesTransactionTransactionAdditionalPrintoutKey

The transaction additional printouts deleted by a service execution.

priceModificationResultCode

String

This parameter defines the price difference limit exceed action for positive items (warn, authorize, forbid, unchecked) if a set or change price operation is attempted.

serialNumberModificationResultCode

String

The serial number set to a line item.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.834. ComGkSoftwarePosApiServiceTransactionTransactionPrintRequest

TransactionPrintRequest Request object for creating a print transaction for an existing transaction (e.g. for printout repetition).

Field Name Required Type Description Format

printedTransactionId

String

The identifier for the transaction to print.

duplicate

X

Boolean

A flag to indicate that it is a duplicate print transaction.

finalizeTransaction

X

Boolean

A flag to indicate if the transaction should be finalized. The default value is true.

copyTransaction

X

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.835. ComGkSoftwarePosApiServiceTransactionTransactionSearchViewsResult

TransactionSearchViewsResult Result object, holding a list of TransactionSearchView.

Field Name Required Type Description Format

transactionSearchViews

List of ComGkSoftwarePosApiModelDomAppViewsTransactionSearchView

A list of transaction search views.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.836. ComGkSoftwarePosApiServiceTransactionTransactionTenderRequest

TransactionTenderRequest Request object for creation of various tender related transactions.

Field Name Required Type Description Format

tenderRegistration

com.gk_software.pos.api.model.dom.app.tender.TenderRegistration

canceled

X

Boolean

A flag to indicate whether the transaction should be marked as cancelled or not.

leadNumber

String

The lead number used for the tender pickup transaction envelope identifier.

finalizeTransaction

Boolean

A flag to indicate whether the transaction should be finalized.

useBalanceAmountFromTillCopyObject

Boolean

boolean: this flag should be set to 'true' if the values for balance amount should be copied from tillCopyObject and not from the tender request. Active balance amount from CRS is only taken for cash in main currency. Default is 'false'

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.837. ComGkSoftwarePosApiServiceTransactionUnfinishedTransactionsRequest

UnfinishedTransactionsRequest Request object for operations with unfinished transactions (e.g. searching unfinished transactions).

Field Name Required Type Description Format

businessUnitId

String

The business unit identifier.

workStationId

String

The workstation identifier.

transactionTypeCodes

List of [String]

A list of transaction type codes. If set only unfinished transactions with a matching transaction type code are processed.

transactionCategoryCode

String

The transaction category code. Only used for finishing unfinished transactions and if it is set to 'AUTO' for an automatic fail control transaction.

transactionIds

List of [String]

A list of transaction identifiers.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.838. ComGkSoftwarePosApiServiceTransactionUpdateSalesOrderItemRequest

UpdateSalesOrderItemRequest The entity UpdateSalesOrderItemRequest

Field Name Required Type Description Format

orderId

String

The order id.

usePosPrices

X

Boolean

The use pos prices.

extendOrderMode

X

Boolean

The extend order mode.

responseData

com.gk_software.pos.api.service.transaction.SalesOrderCommonData

salesOrderStandardPriceSpecificationElementTypeCode

String

The sales order standard price specification element type code.

includeSalesTax

X

Boolean

The include sales tax.

priceTypeCode

String

The price type code.

sapRebatesPromotionId

String

The sap debates promotion id.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.839. ComGkSoftwarePosApiServiceTransactionUpdateSalesOrderSelectedDeliveryItemRequest

UpdateSalesOrderSelectedDeliveryItemRequest The update sales order selected delivery item request object

Field Name Required Type Description Format

orderId

String

The order id.

usePosPrices

X

Boolean

The use pos prices.

extendOrderMode

X

Boolean

The extend order mode.

responseData

com.gk_software.pos.api.service.transaction.SalesOrderCommonData

salesOrderStandardPriceSpecificationElementTypeCode

String

The sales order standard price specification element type code.

includeSalesTax

X

Boolean

The include sales tax.

priceTypeCode

String

The price type code.

sapRebatesPromotionId

String

The sap debates promotion id.

lineItemList

List of ComGkSoftwareGkrApiTxpoolDtoRetailTransactionLineItem

The line item list

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

deliveryTypeCode

String

T delivery type code

salesOrderFinalPricePosPriceSpecificationElementTypeCode

String

The salesorder final price pos price specification element type code

salesOrderDefaultPrepaymentPriceSpecificationElementTypeCode

String

The sales order default prepayment price specification element type code

deliveryPlantID

String

The delivery plant ID

uuid

String

The uuid

downpaymentNotAllowed

Boolean

The down payment not allowed

downPaymentRequest

com.gk_software.pos.api.service.transaction.CreateDownpaymentLineItemRequest

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.840. ComGkSoftwarePosApiServiceTransactionUpdateTransactionExtensionRequest

UpdateTransactionExtensionRequest Request object for updating a transaction extension.

Field Name Required Type Description Format

transactionId

String

extensionKey

String

The transaction extension key to be updated in the transaction.

extensionValue

String

The new transaction extension value to be set in the transaction.

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.841. ComGkSoftwarePosApiServiceTransactionVoidLineItemBatchRequest

VoidLineItemBatchRequest The void line item batch request

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

voidLineItemDetails

X

List of ComGkSoftwarePosApiServiceTransactionVoidLineItemDetail

The void line item details

storeTransaction

X

Boolean

The store transaction

offlineMode

X

Boolean

The offline mode

keyedOnline

Boolean

The keyed on line state

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.842. ComGkSoftwarePosApiServiceTransactionVoidLineItemDetail

VoidLineItemDetail The void line item detail

Field Name Required Type Description Format

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

voidTypeCode

String

The void type code

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.843. ComGkSoftwarePosApiServiceTransactionVoidLineItemRequest

VoidLineItemRequest Domain object for VoidLineItem Request

Field Name Required Type Description Format

operationConfiguration

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

lineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

tenderAuthorizationKey

com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey

voidTypeCode

String

Describes whether the line item was cancelled immediately after registering it, voided by another line item or internally voided.

copyVoidedLineItem

X

Boolean

Flag indicating whether to copy the line item.

giftCertCancellationId

String

A gift certificate service result, it is filled only if a gift certificate line item is canceled online

storeTransaction

X

Boolean

Indicates whether the transaction should be stored.

offlineMode

X

Boolean

The offline mode

keyedOnline

Boolean

The keyed on line state.

serviceScaleMode

Boolean

Indicates whether the POS is in service scale mode.

voidReason

com.gk_software.swee.ses.api.server.md.reason.dto.so.ReasonSO

recalculateTransaction

Boolean

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.844. ComGkSoftwarePosApiServiceTransactionVoidTenderLineItemRequest

VoidTenderLineItemRequest Domain object for VoidTenderLineItem Request

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

retailTransactionLineItemKey

com.gk_software.pos.api.model.dom.app.services.transaction.RetailTransactionLineItemKey

voidTypeCode

String

Describes whether the line item was cancelled immediately after registering it, voided by another line item or internally voided.

tenderGroupCode

String

Describes whether the line item was cancelled immediately after registering it, voided by another line item or internally voided.

Enum: CASH, TERMINAL, GIFT_CERT, COUPON, CHEQUE, CREDIT, PROMOTION, POINTS, CASHENGINE,

terminalTenderCancellationAuthorizationKey

com.gk_software.pos.api.model.dom.app.services.transaction.TenderAuthorizationKey

pointsCancellationTransactionId

String

A gift certificate service result, it is filled only if a gift certificate line item is canceled online

giftCertCancellationTransactionId

String

A gift certificate service result, it is filled only if a gift certificate line item is canceled online

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.845. ComGkSoftwarePosApiServiceTransactionVoidTransactionConsolidateCashInMainCurrencyRequest

VoidTransactionConsolidateCashInMainCurrencyRequest Request to consolidate cash in main currency for process VoidTransaction.

Field Name Required Type Description Format

positionOperationConfig

com.gk_software.pos.api.model.config.process.action.PositionOperationConfig

voidingTransactionId

String

The identifier for the voiding transaction.

cashRefundAmount

Double

The cash refund amount.

double

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.846. ComGkSoftwarePosApiSessionPosSessionData

PosSessionData Store specific session data.

Field Name Required Type Description Format

sessionDataMap

Map of [String]

Map that holds session data.

3.847. ComGkSoftwarePosApiSessionPosSessionId

PosSessionId Identifies a session.

Field Name Required Type Description Format

id

X

String

The session id.

3.848. ComGkSoftwarePosFlowLibsCouponCouponSummary

CouponSummary TODO: undocumented

Field Name Required Type Description Format

couponNumber

String

Count

X

Double

double

promotion

com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionSO

currency

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.849. ComGkSoftwarePosFlowLibsCustomerCustomerCardCode

CustomerCardCode TODO: undocumented

Field Name Required Type Description Format

storeNumber

String

date

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

cardNumber

String

salutation

String

firstName

String

lastName

String

street

String

zip

String

city

String

federalState

String

country

String

email

String

telephone

String

mobilePhone

String

fax

String

businessTelephone

String

taxId

String

gender

String

birthday

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.850. ComGkSoftwarePosFlowLibsCustomerCustomerData

CustomerData TODO: undocumented

Field Name Required Type Description Format

customerId

String

customerGroupId

String

firstName

String

lastName

String

salutation

String

gender

String

birthday

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

street

String

postalCode

String

city

String

customerState

String

country

String

homePhone

String

email

String

fax

String

mobile

String

workPhone

String

taxId

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.851. ComGkSoftwarePosFlowLibsPaymentTerminalTransactionRecoveryValues

TerminalTransactionRecoveryValues TODO: undocumented

Field Name Required Type Description Format

cardNr

String

cardExpirationDate

String

immediateCancellation

Boolean

isoCurrencyNr

String

lastErrorMessage

String

lastErrorMessageForCustomer

String

offlinePayment

Boolean

paymentType

Integer

int32

processMode

String

signatureRequired

Boolean

successful

Boolean

tenderAuthorizationSequenceNumber

Integer

int32

terminalId

String

terminalTransactionNr

String

transactionResultCode

Integer

int32

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.852. ComGkSoftwarePosFlowLibsTransactionDiscountIconList

DiscountIconList TODO: undocumented

Field Name Required Type Description Format

icon

String

iconDisabled

String

promotionId

String

eligibilityId

String

ruleId

String

enabled

Boolean

overlayText

String

placeHolders

List of ComGkSoftwarePosFlowLibsTransactionPlaceHolder

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.853. ComGkSoftwarePosFlowLibsTransactionPlaceHolder

PlaceHolder TODO: undocumented

Field Name Required Type Description Format

placeholder

String

content

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.854. ComGkSoftwarePosFlowLibsTransactionSuspendCodeSkippedItem

SuspendCodeSkippedItem TODO: undocumented

Field Name Required Type Description Format

itemID

String

registrationNumber

String

quantity

String

unitOfMeasure

String

reason

String

xXCustom03

String

Customizable information

xXCustom02

String

Customizable information

xXCustom05

String

Customizable information

xXCustom04

String

Customizable information

xXCustom01

String

Customizable information

xXCustom06

String

Customizable information

xXCustom07

String

Customizable information

xXCustom08

String

Customizable information

xXCustom09

String

Customizable information

xXCustom10

String

Customizable information

xXCustom11

String

Customizable information

xXCustom12

String

Customizable information

xXCustom13

String

Customizable information

xXCustom14

String

Customizable information

xXCustom15

String

Customizable information

3.855. ComGkSoftwareSweeSesApiServerCdDataProviderDtoSoBusinessUnitDetailSO

BusinessUnitDetailSO undocumented

Field Name Required Type Description Format

retailStoreID

String

storeDescription

String

postalCode

String

city

String

street

String

phoneNumber

String

distance

Double

double

xxcustom03

String

xxcustom02

String

xxcustom05

String

xxcustom04

String

xxcustom01

String

3.856. ComGkSoftwareSweeSesApiServerCdDataProviderDtoSoItemDetailSO

ItemDetailSO undocumented

Field Name Required Type Description Format

itemID

String

itemName

String

xxcustom03

String

xxcustom02

String

xxcustom05

String

xxcustom04

String

xxcustom01

String

3.857. ComGkSoftwareSweeSesApiServerCdDataProviderDtoSoStockAmountDetailSO

StockAmountDetailSO undocumented

Field Name Required Type Description Format

retailStoreID

String

itemID

String

uomCode

String

stockType

String

Enum: DEFAULT, FREE, RESERVED, TRANSFER, IN_TRANSIT,

storageLocationID

String

inventoryStateID

String

stockAmount

Double

double

distance

Double

double

xxcustom03

String

xxcustom02

String

xxcustom05

String

xxcustom04

String

xxcustom01

String

3.858. ComGkSoftwareSweeSesApiServerCdDataProviderDtoSoStockAmountSO

StockAmountSO undocumented

Field Name Required Type Description Format

stockAmountDetailList

List of ComGkSoftwareSweeSesApiServerCdDataProviderDtoSoStockAmountDetailSO

businessUnitDetailList

List of ComGkSoftwareSweeSesApiServerCdDataProviderDtoSoBusinessUnitDetailSO

itemDetailList

List of ComGkSoftwareSweeSesApiServerCdDataProviderDtoSoItemDetailSO

3.859. ComGkSoftwareSweeSesApiServerMdItemSellingRuleDtoSoItemSellingRuleSO

ItemSellingRuleSO This object is a set of rules used for item selling. The rules can be referred from the item object and merchandise hierarchy group object.The fields of this rule object are imported directly on the item / MHG, but saved as a separate domain object to save storage place.Import from masterData_Item.xml from the element Item.UOMItem.ItemSellingRule. Import from masterData_BusinessUnit.xml from the element BusinessUnit.MerchandiseHierarchyGroupDetail.ItemSellingRule: DiscountFlag, BonusPointsFlag and NegativePositionFlag.

Field Name Required Type Description Format

itemSellingRuleId

String

A unique system assigned identifier for the item selling rule. Generated, not imported.

priceEntryRequiredFlag

X

Boolean

A flag to denote that the retail price is to be manually entered when this item is sold.

prohibitReturnFlag

X

Boolean

A flag to denote whether or not this item may be returned. (Eg: freezer or chilled merchandise)

allowFoodStampFlag

Boolean

A flag to indicate whether food stamps can be tendered for this item.

wicFlag

Boolean

A flag denoting if this item is allowed in a WIC transaction.

fsaCode

String

deliveryStockAssortmentFlag

Boolean

A flag to indicate if the item can be delivered to the customer.

retainPrepaymentFlag

Boolean

Determines whether a prepayment/downpayment position should be retained when an order of the item is voided (e.g. the prepayment could be retained if the order of a special measured item is voided)

takeAwayAllowedFlag

Boolean

A flag to indicate if the customer may take an item home to test it

serialNumberRequiredFlag

Boolean

Defines if the registration of the item requires a serial number input

taxExemptProbihitedFlag

Boolean

A flag to denote if no tax exemption is allowed for the item. True = no tax exemption allowed.

authorisedForSaleFlag

X

Boolean

A flag to indicate that the retail store is authorized to stock this particular item.

discountFlag

X

Boolean

A flag to indicate whether this item can be discounted.

bonusPointsFlag

X

Boolean

Determines whether bonus points are allowed for the item

quantityInputTypeCode

X

String

Type code for controlling the quantity input

Enum: POSSIBLE, REQUIRED, PROHIBITED,

quantityInputMethod

X

String

Determines how the input of quantity is done on POS

Enum: PIECE, LENGTH, AREA, VOLUME_SPACE, WEIGHT, QUANTITY_AUTOMATIC, QUANTITY_MANUAL, NOT_USED,

sellingEffectiveDate

X

String

Date when selling of the item becomes effective Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

sellingExpirationDate

X

String

Last date when the item is available for sale Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

negativePositionFlag

X

Boolean

If this flag is set to true, automatically a negative position is created when registering this item

priceChangeTypeCode

X

String

Type code for the manual price change. Values:

  • 00 = price 0.00 not allowed LIMITED,

  • 01 = price 0.00 allowed - POSSIBLE,

  • 02 = no price change allowed - PROHIBITED

Enum: POSSIBLE, LIMITED, PROHIBITED,

hidePriceFlag

X

Boolean

Determines whether the price is to be hided (not printed) on the receipt and to be hided (not shown)

showItemOnCustomerDisplayFlag

X

Boolean

Determines whether this item is to be shown on the customer display

barCodeHandlingMethod

X

String

Bar code handling method

Enum: WEIGHT, PRICE, PRICE_WEIGHT,

weightEntryRequiredFlag

X

Boolean

A flag to denote that the weight is to be registered when this item is sold

priceEntryOnScalesAllowedFlag

X

Boolean

Determines whether it is possible to register a price on scales

allowLayawayFlag

Boolean

Flag AllowLayawayFlag defines if an item is allowed for Layaway or not.

layawayDiscountFlag

Boolean

Flag LayawayDiscountFlag defines if promotions are allowed for the 'Layaway' item.

xx_CUSTOM_01

String

Additional field for custom development.

xx_CUSTOM_02

String

Additional field for custom development.

xx_CUSTOM_03

String

Additional field for custom development.

xx_CUSTOM_04

String

Additional field for custom development.

xx_CUSTOM_05

String

Additional field for custom development.

xx_CUSTOM_06

String

Additional field for custom development.

xx_CUSTOM_07

String

Additional field for custom development.

xx_CUSTOM_08

String

Additional field for custom development.

xx_CUSTOM_09

String

Additional field for custom development.

xx_CUSTOM_10

String

Additional field for custom development.

xx_CUSTOM_11

String

Additional field for custom development.

xx_CUSTOM_12

String

Additional field for custom development.

xx_CUSTOM_13

String

Additional field for custom development.

xx_CUSTOM_14

String

Additional field for custom development.

xx_CUSTOM_15

String

Additional field for custom development.

xx_CUSTOM_16

String

Additional field for custom development.

xx_CUSTOM_17

String

Additional field for custom development.

xx_CUSTOM_18

String

Additional field for custom development.

xx_CUSTOM_19

String

Additional field for custom development.

xx_CUSTOM_20

String

Additional field for custom development.

xx_CUSTOM_21

String

Additional field for custom development.

xx_CUSTOM_22

String

Additional field for custom development.

xx_CUSTOM_23

String

Additional field for custom development.

xx_CUSTOM_24

String

Additional field for custom development.

xx_CUSTOM_25

String

Additional field for custom development.

xx_CUSTOM_26

String

Additional field for custom development.

xx_CUSTOM_27

String

Additional field for custom development.

xx_CUSTOM_28

String

Additional field for custom development.

xx_CUSTOM_29

String

Additional field for custom development.

xx_CUSTOM_30

String

Additional field for custom development.

3.860. ComGkSoftwareSweeSesApiServerMdMhgDtoSoMHGTranslationSO

MHGTranslationSO Translation for description of the merchandise hierarchy group in one language.Import: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.TranslationList.Language

Field Name Required Type Description Format

languageID

X

String

Language ISO code identification.Import: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.TranslationList.Language.@ID

name

String

description

String

Description in the given language.Import: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.TranslationList.Language.TranslatedDescription

3.861. ComGkSoftwareSweeSesApiServerMdMhgDtoSoMhgSO

MhgSO Merchandise hierarchy group definition.Import from masterData_MerchandiseHierarchyGroup.xml and masterData_BusinessUnit.xml. The definition of merchandise hierarchy groups is imported from masterData_MerchandiseHierarchyGroup.xml. The masterData_BusinessUnit.xml allows import additional details. If the MHG from masterData_BusinessUnit.xml does not exist, it is created.

Field Name Required Type Description Format

merchandiseHierarchyGroupID

X

String

Identifier of the merchandise hierarchy group.Import: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.MerchandiseHierarchyGroupID masterData_BusinessUnit.xml: BusinessUnit.MerchandiseHierarchyGroupDetail.MerchandiseHierarchyGroupID.

merchandiseHierarchyGroupIDQualifier

String

merchandise HierarchyGroup ID Qualifier

name

String

The name of the merchandise hierarchy group.Import: masterData_MerchandiseHierarchyGroup.xml: first 40 characters from MerchandiseHierarchyGroup.Description

description

String

The description of the merchandise hierarchy group.Import: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.Description

taxGroupID

String

The tax group assigned to the merchandise hierarchy group.Import: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.TaxGroupID

itemSellingRuleID

String

Reference to the ItemSellingRule object.Import: masterData_BusinessUnit.xml:

  • The referred ItemSellingRule object is created / loaded from BusinessUnit.MerchandiseHierarchyGroupDetail.

itemMerchandiseManagementRuleID

String

Reference to the ItemMerchandiseManagementRule object.Import: masterData_MerchandiseHierarchyGroup.xml:

  • The referred ItemMerchandiseManagementRule object is created / loaded from MerchandiseHierarchyGroup.DefaultLayoutClass and MerchandiseHierarchyGroup.DefaultLabelCount.masterData_BusinessUnit.xml:

  • The referred ItemMerchandiseManagementRule object is created / loaded from BusinessUnit.MerchandiseHierarchyGroupDetail.NegativePositionFlag.

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.Generated, not imported.

merchandiseHierarchyLevelID

String

A unique system assigned identifier for the level within the merchandise hierarchy tree.Not imported. Generated for the levelName.

levelName

String

Name for the level within the merchandise hierarchy tree.Import: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.LevelName

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.Generated, not imported.

translationList

List of ComGkSoftwareSweeSesApiServerMdMhgDtoSoMHGTranslationSO

List of translations for description of the merchandise hierarchy group.Import: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.TranslationList

xxcustom03

String

Additional field for custom developmentImport: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_03

xxcustom02

String

Additional field for custom developmentImport: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_02

xxcustom05

String

Additional field for custom developmentImport: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_05

xxcustom04

String

Additional field for custom developmentImport: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_04

xxcustom01

String

Additional field for custom developmentImport: masterData_MerchandiseHierarchyGroup.xml: MerchandiseHierarchyGroup.xx_custom_01

3.862. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionEligibilitySO

PromotionConditionEligibilitySO Promotion eligibilityImport:

  • masterdata_Promotion_SE.xml: Promotion.Condition.Eligibility

  • PromotionCPD.xml: Promotion.Condition.Eligibility

Field Name Required Type Description Format

internalEligibilityID

X

String

A unique identifier for the rule eligibilityGenerated, not imported.

typeCode

X

String

A code that indicates the type of Price Derivation Rule Eligibility. Possible types:

  • 'COMB' = combination

  • 'EGRP' = employee discount group

  • 'CGRP' = customer group

  • 'CUST' = customer

  • 'MSTR' = merchandise category

  • 'ITEM' = item

  • 'TOTL' = total purchase market basket

  • 'COUP' = coupon

  • 'MANU' = manual trigger

  • 'POST' = line item type

  • 'EXTV' = external trigger value

  • 'APRT' = additional price type eligibility

  • 'SITH' = simple threshold eligibilityImport:

  • masterdata_Promotion_SE.xml: filled according to filled eligibility in Promotion.Condition.Eligibility. Supported 'COMB', 'ITEM', 'MSRT', 'TOTL' only.

  • PromotionCPD.xml: filled according to filled eligibility in Promotion.Condition.Eligibility

Enum: COMB, EGRP, CGRP, CUST, MSTR, ITEM, TOTL, COUP, MANU, POST, EXTV, MSET, APRT, SITH, GATR,

rootEligibilityID

String

Reference to the root eligibility of the condition eligibility treeNot imported.

parentEligibilityID

String

Reference to the parent eligibility in the condition eligibility treeNot imported.

levelID

Integer

Level in the eligibility tree the eligibility belongs toNot imported.

int32

effectiveDateTime

String

The timestamp this eligibility becomes activeNot imported. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

expirationDateTime

String

The last date and time that this eligibility is effectiveNot imported. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

statusCode

String

Defines the current status for the eligibility. Examples of valid codes include: AC/null = Active, IA = InactiveImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Not imported, fix value 'AC' used.

negationFlag

Boolean

Determines whether the eligibility must be fulfilled (false) or not (true) in order that the price derivation rule can be applied

recommendationFlag

Boolean

Read only flag which is returned only in case it’s required by the caller from API method.

xxcustom03

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom02

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom05

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom04

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom01

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom06

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom07

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom08

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom09

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom10

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom11

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom12

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom13

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom14

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom15

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom16

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom17

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom18

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom19

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom20

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom21

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom22

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom23

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom24

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom25

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom26

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom27

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom28

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom29

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom30

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

3.863. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionRuleSO

PromotionConditionRuleSO Promotion condition ruleImport:

  • masterdata_Promotion_SE.xml: Promotion.Condition.Rule

  • PromotionCPD.xml: Promotion.Condition.Rule

Field Name Required Type Description Format

internalRuleID

X

String

A identifier for a specific price derivation rule.Generated, not imported.

name

String

Price derivation rule nameNot imported.

description

String

Business description for this price derivation rule.Import:

  • masterdata_Promotion_SE.xml: from Promotion.Condition.Rule.GlobalData.RuleTranslationList or from Promotion.Condition.Rule.GlobalData.Description

transactionControlBreakCode

String

This is a special code that determines when, during the entry of a sale transaction, this rule will be applied. For example a price change rule may be applied on a line item by line item basis (which is DETAIL TIME), a price change rule may be triggered after a transaction is totaled — but before tax and tender entry (i.e. MERCHANDISE SUBTOTAL TIME).

  • line item discount, calculated after each line item („PO“)

  • line item discount, calculated after subtotal (“PC”)

  • transaction discount, calculated after each line item (“SP”)

  • transaction discount, calculated after subtotal („SU“)Import:

  • masterdata_Promotion_SE.xml: Promotion.Condition.Rule.GlobalData.TransactionControlCode

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.TransactionControlCode

Enum: PO, SU, SP, PC, RC,

statusCode

String

Defines the current status for the price derivation rule. Examples of valid codes include: Pending, Active, Canceled, Inactive

  • PD = pending

  • AC/null = active

  • CN = cancelled

  • IA = inactiveImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: 'AC'

typeCode

X

String

Defines the type of price derivation rule.

  • RB = simple rebate

  • MM = Mix & Match

  • GP = Get3Pay2

  • NO = no rebate

  • MA = manual, the discount information is set by POS function

  • EX = external action

  • AP = additional price type rule

  • AB = additional bonusImport: The value is filled according to the used rule type from Promotion.Condition.Rule.

Enum: RB, MM, NO, GP, MA, EX, AP, AB, BM,

ruleID

String

External ident of the price derivation ruleImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.GlobalData.ID

bonusPointsFlag

X

Boolean

Determines whether rebate or bonus points are awarded by the ruleImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: true if Promotion.Condition.Rule.BonusPoints is chosen

roundingMethodCode

String

Determines how the calculated reduction amount is to be rounded;

  • null/00 = commercial rounding

  • 01 = down

  • 02 = up

Enum: COMMERCIAL_ROUNDING, DOWN, UP,

decimalPlacesCount

X

Integer

Requested number of decimal places of the calculated reduction amount;

  • null = 2 decimal places

  • value = the calculated reduction amount is to be rounded/truncated because it should contain only the given number of decimal places

int32

roundDestinationValue

X

Integer

Additional information for rounding, possible values:

  • null/1: no additional treatment of the rounded result necessary

  • 5: the rounded result is to be adjusted to the next resp. previous multiple of 5

int32

discountMethodCode

String

Determines how the rebate influences the transaction:

  • 00/null: the rebate reduces the transaction total

  • 01: the rebate does not influence the transaction total or the amout the customer has to pay, but the customer gets a gift certificate about the rebate amount which he can use for payment the next time

  • 02: the rebate is used as tender for the current transaction, i.e. it reduces the amount the customer still has to pay

  • 03: the rebate reduces the transaction total but it will be counterbalanced by some gift certificate sale.

  • 04: a coupon will be given to the customer instead of a rebate. Transaction total will not be reduced.Import:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml:

  • 00 - if Promotion.Condition.Rule.GlobalData.RebateMethod.NormalRebate is filled

  • 01 - if Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsGiftCert is filled and Promotion.Condition.Rule.RebateMethod.RebateAsGiftCert.IsCharged = false

  • 02 - if Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsTender is filled

  • 03 - if Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsGiftCert is filled and Promotion.Condition.Rule.RebateMethod.RebateAsGiftCert.IsCharged = true

  • 04 - if Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsCoupon is filled

giftCertificateExpirationDate

String

End of the date range in which the gift certificate is validImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsGiftCert.GiftCertExpiryDate Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

tenderTypeCode

String

A code which uniquely identifies the type of tender, ie cash, check, credit card, etc.Import:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.RebateMethod.RebateAsTender.TenderTypeCode

prohibitTransactionRelatedPromotionConditionFlag

X

Boolean

Determines whether applying this condition influences the calculation base of subsequent transaction-related conditionens (false) or not (true); is relevant for position-related 'money' conditions onlyImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.ProhibitsBonRelatedConditionFlag

chooseItemMethod

String

Determines, in which sequence items get rebate:

  • null = determined by the corresponding property of the loyalty engine

  • 01 = lowest rebate first

  • 02 = highest rebate first

  • 03 = lowest rebate first per interval

  • 04 = highest rebate first per interval

  • 00 = determined by the Promotion Calculation EngineImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.ChooseItemMethod

Enum: LOWEST_FIRST, HIGHEST_FIRST, LOWEST_FIRST_INT, HIGHEST_FIRST_INT, DETERMINED_BY_PCE,

noEffectOnSubsequentPromotionConditionFlag

Boolean

Determines whether applying this condition influences the calculation base of subsequent conditions (false) or not (true); is relevant for position-related 'money' conditions onlyImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.NoInfluenceOnSubsequentConditionFlag

calculationBase

String

Base of the calculation:

  • 00/null: is determined by the eligibilities

  • 01: sum of sales - sum of returns

Enum: CALCBASE_00, CALCBASE_01,

couponPrintoutID

String

number of the printout couponImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsCoupon.CouponPrintoutID

couponPrintoutRule

String

Type code of the printout rule

  • null/00 = separate receipt

  • 01 = print at the end of the receiptImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsCoupon.CouponPrintoutRule

Enum: SEPARATE_RECEIPT, PRINT_AT_END,

couponPrintoutText

Object

Formated Text of the printout couponImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsCoupon.CouponPrintoutText

considerPreviousPromotionConditionFlag

X

Boolean

Indicates whether all conditions are to be considered which were applied before (true) or not (false).Import:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.ConsiderAllPreviousConditionsFlag

printoutValidityPeriod

Double

Validity period for printout coupons or gift certificatesImport:

  • masterdata_Promotion_SE.xml: Not imported.

  • PromotionCPD.xml: Promotion.Condition.Rule.GlobalData.RebateMethod.RebateAsGiftCert.PrintoutValidityPeriod or Promotion.Condition.Rule.RebateMethod.RebateAsCoupon.PrintoutValidityPeriod

double

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.Generated, not imported.

promotionConditionRuleTranslationList

List of ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionRuleTranslationSO

List of translations

externalConditionRuleID

String

External ID of the condition rule (filled with PromotionConditionID)

calculationBaseSequence

String

Determines which one of the previously applied modifiers is to be considered as calculation base for the current modification. In detail, the calculation base for the current price derivation rule is to be determined as following: - In case that no price derivation rules were applied before, it is the original price/total. - Null: all price derivation rules which were applied before the current price derivation rule are to be considered, i.e. the calculation base for the current price derivation rule equals to the new price of the price derivation rule which was applied just before it = as latest. - Otherwise, the calculation base for the current price derivation rule equals to the new price of that price derivation rule which was applied one or more steps before it having the highest sequence <= CalculationBaseSequence (or the original price if no such price derivation rule was applied).

roundingRuleID

String

The system-generated identifier of the rounding rule which applies for discounts/bonus points counts resulting from applying the price derivation rule

shareRoundingRuleID

String

The system-generated identifier of the rounding rule which applies for shares resulting from prorating basket-related discounts or bonus points resulting from applying the price derivation rule

pointsAmountRoundingRuleID

String

The system-generated identifier of the rounding rule applies for monetary equivalents to bonus points counts resulting from applying the price derivation rule

noPreviousMonetaryDiscountAllowedFlag

X

Boolean

Determines whether the price derivation rule is applicable in general (false) or only in the case that no other monetary discounts were granted before (true).

increasePriceAllowedFlag

X

Boolean

This flag decides whether a promotion price derivation rule or a particular price is allowed to increase the price in comparison to the latest calculated discount sales price.Possible values:

  • true: price increase is allowed. In this case, the promotion price derivation rule is applied even though the item costs afterwards more than before.

  • false: price increase is not allowed. In this case, the promotion price derivation rule is not applied without any thrown business error or indicator why.

packageLimitQuantity

Integer

For measured items (e.g. pre-packed weighed items), the package limit quantity limits the maximum package count that can receive a benefit. A price derivation rule containing a package limit quantity being not null and greater than zero can be applied to measured items only, but not to piece items.

int32

bonusPointsTypeCode

String

The bonus points type code of the promotion price derivation rule.

xxcustom03

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom02

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom05

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom04

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom01

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom06

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom07

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom08

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom09

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom10

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom11

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom12

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom13

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom14

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom15

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom16

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom17

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom18

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom19

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom20

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom21

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom22

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom23

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom24

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom25

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom26

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom27

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom28

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom29

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom30

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

3.864. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionRuleTranslationSO

PromotionConditionRuleTranslationSO Translation of condition rule texts in one language

Field Name Required Type Description Format

languageID

X

String

Language id

name

String

Translation of the rule name

description

String

Translation of the description

couponPrintoutText

String

Translation of the printout coupon text

3.865. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionSO

PromotionConditionSO Condition of the promotionImport:

  • masterdata_Promotion_SE.xml: Promotion.Condition

  • PromotionCPD.xml: Promotion.Condition

Field Name Required Type Description Format

promotionID

String

The unique identifier for a promotion.Mapped from promotion.

conditionID

String

A identifier for a condition.Generared, not imported.

internalRuleID

String

A identifier for a specific price derivation rule.Generated, not imported.

internalEligibilityID

String

A unique identifier for a Price Derivation Rule eligibility. It is the ID of the root eligibility of the condition. (useful if the combination eligibility is used).

timeGroup

com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionConditionTimeGroupSO

typeCode

String

Code of the condition type

rule

X

com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionConditionRuleSO

eligibility

X

com.gk_software.swee.ses.api.server.md.promotion.dto.so.PromotionConditionEligibilitySO

sequence

X

String

Sequence - for collision handling

resolution

X

String

Resolution - for collision handling

notShowingFlag

X

Boolean

Determines whether the result of the applied condition is to be suppressed on displays / not printed on the receipt; e.g. position-dependent default points are not printed after each position, but only summarized at the end of the receipt.

description

String

Short description

receiptPrinterName

String

Receipt text (overwrites the receipt text of the promotion)

operatorDisplayName

String

Operator display text (overwrites the operator display text of the promotion)

customerDisplayName

String

Customer display text (overwrites the customer display text of the promotion)

itemDiscountControlVector

String

'vector' which describes which discount typecodes are allowed for usage by the loyalty server; Item.DiscountTypeCode is used as an index in order to find the right position inside the vector; Possible values for each position are:

  • 0 -→ no discount possible

  • 1 -→ discount possible

saleReturnTypeCode

String

Determines whether the condition can be used only for sales, only for returns, or for both:

  • 00/null: for sales as well as for returns

  • 01: only for sales

  • 02: only for returns

Enum: SALES_RETURNS, SALES, RETURNS,

amendmentTypeCode

String

Determines whether the condition can be used only for sales, only for amendments, or for both:

  • 00/null: for sales as well as for amendments

  • 01: only for sales

  • 02: only for amendments

Enum: SALES_AMENDMENTS, SALES, AMENDMENTS,

exclusiveFlag

X

Boolean

determines whether this condition is an exclusive conditionImport:

  • masterdata_Promotion_SE.xml: Promotion.Condition.GlobalData.ExclusivenessFlag

  • PromotionCPD.xml: Promotion.Condition.GlobalData.ExclusivenessFlag

iconID

String

ID of the icon that should be displayed as sales information on POSImport:

  • PromotionCPD.xml: Promotion.Condition.GlobalData.IconID

concurrenceControlVector

String

Determines how this condition works in relation to other applicable conditions

notConsideredInLineItemModeFlag

X

Boolean

Describes whether the promotion is prohibited/cannot be applied in line item mode.

recommendationThresholdPercentage

Integer

Defines what percentage of the triggers of the recommended promotion have to be reached by the items in the transaction in order for the PCE to make the recommendation. The supported types of leaf eligibilities which are considered when evaluating the threshold percentage are: ITEM, MSET, MSTR, SITH, TOTL.

int32

recommendationContextList

List of [String]

Defines the list of recommendation contexts in which the promotion can be recommended by the PCE.

recommendationFlag

Boolean

Flag indicating if the promotion price derivation rule is available for recommendations or not.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.Generated, not imported.

promotionConditionTranslationList

List of ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionTranslationSO

List of translations

xxcustom03

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom02

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom05

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom04

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom01

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom06

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom07

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom08

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom09

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom10

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom11

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom12

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom13

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom14

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom15

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom16

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom17

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom18

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom19

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom20

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom21

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom22

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom23

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom24

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom25

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom26

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom27

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom28

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom29

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom30

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

3.866. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionTimeGroupSO

PromotionConditionTimeGroupSO Time restriction

Field Name Required Type Description Format

timePeriodList

List of ComGkSoftwareSweeSesApiServerMdPromotionDtoSoTimePeriodSO

List of time periodsImport:

  • masterdata_Promotion_SE.xml: Promotion.Condition.GlobalData.TimePeriod

  • PromotionCPD.xml: Promotion.Condition.GlobalData.TimePeriod

internalTimeGroupID

X

String

ID of the time groupGenerated, not imported.

3.867. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionTranslationSO

PromotionConditionTranslationSO Translation of condition texts in one language

Field Name Required Type Description Format

languageID

X

String

Language id

operatorDisplayName

String

Translation of the operator display text.

customerDisplayName

String

Translation of the customer display text.

receiptPrinterName

String

Translation of the receipt text.

description

String

Translation of the short description

3.868. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionItemFilterSO

PromotionItemFilterSO This domain object contains the promotion data relevant for the Loyalty Engine.Import from:

Field Name Required Type Description Format

itemID

String

unitOfMeasureCode

String

timestamp

String

Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

considerOnlyDiscountAdviceConditions

Boolean

calculationMode

String

Enum: BASKET, LINE_ITEM,

3.869. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionSO

PromotionSO This domain object contains the promotion data relevant for the Loyalty Engine.Import from:

Field Name Required Type Description Format

businessUnitGroupID

String

The unique identifier of the business unit group.

promotionID

X

String

External ident of the promotionImport:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.ID

  • PromotionCPD.xml: Promotion.GlobalData.ID

effectiveDateTime

String

Date and time when the promotion becomes effectiveImport:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.EffectiveDate

  • PromotionCPD.xml: Promotion.GlobalData.EffectiveDate Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

expirationDateTime

String

The last date and time when this promotion is effective.Import:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.ExpiryDate

  • PromotionCPD.xml: Promotion.GlobalData.ExpiryDate Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

operatorDisplayName

String

Text to be displayed to the operator.

customerDisplayName

String

Text to be displayed to the customer.

receiptPrinterName

X

String

Text which is to be printed on the receipt

origin

X

String

Origin of the promotion

description

String

Promotion description

promotionTypeID

String

Promotion typeImport:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.PromotionType

  • PromotionCPD.xml: Promotion.GlobalData.PromotionType

conditionList

List of ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionConditionSO

list of promotion conditions

internalPromotionID

String

The unique identifier for a promotion.Not imported, generated.

packageID

String

Internal identification of the import package (e.g. IDoc file). The identification is used for monitoring purposes.Not imported, generated.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.Generated, not imported.

externalOfferID

String

Another external ident of the promotion. It is needed by/known to the retailer.

lastChangeTimestamp

String

The date and time when the promotion was changed at latest. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

promotionTranslationList

List of ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionTranslationSO

List of translations

xxcustom03

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom02

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom05

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom04

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom01

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom06

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom07

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom08

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom09

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom10

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom11

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom12

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom13

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom14

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom15

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom16

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom17

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom18

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom19

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom20

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom21

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom22

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom23

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom24

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom25

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom26

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom27

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom28

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom29

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

xxcustom30

String

Additional field for custom development.Import from masterdata_Promotion_SE.xml only.

3.870. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionTranslationSO

PromotionTranslationSO Translation of the promotion texts in one language

Field Name Required Type Description Format

languageID

X

String

Language idImport:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.PromotionTranslationList.Language.@ID

  • PromotionCPD.xml: Promotion.GlobalData.PromotionTranslationList.Language.@ID

operatorDisplayName

String

Translation of the text to be displayed to the operator.Import:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.PromotionTranslationList.Language.TranslatedOperatorDisplayName

  • PromotionCPD.xml: Promotion.GlobalData.PromotionTranslationList.Language.TranslatedOperatorDisplayName

customerDisplayName

String

Translation of the text to be displayed to the customer.Import:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.PromotionTranslationList.Language.TranslatedCustomerDisplayName

  • PromotionCPD.xml: Promotion.GlobalData.PromotionTranslationList.Language.TranslatedCustomerDisplayName

receiptPrinterName

String

Translation of the text to be printed on the receiptImport:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.PromotionTranslationList.Language.TranslatedReceiptPrinterName

  • PromotionCPD.xml: Promotion.GlobalData.PromotionTranslationList.Language.TranslatedReceiptPrinterName

description

String

Translation of the short descriptionImport:

  • masterdata_Promotion_SE.xml: Promotion.GlobalData.PromotionTranslationList.Language.TranslatedDescription

  • PromotionCPD.xml: Promotion.GlobalData.PromotionTranslationList.Language.TranslatedDescription

3.871. ComGkSoftwareSweeSesApiServerMdPromotionDtoSoTimePeriodSO

TimePeriodSO Time periodImport:

  • masterdata_Promotion_SE.xml: Promotion.Condition.GlobalData.TimePeriod

  • PromotionCPD.xml: Promotion.Condition.GlobalData.TimePeriod

Field Name Required Type Description Format

dayOfWeek

String

A 2 character code denoting the day of the week that the time period falls onImport:

  • masterdata_Promotion_SE.xml: Promotion.Condition.GlobalData.TimePeriod.Weekday

  • PromotionCPD.xml: Promotion.Condition.GlobalData.TimePeriod.Weekday

Enum: MO, TU, WE, TH, FR, SA, SU,

startTime

String

The time of day that the time period commences Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

duration

Integer

The duration included in the time period from the start time

int32

internalTimePeriodID

X

String

ID of the time periodGenerated, not imported.

timeRestriction

String

The time restriction in cron format.

3.872. ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonCodeGroupParameterSO

ReasonCodeGroupParameterSO Parameter defined for the reason group

Field Name Required Type Description Format

reasonCodeGroupCode

X

String

Code of the reason group

reasonCodeGroupParameterCode

String

Reason code group parameter code

reasonCodeGroupParameterName

String

Reason code group parameter name

3.873. ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonCodeGroupSO

ReasonCodeGroupSO Reason code group master data. Reason groups represent e.g. various processes.

Field Name Required Type Description Format

reasonCodeGroupCode

X

String

A retailer assigned code denoting the family of related reason codes for classifying data and actions within the systems of the retail enterprise.

businessUnitGroupID

X

String

The unique identifier of the business unit group.Import: masterData_Reason.xml: BusinessUnitGroupID or the BusinessUnitGroupID for the ExternalBusinessUnitGroupID from ReasonCodeGroup.BugHeader or if not filled, then from ReasonCodeGroupMasterData.BugHeader. If not filled, then the data is globally valid.

reasonCodeGroupDescription

String

Description of the reason code group

reasonCodeGroupParameterList

List of ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonCodeGroupParameterSO

List of parameters defined for this reason code groupNot used, not imported.

tid

String

Translation identifier

translations

List of ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonCodeGroupTranslationSO

List of translations

origin

String

Enum: PARENT_COPY, IMPORT, MANUAL,

xxcustom03

String

Additional field for custom development

xxcustom02

String

Additional field for custom development

xxcustom05

String

Additional field for custom development

xxcustom04

String

Additional field for custom development

xxcustom01

String

Additional field for custom development

3.874. ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonCodeGroupTranslationSO

ReasonCodeGroupTranslationSO Translation of reason group texts in a specific language

Field Name Required Type Description Format

languageID

X

String

Language ISO code identification

reasonCodeGroupDescription

String

Localized description of the reason group in the given language

3.875. ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonParameterSO

ReasonParameterSO Reason parameter. The parameters are not used in a generalized, cross-process manner. Each process uses its own parameters. Meaning of the most important parameters in the merchandise management processes:

  • SAP_BEWART � movement type of the leading system

  • SAP_GRUND � reason code of the leading system

  • AUTO_RELEASE � defines whether the documents registered on the handheld are automatically released

  • SKIP_ON_MOBILE � defines whether the reason is displayed on the mobile handheld device.

  • STOCK_IMPACT � determines the way in which the movement affects item stock (0 � no impact, 1 � increase, -1 = decrease)

Field Name Required Type Description Format

reasonParameterCode

X

String

Reason parameter code

reasonParameterName

String

Reason parameter name

reasonParameterValue

String

Reason parameter value

3.876. ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonSO

ReasonSO Reasons are used for sale and merchandise management processes. They are used to designate different goods movements. Reasons may contain a number of parameters. Each parameter has a defined name with a certain meaning for the respective process. Reasons are grouped by processes. Each reason is identified based on a combination of code + group. Each group has a fixed code. The reasons belonging to this group are used in the respective process.Import from masterData_Reason.xml.

Field Name Required Type Description Format

businessUnitGroupID

X

String

The unique identifier of the business unit group.Import: masterData_Reason.xml: BusinessUnitGroupID or the BusinessUnitGroupID for the ExternalBusinessUnitGroupID from Reason.BugHeader or if not filled, then from ReasonMasterData.BugHeader. If not filled, then the reason is globally valid.

reasonDescription

String

Long description of the reason

reasonShortText

String

Reason short text

reasonCodeGroupCode

X

String

Code of the group to which the reason belongs

reasonCodeGroupDescription

String

Description of the assigned reason group; for information purposesNot imported, loaded from ReasonCodeGroupSO.reasonCodeGroupDescription

reasonOrder

Integer

Defines the order within a group for display in the graphical user interface

int32

reasonParameterList

List of ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonParameterSO

List of reason parameters

tid

String

Translation identifier

translations

List of ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonTranslationSO

List of translations

origin

String

Type of origin. OriginCode: PARENT_COPY = '00' IMPORT = '01' MANUAL = '02'

Enum: PARENT_COPY, IMPORT, MANUAL,

reasonCode

X

String

A unique retailer defined reason code for an action that is taken (or not taken) at a workstation / device.

xxcustom03

String

Additional field for custom development

xxcustom02

String

Additional field for custom development

xxcustom05

String

Additional field for custom development

xxcustom04

String

Additional field for custom development

xxcustom01

String

Additional field for custom development

3.877. ComGkSoftwareSweeSesApiServerMdReasonDtoSoReasonTranslationSO

ReasonTranslationSO Translation of reason texts in a specific language

Field Name Required Type Description Format

languageID

X

String

Language ISO code identification

reasonDescription

String

Reason description in the given language.

reasonShortText

String

Reason short text in the given language

3.878. ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoMerchandiseHierarchyGroupAssignmentSO

MerchandiseHierarchyGroupAssignmentSO Reference to the merchandise hierarchy group which the sales restriction is assigned to

Field Name Required Type Description Format

merchandiseHierarchyGroupID

X

String

ID of the merchandise hierarchy group which the sales restriction is assigned toImport: masterData_BusinessUnit.xml: BusinessUnit.MerchandiseHierarchyGroupDetail.MerchandiseHierarchyGroupID.

3.879. ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoSalesRestrictionSO

SalesRestrictionSO Specific items can be sold under defined conditions only, e.g. alcohol drinks from 18 years. Sales restrictions determine these conditions.Import: masterData_Item.xml: Item.UOMItem.SalesRestrictionList masterData_BusinessUnit.xml: BusinessUnit.MerchandiseHierarchyGroupDetail.RiskSaleResctriction.

Field Name Required Type Description Format

salesRestrictionID

X

String

Sales restriction identifierGenerated, not imported.

businessUnitGroupID

String

A unique system assigned identifier for a group of business units.

salesRestrictionValue

String

The value of the sales restriction - its content depends on the SalesRestrictionTypeCode, e.g. * Age => minimum customer age * Sales prohibition period => time group identifier * Limit => quantity limitImport: masterData_Item.xml: Item.UOMItem.SalesRestriction.SalesRestrictionValue

merchandiseHierarchyGroupAssignmentList

List of ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoMerchandiseHierarchyGroupAssignmentSO

List of merchandise hierarchy groups which the sales restriction is assigned toImport: masterData_BusinessUnit.xml: BusinessUnit.MerchandiseHierarchyGroupDetail.MerchandiseHierarchyGroupID.

unitOfMeasureItemAssignmentList

List of ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoUnitOfMeasureItemAssignmentSO

List of UOM items which the sales restriction is assigned toImport: masterData_Item.xml: Item identification.

questionText

String

The text of the question that the customer is to be asked when validating a restriction.Import: masterData_Item.xml: Item.UOMItem.SalesRestriction.QuestionText

questionTypeCode

String

Type code of the question.Import: masterData_Item.xml: Item.UOMItem.SalesRestriction.QuestionTypeCode

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.Generated, not imported.

translationList

List of ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoSalesRestrictionTranslationSO

List of translationsImport: masterData_Item.xml: Item.UOMItem.SalesRestriction.TranslationList

xx_CUSTOM_01

String

Additional field for custom development.

xx_CUSTOM_02

String

Additional field for custom development.

xx_CUSTOM_03

String

Additional field for custom development.

xx_CUSTOM_04

String

Additional field for custom development.

xx_CUSTOM_05

String

Additional field for custom development.

xx_CUSTOM_06

String

Additional field for custom development.

xx_CUSTOM_07

String

Additional field for custom development.

xx_CUSTOM_08

String

Additional field for custom development.

xx_CUSTOM_09

String

Additional field for custom development.

xx_CUSTOM_10

String

Additional field for custom development.

xx_CUSTOM_11

String

Additional field for custom development.

xx_CUSTOM_12

String

Additional field for custom development.

xx_CUSTOM_13

String

Additional field for custom development.

xx_CUSTOM_14

String

Additional field for custom development.

xx_CUSTOM_15

String

Additional field for custom development.

xx_CUSTOM_16

String

Additional field for custom development.

xx_CUSTOM_17

String

Additional field for custom development.

xx_CUSTOM_18

String

Additional field for custom development.

xx_CUSTOM_19

String

Additional field for custom development.

xx_CUSTOM_20

String

Additional field for custom development.

xx_CUSTOM_21

String

Additional field for custom development.

xx_CUSTOM_22

String

Additional field for custom development.

xx_CUSTOM_23

String

Additional field for custom development.

xx_CUSTOM_24

String

Additional field for custom development.

xx_CUSTOM_25

String

Additional field for custom development.

xx_CUSTOM_26

String

Additional field for custom development.

xx_CUSTOM_27

String

Additional field for custom development.

xx_CUSTOM_28

String

Additional field for custom development.

xx_CUSTOM_29

String

Additional field for custom development.

xx_CUSTOM_30

String

Additional field for custom development.

salesRestrictionTypeCode

X

String

Sales restriction type code, e.g. * AGE, CAGE => Age (customer age is to be checked) * TIME => Sales prohibition period (sale is prohibited during specified time) * LIMT => Limit (maximally this quantity of the item may be sold) * WGHT => Weight (the weight is to be checked) * RISK => Risk (the sale of that item is to be double-checked)Import: masterData_Item.xml: Item.UOMItem.SalesRestriction.SalesRestrictionTypeCode masterData_BusinessUnit.xml: 'RISK' for BusinessUnit.MerchandiseHierarchyGroupDetail.RiskSaleResctriction

3.880. ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoSalesRestrictionTranslationSO

SalesRestrictionTranslationSO Translation of sales restriction texts in one language

Field Name Required Type Description Format

languageID

X

String

Language ISO code identificationImport: masterData_Item.xml: Item.UOMItem.SalesRestriction.TranslationList.Language.@ID

questionText

String

Localized question text in the given language.Import: masterData_Item.xml: Item.UOMItem.SalesRestriction.TranslationList.Language.TranslatedQuestionText

3.881. ComGkSoftwareSweeSesApiServerMdSalesRestrictionDtoSoUnitOfMeasureItemAssignmentSO

UnitOfMeasureItemAssignmentSO Reference to the item which the sales restriction is assigned to

Field Name Required Type Description Format

itemID

X

String

ID of the item which the sales restriction is assigned toImport: masterData_Item.xml: Item.ItemID

unitOfMeasureCode

X

String

Unit of measure of the item which the sales restriction is assigned toImport: masterData_Item.xml: Item.UOMItem.UOMCode

3.882. ComGkSoftwareSweeSesApiServerMdUomDtoSoUomConversionSO

UomConversionSO Conversion of one measure unit into another one.Not used. Not filled in the data editor.

Field Name Required Type Description Format

sourceUomCode

X

String

Source unit of measure code

destinationUomCode

String

Destination unit of measure code

factor

Double

The factor that converts the source UOM to the destination UOM

double

multiplyFlag

Boolean

Determines whether conversion is done by multiplying (true) or dividing (false)

3.883. ComGkSoftwareSweeSesApiServerMdUomDtoSoUomSO

UomSO Units in which a value is being expressed, or manner in which a measurement has been taken. Unit of measure codes are referred from the item. The codes have to be initialized before they are used on the item.Import from dc_import_UnitOfMeasure.

Field Name Required Type Description Format

unitOfMeasureCode

X

String

Identification of the unit of measureImport: dc_import_UnitOfMeasure: UnitOfMeasure.UOMCode

translatedUOMCode

X

String

Localized code of the unit of measure. This code is displayed in the GUI and can be used also in exports. Example: The unit of measure with the code 'PCE' has the localized code 'ST'.

unitOfMeasureTypeCode

String

Indicates what this unit of measure entity type instance measures. Examples include weight or mass, length, cube (length x width x depth), volume, discrete items (each), etc.Import: dc_import_UnitOfMeasure: UnitOfMeasure.UOMTypeCode

englishMetricFlag

Boolean

Indicates whether this unit of measure is part of the English or metric system of measurements.

name

String

Name assigned to this unit of measure.

description

String

Description assigned to this unit of measure.

uomConversionList

List of ComGkSoftwareSweeSesApiServerMdUomDtoSoUomConversionSO

List of conversions from this unit of measure into other units of measureNot used. Not filled in the data maintenance.

decimalPlacesCount

Integer

Allowed count of decimal places. The quantities are displayed with this decimal places count in the GUI and reports. When registering an item in this unit, there can be registered maximally this count of decimal places.

int32

isoUnitOfMeasureCode

String

The corresponding ISO code for this unit of measureNot imported.

tid

String

Translation identifier - used for the unique identification of translations in the common translation table.Generated, not imported.

translations

List of ComGkSoftwareSweeSesApiServerMdUomDtoSoUomTranslationSO

List of translations of unit of measure textsImport: dc_import_UnitOfMeasure: UnitOfMeasure.UomTranslationList

xxcustom03

String

Additional field for custom development

xxcustom02

String

Additional field for custom development

xxcustom05

String

Additional field for custom development

xxcustom04

String

Additional field for custom development

xxcustom01

String

Additional field for custom development

3.884. ComGkSoftwareSweeSesApiServerMdUomDtoSoUomTranslationSO

UomTranslationSO Translation of UOM texts in one language

Field Name Required Type Description Format

languageID

X

String

Language ISO code identification

translatedUOMCode

String

Localized code of unit of measure in the given language

name

String

Name of the unit of measure in the given language

description

String

Description of the unit of measure in the given language

3.885. ComGkSoftwareSweeSesApiServerUmOperatorDtoSoAbstractOperatorSO

AbstractOperatorSO The data of an operator (person) who can work in many retail stores. The operator can obtain different login data and different roles in different retail stores.Import from Operator.xml.

Field Name Required Type Description Format

operatorID

X

String

The unique ID of the operator (Note: Not the login name. The login name can be store specific.)<dl> <dt>+</dt></dl>

workerID

X

String

Worker ID. This attribute can be used as the connection between the operator and the worker object.

salutation

String

Salutation

firstName

String

First name

lastName

String

Last name

languageID

X

String

ISO language ID. The GUI in the portal, on the hand-held and on the POS is displayed in this language after user login

leftHandedFlag

X

Boolean

Flag for left handed. The flag can control the GUI of the peripheral device.

emailAddress

String

Email address

birthYearNumber

Integer

Birth year

int32

birthMonthNumber

Integer

Birth month

int32

birthDayNumber

Integer

Birth day

int32

operatorAssignmentSOList

List of ComGkSoftwareSweeSesApiServerUmOperatorDtoSoOperatorAssignmentSO

Role assignments in specific retail stores

peripheralAccessSOList

List of ComGkSoftwareSweeSesApiServerUmOperatorDtoSoPeripheralAccessSO

Login data for periphery classes in specific retail stores

origin

String

Origin of the import

  • 00 - IMPORT

  • 01 - MANUAL

Enum: IMPORT, MANUAL,

packageID

String

Internal identifier of the import file

opAsgnList

List of ComGkSoftwareSweeSesApiServerUmOperatorDtoSoOperatorAssignmentSO

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

isocountryCode

String

ISO country code

3.886. ComGkSoftwareSweeSesApiServerUmOperatorDtoSoOperatorAssignmentSO

OperatorAssignmentSO Assignment of the operator to a role in a specific retail store

Field Name Required Type Description Format

retailStoreID

X

String

Retail store ID of the role assignmentImport: Operator.xml: from Operator.BusinessUnitAssignment.BusinessUnitIdentification: BusinessUnitID or the corresponding retail store ID for the ExternalBusinessUnitID

workGroupID

X

String

ID of the assigned role in the storeImport: Operator.xml: Operator.BusinessUnitAssignment.BusinessUnitAssignmentContent.RoleID

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.887. ComGkSoftwareSweeSesApiServerUmOperatorDtoSoPeripheralAccessSO

PeripheralAccessSO Login data of one specific periphery class in the specific retail store

Field Name Required Type Description Format

retailStoreID

X

String

Retail store ID of the periphery access assignmentImport: Operator.xml: from Operator.BusinessUnitAssignment.BusinessUnitIdentification: BusinessUnitID or the corresponding retail store ID for the ExternalBusinessUnitID

peripheralsTypeCode

X

String

Identification of the periphery class. Possible values: 'Mobile', 'Web', 'POS', 'SCALE', 'RVM', 'ESL' etc. This attribute allows to define different login data for different peripheral systems.Import: Operator.xml: Operator.BusinessUnitAssignment.BusinessUnitAssignmentContent.PeripheralSystemTypeLogin.PeripheralSystemType

loginName

X

String

Login name. The login name for the target systems POS, Scale and Mobile can be numeric only.Import: Operator.xml: Operator.BusinessUnitAssignment.BusinessUnitAssignmentContent.PeripheralSystemTypeLogin.LoginName

loginPassword

String

Password. The password for the target systems POS, Scale and Mobile can be numeric only.Import: Operator.xml: Operator.BusinessUnitAssignment.BusinessUnitAssignmentContent.PeripheralSystemTypeLogin.Password

passwordCreateTimestamp

X

String

Timestamp (date and time), when the password was created. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

passwordFailedAttemptsCount

X

Integer

Count of failed log in attempts. This value is reset after a successfully log in. FAT POS will save these attributes locally. They will be never known on the central.

int32

passwordLastSuccessfulLoginTimestamp

String

Timestamp of last successfully log in FAT POS will save these attributes locally. They will be never known on the central. Date format 'yyyy-MM-dd’T’HH:mm:ss.SSS' (no timezone)

accessBlockingFlag

X

Boolean

Determines, if the access is blocked. FAT POS will save these attributes locally. They will be never known on the central.

initialPasswordFlag

Boolean

Initial password flag

xxcustom03

String

Additional field for custom development.

xxcustom02

String

Additional field for custom development.

xxcustom05

String

Additional field for custom development.

xxcustom04

String

Additional field for custom development.

xxcustom01

String

Additional field for custom development.

3.888. CurrencyResult

Field Name Required Type Description Format

baseCurrency

com.gk_software.gkr.api.server.md.currency.dto.dom.CurrencyDO

currencies

List of ComGkSoftwareGkrApiServerMdCurrencyDtoDomCurrencyDO

availableCurrencyCodes

List of [String]

exchangeRates

Map of ComGkSoftwareGkrApiServerMdExchangeRateDtoDomExchangeRateDO

3.889. ErrorCode

Field Name Required Type Description Format

errorCode

String

message

String

messageKey

String

arguments

List of [String]

3.890. ExchangeRatesResult

Field Name Required Type Description Format

fromCurrency

String

exchangeRatesByCurrencyCode

Map of ComGkSoftwareGkrApiServerMdExchangeRateDtoDomExchangeRateDO

3.891. FilterPerTenderResult

Field Name Required Type Description Format

allowedTender

Set of ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

allowedTenderAmounts

Map of [Number]

forbiddenTender

Set of ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

authorizationNeededTender

Set of ComGkSoftwareGkrApiServerMdTenderDtoDomTenderDO

tenderErrorCodeMap

Map of ErrorCode

3.892. ItemSearchResponse

Field Name Required Type Description Format

listPosUOMItemSearchView

List of ComGkSoftwareGkrApiServerMdItemDtoDomPosPosUOMItemSearchView

foundPosUOMItemDO

com.gk_software.gkr.api.server.md.item.dto.dom.pos.PosUOMItemDO

3.893. Money

Field Name Required Type Description Format

amount

Integer

int32

currency

String

3.894. PceContext

Field Name Required Type Description Format

calculationScheme

String

recommendationMode

String

recommendationContext

String

configuration

Map of [String]

3.895. PinInfoType

Field Name Required Type Description Format

serialNumber

String

pinCode

String

validTo

Date

date-time

printoutText

String

3.896. PosSession

Field Name Required Type Description Format

id

com.gk_software.pos.api.session.PosSessionId

transaction

PosTransaction

tenantId

String

workstationId

String

workstationTypeCode

String

operatorId

String

deviceId

String

tillId

com.gk_software.gkr.api.server.md.till.dto.dom.TillDO.Key

clientVersion

String

activeLanguageScope

String

Enum: Operator, Customer, Transaction, MasterData,

trainingMode

Boolean

readOnlyLastSetTimestamp

Long

int64

workstationStatus

com.gk_software.gkr.api.login_manager.dto.WorkstationStatus

workstationTenderRepositoryStatus

com.gk_software.gkr.api.login_manager.dto.WorkstationTenderRepositoryStatus

posServerLogoutRequested

Boolean

useLoginTypeTechnicalForLoginManager

Boolean

promotionServiceEnabled

Boolean

packagePricingSession

com.gk_software.package_pricing.pos.api.calculation.PackagePricingSession

packagePricingServiceEnabled

Boolean

additionalSessionCriteria_01

String

additionalSessionCriteria_02

String

dataPrivacyEnabled

Boolean

storeTransaction

Boolean

pceContext

PceContext

posContext

String

tempTransactionBoundCache

Map of [Object]

retailStore

com.gk_software.gkr.api.server.md.business_unit.dto.dom.BusinessUnitDO

mainTransaction

PosTransaction

posSessionData

com.gk_software.pos.api.session.PosSessionData

temoraryPromotionSO

List of ComGkSoftwareSweeSesApiServerMdPromotionDtoSoPromotionSO

lastServerStatusOnline

Boolean

3.897. PosTransaction

Field Name Required Type Description Format

transaction

com.gk_software.gkr.api.txpool.dto.Transaction

3.898. PrepaidInfoType

Field Name Required Type Description Format

faceValue

Money

itemId

String

quantity

Integer

int32

prepaidType

String

3.899. PrepaidPinRequest

Field Name Required Type Description Format

uuid

String

country

String

store

String

posNumber

String

posTimestamp

Date

date-time

voucherNo

String

voucherId

String

prepaidInfos

List of PrepaidInfoType

prepaidTypes

List of PrepaidType

3.900. PrepaidPinResponse

Field Name Required Type Description Format

returnCode

String

prepaidReturnInfos

List of PrepaidReturnInfoType

3.901. PrepaidReturnInfoType

Field Name Required Type Description Format

returnCode

String

pinInfos

List of PinInfoType

3.902. PrepaidType

Field Name Required Type Description Format

smId

Integer

int32

itemId

String

providerCode

String

resourceId

String

3.903. PromotionInputResponse

Field Name Required Type Description Format

promotionInputRequestList

List of ComGkSoftwarePosApiModelDomAppPromotionInputRequestPromotionInputRequest

startSequence

Integer

int32

3.904. PromotionValidationResultType

Field Name Required Type Description Format

value

String