workday.payroll
Module workday.payroll
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_workday.payroll_1.5.1.png)
ballerinax/workday.payroll Ballerina library
Overview
This is a generated connector for WorkDay payroll REST API v2 OpenAPI specification.
The Payroll service enables you to access and manage payroll information, such as pay groups, payroll inputs, and tax rates.
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.payroll: Client![](/images/permalink.svg)
This is a generated connector for WorkDay payroll REST API v2 OpenAPI specification. The Payroll service enables you to access and manage payroll information,such as pay groups, payroll inputs, and tax rates.
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
getPayGroupBySubResourceID![](/images/permalink.svg)
function getPayGroupBySubResourceID(string id, string subresourceID) returns PayGroupViewDetail|error
Retrieves a single pay group instance.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- PayGroupViewDetail|error - Successful response. A successful response can return no matched data.
getPayGroupByID![](/images/permalink.svg)
function getPayGroupByID(string id) returns PayGroupViewDetail|error
Retrieves a single pay group instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- PayGroupViewDetail|error - Successful response. A successful response can return no matched data.
getPayGroupByJobID![](/images/permalink.svg)
function getPayGroupByJobID(string id, string? effective, int? 'limit, int? offset) returns InlineResponse200|error
Retrieves the pay group for a specified job ID. This method always returns 1 pay group.
Parameters
- id string - The Workday ID of the resource.
- effective string? (default ()) - The effective date of the pay group, using the date format yyyy-mm-dd.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
getInstanceForEndpointParameters![](/images/permalink.svg)
function getInstanceForEndpointParameters() returns MultipleInstanceModelReference|error
Retrieves instances that can be used as values for other endpoint parameters in this service.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
getWorkTagInstancesForEndpointParameters![](/images/permalink.svg)
function getWorkTagInstancesForEndpointParameters(string? payComponent, string? 'worker, string? startDate, string? endDate) returns MultipleInstanceModelReference|error
Retrieves instances that can be used as values for other endpoint parameters in this service.
Parameters
- payComponent string? (default ()) - The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents.
- 'worker string? (default ()) - The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service.
- startDate string? (default ()) - The start date for the positions, using the date format yyyy-mm-dd.
- endDate string? (default ()) - The end date for the positions, using the date format yyyy-mm-dd.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
getPayGroupDetailsByID![](/images/permalink.svg)
function getPayGroupDetailsByID(string id) returns PayGroupDetailView|error
Retrieves a single pay group detail instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- PayGroupDetailView|error - Successful response. A successful response can return no matched data.
getCollectionOfJobs![](/images/permalink.svg)
function getCollectionOfJobs(int? 'limit, int? offset) returns InlineResponse2001|error
Retrieves a collection of jobs.
Parameters
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Return Type
- InlineResponse2001|error - Successful response. A successful response can return no matched data.
getRunCategoriesForEndpointParameters![](/images/permalink.svg)
function getRunCategoriesForEndpointParameters(string? payComponent, string? 'worker, string? startDate, string? endDate) returns MultipleInstanceModelReference|error
Retrieves instances that can be used as values for other endpoint parameters in this service.
Parameters
- payComponent string? (default ()) - The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents.
- 'worker string? (default ()) - The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service.
- startDate string? (default ()) - The start date for the positions, using the date format yyyy-mm-dd.
- endDate string? (default ()) - The end date for the positions, using the date format yyyy-mm-dd.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
getCollectionOfPayGroupDetails![](/images/permalink.svg)
function getCollectionOfPayGroupDetails(int? 'limit, int? offset, string[]? runCategories) returns InlineResponse2002|error
Retrieves a collection of pay group details.
Parameters
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
- runCategories string[]? (default ()) - One or more Workday IDs of run categories for the pay group. You can use returned ids from GET /values/payrollInputsGroup/runCategories.You can specify 1 or more runCategories query parameters, example: runCategories=category1&runCategories=category2
Return Type
- InlineResponse2002|error - Successful response. A successful response can return no matched data.
getSingleJobByID![](/images/permalink.svg)
Retrieves a single job instance.
Parameters
- id string - The Workday ID of the resource.
getPositionInstancesForOtherEndpoints![](/images/permalink.svg)
function getPositionInstancesForOtherEndpoints(string? payComponent, string? 'worker, string? startDate, string? endDate) returns MultipleInstanceModelReference|error
Retrieves instances that can be used as values for other endpoint parameters in this service.
Parameters
- payComponent string? (default ()) - The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents.
- 'worker string? (default ()) - The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service.
- startDate string? (default ()) - The start date for the positions, using the date format yyyy-mm-dd.
- endDate string? (default ()) - The end date for the positions, using the date format yyyy-mm-dd.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
getPayRollInputInstance![](/images/permalink.svg)
function getPayRollInputInstance(string id) returns PayrollInputView|error
Retrieves a single payroll input instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
- PayrollInputView|error - Successful response. A successful response can return no matched data.
deleteExistingPayroll![](/images/permalink.svg)
Deletes an existing payroll input instance.
Parameters
- id string - The Workday ID of the resource.
Return Type
updateAnExistingPayroll![](/images/permalink.svg)
function updateAnExistingPayroll(string id, PayrollInputView payload) returns PayrollInputView|error
Partially updates an existing payroll input instance.
Return Type
- PayrollInputView|error - Successful response. A successful response can return no matched data. Updating resource.
getCollectionOfPayroll![](/images/permalink.svg)
function getCollectionOfPayroll(string? endDate, int? 'limit, int? offset, string[]? payComponent, string? startDate, string[]? 'worker) returns InlineResponse2003|error
Retrieves a collection of payroll inputs. At least 1 query parameter is required to get data.
Parameters
- endDate string? (default ()) - The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
- payComponent string[]? (default ()) - The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents.
- startDate string? (default ()) - The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd.
- 'worker string[]? (default ()) - The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service.
Return Type
- InlineResponse2003|error - Successful response. A successful response can return no matched data.
createPayrollInputs![](/images/permalink.svg)
function createPayrollInputs(PayrollInputView payload, string? endDate, string[]? payComponent, string? startDate, string[]? 'worker) returns PayrollInputView|error
Creates payroll inputs.
Parameters
- payload PayrollInputView -
- endDate string? (default ()) - The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd.
- payComponent string[]? (default ()) - The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents.
- startDate string? (default ()) - The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd.
- 'worker string[]? (default ()) - The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service.
Return Type
- PayrollInputView|error - Resource created.
getStateInstancesForEndpointParameters![](/images/permalink.svg)
function getStateInstancesForEndpointParameters() returns MultipleInstanceModelReference|error
Retrieves instances that can be used as values for other endpoint parameters in this service.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
getCompanySUIRates![](/images/permalink.svg)
function getCompanySUIRates(string? company, string? effective, int? 'limit, int? offset, string? payrollStateAuthorityTaxCode) returns InlineResponse2004|error
Retrieves a single or a collection of company SUI rates.
Parameters
- company string? (default ()) - The company reference ID or WID that represents 1 or more companies. Example: company=comp1&company=comp2&company=cb550da820584750aae8f807882fa79a
- effective string? (default ()) - The effective date for the SUI rate, using the yyyy-mm-dd format.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
- payrollStateAuthorityTaxCode string? (default ()) - The FIPS code or WID that represents 1 or more states. Example: payrollStateAuthorityTaxCode=06&payrollStateAuthorityTaxCode=3b3d378d5f4a48b8b3ac46fee0703226&payrollStateAuthorityTaxCode=48
Return Type
- InlineResponse2004|error - Successful response. A successful response can return no matched data.
createCompanySUIRates![](/images/permalink.svg)
function createCompanySUIRates(CompanySuiRateDetails payload, string? company, string? effective, string? payrollStateAuthorityTaxCode) returns CompanySuiRateDetails|error
Creates a single or a collection of Company SUI Rates.
Parameters
- payload CompanySuiRateDetails -
- company string? (default ()) - The company reference ID or WID that represents 1 or more companies. Example: company=comp1&company=comp2&company=cb550da820584750aae8f807882fa79a
- effective string? (default ()) - The effective date for the SUI rate, using the yyyy-mm-dd format.
- payrollStateAuthorityTaxCode string? (default ()) - The FIPS code or WID that represents 1 or more states. Example: payrollStateAuthorityTaxCode=06&payrollStateAuthorityTaxCode=3b3d378d5f4a48b8b3ac46fee0703226&payrollStateAuthorityTaxCode=48
Return Type
- CompanySuiRateDetails|error - Resource created.
getPayComponentsForEndpoints![](/images/permalink.svg)
function getPayComponentsForEndpoints(string? payComponent, string? 'worker, string? startDate, string? endDate) returns MultipleInstanceModelReference|error
Retrieves instances that can be used as values for other endpoint parameters in this service.
Parameters
- payComponent string? (default ()) - The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents.
- 'worker string? (default ()) - The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service.
- startDate string? (default ()) - The start date for the positions, using the date format yyyy-mm-dd.
- endDate string? (default ()) - The end date for the positions, using the date format yyyy-mm-dd.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
getCollectionOfPayGroups![](/images/permalink.svg)
function getCollectionOfPayGroups(string? country, int? 'limit, int? offset) returns InlineResponse200|error
Retrieves a collection of pay groups.
Parameters
- country string? (default ()) - The Workday ID of the country or territory of the pay group. You can use a returned country id from any of the payGroups endpoints in this Payroll API.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
Records![](/images/permalink.svg)
workday.payroll: 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.payroll: CompanyDetail![](/images/permalink.svg)
Fields
- company string? - The Reference ID to use for lookups within our Workday Web Services. For supervisory organizations, this is also the Organization_ID.
- fein string? - The FEIN for the US company.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.payroll: CompanyDetail2![](/images/permalink.svg)
Fields
- id string? - Id of the instance
workday.payroll: CompanyInstance![](/images/permalink.svg)
Fields
- Fields Included from *CompanyDetail
workday.payroll: CompanyInstanceDetail![](/images/permalink.svg)
Fields
- Fields Included from *CompanyDetail2
- id string
- anydata...
workday.payroll: CompanySuiRateDetails![](/images/permalink.svg)
Fields
- companyInstance CompanyInstanceDetail -
- stateInstance StateInstanceDetail -
- exempt boolean? - If true, the SUI rate is exempt.
- startDate string - The start date for company tax reporting.
- taxCode string - The deduction for company tax reporting.
- ein string? - The payroll tax authority EIN field for company tax reporting.
- endDate string? - The end date for company tax reporting.
- applicableRate string? - The tax override rate for company tax reporting.
- id string? - Id of the instance
workday.payroll: 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.payroll: Country![](/images/permalink.svg)
Fields
- Fields Included from *CountryDataForLocationData
- descriptor string
- anydata...
workday.payroll: CountryDataForLocationData![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.payroll: Currency![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: CurrentPeriodInProgress![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: ErrorModelReference![](/images/permalink.svg)
Fields
- 'error string - A description of the error
workday.payroll: FacetsModelReferenceInner![](/images/permalink.svg)
This object represents the possible facets for this resource
Fields
- descriptor string? - A description of the facet
- facetParameter string? - The alias used to select the facet
workday.payroll: FirstProcessingPeriod![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: InlineResponse200![](/images/permalink.svg)
collection something or other
Fields
- data PayGroupViewDetail[]? -
- total int? -
workday.payroll: InlineResponse2001![](/images/permalink.svg)
collection something or other
Fields
- data JobData[]? -
- total int? -
workday.payroll: InlineResponse2002![](/images/permalink.svg)
collection something or other
Fields
- data PayGroupDetailView[]? -
- total int? -
workday.payroll: InlineResponse2003![](/images/permalink.svg)
collection something or other
Fields
- data PayrollInputView[]? -
- total int? -
workday.payroll: InlineResponse2004![](/images/permalink.svg)
collection something or other
Fields
- data SuiRatesSummary[]? -
- total int? -
workday.payroll: InputInterfaceDetail![](/images/permalink.svg)
Fields
- name string? - The alternate ID of the related calculation for the pay component and pay component related calculation.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.payroll: InputLine![](/images/permalink.svg)
Fields
- 'type Type? -
- value int? - The value for the input line.
- id string? - Id of the instance
workday.payroll: 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.payroll: JobData![](/images/permalink.svg)
Fields
- location Location? -
- businessTitle string? - The business title for the position.
- 'worker Worker? -
- supervisoryOrganization SupervisoryOrganization? -
- nextPayPeriodStartDate string? - The next pay period start date for the job.
- jobType JobType? -
- jobProfile JobProfile? -
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.payroll: JobProfile![](/images/permalink.svg)
Fields
- Fields Included from *JobProfileJobView
workday.payroll: JobProfileJobView![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: JobType![](/images/permalink.svg)
Fields
- Fields Included from *JobTypeData
- descriptor string
- anydata...
workday.payroll: JobTypeData![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
workday.payroll: LastPeriodCompleted![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: Location![](/images/permalink.svg)
Fields
- Fields Included from *LocationDataJobView
workday.payroll: LocationDataJobView![](/images/permalink.svg)
Fields
- country Country? -
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: MultipleInstanceModelReference![](/images/permalink.svg)
Fields
- total int? -
- data InstanceModelReference[]? -
workday.payroll: NextPeriodToProcess![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: PayComponent![](/images/permalink.svg)
Fields
- Fields Included from *PayComponentDetail
workday.payroll: PayComponentDetail![](/images/permalink.svg)
Fields
- code string? - The payroll code of the pay component.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: PayGroup![](/images/permalink.svg)
Fields
- Fields Included from *PayGroupSimpleViewDetail
workday.payroll: PayGroupDetailMiniViewDetail![](/images/permalink.svg)
Fields
- runCategory RunCategory2? -
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: PayGroupDetailView![](/images/permalink.svg)
Fields
- runCategory RunCategory? -
- currentPeriodInProgress CurrentPeriodInProgress? -
- nextPeriodToProcess NextPeriodToProcess? -
- firstProcessingPeriod FirstProcessingPeriod? -
- lastPeriodCompleted LastPeriodCompleted? -
- periodSchedule PeriodSchedule? -
- payRunGroup PayRunGroupSimpleViewDetail[]? - Contains one or more pay groups that are processed or run at the same time.
- payGroup PayGroup? -
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.payroll: PayGroupSimpleViewDetail![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: PayGroupViewDetail![](/images/permalink.svg)
Fields
- country Country? -
- payGroupDetails PayGroupDetailMiniViewDetail[]? - Contains the pay group detail.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: PayrollInputView![](/images/permalink.svg)
Fields
- runCategories RunCategoryDetail[]? - The run category for the payroll input.
- payComponent PayComponent? -
- comment string? - The text comment for this input.
- startDate string? - The start date before which this input does not apply.
- currency Currency? -
- worktags Worktag[]? - The worktags associated with the payroll input.
- inputDetails InputLine[]? - The details for this payroll input.
- ongoing boolean? - If true, the payroll input is ongoing.
- position Position? -
- fieldEditability string? - The editability status indicating the fields that can be updated in the payroll input request. Possible values: all, none, endDateOnly
- endDate string? - The end date after which this input does not apply.
- 'worker WorkerDc? -
- adjustment boolean? - If true, the input is for an adjustment as opposed to an override.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.payroll: PayRunGroupSimpleViewDetail![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.payroll: PeriodSchedule![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: Position![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: 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.payroll: RunCategory![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: RunCategory2![](/images/permalink.svg)
Fields
- Fields Included from *InstanceModelReference
workday.payroll: RunCategoryDetail![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: State2![](/images/permalink.svg)
Fields
- id string? - Id of the instance
workday.payroll: StateDetail![](/images/permalink.svg)
Fields
- payrollStateAuthorityTaxCode string? - The Payroll Authority Tax Code for a Payroll Tax Authority.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: StateInstance![](/images/permalink.svg)
Fields
- Fields Included from *StateDetail
workday.payroll: StateInstanceDetail![](/images/permalink.svg)
Fields
- Fields Included from *State2
- id string
- anydata...
workday.payroll: SuiRatesSummary![](/images/permalink.svg)
Fields
- id string? - Unique identifier for company SUI rate.
- ein string? - The EIN value for the company SUI rate.
- startDate string? - The start date value of the row for company SUI rate.
- exempt boolean? - If true, the SUI rate is exempt.
- endDate string? - The end date value of the row for company SUI rate.
- einType string? - The EIN type. Valid values: SUI EIN, STATE EIN, FEIN.
- rateType string? - The rate type. Valid values: OR for override rate, DR for default rate.
- taxCode string? - The payroll tax code. As of v1, the default value is W_SUIER.
- applicableRate string? - The applicable rate for the company SUI.
- stateInstance StateInstance? -
- companyInstance CompanyInstance? -
workday.payroll: SupervisoryOrganization![](/images/permalink.svg)
Fields
- Fields Included from *SupervisoryOrganizationJobView
workday.payroll: SupervisoryOrganizationJobView![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: Type![](/images/permalink.svg)
Fields
- Fields Included from *InputInterfaceDetail
workday.payroll: ValidationErrorModelReference![](/images/permalink.svg)
Fields
- Fields Included from *ErrorModelReference
- error string
- anydata...
- errors ErrorModelReference[]? - An array of validation errors
workday.payroll: Worker![](/images/permalink.svg)
Fields
- Fields Included from *WorkerJobView
workday.payroll: WorkerDc![](/images/permalink.svg)
Fields
- Fields Included from *WorkerDetail
workday.payroll: WorkerDetail![](/images/permalink.svg)
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.payroll: WorkerJobView![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.payroll: Worktag![](/images/permalink.svg)
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
Import
import ballerinax/workday.payroll;
Metadata
Released date: over 1 year ago
Version: 1.5.1
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