Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Accrual

Get Talent Accrual Plan Option Items

Returns the accrual plan options available to the talent, based on their current branch.

get/v3/talent/accrual-options/accrual-plans

Query parameters

talentGuidstring uuid

The unique identifier of a Talent record, formatted as a UUID.

talentExternalIdstring

The external ID of the Talent entity, used as an alternative to the TalentGuid query parameter. When provided with a valid ExternalIdSource header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an ExternalEntityNotFound error is returned. If a match is found, the response includes a TalentGuid header containing the classic entity record ID.

configAccrualPlanGuidstring uuid

The unique identifier for the accrual plan record, formatted as a UUID.

Headers

FrontOfficeTenantIdinteger required

An integer identifier for the tenant that the request is being made for.

RequestOriginstring required

The string source name (such as application or function name) that indicates the origin of the request.

RequestIdstring uuid required

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

ExternalIdSource'BOLD' required
Example:BOLD

The external ID source that determines which external reference source is used to perform an external ID lookup.

RequestUserExternalIdstring required
Example:ABC123

The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.

Response

Successfully retrieved talent accrual plan option items.

configAccrualPlanGuidstring uuid

The unique identifier for the Accrual Plan.

staffingSupplierGuidstring uuid

The unique identifier for the Division associated with this accrual plan.

accrualPlanstring

The name of the accrual plan in plain text.

descriptionstring

The description for this accrual plan in plain text.

ratenumber

The default rate at which this plan accrues usable time off.

accrualRateTypeOption'PerHour' | 'PerPayPeriod' | 'Unknown'

An option used to define the rate type for talent accrual plans.

payPeriodLimitnumber

The default number of units the plan is allowed to accrue per pay period.

yearlyLimitnumber

The default number of units the plan is allowed to accrue per year.

maximumAccrualBalancenumber

The default maximum number of units the employee can accrue on this plan per year.

initialBalancenumber

The default number of units to add to the plan balance upon initial setup.

unlimitedCarryoverboolean

A default boolean value indicating whether this plan has a limit to the number of units the talent is allowed to carry over year over year.

allowedCarryovernumber

The default number of units a talent is allowed to carry over into the next accrual year. Only used if the plan is not configured with unlimited carryover.

accrualDateTypeOption'CalendarDate' | 'AnniversaryDate' | 'Unknown'

An option used to define the date type for talent accrual plans.

activeboolean

An indication of whether this plan is active at a system level.

processingMethodstring

The processing method for the accrual plan.

accrualPayTypeOption'IncludeInWeeklyPay' | 'AccrueForLaterPayout' | 'Unknown'

An option used to define the pay type for talent accrual plans. Used only for Canadian accrual plans.

autoInsertboolean

An indication of whether this plan should automatically be inserted on talent records when the time entry batch is closed.

suppressionDaysinteger

An integer value representing the number of days this plan is hidden from view from the talent. Used in scenarios in which the talent does not have access to use the plan for a specific number of days.