Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Accrual

Create Talent Accrual Plan Manual Entry

Creates a manual entry for the specified accrual plan and talent.

post/v3/talent/accrual-manual-entries

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.

AllowNonCurrentEffectiveDateboolean

An indication of whether the user has approved an effective date that falls outside the current accrual period.

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.

Request body

talentAccrualGuidstring uuid

The unique identifier for the Talent Accrual record.

accruedUnitnumber

The number of units for the manual entry. Can be either a positive or negative value.

effectiveDatestring date-time nullable

The effective date for the accrued units on this manual entry. This date is used to determine which accrual period the units should apply to. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format, for example, 2026-12-01 or 2026-12-01T14:30:00.

excludeFromLimitCalculationboolean

An indication of whether manual units are excluded from the various limits associated with the plan. When set to true, the units do not count toward yearly or pay period limits.

notestring

A free-text note field associated with the manually entered hours.

Response

The provided EffectiveDate is not within the current accrual period.

object required