v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Placements

Update a Placement

Updates information about the specified placement.

put/v1/placement/{placementId}

Path parameters

placementIdstring required

The identifier for the placement that should be updated.

Headers

RequestIdstring uuid

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

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.

Request body

idinteger

The identifier for the placement.

talentIdinteger required

The identifier for the talent.

jobIdinteger required

The identifier for the job.

extensionIdinteger

The optional identifier for the placement extension.

startDatestring date-time required

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.

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.

payBasisstring

The pay basis for the placement. Valid values are Commission, Day, Hourly, Hybrid/Other, Piece Pay, Salary, Shift, and Weekly.

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.

recruiterUserIdinteger

The identifier for the recruiter user.

recruiterUserstring

The email of the recruiter user.

enteredByUserIdinteger required

The identifier for the user who created the placement.

createdDatestring date-time required

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 optional 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 optional 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 required

The origin of the placement.

timeApproverIdsinteger[]

List of identifiers for Time Approver users.

Example request

{
  "id": 123456,
  "talentId": 189482,
  "jobId": 175529,
  "extensionId": 98765,
  "payRates": {
    "regular": 15.5,
    "overtime": 23.25,
    "doubletime": 31
  },
  "billRates": {
    "regular": 15.5,
    "overtime": 23.25,
    "doubletime": 31
  },
  "commissionUsers": [
    {
      "commissionUserType": "Recruiter",
      "userId": 123456,
      "commissionPercent": 10
    }
  ],
  "frontOfficeId": 12353,
  "payBasis": "Hourly",
  "placementAdditionalRates": [
    {
      "leaveTypeID": 123,
      "payRate": 25,
      "billRate": 30,
      "inputType": "Hours",
      "payBillTerm": 1
    }
  ],
  "endReasonId": 321,
  "endReason": "Project completed successfully",
  "recruiterUserId": 24398,
  "recruiterUser": "john.doe@example.com",
  "enteredByUserId": 18925,
  "origin": "Acme Partner",
  "timeApproverIds": [
    123456,
    789012
  ],
  "placementScheduleShiftDtos": [
    {
      "id": 123456,
      "jobScheduleShiftId": 789012,
      "weekDay": 1,
      "duration": 480,
      "startTime": "08:00:00",
      "status": "COMMITTED"
    }
  ]
}

Response

The updated placement details.

placementGuidstring uuid

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

branchGuidstring uuid

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

backOfficeAssignmentIdinteger

The ID of the Assignment in the Back Office.

isW2boolean

An indication of whether the placement is a W2 placement (true) or a contract placement (false).

agencyGuidstring uuid

The vendor agency GUID, used when the placement is a contract placement (IsW2 = false) and payment should be directed to the vendor instead of the talent.

jobTitlestring

Job title for the placement, as defined on the Job.

Example response

{
  "WorkSiteAddress": {
    "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
    "street1": "123 Main St.",
    "street2": "Suite 250",
    "city": "Minneapolis",
    "state": "MN",
    "postalCode": "55435",
    "country": "US"
  }
}