v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Burden

Burden Rate Setup With Burden Factor

Returns a predefined list of burden rates setup in the system, with the relevant burden factors applied.

get/v3/admin/burden-rate-with-factor

Query parameters

branchGuidstring uuid

The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.

branchExternalIdstring

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

effectiveDatestring date-time

A general use datetime value representing a specific point in time, used to compare against a date range. 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.

Headers

FrontOfficeTenantIdinteger required

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

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.

RequestOriginstring required

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

ExternalIdSource'BOLD' required
Example:BOLD

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

RequestUserExternalIdstring
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 employer burden rates with burden factor.

burdenGuidstring uuid required

The unique identifier for the Burden.

burdenRateGuidstring uuid required

The unique identifier for the Burden Rate.

burdenNamestring

The name for this burden.

categorystring

The category for the burden.

calcType'TotalSales' | 'NodeType'
ratenumber nullable

The rate as a percentage for the burden.

burdenFactornumber

A multiplier applied to the rate used for the burden calculation.

rateStartDatestring date-time nullable

The start date for the burden rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

rateEndDatestring date-time nullable

The end date for the burden rate. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.