---
title: "Get Talent Accrual Plan Option Items"
method: GET
path: "/v3/talent/accrual-options/accrual-plans"
tags: ["Accrual"]
---

# Get Talent Accrual Plan Option Items

`GET /v3/talent/accrual-options/accrual-plans`

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

## Query parameters

- `talentGuid` string, uuid
- `talentExternalId` string
- `configAccrualPlanGuid` string, uuid

## Headers

- `FrontOfficeTenantId` integer, required
- `RequestOrigin` string, required
- `RequestId` string, uuid, required — The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.
- `ExternalIdSource` 'BOLD', required
- `RequestUserExternalId` string, required

## Response `200`

Successfully retrieved talent accrual plan option items.

- AccrualPlanOption[]
  - `configAccrualPlanGuid` string, uuid — The unique identifier for the Accrual Plan.
  - `staffingSupplierGuid` string, uuid — The unique identifier for the Division associated with this accrual plan.
  - `accrualPlan` string — The name of the accrual plan in plain text.
  - `description` string — The description for this accrual plan in plain text.
  - `rate` number — 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.
  - `payPeriodLimit` number — The default number of units the plan is allowed to accrue per pay period.
  - `yearlyLimit` number — The default number of units the plan is allowed to accrue per year.
  - `maximumAccrualBalance` number — The default maximum number of units the employee can accrue on this plan per year.
  - `initialBalance` number — The default number of units to add to the plan balance upon initial setup.
  - `unlimitedCarryover` boolean — 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.
  - `allowedCarryover` number — 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.
  - `active` boolean — An indication of whether this plan is active at a system level.
  - `processingMethod` string — 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.
  - `autoInsert` boolean — An indication of whether this plan should automatically be inserted on talent records when the time entry batch is closed.
  - `suppressionDays` integer — 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.

## Other responses

- `402` — Additional subscription required.
- `403` — Access Denied
- `404` — Not found
- `405` — Unsupported method
- `415` — Unsupported format(s) indicated by the Content-Type header
- `429` — Too many requests
- `500` — An unexpected error occurred
- `502` — Service Unavailable
- `504` — Gateway Timeout

---

[API](https://skmtc.net/avionte/apis/aviont-partner-authorization-api.md) · [All operations](https://skmtc.net/avionte/apis/aviont-partner-authorization-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avionte/aviont-partner-authorization-api/revisions/846b33e4e71b/schema)