Module saps4hana.itcm.accountreceivable
ballerinax/saps4hana.itcm.accountreceivable Ballerina library
1.5.2
Overview
The SAP S/4HANA Intelligent Trade Claims Management API v1.0.0 connector(https://help.sap.com/viewer/902b9d277dfe48fea582d28849d54935/CURRENT/en-US) OpenAPI specification. A user in SAP Intelligent Trade Claims Management can create and update existing accounts receivable open items within SAP Intelligent Trade Claims Management. Accounts receivable open items contribute to baseline information for claims to be built.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
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.accountreceivable: Client
Isolated
This is a generated connector for SAP Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. A user in SAP Intelligent Trade Claims Management can create and update existing accounts receivable open items within SAP Intelligent Trade Claims Management. Accounts receivable open items contribute to baseline information for claims to be built.
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
createAROpenItem
Isolated FunctionRemote Function
function createAROpenItem(ReceivedParamDTO payload) returns ResponseAROpenItemsMessage|errorCreate a new AR Open Item
Parameters
- payload ReceivedParamDTO - Request payload to create AR Open Item
Return Type
- ResponseAROpenItemsMessage|error - Success Created.
getAROpenItemById
Isolated FunctionRemote Function
function getAROpenItemById(int id) returns ResidualAccountingDocumentItem4ApiDTO|errorGet the detail of an AR Open Item by id
Parameters
- id int - id
Return Type
batchCreateReasonCode
Isolated FunctionRemote Function
function batchCreateReasonCode(ReasonCodeMockDTO payload) returns ResponseReasonCodesMessage|errorCreate a Reason Code
Parameters
- payload ReasonCodeMockDTO - Request payload to create reason code
Return Type
- ResponseReasonCodesMessage|error - Success Created.
getReasonCodeList
Isolated FunctionRemote Function
function getReasonCodeList(string code) returns ReasonCodeDTO|errorGet the detail of a Reason Code by code
Parameters
- code string - code
Return Type
- ReasonCodeDTO|error - OK.
Records
saps4hana.itcm.accountreceivable: 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
- proxy? ProxyConfig - Proxy server related options
saps4hana.itcm.accountreceivable: ConnectionConfig
Closed record
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-forwardedheader
- 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.accountreceivable: OAuth2ClientCredentialsGrantConfig
Closed record
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.accountreceivable: 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.accountreceivable: ReasonCodeDescriptionDto
Fields
- Language? string -
- PaymentDifferenceReason? string -
- PaymentDifferenceReasonDesc? string -
- PaymentDifferenceReasonName? string -
saps4hana.itcm.accountreceivable: ReasonCodeDTO
Fields
- code? string -
- description? string -
- id? int -
- reasonCodeTradeType? string -
saps4hana.itcm.accountreceivable: ReasonCodeMockDTO
Fields
- CompanyCode? string -
- IsDisputed? boolean -
- PaymentDifferenceReason? string -
- PaytDiffIsChargedToSprtGLAcct? boolean -
- to_Text? ReasonCodeDescriptionDto[] -
saps4hana.itcm.accountreceivable: ReceivedParamDTO
Fields
- arOpenItemList? ResidualAccountingDocumentItemDTO[] -
- invoiceReference? string -
- salesArea? SalesAreaDTO -
saps4hana.itcm.accountreceivable: ResidualAccountingDocumentItem4ApiDTO
Fields
- accountingDocument? string -
- accountingDocumentItem? string -
- accountingDocumentItemText? string -
- amountInTransactionCurrency? decimal -
- assignmentReference? string -
- clearedAccountingDocument? string -
- clearedAccountingDocumentItem? string -
- clearedDate? string -
- clearedFiscalYear? string -
- clearingAccountingDocument? string -
- clearingDocFiscalYear? string -
- companyCode? string -
- creationDate? string -
- creationTime? string -
- customer? string -
- customerName? string -
- fiscalYear? string -
- invoiceItemReference? string -
- invoiceReference? string -
- isOpen? boolean -
- itemText? string -
- lastChangedDate? string -
- paymentDifferenceReason? string -
- tradeType? string -
- transactionCurrency? string -
saps4hana.itcm.accountreceivable: ResidualAccountingDocumentItemDTO
Fields
- ACCOUNTINGDOCUMENT? string -
- ACCOUNTINGDOCUMENTITEM? string -
- AMOUNTINTRANSACTIONCURRENCY? decimal -
- ASSIGNMENTREFERENCE? string -
- BILLINGDOCUMENT? string -
- CHANGEDOCUMENTCREATIONDATE? int -
- CHANGEDOCUMENTCREATIONTIME? int -
- CLEAREDACCOUNTINGDOCUMENT? string -
- CLEAREDACCOUNTINGDOCUMENTITEM? string -
- CLEAREDFISCALYEAR? string -
- CLEARINGACCOUNTINGDOCUMENT? string -
- CLEARINGCREATIONDATE? int -
- CLEARINGDATE? int -
- CLEARINGDOCFISCALYEAR? string -
- COMPANYCODE? string -
- CREATIONDATE? int -
- CREATIONTIME? int -
- CUSTOMER? string -
- DEBITCREDITCODE? string -
- FISCALYEAR? string -
- INVOICEITEMREFERENCE? string -
- INVOICEREFERENCE? string -
- INVOICEREFERENCEFISCALYEAR? string -
- ITEMTTEXT? string -
- LASTCHANGEDATE? int -
- OPENITEMCREATIONDATE? int -
- OPENITEMCREATIONTIME? int -
- PAYMENTDIFFERENCEREASON? string -
- TRANSACTIONCURRENCY? string -
- amountInCompanyCodeCurrency? int -
- lastChangeDateTime? string -
- recordScenario? string -
- salesArea? SalesAreaDTO -
- sortedTime? string -
saps4hana.itcm.accountreceivable: ResponseAROpenItemsMessage
Fields
- invoiceReference? string -
- message? string -
- timestamp? string -
saps4hana.itcm.accountreceivable: ResponseForbiddenMessage
Fields
- message? string -
- timestamp? string -
- uri? string -
saps4hana.itcm.accountreceivable: ResponseMessage
Fields
- 'error? string -
- message? string -
- timestamp? string -
- uri? string -
saps4hana.itcm.accountreceivable: ResponseReasonCodesMessage
Fields
- invoiceReference? string -
- message? string -
- timestamp? string -
saps4hana.itcm.accountreceivable: SalesAreaDTO
Fields
- distributionChannelCode? string -
- salesDivision? string -
- salesOrganizationID? string -