saps4hana.itcm.customer
Module saps4hana.itcm.customer
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_saps4hana.itcm.customer_1.5.0.png)
ballerinax/saps4hana.itcm.customer Ballerina library
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![](/images/permalink.svg)
saps4hana.itcm.customer: Client![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function createCustomer(CustomerDTO payload) returns ResponseCreatedMessage|error
Create a new Customer
Parameters
- payload CustomerDTO - Request payload to create customer
Return Type
- ResponseCreatedMessage|error - Success Created.
getCustomerByExternalId![](/images/permalink.svg)
function getCustomerByExternalId(string externalid) returns CustomerDTO|error
Get the details of a Customer with externalId
Parameters
- externalid string - customer's external id
Return Type
- CustomerDTO|error - OK.
deleteCustomer![](/images/permalink.svg)
function deleteCustomer(string externalid) returns ResponseDeleteCurrencyMessage|error
Delete a Customer with externalId
Parameters
- externalid string - customer's external id
Return Type
Records![](/images/permalink.svg)
saps4hana.itcm.customer: ClientHttp1Settings![](/images/permalink.svg)
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
- proxy ProxyConfig? - Proxy server related options
saps4hana.itcm.customer: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- 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
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- 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
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
saps4hana.itcm.customer: CustomerDTO![](/images/permalink.svg)
Fields
- businessSystem int? -
- customerAddress ScriptedOrganizationAddressDTO? -
- customerSalesData CustomerSalesAspectDTO[]? -
- deletionIndicator boolean? -
- externalID string? -
- externalId string? -
- fullName string? -
- name string? -
- supplierID string? -
saps4hana.itcm.customer: CustomerPartnerRoleDTO![](/images/permalink.svg)
Fields
- customerID string? -
- name string? -
- partnerCode string? -
- partnerDescription string? -
saps4hana.itcm.customer: CustomerSalesAspectDTO![](/images/permalink.svg)
Fields
- customerPartnerRole CustomerPartnerRoleDTO[]? -
- salesArea SalesAreaDTO? -
saps4hana.itcm.customer: OAuth2ClientCredentialsGrantConfig![](/images/permalink.svg)
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://colgate-dev1.authentication.us30.hana.ondemand.com/oauth/token") - Token URL
saps4hana.itcm.customer: PageDTO![](/images/permalink.svg)
Fields
- content CustomerDTO[]? -
- first boolean? -
- last boolean? -
- pageNumber int? -
- pageSize int? -
- totalElements int? -
- totalPages int? -
saps4hana.itcm.customer: ProxyConfig![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- id string? -
- message string? -
- timestamp string? -
saps4hana.itcm.customer: ResponseDeleteCurrencyMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
saps4hana.itcm.customer: ResponseForbiddenMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.customer: ResponseNotFoundMessage![](/images/permalink.svg)
Fields
- message string? -
- 'error string? -
- timestamp string? -
saps4hana.itcm.customer: ResponseUnauthorizedMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.customer: SalesAreaDTO![](/images/permalink.svg)
Fields
- distributionChannelCode string? -
- salesDivision string? -
- salesOrganizationID string? -
saps4hana.itcm.customer: ScriptedOrganizationAddressDTO![](/images/permalink.svg)
Fields
- formattedOrgNameLine1 string? -
- formattedOrgNameLine2 string? -
- formattedOrgNameLine3 string? -
- formattedOrgNameLine4 string? -
Import
import ballerinax/saps4hana.itcm.customer;
Metadata
Released date: over 1 year ago
Version: 1.5.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Business Management/ERP
Cost/Paid
Contributors
Dependencies