saps4hana.itcm.agreement
Module saps4hana.itcm.agreement
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_saps4hana.itcm.agreement_1.5.0.png)
ballerinax/saps4hana.itcm.agreement Ballerina library
Overview
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAP Intelligent Trade Claims Management, agreements are used as contractual commitments or obligations to calculate accruals and promotion eligibility.
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.agreement: Client![](/images/permalink.svg)
This is a generated connector for SAP Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAP Intelligent Trade Claims Management, agreements are used as contractual commitments or obligations to calculate accruals and promotion eligibility.
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
createAgreement![](/images/permalink.svg)
function createAgreement(AgreementHeaderDTOIncoming payload) returns ResponseAgreementMessage|error
Create a new Agreement
Parameters
- payload AgreementHeaderDTOIncoming - Request payload to create an agreement
Return Type
- ResponseAgreementMessage|error - Success Created.
deleteAgreement![](/images/permalink.svg)
function deleteAgreement(string externalId) returns ResponseAgreementDeletionMessage|error
Delete an Agreement
Parameters
- externalId string - agreement id to be deleted
Return Type
- ResponseAgreementDeletionMessage|error - Success Deleted.
Records![](/images/permalink.svg)
saps4hana.itcm.agreement: AgreementAccrualDTOIncoming![](/images/permalink.svg)
Fields
- accrualAttributes string? -
- conditionCurrency string? -
- conditionRecordAttributes string? -
- conditionRecordNumber string? -
- conditionTypeExternalId string? -
- customerHierarchyNode HierarchyNodeKey? -
- customerExternalId string? -
- externalKey string -
- maxPayOutAmount Amount? -
- openAccrualAmount Amount? -
- paidOutAmount Amount? -
- productHierarchyNodeLevel1 HierarchyNodeKey? -
- productHierarchyNodeLevel2 HierarchyNodeKey? -
- productHierarchyNodeLevel3 HierarchyNodeKey? -
- externalProductId string? -
- rebateAmount Amount? -
- rebateBaseAmount int? -
- rebateBaseUnit string? -
- rebatePercentage decimal? -
- externalSalesArea SalesArea? -
saps4hana.itcm.agreement: AgreementHeaderDTOIncoming![](/images/permalink.svg)
Fields
- additionalValueDays int? -
- accruals AgreementAccrualDTOIncoming[]? -
- description string? -
- externalStatus string? -
- texts AgreementTextDTOOutgoing[]? -
- externalType string? -
- validFrom string? -
- validTo string? -
- businessSystem int -
- externalCustomerId string? -
- isMarkedForDeletion boolean(default false) -
- fixedValueDate string? -
- externalPaymentMethod string? -
- externalPaymentTerms string? -
- promotionExternalID string? -
- reference string? -
- externalSalesArea SalesArea? -
- salesHeader SalesDocument -
- isInPrecisionMode boolean? -
saps4hana.itcm.agreement: AgreementTextDTOOutgoing![](/images/permalink.svg)
Fields
- 'type AgreementTextType? -
- language string? -
- text string? -
saps4hana.itcm.agreement: AgreementTextType![](/images/permalink.svg)
Fields
- externalId string? -
- names AgreementTextTypeName[]? -
saps4hana.itcm.agreement: AgreementTextTypeName![](/images/permalink.svg)
Fields
- text string? -
- language string? -
saps4hana.itcm.agreement: AgreementType![](/images/permalink.svg)
Fields
- canConditionRecordValidityDiffer boolean? -
- externalConditionTypeTableGroup string? -
- isEnhancedProcessingVakeyActive boolean? -
- externalFinalSettlementOrderType string? -
- language string? -
- externalManualAccrualOrderType string? -
- externalManualPaymentProcedure string? -
- externalMinValueForFinalSettlement string? -
- externalPartialSettlementOrderType string? -
- externalPaymentMethod string? -
- canManualAccrualsBePosted boolean? -
- rebateAgreementType string -
- shallManualAccrualsBeReversed boolean? -
- text string? -
saps4hana.itcm.agreement: Amount![](/images/permalink.svg)
Fields
- amount decimal? -
- currencyCode string? -
saps4hana.itcm.agreement: 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.agreement: ConditionTypeText![](/images/permalink.svg)
Fields
- externalConditonTypeId string? -
- text string? -
- language string? -
saps4hana.itcm.agreement: 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.agreement: HierarchyNodeKey![](/images/permalink.svg)
Fields
- hierarchyID string? -
- hierarchyNodeID string? -
- hierarchyTypeCode string? -
saps4hana.itcm.agreement: 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.agreement: 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.agreement: ResponseAgreementDeletionMessage![](/images/permalink.svg)
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.agreement: ResponseAgreementMessage![](/images/permalink.svg)
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.agreement: ResponseDeleteMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
saps4hana.itcm.agreement: ResponseForbiddenMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.agreement: ResponseMessage![](/images/permalink.svg)
Fields
- 'error string? -
- message string? -
- timestamp string? -
saps4hana.itcm.agreement: SalesArea![](/images/permalink.svg)
Fields
- distributionChannel string? -
- salesDivision string? -
- salesOrganization string? -
saps4hana.itcm.agreement: SalesDocument![](/images/permalink.svg)
Fields
- currencyCode string? -
- displayID string -
Import
import ballerinax/saps4hana.itcm.agreement;
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