Placements

Get a Placement

Returns details about the specified placement.

get/v1/placement/{placementId}

Request

Base URL
https://api.avionte.com/front-office
URL
https://api.avionte.com/front-office/v1/placement/{placementId}
Auth
- API key in header x-api-key
- or HTTP bearer

Path parameters

placementIdstring required

The unique identifier for the placement to retrieve.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

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

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The placement details.

idinteger

The identifier for the placement.

talentIdinteger

The identifier for the talent.

jobIdinteger

The identifier for the job.

extensionIdinteger

The identifier for the current active placement extension.

extensionIdListinteger[]

The list of identifiers for all of the placement extensions for the placement.

startDatestring date-time

The placement start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

endDatestring date-time

The placement end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

isActiveboolean

An indication of whether the placement is active or not.

estimatedGrossProfitnumber

Estimated gross profit.

employmentType'Temporary' | 'Permanent'

Employment types available for selection.

frontOfficeIdinteger

The identifier for the placement's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the <a href="https://developer.avionte.com/reference/getbranches">Get Branches</a> endpoint to retrieve the ID.

isPermanentPlacementExtensionboolean

An indication of whether the placement is permanent or not.

payBasisstring

The pay basis for the placement.

hiredDatestring date-time

The date the talent was hired. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

endReasonIdinteger

The identifier for the end reason.

endReasonstring

The reason for ending the placement.

performanceIdinteger

The identifier for the performance.

performancestring

The performance rating recorded for ending the placement.

enteredByUserIdinteger

The identifier for the user who entered the placement record.

enteredByUserstring

The email of the user who entered the placement record.

recruiterUserIdinteger

The identifier for the recruiter user.

recruiterUserstring

The email of the recruiter user.

createdByUserIdinteger

The identifier for the user who created the placement.

createdDatestring date-time

The date when the placement was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

hasNoEndDateboolean

An indication of whether the placement has an end date or not.

originalStartDatestring date-time

The original start date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

finalEndDatestring date-time

The final end date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

originstring

The origin of the placement.

reqEmploymentTypestring

The employment type code for the placement.

reqEmploymentTypeNamestring

The display name of the employment type for the placement.

shiftNamestring

Description of the configured job shift.

flsaClassification'Exempt' | 'NonExempt' | 'None'

The Fair Labor Standards Act (FLSA) classification for the placement, which determins the talent's eligibility for overtime pay. Valid values are Exempt, NonExempt, and None.

workScheduleType'Full-Time' | 'Part-Time' | 'Intermittent' | 'None'

The expected work schedule for the placement. Valid values are Full-Time, Part-Time, Intermittent, and None.

remoteWorkboolean

An indication of whether the placement is a remote work arrangement.

currencystring

The currency the placement's rates are quoted in. Valid values are USD and CAD. Null or empty indicates no currency has been set for the placement.

Example response

{
  "id": 123456,
  "talentId": 789012,
  "jobId": 345678,
  "extensionId": 901234,
  "extensionIdList": [
    901234,
    567890
  ],
  "isActive": true,
  "payRates": {
    "regular": 15.5,
    "overtime": 23.25,
    "doubletime": 31
  },
  "billRates": {
    "regular": 15.5,
    "overtime": 23.25,
    "doubletime": 31
  },
  "commissionUsers": [
    {
      "commissionUserType": "CommissionRecipient",
      "userId": 18394,
      "userFullName": "John Doe",
      "commissionPercent": 10.5
    }
  ],
  "estimatedGrossProfit": 1500,
  "frontOfficeId": 123,
  "payBasis": "Hourly",
  "placementAdditionalRates": [
    {
      "leaveRuleId": 12345,
      "leaveTypeID": 6789,
      "payRate": 20,
      "billRate": 30,
      "inputType": "Hours",
      "payBillTerm": 1,
      "leaveType": "Sick Leave"
    }
  ],
  "endReasonId": 456,
  "endReason": "Contract completed",
  "performanceId": 421,
  "performance": "Excellent",
  "enteredByUserId": 78934,
  "enteredByUser": "john.doe@example.com",
  "recruiterUserId": 12345,
  "recruiterUser": "john.doe@example.com",
  "customDetails": [
    {
      "id": 123456,
      "placementId": 789012,
      "jobId": 345678,
      "talentId": 901234,
      "name": "Dress Code",
      "value": "Business Casual",
      "additionalValue": "No jeans",
      "type": "text"
    }
  ],
  "createdByUserId": 67890,
  "origin": "Partner XYZ",
  "reqEmploymentType": "1099",
  "reqEmploymentTypeName": "1099 Contractor",
  "shiftName": "Day Shift",
  "placementScheduleShifts": [
    {
      "id": 12345,
      "weekDay": 1,
      "duration": 480,
      "startTime": "08:00:00",
      "createdDate": "2024-12-01T14:30:00.546Z",
      "updatedDate": "2024-12-01T14:30:00.546Z",
      "status": "COMMITTED"
    }
  ],
  "placementScheduleDays": {
    "startTimeLocal": "08:00:00",
    "endTimeLocal": "17:00:00",
    "shiftScheduleDays": {
      "monday": true,
      "tuesday": true,
      "wednesday": true,
      "thursday": true,
      "friday": true
    }
  },
  "approvers": [
    {
      "extensionId": 901234,
      "approverUserId": 78934,
      "approverEntityId": 78934,
      "approverEntityType": "HCM User",
      "approverType": "Both"
    }
  ],
  "flsaClassification": "Exempt",
  "workScheduleType": "Full-Time",
  "currency": "USD"
}

Changes

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