Ballerina Central will undergo scheduled maintenance on Wednesday, August 06, from 00:30 AM to 01:30 AM UTC. During this time, Ballerina Central login and sign up will be temporarily disabled. We appreciate your patience as we work to improve your experience. For more information, reach out to contact@ballerina.io
 
Ballerina library

saps4hana.itcm.organizationaldata

Module saps4hana.itcm.organizationaldata

OverviewPrerequisites

API

Client

Definitions

ClientHttp1Settings
ConnectionConfig
DistributionChannelDeleteResponse
DistributionChannelResponse
DistributionChannelResponseNotFound
ExternalDistributionChannelDescriptionDTO
ExternalDistributionChannelDTO
ExternalSalesAreaDescriptionDTO
ExternalSalesAreaDTO
ExternalSalesDivisionDescriptionDTO
ExternalSalesDivisionDTO
ExternalSalesOrganizationDescriptionDTO
ExternalSalesOrganizationDTO
OAuth2ClientCredentialsGrantConfig
ProxyConfig
ResponseCreated
ResponseForbiddenMessage
ResponseMessage
ResponseNotFoundMessage
ResponseUnauthorizedMessage
SalesAreaDeleteResponse
SalesAreaResponse
SalesAreaResponseNotFound
SalesDivisionDeleteResponse
SalesDivisionResponse
SalesDivisionResponseNotFound
SalesOrganizationDeleteResponse
SalesOrganizationResponse
SalesOrganizationResponseNotFound
SalesOrgDeleteResponse

ballerinax/saps4hana.itcm.organizationaldata Ballerina library

1.5.1

Overview

This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. SAP Intelligent Trade Claims Management uses the organizational data services to represent distribution channel services, sales areas, sales divisions, and sales organizations for customer management.

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.organizationaldata: Client

Isolated

This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. SAP Intelligent Trade Claims Management uses the organizational data services to represent distribution channel services, sales areas, sales divisions, and sales organizations for customer management.

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

createDistributionChannel

Isolated FunctionRemote Function
function createDistributionChannel(ExternalDistributionChannelDTO payload) returns ResponseCreated|error

Create a new Distribution Channel

Parameters
Return Type

getDistributionChannelByExternalId

Isolated FunctionRemote Function
function getDistributionChannelByExternalId(string externalId) returns DistributionChannelResponse|error

Get particular Distribution Channel

Parameters
  • externalId string - externalId
Return Type

deleteDistributionChannel

Isolated FunctionRemote Function
function deleteDistributionChannel(string externalId) returns DistributionChannelDeleteResponse|error

Delete particular Distribution Channel

Parameters
  • externalId string - externalId
Return Type

createSalesArea

Isolated FunctionRemote Function
function createSalesArea(ExternalSalesAreaDTO payload) returns ResponseCreated|error

Create a new Sales Area

Parameters
Return Type

getSalesAreaByExternalId

Isolated FunctionRemote Function
function getSalesAreaByExternalId(string externalId) returns SalesAreaResponse|error

Get particular Sales Area

Parameters
  • externalId string - externalId
Return Type

deleteSalesArea

Isolated FunctionRemote Function
function deleteSalesArea(string externalId) returns SalesAreaDeleteResponse|error

Delete particular Sales Area

Parameters
  • externalId string - externalId
Return Type

createSalesDivision

Isolated FunctionRemote Function
function createSalesDivision(ExternalSalesDivisionDTO payload) returns ResponseCreated|error

Create a new Sales Division

Parameters
Return Type

getSalesDivisionByExternalId

Isolated FunctionRemote Function
function getSalesDivisionByExternalId(string externalId) returns SalesDivisionResponse|error

Get particular Sales Division

Parameters
  • externalId string - externalId
Return Type

deleteSalesDivision

Isolated FunctionRemote Function
function deleteSalesDivision(string externalId) returns SalesDivisionDeleteResponse|error

delete particular Sales Division

Parameters
  • externalId string - externalId
Return Type

createSalesOrganization

Isolated FunctionRemote Function
function createSalesOrganization(ExternalSalesOrganizationDTO payload) returns ResponseCreated|error

Create a new Sales Organization

Parameters
Return Type

getSalesOrganizationByExternalId

Isolated FunctionRemote Function
function getSalesOrganizationByExternalId(string externalId) returns SalesOrganizationResponse|error

Get particular Sales Organization

Parameters
  • externalId string - externalId
Return Type

deleteSalesOrganization

Isolated FunctionRemote Function
function deleteSalesOrganization(string externalId) returns SalesOrgDeleteResponse|error

Delete particular Sales Organization

Parameters
  • externalId string - externalId
Return Type

Records

saps4hana.itcm.organizationaldata: 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.organizationaldata: 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.organizationaldata: DistributionChannelDeleteResponse

Fields

saps4hana.itcm.organizationaldata: DistributionChannelResponse

Fields

saps4hana.itcm.organizationaldata: DistributionChannelResponseNotFound

Fields

saps4hana.itcm.organizationaldata: ExternalDistributionChannelDescriptionDTO

Fields

saps4hana.itcm.organizationaldata: ExternalDistributionChannelDTO

Fields

saps4hana.itcm.organizationaldata: ExternalSalesAreaDescriptionDTO

Fields

saps4hana.itcm.organizationaldata: ExternalSalesAreaDTO

Fields
  • externalDistributionChannel string? -
  • externalSalesDivision string? -
  • externalSalesOrganization string? -

saps4hana.itcm.organizationaldata: ExternalSalesDivisionDescriptionDTO

Fields

saps4hana.itcm.organizationaldata: ExternalSalesDivisionDTO

Fields

saps4hana.itcm.organizationaldata: ExternalSalesOrganizationDescriptionDTO

Fields

saps4hana.itcm.organizationaldata: ExternalSalesOrganizationDTO

Fields
  • externalCompanyCodeId string? -

saps4hana.itcm.organizationaldata: 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.organizationaldata: 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.organizationaldata: ResponseCreated

Fields

saps4hana.itcm.organizationaldata: ResponseForbiddenMessage

Fields

saps4hana.itcm.organizationaldata: ResponseMessage

Fields

saps4hana.itcm.organizationaldata: ResponseNotFoundMessage

Fields

saps4hana.itcm.organizationaldata: ResponseUnauthorizedMessage

Fields

saps4hana.itcm.organizationaldata: SalesAreaDeleteResponse

Fields

saps4hana.itcm.organizationaldata: SalesAreaResponse

Fields

saps4hana.itcm.organizationaldata: SalesAreaResponseNotFound

Fields

saps4hana.itcm.organizationaldata: SalesDivisionDeleteResponse

Fields

saps4hana.itcm.organizationaldata: SalesDivisionResponse

Fields

saps4hana.itcm.organizationaldata: SalesDivisionResponseNotFound

Fields

saps4hana.itcm.organizationaldata: SalesOrganizationDeleteResponse

Fields

saps4hana.itcm.organizationaldata: SalesOrganizationResponse

Fields

saps4hana.itcm.organizationaldata: SalesOrganizationResponseNotFound

Fields

saps4hana.itcm.organizationaldata: SalesOrgDeleteResponse

Fields

Import

import ballerinax/saps4hana.itcm.organizationaldata;Copy

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Metadata

Released date: about 2 years ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 5

Current verison: 5

Weekly downloads

Source repository

Keywords

Business Management/ERP

Cost/Paid

Contributors

Dependencies

ballerina/url/2.2.3ballerina/constraint/1.1.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC