AVavionte
TalentBenefits

Get Benefit Partner Transaction Types

Retrieves a list of talent benefit enrollment transaction types for the requesting authorized partner.

get/v1/transaction-types/partner-benefits

Request

  • Base URL
    https://api.avionte.com/back-office
  • URL
    https://api.avionte.com/back-office/v1/transaction-types/partner-benefits
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

returnAllGroupsboolean

An indication of whether to return transaction types from all of the partner's configured transaction type groups instead of only the partner's primary group. Defaults to false.

Headers

FrontOfficeTenantIdinteger

An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.

Tenantstring

Tenant company code for scoped data access during the request.

RequestIdstring uuid required

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

Response

200 response

transactionTypeIdinteger

The unique identifier for the talent benefit transaction type.

namestring

The display name of the transaction type.

systemNamestring

The internal system name of the transaction type.

deductionCategoryIdinteger

The unique identifier for the deduction category associated with the transaction type.

isEmployeeDeductionboolean

An indication of whether the transaction type represents an employee deduction.

isEmployerContributionboolean

An indication of whether the transaction type represents an employer contribution.

isPreTaxboolean

An indication of whether the transaction type is categorized as pre-tax.

isPayCodeboolean

An indication of whether the transaction type is a paycode.

groupNamestring

The name of the transaction type group that the transaction type belongs to.

Changes

No recorded changes to this operation across all 1 revision of this API.