Module workday.coreaccounting
ballerinax/workday.coreaccounting Ballerina library
1.5.2
Overview
The WorkDay Core Accounting REST API v1 connector(https://community.workday.com/sites/default/files/file-hosting/restapi/index.html) OpenAPI specification.
The Core Accounting service enables applications to access and configure common financial components that you use to manage your financial accounting.
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 a workday application in the Credential Administrator console
- Obtain tokens by following this guide
Clients
workday.coreaccounting: Client
Isolated
This is a generated connector for WorkDay Connect Service REST API v1 OpenAPI specification. The Core Accounting service enables applications to access and configure common financial components that you use to manage your financial accounting.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Follow [this guide] https://credentials.workday.com/docs/authentication/ and obtain tokens.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getAllCurrencies
Isolated FunctionRemote Function
function getAllCurrencies() returns InlineResponse200|errorRetrieves the details on all currencies in your tenant.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
getCurrencyByID
Isolated FunctionRemote Function
function getCurrencyByID(string id) returns CurrencySummary|errorRetrieves the details of a specified currency.
Parameters
- id string - The Workday ID of the resource.
Return Type
- CurrencySummary|error - Successful response. A successful response can return no matched data.
getLedgerAccountByPostingRule
Isolated FunctionRemote Function
function getLedgerAccountByPostingRule(string? accountPostingRuleSet, string? accountPostingRuleType, string[]? dimensionValue) returns InlineResponse2001|errorRetrieves the ledger account and resulting worktags of a specified account posting rule.
Parameters
- accountPostingRuleSet string? (default ()) - (Required) The Workday ID or reference ID for the account posting rule set. The reference ID uses the accountPostingRuleSet=sampleRefIdType=value format. Example: accountPostingRuleSet=Account_Posting_Rule_Set_ID=ACCOUNT_POSTING_RULE_SET-1
- accountPostingRuleType string? (default ()) - (Required) The Workday ID or reference ID for the account posting rule type. The reference ID uses the accountPostingRuleType=sampleRefIdType=value format. Example: accountPostingRuleType=Account_Posting_Rule_Type_ID=CASH
- dimensionValue string[]? (default ()) - The Workday IDs or reference IDs for the dimension value of the account posting rule condition. The reference ID uses the dimensionValue=sampleRefIdType=value format format. Example: dimensionValue=Fund_ID=F03.1.3.
Return Type
- InlineResponse2001|error - Successful response. A successful response can return no matched data.
Records
workday.coreaccounting: 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
workday.coreaccounting: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - 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
workday.coreaccounting: CurrencySummary
Fields
- code? string - ID
- precision? int - Precision
- descriptor? string - A preview of the instance
- id? string - Id of the instance
workday.coreaccounting: ErrorModelReference
Fields
- 'error string - A description of the error
workday.coreaccounting: InlineResponse200
collection something or other
Fields
- data? CurrencySummary[] -
- total? int -
workday.coreaccounting: InlineResponse2001
collection something or other
Fields
- data? ViewLedgerAccount[] -
- total? int -
workday.coreaccounting: InstanceModelReference
Fields
- id string - wid / id / reference id
- descriptor? string - A description of the instance
- href? string - A link to the instance
workday.coreaccounting: MultipleInstanceModelReference
Fields
- total? int -
- data? InstanceModelReference[] -
workday.coreaccounting: 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
workday.coreaccounting: ValidationErrorModelReference
Fields
- Fields Included from *ErrorModelReference
- error string
- anydata...
- errors? ErrorModelReference[] - An array of validation errors
workday.coreaccounting: ViewLedgerAccount
Fields
- ledgerAccountName? string - The name of the ledger account.
- descriptor? string - A preview of the instance
- id? string - Id of the instance
workday.coreaccounting: WorkTagSummary
Fields
- descriptor? string - A preview of the instance
- id? string - Id of the instance