1
Integration
55
Endpoints
Available integrations
Mercury
Get all Activity Purposes. Optionally filter by Activity Type.
Get All Applicants paginated with optional parameters.
Get a Candidate Company record by Id.
Get All Candidates with optional isActive flag (Deprecated). Use GET /contacts and filter by Contact Type to return only Candidates
Get a candidate record by a given ID (Deprecated). Use GET /contacts/{contactId}
Get all Placements for a Candidate
Get all clients in the Mercury system. (Deprecated) Use GET /v3/clients/
Get client by Id in the Mercury system.
Get a Compliance record by Id.
Get All Contacts (Deprecated). Use .../v2/contacts
Get a Contact record by Id.
Returns Activities (Email, Appointment, Update, Phone and Task) associated against a Contact.
Get Annotations by Contact record Id.
Get All Applicants associated with a Contact; paginated with optional parameters.
Get the Primary CV document against a Contact record.
Get all File Details against a Contact record.
Get Education records for Contact.
Get Skill records for Contact.
Get Work History records for Contact.
Get a document by a specified path and filename.
Get All Placements with pagination
Get a Placement by a given Id
Get a list of Compliance records for a given Placement Id
Get a list of Finance Rate records by a given Placement Id
Get a Fees by a given Placement Id
Get All Placements Fee with pagination
Get All Shortlist records with pagination.
Get All Shortlist Update records with pagination.
Get all System User records.
Get a System User record by Id.
Get All Vacancies (Deprecated). Use .../v2/vacancies
Get a Vacancy record by Id.
Get Shortlist records by Vacancy Id.
Patch Applicant by Id.
Patch Client By Id
Patch a Compliance record by Id.
Patch Single Contact.
All fields set:
PATCH /Contacts/{contactId}
{
"isCandidateContact": true,
"isClientContact": true,
"latestSource": "Latest Source",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobTitle": "Job Title",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owningConsultantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalIdentifier": "123ABC",
"firstName": "YourFirstName",
"middleName": "YourMiddleName",
"lastName": "YourLastName" // required,
"personalEmail": "test@myemail.com",
"workEmail": "string",
"workMobile": "string",
"workPhone": "string",
"personalMobile": "string",
"personalPhone": "string",
"linkedInUrl": "string",
"niNumber": "string",
"birthDate": "2024-07-31T15:27:57.260Z",
"gender": "0",
"homeAddress": {
"name": "Address 1",
"line1": "Line 1",
"line2": "Line 2",
"line3": "Line 3",
"city": "City",
"state": "State",
"postcode": "Postcode",
"country": "Country"
},
"preferences": {
"availability": "2024-07-31T15:27:57.260Z",
"noticePeriod": 0,
"noticePeriodType": "0",
"currencyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isContractor": true,
"isTemporary": true,
"isPermanent": true,
"expectedRateLow": 0,
"expectedRateHigh": 0,
"expectedSalaryLow": 0,
"expectedSalaryHigh": 0,
"contractorPayFrequency": "0",
"temporaryPayFrequency": "0"
},
"profileSummary": "Profile Summary",
"rolesSought": "Roles Sought",
"latestEmployer": "Latest Employer",
"customTextFields": {
"User Field 1": "string",
"User Field 2": "string",
"User Field 3": "string"
"User Field 4": "string",
"User Field 5": "string",
},
"customNumericFields": {
"Numeric User Field 1": 0,
"Numeric User Field 2": 0,
"Numeric User Field 3": 0
"Numeric User Field 4": 0
"Numeric User Field 5": 0
},
"customBooleanFields": {
"Boolean User Field 1": true,
"Boolean User Field 2": true,
"Boolean User Field 3": true
"Boolean User Field 4": true
"Boolean User Field 5": true
},
"customDateFields": {
"Date User Field 1": "2024-07-31T15:27:57.260Z",
"Date User Field 2": "2024-07-31T15:27:57.260Z",
"Date User Field 3": "2024-07-31T15:27:57.260Z"
"Date User Field 4": "2024-07-31T15:27:57.260Z"
"Date User Field 5": "2024-07-31T15:27:57.260Z"
},
"customDateTimeFields": {
"Datetime User Field 1": "2024-07-31T15:27:57.260Z",
"Datetime User Field 2": "2024-07-31T15:27:57.260Z",
"Datetime User Field 3": "2024-07-31T15:27:57.260Z",
"Datetime User Field 4": "2024-07-31T15:27:57.260Z",
"Datetime User Field 5": "2024-07-31T15:27:57.260Z",
}
}
Patch Single Activity.
For Appointment Activity Type:
PATCH /Contacts/{contactId}/activities/{activityId}
{
"activityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subject": "activity subject",
"description": "activity description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": 1,
"startDate": "2024-08-20T15:30:00.000Z",
"endDate": "2024-08-20T16:30:00.000Z",
"duration": 60,
"asA": 2,
"isAllDayEvent": false,
"isOnlineMeeting": false,
"required": [
{
"emailAddress": "test@contoso.com",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": 1
},
],
"optional": [],
"location": "Meeting Room Alpha",
}
For Email Acitivity Type:
PATCH /Contacts/{contactId}/activities/{activityId}
{
"activityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subject": "email subject",
"description": "email description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": 2,
"category": "email category",
"subcategory": "email sub-category",
"duration": 10,
"asA": 2,
"dueDate": "2024-08-20T15:30:00.000Z",
"to": [{
"emailAddress": "test@contoso.com",
"entityId": "2c593h41-5717-4562-b3fc-1g511h52h2f5",
"entityType": 1
}],
"bcc": [],
"ccc": [],
"aboutVacancyId": "2c593h41-5717-4562-b3fc-1g511h52h2f5"
}
For Phone Activity Type:
PATCH /Contacts/{contactId}/activities/{activityId}
{
"activityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subject": "phone subject",
"description": "phone description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"asA": 2,
"to": [{
"emailAddress": "test@contoso.com",
"entityId": "2c593h41-5717-4562-b3fc-1g511h52h2f5",
"entityType": 1
}],
"dueDate": "2024-08-20T15:30:00.000Z",
"direction": 1,
"markAsCompleted": true,
"followUp": true,
"leftVoicemail": false,
"followUpDate": "2024-08-20T15:30:00.000Z"
}
For Task Activity Type:
PATCH /Contacts/{contactId}/activities/{activityId}
{
"activityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subject": "task subject",
"description": "task description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"duration": 60,
"priority": 0,
"dueDate": "2024-08-20T15:30:00.000Z"
}
For Update Activity Type:
PATCH /Contacts/{contactId}/activities/{activityId}
{
"activityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"subject": "update subject",
"description": "update description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"startDate": "2024-08-20T15:30:00.000Z",
"endDate": "2024-08-20T16:30:00.000Z",
"dueDate": "2024-08-20T15:30:00.000Z"
}
Patch a Skill level record
Patch a batch of Vacancies.
Minimum fields set:
PATCH /Vacancies/batch
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
All fields set for permanent position:
PATCH /Vacancies/batch
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalId": "string",
"status": 0,
"statusDescription": 143570008,
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobTitle": "string",
"jobDescription": "string",
"startDate": "2024-08-22",
"numberOfPositions": 1,
"speculative": false,
"permanentDetails": {
"salary": 30000,
"packageValue": 35000,
"benefits": {
"holidays": 25,
"hasCompanyCar": false,
"hasPensionScheme": true,
"hasMedicalInsurance": true,
"bonusShares": "string"
}
},
"contractTempDetails": null,
"currency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"frequency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobSummary": "Job Summary",
"alternativeAdvertText1": "Advert Text Part 1",
"alternativeAdvertText2": "Advert Text Part 2",
"consultant": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveryOwner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reviewDate": "2024-08-19",
"jobStatus": 1,
"hiringManager": {
"name": "FirstName LastName",
"email": "firstname.lastname@company.com"
},
"source": "Vacancy Source",
"discipline": "Vacancy discipline",
"vacancyType": "Vacancy type",
"clientAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": High = 0, Medium = 1, Low = 2, OnHold = 3
}
]
All fields set for temporary/contract position:
PATCH /Vacancies/batch
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalId": "string",
"status": 0,
"statusDescription": 143570008,
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobTitle": "string",
"jobDescription": "string",
"startDate": "2024-08-22",
"numberOfPositions": 1,
"speculative": false,
"permanentDetails": null,
"contractTempDetails": {
"charge": 0,
"pay": 250,
"hoursPerDay": 7.5,
"numberOfWeeks": 52,
"daysPerWeek": 5,
"taxableAs": 1
},
"currency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"frequency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobSummary": "Job Summary",
"alternativeAdvertText1": "Advert Text Part 1",
"alternativeAdvertText2": "Advert Text Part 2",
"consultant": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveryOwner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reviewDate": "2024-08-19",
"jobStatus": 1,
"hiringManager": {
"name": "FirstName LastName",
"email": "firstname.lastname@company.com"
},
"source": "Vacancy Source",
"discipline": "Vacancy discipline",
"vacancyType": "Vacancy type",
"clientAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": High = 0, Medium = 1, Low = 2, OnHold = 3
}
]
Patch a work history record
Upload a document against a Candidate Contact record (Deprecated). Use contacts/{contactId}/document
Creates a Contact by parsing an uploaded CV
Create a client in the Mercury system.
Minumum fields set:
POST /Clients
{
"Name": "ClientName" // Required
"primaryAddress": {
"state": "North State" // Only required when Country contains States,
"name": "Head Office", // Required
"line1": "Main building", // Required
"city": "Stand City", // Required
"country": "Germany" // Required
}
}
All fields set:
POST /Clients
{
"addresses": [
{
"line2": "13th Avenue",
"line3": "Noughtsville",
"state": "South State" // Only required when Country contains States,
"postcode": "SA6 3LF",
"name": "Alternate Address",
"line1": "Second building",
"city": "Sitdown City",
"country": "France"
}
],
"name": "Client Name",
"primaryAddress": {
"line2": "12th Avenue",
"line3": "Checksville",
"state": "North State" // Only required when Country contains States,
"postcode": "TE5 1NG",
"name": "Head Office",
"line1": "Main building",
"city": "Stand City",
"country": "Germany"
}
}
Upload evidence against a Compliance record.
Create Single Contact.
Minumum fields set:
POST /Contacts
{
"lastName": "YourLastName"
}
All fields set:
POST /Contacts
{
"isCandidateContact": true,
"isClientContact": true,
"latestSource": "Latest Source",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobTitle": "Job Title",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owningConsultantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalIdentifier": "123ABC",
"firstName": "YourFirstName",
"middleName": "YourMiddleName",
"lastName": "YourLastName" // required,
"personalEmail": "test@myemail.com",
"workEmail": "string",
"workMobile": "string",
"workPhone": "string",
"personalMobile": "string",
"personalPhone": "string",
"linkedInUrl": "string",
"niNumber": "string",
"birthDate": "2024-07-31T15:27:57.260Z",
"gender": "0",
"homeAddress": {
"name": "Address 1",
"line1": "Line 1",
"line2": "Line 2",
"line3": "Line 3",
"city": "City",
"state": "State",
"postcode": "Postcode",
"country": "Country"
},
"preferences": {
"availability": "2024-07-31T15:27:57.260Z",
"noticePeriod": 0,
"noticePeriodType": "0",
"currencyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isContractor": true,
"isTemporary": true,
"isPermanent": true,
"expectedRateLow": 0,
"expectedRateHigh": 0,
"expectedSalaryLow": 0,
"expectedSalaryHigh": 0,
"contractorPayFrequency": "0",
"temporaryPayFrequency": "0"
},
"profileSummary": "Profile Summary",
"rolesSought": "Roles Sought",
"latestEmployer": "Latest Employer",
"customTextFields": {
"User Field 1": "string",
"User Field 2": "string",
"User Field 3": "string"
"User Field 4": "string",
"User Field 5": "string",
},
"customNumericFields": {
"Numeric User Field 1": 0,
"Numeric User Field 2": 0,
"Numeric User Field 3": 0
"Numeric User Field 4": 0
"Numeric User Field 5": 0
},
"customBooleanFields": {
"Boolean User Field 1": true,
"Boolean User Field 2": true,
"Boolean User Field 3": true
"Boolean User Field 4": true
"Boolean User Field 5": true
},
"customDateFields": {
"Date User Field 1": "2024-07-31T15:27:57.260Z",
"Date User Field 2": "2024-07-31T15:27:57.260Z",
"Date User Field 3": "2024-07-31T15:27:57.260Z"
"Date User Field 4": "2024-07-31T15:27:57.260Z"
"Date User Field 5": "2024-07-31T15:27:57.260Z"
},
"customDateTimeFields": {
"Datetime User Field 1": "2024-07-31T15:27:57.260Z",
"Datetime User Field 2": "2024-07-31T15:27:57.260Z",
"Datetime User Field 3": "2024-07-31T15:27:57.260Z",
"Datetime User Field 4": "2024-07-31T15:27:57.260Z",
"Datetime User Field 5": "2024-07-31T15:27:57.260Z",
}
}
Create Activity against a Contact record.
For Appointment Activity Type:
POST /activities
{
"subject": "activity subject",
"description": "activity description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityType": 3,
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": 1,
"starteDate": "2024-08-20T15:30:00.000Z",
"endDate": "2024-08-20T16:30:00.000Z",
"duration": 60,
"asA": 2,
"isAllDayEvent": false,
"isOnlineMeeting": false,
"required": [
{
"emailAddress": "test@contoso.com",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": 1
},
],
"optional": [],
"location": "Meeting Room Alpha",
}
For Email Acitivity Type:
POST /activites
{
"subject": "email subject",
"description": "email description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityType": 0,
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": 2,
"category": "email category",
"subcategory": "email sub-category",
"duration": 10,
"asA": 2,
"from": {
"emailAddress": "user@mycompany.com",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": 3
},
"to": {
"emailAddress": "test@contoso.com",
"entityId": "2c593h41-5717-4562-b3fc-1g511h52h2f5",
"entityType": 1
},
"bcc": {},
"ccc": {},
"aboutVacancyId": "2c593h41-5717-4562-b3fc-1g511h52h2f5"
}
For Phone Activity Type:
POST /activities:
{
"subject": "phone subject",
"description": "phone description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityType": 1,
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"asA": 2,
"from": {
"emailAddress": "user@mycompany.com",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": 3
},
"to": {
"emailAddress": "test@contoso.com",
"entityId": "2c593h41-5717-4562-b3fc-1g511h52h2f5",
"entityType": 1
},
"dueDate": "2024-08-20T15:30:00.000Z",
"direction": 1,
"markAsCompleted": true,
"followUp": true,
"leftVoicemail": false,
"followUpDate": "2024-08-20T15:30:00.000Z"
}
For Task Activity Type:
POST /activites
{
"subject": "task subject",
"description": "task description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityType": 2,
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"duration": 60,
"priority": 0,
"dueDate": "2024-08-20T15:30:00.000Z"
}
For Update Activity Type:
POST /activities
{
"subject": "update subject",
"description": "update description",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"activityType": 4,
"activityPurposeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"starteDate": "2024-08-20T15:30:00.000Z",
"endDate": "2024-08-20T16:30:00.000Z",
"dueDate": "2024-08-20T15:30:00.000Z"
}
Create Annotation against a Contact record.
Upload a CV document against a Contact record.
Upload a non-CV document against a Contact record.
Create a Compliance record for a given Placement Id
Minumum fields set:
POST /placements/{PlacementId}/compliance
{
"placementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Can only be set if contactId is not set
-----or-----
"cotactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Can only be set if placementId is not set
"criterion": "string",
"name": "string",
"status": 0,
"validity": 0
}
All fields set:
POST /placements/{PlacementId}/compliance
{
"placementId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Can only be set if contactId is not set
-----or-----
"contactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Can only be set if placementId is not set
"criterion": "string",
"name": "string",
"status": 0,
"validity": 0,
"validFrom": "2024-03-17",
"validTo": "2024-03-17",
"checkedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"checkedOn": "2024-03-17"
}
Create a batch of Vacancies.
Minimum fields set:
POST /Vacancies/batch
[
{
"externalId": "vac-123",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"typeOfPosition": 0,
"jobTitle": "Job Title",
"jobDescription": "Job Description",
"startDate": "2024-08-05",
"numberOfPositions": 1
}
]
All fields set for permanent position:
POST /Vacancies/batch
[
{
"externalId": "vac-123",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"typeOfPosition": 0,
"jobTitle": "Job Title",
"jobDescription": "Job Description",
"startDate": "2024-08-26",
"numberOfPositions": 1,
"speculative": false,
"permanentDetails": {
"salary": 30000,
"packageValue": 35000,
"benefits": {
"holidays": 25,
"hasCompanyCar": false,
"hasPensionScheme": true,
"hasMedicalInsurance": true,
"bonusShares": "string"
}
},
"contractTempDetails": null,
"currency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"frequency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobSummary": "Job Summary",
"alternativeAdvertText1": "Advert Text Part 1",
"alternativeAdvertText2": "Advert Text Part 2",
"consultant": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveryOwner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reviewDate": "2024-08-19",
"jobStatus": 1,
"hiringManager": {
"name": "FirstName LastName",
"email": "firstname.lastname@company.com"
},
"source": "Vacancy Source",
"discipline": "Vacancy discipline",
"vacancyType": "Vacancy type",
"clientAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": High = 0, Medium = 1, Low = 2, OnHold = 3
}
]
All fields set for temporary/contract position:
POST /Vacancies/batch
[
{
"externalId": "vac-123",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"typeOfPosition": 0,
"jobTitle": "Job Title",
"jobDescription": "Job Description",
"startDate": "2024-08-26",
"numberOfPositions": 1,
"speculative": false,
"permanentDetails": null,
"contractTempDetails": {
"charge": 0,
"pay": 250,
"hoursPerDay": 8,
"numberOfWeeks": 104,
"daysPerWeek": 5,
"taxableAs": 1
},
"currency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"frequency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobSummary": "Job Summary",
"alternativeAdvertText1": "Advert Text Part 1",
"alternativeAdvertText2": "Advert Text Part 2",
"consultant": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveryOwner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reviewDate": "2024-08-19",
"jobStatus": 1,
"hiringManager": {
"name": "FirstName LastName",
"email": "firstname.lastname@company.com"
},
"source": "Vacancy Source",
"discipline": "Vacancy discipline",
"vacancyType": "Vacancy type",
"clientAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": High = 0, Medium = 1, Low = 2, OnHold = 3
}
]
Updates a specified Contact with details provided in the uploaded CV
Update a candidate record (Deprecated). Use PATCH /contacts/{contactId}
Update a batch of Vacancies.
Minimum fields set:
PUT /Vacancies/batch
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalId": "vac-123",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobTitle": "Job Title",
"jobDescription": "Job Description",
"startDate": "2024-08-05",
"numberOfPositions": 1
}
]
All fields set for permanent position:
PUT /Vacancies/batch
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalId": "vac-123",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status: 0,
"statusDescription": 143570005,
"jobTitle": "Job Title",
"jobDescription": "Job Description",
"startDate": "2024-08-26",
"numberOfPositions": 1,
"speculative": false,
"permanentDetails": {
"salary": 30000,
"packageValue": 35000,
"benefits": {
"holidays": 25,
"hasCompanyCar": false,
"hasPensionScheme": true,
"hasMedicalInsurance": true,
"bonusShares": "string"
}
},
"contractTempDetails": null,
"currency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"frequency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobSummary": "Job Summary",
"alternativeAdvertText1": "Advert Text Part 1",
"alternativeAdvertText2": "Advert Text Part 2",
"consultant": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveryOwner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reviewDate": "2024-08-19",
"jobStatus": 1,
"hiringManager": {
"name": "FirstName LastName",
"email": "firstname.lastname@company.com"
},
"source": "Vacancy Source",
"discipline": "Vacancy discipline",
"vacancyType": "Vacancy type",
"clientAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": High = 0, Medium = 1, Low = 2, OnHold = 3
}
]
All fields set for temporary/contract position:
PUT /Vacancies/batch
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalId": "vac-123",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": 0,
"statusDescription": 143570005,
"jobTitle": "Job Title",
"jobDescription": "Job Description",
"startDate": "2024-08-26",
"numberOfPositions": 1,
"speculative": false,
"permanentDetails": null,
"contractTempDetails": {
"charge": 0,
"pay": 250,
"hoursPerDay": 7.5,
"numberOfWeeks": 52,
"daysPerWeek": 5,
"taxableAs": 1
},
"currency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"frequency": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobSummary": "Job Summary",
"alternativeAdvertText1": "Advert Text Part 1",
"alternativeAdvertText2": "Advert Text Part 2",
"consultant": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deliveryOwner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reviewDate": "2024-08-19",
"jobStatus": 1,
"hiringManager": {
"name": "FirstName LastName",
"email": "firstname.lastname@company.com"
},
"source": "Vacancy Source",
"discipline": "Vacancy discipline",
"vacancyType": "Vacancy type",
"clientAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": High = 0, Medium = 1, Low = 2, OnHold = 3
}
]