New: Kith open-sources its ATS.Read why
Skip to Content
Inputs

UpdatePlacementInput

The offer and placement details to set. A field left out is unchanged; null clears it, except the currency and isReferralPaid. The fields from offerAcceptedAt on are a placement's alone: they are refused with NOT_A_PLACEMENT unless the candidate is at the hired stage.

input UpdatePlacementInput {
  currency: String
  expectedVersion: String!
  feePercent: Decimal
  fellThroughAt: Date
  fellThroughReason: String
  guaranteeDays: Int
  invoiceDate: Date
  invoiceStatus: PlacementInvoiceStatus
  isReferralPaid: Boolean
  jobCandidateId: ID!
  notes: String
  offerAcceptedAt: Date
  offerSalary: Decimal
  ownerId: ID
  paidDate: Date
  placementFee: Decimal
  referralFee: Decimal
  referralPersonId: ID
  splits: [PlacementSplitInput!]
  startDate: Date
}

Fields

UpdatePlacementInput.currency · String scalar

The currency of both amounts, as a three-letter ISO 4217 code in upper case, such as GBP. It cannot be cleared.

UpdatePlacementInput.expectedVersion · String! non-null scalar

The placementVersion of the place you read. The change is refused with STALE_VERSION if the placement's details have changed since; Kith ATS grading or re-ranking the place does not change it.

UpdatePlacementInput.feePercent · Decimal scalar

The fee as a percentage of the salary, from 0 to 100, such as 22.5.

UpdatePlacementInput.fellThroughAt · Date scalar

The day the candidate left inside the guarantee.

UpdatePlacementInput.fellThroughReason · String scalar

Why the placement fell through. Blank clears it.

UpdatePlacementInput.guaranteeDays · Int scalar

How many days the guarantee runs from the start. Kith ATS works out its last day.

UpdatePlacementInput.invoiceDate · Date scalar

The day the invoice was sent.

UpdatePlacementInput.invoiceStatus · PlacementInvoiceStatus enum

Where the invoice stands.

UpdatePlacementInput.isReferralPaid · Boolean scalar

True once the referral fee has been paid. It cannot be cleared: give false.

UpdatePlacementInput.jobCandidateId · ID! non-null scalar

The id of the candidate's place on the job.

UpdatePlacementInput.notes · String scalar

The recruiter's notes on them for this job. Blank clears them.

UpdatePlacementInput.offerAcceptedAt · Date scalar

The day the candidate accepted the offer.

UpdatePlacementInput.offerSalary · Decimal scalar

The salary offered, zero or more, such as 85000.00.

UpdatePlacementInput.ownerId · ID scalar

The teammate responsible for the placement. Null for nobody.

The day the invoice was paid.

UpdatePlacementInput.placementFee · Decimal scalar

The fee for the placement, zero or more.

UpdatePlacementInput.referralFee · Decimal scalar

The fee owed to whoever referred them, zero or more, in currency.

UpdatePlacementInput.referralPersonId · ID scalar

The person, from the workspace's people, who referred the candidate. Null for nobody.

UpdatePlacementInput.splits · [PlacementSplitInput!] list input

Who shares the credit, replacing what is there; null or an empty list for nobody. Each teammate once, 20 at most, 100 percent at most together.

UpdatePlacementInput.startDate · Date scalar

The day they start.

Member Of

updatePlacement mutation