---
title: "Gets a placement"
method: GET
path: "/Entity/Placement"
tags: ["Entity"]
---

# Gets a placement

`GET /Entity/Placement`

## Query parameters

- `id` integer, required

## Response `200`

OK

- PlacementGetResult
  - `Id` integer, required
  - `Type` 'Permanent' | 'Contract' | 'Temporary' | 'FixedTerm', required
  - `Created` string, date-time, required
  - `LastUpdated` string, date-time, required
  - `CandidateId` integer, required
  - `JobId` integer, required
  - `Company` Entity, required
    - `Id` integer
    - `Name` string, nullable
  - `JobTitleId` integer, required
  - `ClientJobTitle` string, required
  - `OwningConsultants` PlacementOwningConsultant[], required
    - `ConsultantId` integer, required
    - `ConsultantRoleId` integer, nullable
    - `Split` number, double, required
  - `Location` PlacementLocationDetail, required
    - `LocationName` string, required
    - `AddressLine1` string, required
    - `AddressLine2` string, required
    - `AddressLine3` string, required
    - `Town` string, required
    - `County` string, required
    - `Postcode` string, required
    - `Country` Country, required
      - `IsActive` boolean
      - `Id` integer
      - `Name` string, nullable
      - `Code` string, nullable
      - `IsDefaultCountryForAddresses` boolean
  - `ClientRef` string, required
  - `Alert` string, required
  - `ProjectCodeId` integer, required
  - `Benefits` BenefitRequest[], required
    - `BenefitId` integer, required
    - `Notes` string, required
  - `AlternateCode` string, required
  - `CoreRateTypeId` integer, required
  - `PayCurrencyId` integer, required
  - `ChargeCurrencyId` integer, required
  - `MarginMarkupPercentageFixed` boolean, required
  - `StartDate` string, date-time, required
  - `EndDate` string, date-time, required
  - `Hours` number, nullable — Hours for Contract or Fixed Term placements
  - `HoursPer` Interval
    - `IsActive` boolean
    - `Id` integer
    - `Name` string, nullable
  - `PlacedDate` string, date-time, nullable — Placed Date for Perm, Contract or Fixed Term placements
  - `IR35Status` 'Unknown' | 'IR35' | 'OutsideIR35', required
  - `WorkerTypeId` integer, required
  - `ReportsToContactId` integer, required
  - `MainContactId` integer, required
  - `OtherContacts` PlacementContactRequest[], required
    - `ContactId` integer, required
    - `Type` string, required
    - `JobTitle` string, required
  - `PurchaseOrders` PurchaseOrderResult[], required
    - `Id` integer, required
    - `CompanyId` integer, required
    - `Name` string, required
    - `ValidFromDate` string, date-time, required
    - `ValidToDate` string, date-time, required
    - `Value` number, required
    - `ValueCurrencyId` integer, required
    - `EstimatedValue` number, required
    - `EstimatedValueCurrencyId` integer, required
    - `ActualValue` number, required
    - `ActualValueCurrencyId` integer, required
    - `Description` string, required
  - `BackOfficeSectorId` integer, required
  - `DivisionDepartmentSplits` PlacementDivisionDepartmentRequest[], required
    - `DivisionId` integer, required
    - `DepartmentId` integer, required
    - `Split` number, double, required
  - `Notes` string, required
  - `OverrideInvoiceDetails` boolean, required
  - `InvoiceLocation` PlacementLocationDetail, required
    - `LocationName` string, required
    - `AddressLine1` string, required
    - `AddressLine2` string, required
    - `AddressLine3` string, required
    - `Town` string, required
    - `County` string, required
    - `Postcode` string, required
    - `Country` Country, required
      - `IsActive` boolean
      - `Id` integer
      - `Name` string, nullable
      - `Code` string, nullable
      - `IsDefaultCountryForAddresses` boolean
  - `InvoiceContactId` integer, required
  - `TimesheetAuthoriserContactId` integer, required
  - `SecondTimesheetAuthoriserContactId` integer, required
  - `TimesheetIntervalId` integer, required
  - `JobHistoryRequested` boolean, required
  - `Salary` number, nullable — Salary for Perm or Fixed Term placements
  - `SalaryPer` Interval
    - `IsActive` boolean
    - `Id` integer
    - `Name` string, nullable
  - `Package` number, nullable — Package for Perm or Fixed Term placements
  - `FeePercentage` number, nullable — Fee Percentage for Perm or Fixed Term placements
  - `FeeValue` number, nullable — Fee Value for Perm or Fixed Term placements
  - `CapFeeValueAt` number, nullable — Cap Fee Value At for Perm or Fixed Term placements
  - `Status` PlacementStatus
    - `IsActive` boolean
    - `Id` integer
    - `Name` string, nullable
    - `Type` 'Current' | 'Closed'
  - `BreaksType` 'PaidAndCharged' | 'UnpaidAndUncharged'
  - `Rates` PlacementRateRequest[], required
    - `StartDate` string, date-time, nullable
    - `EndDate` string, date-time, nullable
    - `Pay` number, required
    - `NonPayePay` number, required
    - `Charge` number, required
    - `RateIntervalId` integer, required
    - `RateTypeId` integer, required
    - `TotalPay` number, required
    - `TotalCost` number, required
    - `Profit` number, required
    - `MarginPercentage` number, required
    - `MarkupPercentage` number, required
  - `Shifts` PlacementShiftResult[], required
    - `Id` integer, required
    - `Status` 'AwaitingConfirmation' | 'Confirmed', required
    - `IsStarted` boolean, required
    - `IsTimeWorked` boolean, required
    - `Start` string, date-time, required
    - `End` string, date-time, required
    - `TimeZoneId` string, required
    - `BreakLengthMinutes` integer, nullable
  - `CustomFields` CustomFieldDetail
    - `CategorisedMultiSelectFields` CategorisedMultiSelectField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Values` string[], required
      - `ValueIds` integer[], required
    - `CheckBoxFields` CheckBoxField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Value` boolean, required
    - `ComboBoxFields` ComboBoxField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Value` string, required
      - `ValueId` integer, required
    - `DateTimePickerFields` DateTimePickerField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Value` string, date-time, nullable
    - `DecimalFields` DecimalField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Value` number, required
    - `IntegerFields` IntegerField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Value` integer, required
    - `MultiSelectListBoxFields` MultiSelectListBoxField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Values` string[], required
      - `ValueIds` integer[], required
    - `NoteControlFields` NoteControlField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Value` string, byte, required
      - `ValueText` string, required
    - `TextBoxFields` TextBoxField[], required
      - `Id` integer, required
      - `Name` string, required
      - `Value` string, required

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `404` — NotFound

---

[API](https://skmtc.dev/vslcloud/apis/infinity-api.md) · [All operations](https://skmtc.dev/vslcloud/apis/infinity-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vslcloud/infinity-api/revisions/54661781612a/schema)