Public API Reference (Beta)Placement

Create a placement

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Request

This endpoint expects an object.
requirementGuidstringRequired
GUID of the requirement this placement is for.
applicantGuidstringRequired
GUID of the applicant being placed.
startDatestringRequired

ISO-8601 start date of the placement.

hireDatestringRequired

ISO-8601 hire date of the placement.

billTypeIdlongRequired

ID of the bill type (pay period). 1=Hourly, 2=Daily, 3=Monthly, 4=Annually, 5=Weekly, 6=Biweekly.

payTypeIdlongRequired

ID of the pay type (pay period). 1=Hourly, 2=Daily, 3=Monthly, 4=Annually, 5=Weekly, 6=Biweekly.

employmentTypeIdlongRequired
ID of the employment type for this placement.
placementTypeIdlongRequired

ID of the placement type. 1=Contract, 2=Permanent, 3=Internal, 4=Contract to Hire.

endDatestringOptional

ISO-8601 end date of the placement. Defaults to startDate if omitted.

billRatedoubleOptional
Bill rate for this placement.
payRatedoubleOptional
Pay rate for this placement.
commissionFeedoubleOptional
Flat commission fee.
commissionPctdoubleOptional
Commission percentage.

Response

Placement created