Update Candidate
Nxsys Umbrella - Production
https://api.nxsys.tech
Nxsys Umbrella - Production
https://api.nxsys.tech
PUT
https://api.nxsys.tech
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.nxsys.tech/nxsys/candidates/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
"generalSetting": {
"agencyRef": "___/ST-82514",
"title": "NONE",
"gender": "MALE",
"forename": "Michael",
"surname": "Smith",
"DOB": "1990-05-15",
"maritalStatus": "SINGLE",
"NINumber": "QQ123456C",
"nationality": "British",
"address": [
"Address 1",
"Address 2",
"Address 3"
],
"city": "London",
"county": "Greater London",
"postCode": "SW1A 1AA",
"country": "AF",
"mobile": "07123456789",
"email": "sample@domain.com",
"registrationStatus": "ONGOING",
"dateOfJoining": "2024-01-01",
"payFrequency": "WEEKLY",
"payMethod": "BACS",
"jobDescription": "Software Engineer",
"annualSalary": 35000,
"rateHour": 15.5,
"hours": 40,
"emergencyName": "John Doe",
"emergencyAddress": [
"123 Main St",
"Apt 4B"
],
"emergencyCity": "London",
"emergencyCounty": "Greater London",
"emergencyCountry": "GB",
"emergencyPostCode": "SW1A 1AA",
"emergencyMobile": "07123456789",
"emergencyEmail": "emergency@domain.com",
"rightToWorkStatus": "APPEAL",
"documentType": "BIOMETRIC_RESIDENCE_PERMIT",
"documentExpiryDate": null,
"document": null,
"primaryAgencyId": null,
"secondaryAgencyId": "agency-12345",
"department": "Finance",
"pensionSetting": {
"scheme": "NEST",
"reference": "PEN123456",
"outsideUKWorker": false,
"lastAssessmentOn": "2024-01-15",
"dateOnClassifiedOn": "2024-01-20",
"ejhDate": "2024-02-01",
"postponementEndDate": "2024-03-01",
"memberId": "MEM123456",
"membershipStartDate": "2024-01-10",
"optInDate": "2024-01-25",
"optOutDate": "2024-02-15",
"optState": "ignition",
"isSalarySacrifice": true,
"pensionCalculationType": "NET_PAY_ARRANGEMENT"
}
},
"bankSetting": {
"bankName": "HSBC",
"accountName": "John Smith",
"accountNumber": "12345678",
"sortCode": "12-34-56",
"buildingSocietyNumber": "BS123456",
"IBANReference": "GB29NWBK60161331926819",
"SWIFTNo": "NWBKGB2L",
"author": "admin"
},
"payrollSetting": {
"paymentModel": "CIS",
"cisStatus": "GROSS_0%",
"personalVerificationNumber": "PVN1234567",
"verificationDate": "2024-06-30",
"matchDate": "2024-07-01",
"UTRNo": "1234567890",
"companyName": "Acme Ltd",
"registrationNumber": "NI123456",
"paymentTerm": "ON_INVOICING",
"marginMethod": "FIXED_FEE",
"margin": 25,
"marginCapped": 100,
"assignmentRequired": true,
"timesheetApprovalNeeded": "NOT_AVAILABLE",
"timesheetApprover": [
"agency-12345",
"agency-67890"
],
"businessType": "SOLE_TRADER",
"firmName": null,
"partnersName": null,
"partnersCategory": "INDIVIDUAL",
"VATRegNo": null,
"taxCode": "125L",
"taxBasis": "W1M1",
"niCategory": "A",
"workplacePostcode": "string",
"starterType": "NEW_WITH_P45",
"starterDeclaration": "FIRST_JOB_SINCE_START_TAX_YEAR",
"p45GrossToDate": 0,
"p45TaxToDate": 0,
"isApprentice": true,
"studentLoanPlan1StartDate": "2019-08-24T14:15:22Z",
"studentLoanPlan1EndDate": "2019-08-24T14:15:22Z",
"studentLoanPlan2StartDate": "2019-08-24T14:15:22Z",
"studentLoanPlan2EndDate": "2019-08-24T14:15:22Z",
"studentLoanPlan4StartDate": "2019-08-24T14:15:22Z",
"studentLoanPlan4EndDate": "2019-08-24T14:15:22Z",
"studentLoanPostGraStartDate": "2019-08-24T14:15:22Z",
"studentLoanPostGraEndDate": "2019-08-24T14:15:22Z",
"holidayPayMethod": "ROLLED_UP",
"includeInTimesheetRate": true,
"holidayPayRate": 0,
"holidayPayOpeningBalance": 0,
"holidayPayAppLevy": 0,
"holidayPayErNI": 0,
"holidayPayErPen": 0,
"expenseClaimRule": "ALLOW",
"isRequiredAttachmentExpenses": true,
"expenseOpeningBalance": 0,
"reclaimAppLevy": true,
"openingBalance": {
"eeNI": 1200.5,
"erNI": 800.75,
"eePension": 500,
"erPension": 300,
"stLoan": 2000,
"pgLoan": 1500,
"ssp": 100,
"sap": 50,
"sncp": 0,
"shpp": 75,
"sppa": 60,
"spp": 60,
"grossToLel": 10000,
"grossLelToPt": 5000,
"grossPtToUEL": 3000,
"gross": 18000,
"grossForTax": 17000,
"grossForNI": 16000,
"tax": 2500
}
}
}'Response Response Example
201 - Example 1
{
"data": {
"candidate": {
"id": "cnd-123456",
"agencyRef": "AGY-001",
"title": "Mr",
"gender": "Male",
"forename": "John",
"surname": "Doe",
"DOB": "1990-01-01",
"maritalStatus": "SINGLE",
"NINumber": "QQ123456C",
"nationality": "British",
"address": [
"123 Main St",
"Apt 4B"
],
"city": "London",
"county": "Greater London",
"postCode": "SW1A 1AA",
"country": "GB",
"mobile": "07123456789",
"email": "john.doe@example.com",
"status": "ACTIVE",
"registrationStatus": "REGISTRATION_COMPLETE",
"dateOfJoining": "2024-01-01",
"payFrequency": "WEEKLY",
"dateLeft": null,
"reason": null,
"payMethod": "BACS",
"jobDescription": "Software Engineer",
"annualSalary": 35000,
"rateHour": 15.5,
"hours": 40,
"emergencyName": "Jane Doe",
"emergencyAddress": [
"456 Side St"
],
"emergencyCity": "London",
"emergencyCounty": "Greater London",
"emergencyCountry": "GB",
"emergencyPostCode": "SW1A 1AA",
"emergencyMobile": "07123456780",
"emergencyEmail": "jane.doe@example.com",
"rightToWorkStatus": "BRITISH_CITIZEN",
"documentType": "PASSPORT",
"documentExpiryDate": "2030-01-01",
"document": "https://example.com/document.pdf",
"pensionSetting": {
"outsideUKWorker": false,
"lastAssessmentOn": "2024-01-15",
"dateOnClassifiedOn": "2024-01-20",
"ejhDate": "2024-02-01",
"postponementEndDate": "2024-03-01",
"memberId": "MEM123456",
"membershipStartDate": "2024-01-10",
"optInDate": "2024-01-25",
"optOutDate": null,
"optState": "ignition"
},
"bank": {
"bankName": "HSBC",
"accountName": "John Doe",
"accountNumber": "12345678",
"sortCode": "12-34-56",
"buildingSocietyNumber": "BS123456",
"IBANReference": "GB29NWBK60161331926819",
"SWIFTNo": "NWBKGB2L"
},
"setting": {
"paymentModel": "UMBRELLA",
"cisStatus": "GROSS_0%",
"personalVerificationNumber": "PVN1234567",
"verificationDate": "2024-06-30",
"matchDate": "2024-07-01",
"UTRNo": "1234567890",
"companyName": "Acme Ltd",
"registrationNumber": "NI123456",
"paymentTerm": "ON_INVOICING",
"marginMethod": "FIXED_FEE",
"margin": 25,
"marginCapped": 100,
"assignmentRequired": true,
"timesheetApprovalNeeded": "NOT_AVAILABLE",
"businessType": "COMPANY",
"firmName": "Acme Partners",
"partnersName": "Jane Smith",
"partnersCategory": "PARTNER",
"VATRegNo": "GB123456789",
"taxCode": "125L",
"taxBasis": "CUMULATIVE",
"niCategory": "A",
"starterType": "NEW_WITHOUT_P45",
"starterDeclaration": "CURRENTLY_ONLY_JOB",
"p45GrossToDate": 0,
"p45TaxToDate": 0,
"isApprentice": false,
"studentLoanPlan1StartDate": null,
"studentLoanPlan1EndDate": null,
"studentLoanPlan2StartDate": null,
"studentLoanPlan2EndDate": null,
"studentLoanPlan4StartDate": null,
"studentLoanPlan4EndDate": null,
"studentLoanPostGraStartDate": null,
"studentLoanPostGraEndDate": null,
"holidayPayMethod": "INCLUDED",
"includeInTimesheetRate": true,
"holidayPayRate": 12.07,
"holidayPayOpeningBalance": 0,
"holidayPayAppLevy": 0,
"holidayPayErNI": 0,
"holidayPayErPen": 0,
"expenseClaimRule": "STANDARD",
"isRequiredAttachmentExpenses": false,
"expenseOpeningBalance": 0,
"reclaimAppLevy": false,
"openingBalance": {
"eeNI": 1200.5,
"erNI": 800.75,
"eePension": 500,
"erPension": 300,
"stLoan": 2000,
"pgLoan": 1500,
"ssp": 100,
"sap": 50,
"sncp": 0,
"shpp": 75,
"sppa": 60,
"spp": 60,
"grossToLel": 10000,
"grossLelToPt": 5000,
"grossPtToUEL": 3000,
"gross": 18000,
"grossForTax": 17000,
"grossForNI": 16000,
"tax": 2500
}
}
},
"success": true
},
"success": true
}Request
Path Params
Body Params application/json