--- swagger: "2.0" info: version: "5.19.1-b19-SNAPSHOT" title: "GK application - OmniPOS Service API" host: "localhost:8080" basePath: "/pos-service/tenants//services/**" tags: - name: "AuthenticationService" - name: "AuthorizationService" - name: "BillDocWebService" - name: "CouponingService" - name: "CustomerByIdWebService" - name: "CustomerOperationService" - name: "CustomerTransactionService" - name: "DataPrivacyLogService" - name: "DigitalReceiptService" - name: "DynamicTableauService" - name: "EventLogService" - name: "EwicItemCategoryService" - name: "ExternalCartService" - name: "ExternalCustomerService" - name: "ExternalItemQueryService" - name: "ExternalOrderService" - name: "GiftCertificateTransactionService" - name: "GkrSvsPrepaidServerService" - name: "HospitalityService" - name: "ItemQueryService" - name: "LayawayService" - name: "LineItemService" - name: "LoyaltyRewardService" - name: "LoyaltySystemService" - name: "MasterDataService" - name: "PayablesAccountWebService" - name: "PaymentService" - name: "PosGroupManagementService" - name: "PosSessionService" - name: "PosTransactionService" - name: "PrepaidCreditTransactionService" - name: "PricingService" - name: "PromotionTriggerService" - name: "RescanService" - name: "SalesOrderBasicWebService" - name: "SalesOrderByIdV3WebService" - name: "SalesOrderChangeRequestConfirmationWebService" - name: "SalesOrderCreateCheckWebService" - name: "SalesOrderCreateRequestConfirmationWebService" - name: "SalesOrderSalesDocReadWebService" - name: "SalesOrderService" - name: "SmartPOSMDReplicationStateProviderService" - name: "SmartPOSService" - name: "StockService" - name: "StoredValueServerService" - name: "SubtotalService" - name: "SystemService" - name: "TaxEngineService" - name: "TillService" schemes: - "https" paths: /com.gk_software.pos.api.service.communication.ws.billdoc.BillDocWebService/getInvoiceData: post: tags: - "BillDocWebService" summary: "Method that allows retrieving of invoice data using the invoice number." description: "Method that allows retrieving of invoice data using the invoice\ \ number.


WssbRfcBillDocRead" operationId: "BillDocWebService.getInvoiceData" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "The BillDocRequest object." required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.billdoc.BillDocRequest" responses: 200: description: "Success" schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.billdoc.BillDocResponse" 500: description: "in case of any error." /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/createCustomer: post: tags: - "CustomerOperationService" summary: "Create new customer in given data provider with specified details." description: "Create new customer in given data provider with specified details." operationId: "CustomerOperationService.createCustomer" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "the UpdateCustomerRequest" required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.UpdateCustomerRequest" responses: 200: description: "Success" schema: type: "string" 500: description: "in case of any error" /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerById: post: tags: - "CustomerOperationService" summary: "Search customer by given ID." description: "Search customer by given ID." operationId: "CustomerOperationService.findCustomerById" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "The FindCustomerByIdRequest" required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.FindCustomerByIdRequest" responses: 200: description: "Success" schema: $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" 500: description: "In case an error occurs." /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerContactViewListByFilter: post: tags: - "CustomerOperationService" summary: "Search customer by filter." description: "Search customer by filter." operationId: "CustomerOperationService.findCustomerContactViewListByFilter" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "The SearchCustomerRequest including the search criteria" required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_search_by_criteria.SearchCustomerRequest" responses: 200: description: "Success" schema: type: "array" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerContactView" 500: description: "in case of any error." /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerDataById: post: tags: - "CustomerOperationService" summary: "Search customer by given ID." description: "Search customer by given ID." operationId: "CustomerOperationService.findCustomerData" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "The FindCustomerDataRequest" required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.FindCustomerDataRequest" responses: 200: description: "Success" schema: $ref: "#/definitions/com.gk_software.pos.flow.libs.customer.CustomerData" 500: description: "in case of any error" /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findCustomerDataByPartyIdentification: post: tags: - "CustomerOperationService" summary: "Find customer list by given party identification." description: "Find customer list by given party identification." operationId: "CustomerOperationService.findCustomerByPartyIdentification" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "The FindCustomerByPartyIdentificationRequest" required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.FindCustomerByPartyIdentificationRequest" responses: 200: description: "Success" schema: type: "array" items: $ref: "#/definitions/com.gk_software.gkr.api.server.md.customer.dto.dom.CustomerDO" 500: description: "in case of any error" /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/findLastCustomerId: post: tags: - "CustomerOperationService" operationId: "findLastCustomerId" consumes: - "application/json" produces: - "application/json" parameters: [] responses: 200: description: "successful operation" schema: type: "string" /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/mapCustomerDOToCustomerData: post: tags: - "CustomerOperationService" operationId: "mapCustomerDOToCustomerData" consumes: - "application/json" produces: - "application/json" parameters: [] responses: 200: description: "successful operation" schema: $ref: "#/definitions/com.gk_software.pos.flow.libs.customer.CustomerData" /com.gk_software.pos.api.service.communication.ws.customer.CustomerOperationService/updateCustomer: post: tags: - "CustomerOperationService" summary: "Update customer in given data provider with specified details." description: "Update customer in given data provider with specified details." operationId: "CustomerOperationService.updateCustomer" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "The UpdateCustomerRequest" required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.operation.UpdateCustomerRequest" responses: 200: description: "Success" 500: description: "in case of any error." /com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerByIdWebService/searchCustomerById: post: tags: - "CustomerByIdWebService" summary: "Search customer by customer id" description: "Search customer by customer id" operationId: "CustomerByIdWebService.searchCustomerById" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "The CustomerWebserviceRequest including customer identifier\ \ and web service config" required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebserviceRequest" responses: 200: description: "Success" schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.customer_by_id.CustomerWebServiceResultSAPERP" 500: description: "" /com.gk_software.pos.api.service.communication.ws.payables_account.PayablesAccountWebService/getAccountBalance: post: tags: - "PayablesAccountWebService" summary: "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." operationId: "PayablesAccountWebService.getAccountBalance" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "The account balance request containing the necessary information\ \ for the balance request, as web service configuration, customer id and\ \ accounting area." required: true schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.payables_account.AccountBalanceRequest" responses: 200: description: "Success" schema: $ref: "#/definitions/com.gk_software.pos.api.service.communication.ws.payables_account.AccountBalanceResult" 500: description: "The exception is thrown if an unexpected error occurs, i.e.:\ \