workday.coreaccounting
Module workday.coreaccounting
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_workday.coreaccounting_1.5.0.png)
ballerinax/workday.coreaccounting Ballerina library
Overview
This is a generated connector for WorkDay Core Accounting 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.
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![](/images/permalink.svg)
workday.coreaccounting: Client![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
function getAllCurrencies() returns InlineResponse200|error
Retrieves the details on all currencies in your tenant.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
getCurrencyByID![](/images/permalink.svg)
function getCurrencyByID(string id) returns CurrencySummary|error
Retrieves 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![](/images/permalink.svg)
function getLedgerAccountByPostingRule(string? accountPostingRuleSet, string? accountPostingRuleType, string[]? dimensionValue) returns InlineResponse2001|error
Retrieves 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![](/images/permalink.svg)
workday.coreaccounting: 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
workday.coreaccounting: ConnectionConfig![](/images/permalink.svg)
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-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
workday.coreaccounting: CurrencySummary![](/images/permalink.svg)
Fields
- code string? - ID
- precision int? - Precision
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.coreaccounting: ErrorModelReference![](/images/permalink.svg)
Fields
- 'error string - A description of the error
workday.coreaccounting: InlineResponse200![](/images/permalink.svg)
collection something or other
Fields
- data CurrencySummary[]? -
- total int? -
workday.coreaccounting: InlineResponse2001![](/images/permalink.svg)
collection something or other
Fields
- data ViewLedgerAccount[]? -
- total int? -
workday.coreaccounting: InstanceModelReference![](/images/permalink.svg)
Fields
- id string - wid / id / reference id
- descriptor string? - A description of the instance
- href string? - A link to the instance
workday.coreaccounting: MultipleInstanceModelReference![](/images/permalink.svg)
Fields
- total int? -
- data InstanceModelReference[]? -
workday.coreaccounting: 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
workday.coreaccounting: ValidationErrorModelReference![](/images/permalink.svg)
Fields
- Fields Included from *ErrorModelReference
- error string
- anydata...
- errors ErrorModelReference[]? - An array of validation errors
workday.coreaccounting: ViewLedgerAccount![](/images/permalink.svg)
Fields
- ledgerAccountName string? - The name of the ledger account.
- resultingWorktags WorkTagSummary[]? - The resulting worktags configured for an account posting rule.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.coreaccounting: WorkTagSummary![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
Import
import ballerinax/workday.coreaccounting;
Metadata
Released date: about 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: 0
Current verison: 0
Weekly downloads
Keywords
Finance/Accounting
Cost/Paid
Contributors
Dependencies