Ballerina library

saps4hana.itcm.customer

Module saps4hana.itcm.customer

OverviewPrerequisites

API

Client

Definitions

ClientHttp1Settings
ConnectionConfig
CustomerDTO
CustomerPartnerRoleDTO
CustomerSalesAspectDTO
OAuth2ClientCredentialsGrantConfig
PageDTO
ProxyConfig
ResponseCreatedMessage
ResponseDeleteCurrencyMessage
ResponseForbiddenMessage
ResponseNotFoundMessage
ResponseUnauthorizedMessage
SalesAreaDTO
ScriptedOrganizationAddressDTO

ballerinax/saps4hana.itcm.customer Ballerina library

1.5.1

Overview

This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, the customer service allows you to access their customers retailer and distributor information.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  • Create and configure an OAuth2 client credentials by following this guide.

Clients

saps4hana.itcm.customer: Client

Isolated

This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, the customer service allows you to access their customers retailer and distributor information.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create and configure an OAuth2 client credentials by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string - URL of the target service

createCustomer

Isolated FunctionRemote Function
function createCustomer(CustomerDTO payload) returns ResponseCreatedMessage|error

Create a new Customer

Parameters
  • payload CustomerDTO - Request payload to create customer
Return Type

getCustomerByExternalId

Isolated FunctionRemote Function
function getCustomerByExternalId(string externalid) returns CustomerDTO|error

Get the details of a Customer with externalId

Parameters
  • externalid string - customer's external id
Return Type

deleteCustomer

Isolated FunctionRemote Function
function deleteCustomer(string externalid) returns ResponseDeleteCurrencyMessage|error

Delete a Customer with externalId

Parameters
  • externalid string - customer's external id
Return Type

Records

saps4hana.itcm.customer: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

saps4hana.itcm.customer: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

saps4hana.itcm.customer: CustomerDTO

Fields
  • businessSystem int? -

saps4hana.itcm.customer: CustomerPartnerRoleDTO

Fields

saps4hana.itcm.customer: CustomerSalesAspectDTO

Fields

saps4hana.itcm.customer: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields
  • tokenUrl string(default "https://colgate-dev1.authentication.us30.hana.ondemand.com/oauth/token") - Token URL

saps4hana.itcm.customer: PageDTO

Fields
  • pageNumber int? -
  • pageSize int? -
  • totalElements int? -
  • totalPages int? -

saps4hana.itcm.customer: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

saps4hana.itcm.customer: ResponseCreatedMessage

Fields

saps4hana.itcm.customer: ResponseDeleteCurrencyMessage

Fields

saps4hana.itcm.customer: ResponseForbiddenMessage

Fields

saps4hana.itcm.customer: ResponseNotFoundMessage

Fields

saps4hana.itcm.customer: ResponseUnauthorizedMessage

Fields

saps4hana.itcm.customer: SalesAreaDTO

Fields
  • distributionChannelCode string? -
  • salesOrganizationID string? -

saps4hana.itcm.customer: ScriptedOrganizationAddressDTO

Fields
  • formattedOrgNameLine1 string? -
  • formattedOrgNameLine2 string? -
  • formattedOrgNameLine3 string? -
  • formattedOrgNameLine4 string? -

Import

import ballerinax/saps4hana.itcm.customer;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 2

Current verison: 2

Weekly downloads

Source repository

Keywords

Business Management/ERP

Cost/Paid

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC