Sign in
DirectHires

Replaces every updatable header field of a direct hire (BF-7509).

Required: candidateName, candidateTitle, startDate, mailInvoiceDate, candidateSalary, fee (a percentage), mailInvoiceToAddress. Every other field that is absent or null is cleared - use PATCH to change only some. Field names are those of GET /v1/DirectHires/{jobId}, so its data can be sent back; keys that are not fields are ignored. A jobId in the body must equal the route; a clientId must equal the stored client. totalInvoiceAmount and totalGrossProfit are computed by the server. Once the direct hire is invoiced or voided its money (salary, fee, credit discount, sign-on bonus, other GP reduction) cannot change. Invoice splits, custom fields, contacts and offer letters are not changed. When every value equals the stored one nothing is written.

put/v{version}/DirectHires/{jobId}

Path parameters

jobIdinteger required
versionstring required

Headers

company-idstring required

Request body

jobIdinteger
clientIdinteger nullable
candidateNamestring nullable
candidateTitlestring nullable
startDatestring date-time nullable
mailInvoiceDatestring date-time nullable
candidateSalarynumber double nullable
feenumber double nullable
creditDiscountnumber double nullable
creditDiscountNotesstring nullable
signOnBonusnumber double nullable
otherGPReductionnumber double nullable
reductionNotesstring nullable
invoiceMessagestring nullable
notesstring nullable
mailInvoiceToAddressboolean nullable
addressIdinteger nullable
contractIdinteger nullable
remittanceIdinteger nullable
paymentTermIdinteger nullable
bonusPayableTostring nullable
bonusAddress1string nullable
bonusAddress2string nullable
bonusCitystring nullable
bonusStatestring nullable
bonusZipCodestring nullable
mailCheckOnstring date-time nullable

Response

Success

isValidboolean
errorsstring[] nullable
warningsstring[] nullable
infostring[] nullable
messagestring nullable

Changes

Changed in 1 of the 8 revisions of this API.1