Sign in

v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB
Entity

Gets a placement

get/Entity/Placement

Query parameters

idinteger required

Placement Id to return

Response

OK

Idinteger required
Type'Permanent' | 'Contract' | 'Temporary' | 'FixedTerm' required
Createdstring date-time required
LastUpdatedstring date-time required
CandidateIdinteger required
JobIdinteger required
JobTitleIdinteger required
ClientJobTitlestring required
ClientRefstring required
Alertstring required
ProjectCodeIdinteger required
AlternateCodestring required
CoreRateTypeIdinteger required
PayCurrencyIdinteger required
ChargeCurrencyIdinteger required
MarginMarkupPercentageFixedboolean required
StartDatestring date-time required
EndDatestring date-time required
Hoursnumber nullable

Hours for Contract or Fixed Term placements

PlacedDatestring date-time nullable

Placed Date for Perm, Contract or Fixed Term placements

IR35Status'Unknown' | 'IR35' | 'OutsideIR35' required
WorkerTypeIdinteger required
ReportsToContactIdinteger required
MainContactIdinteger required
BackOfficeSectorIdinteger required
Notesstring required
OverrideInvoiceDetailsboolean required
InvoiceContactIdinteger required
TimesheetAuthoriserContactIdinteger required
SecondTimesheetAuthoriserContactIdinteger required
TimesheetIntervalIdinteger required
JobHistoryRequestedboolean required
Salarynumber nullable

Salary for Perm or Fixed Term placements

Packagenumber nullable

Package for Perm or Fixed Term placements

FeePercentagenumber nullable

Fee Percentage for Perm or Fixed Term placements

FeeValuenumber nullable

Fee Value for Perm or Fixed Term placements

CapFeeValueAtnumber nullable

Cap Fee Value At for Perm or Fixed Term placements

BreaksType'PaidAndCharged' | 'UnpaidAndUncharged'