Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get Talent Deductions

Returns a list of talent deductions for the specified talent. Transaction type names are masked for security/privacy reasons.

get/v1/talent-deduction/{talentGuid}

Path parameters

talentGuidstring required

The unique identifier for the talent, formatted as a GUID.

Query parameters

activeOnlyboolean

An indication of whether to exclude inactive deductions in the result. Defaults to true.

Headers

FrontOfficeTenantIdinteger required

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

RequestIdstring uuid required

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

Response

200 response

talentBenefitDeductionGuidstring guid

A unique identifier for the talent benefit deduction, formatted as a GUID.

deductionAmountnumber double required

The amount to be deducted.

deductionAmountType'Fixed' | 'PercentOfGross' | 'PercentOfNet'
deductionStartDatestring date-time required

The start date for the deduction. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-01T14:30:00Z or 2024-12-01T14:30:00.1234567+00:00.

deductionEndDatestring date-time

The end date for the deduction. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-01T14:30:00Z or 2024-12-01T14:30:00.1234567+00:00.

deductionPayCycle'Unknown' | 'Weekly' | 'BiWeekly' | 'Monthly' | 'SemiMonthly' | 'Daily' | 'Yearly' | 'Hourly' required
referenceNumberstring

A reference number associated with the deduction.

payPeriodLimitnumber

The maximum deduction amount allowed per pay period. If no limit, then set to 0.

monthlyLimitnumber

The maximum deduction amount allowed per month. If no limit, then set to 0.

yearlyLimitnumber

The maximum deduction amount allowed per year. If no limit, then set to 0.

lifeTimeLimitnumber

The maximum deduction amount allowed over the lifetime of the deduction. If no limit, then set to 0.

notestring

An optional note or comment related to the deduction.

isActiveboolean

An indication of whether the deduction is active or not.

isCourtOrderedboolean

An indication of whether the deduction is the result of a court order.