Nxsys API Documentation
    Nxsys API Documentation
    • Introduction
      • Nxsys API Documentation
      • Base URL and Environments
      • Handling Errors
      • Pagination
      • Best Practices
    • Authentication
      • Overview
      • Step 1: Create a Client Application
      • Step 2: Obtain Authorization Code
      • Step 3: Exchange your Authorization Code for an Access Token
      • Step 4: Refresh your Access Token
    • APIs
      • Authentication
        • Get url to connect Nxsys system
        • Get access token
      • Candidates
        • Create Candidate
        • Get Candidates
        • Update Candidate
      • Candidates Ireland
        • ClientCandidatesIrelandController_createIrelandCandidate
        • Get Candidates
        • Update Candidate
        • Get Candidate by ID
      • VAT Codes
        • Get list default VAT Code
      • PaymentRate
        • Create new Payment Rate
        • OpenAPIPaymentRateController_findAllPaymentRates
        • OpenAPIPaymentRateController_findPaymentRateById
        • Update Payment Rate
      • Timesheet
        • Create timesheets
        • OpenAPITimesheetController_findAllTimeSheet
        • OpenAPITimesheetController_findTimeSheetById
        • OpenAPITimesheetController_editTimeSheetById
      • Payslips
        • Get Payslips
    • Schemas
      • Schemas
        • AgencyCreateDto
      • PensionSettingDTO
      • GeneralSettingDTO
      • BankSettingDTO
      • OpeningBalanceDTO
      • PayrollSettingDTO
      • CreateCandidateDTO
      • GeneralSettingUpdateDTO
      • PayrollSettingUpdateDTO
      • UpdateCandidateDTO
      • PaymentRateCreateDto
      • IrelandGeneralSettingDTO
      • PaymentRateEditDto
      • IrelandBankSettingDTO
      • OpenAPIRateTimeSheet
      • IrelandPayrollSettingDTO
      • OpenAPITimeSheetCreateDto
      • CreateIrelandCandidateDTO
      • OpenAPITimeSheetEditDto
      • UpdateIrelandGeneralSettingDTO
      • UpdateIrelandBankSettingDTO
      • UpdateIrelandPayrollSettingDTO
      • UpdateIrelandCandidateDTO

    CreateCandidateDTO

    {
        "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": null,
            "allowPortalLogin": false,
            "loginId": "candidate@example.com",
            "isRestrictedHours": false,
            "workingPatternId": 1,
            "payrollCalculationStart": "2024-01-01",
            "payrollCalculationEnd": "2024-12-31",
            "workingTimeRegulation": "OPT_IN",
            "agencyConductRegulation": "OPT_IN",
            "pensionSetting": {
                "scheme": "NEST",
                "reference": "PEN123456",
                "outsideUKWorker": true,
                "lastAssessmentOn": "2019-08-24T14:15:22.123Z",
                "dateOnClassifiedOn": "2019-08-24T14:15:22.123Z",
                "ejhDate": "2019-08-24T14:15:22.123Z",
                "postponementEndDate": "2019-08-24T14:15:22.123Z",
                "memberId": null,
                "membershipStartDate": "2019-08-24T14:15:22.123Z",
                "optInDate": "2019-08-24T14:15:22.123Z",
                "optOutDate": "2019-08-24T14:15:22.123Z",
                "optState": "ignition",
                "isSalarySacrifice": true,
                "pensionCalculationType": "NET_PAY_ARRANGEMENT"
            }
        },
        "bankSetting": {
            "bankName": "HSBC",
            "accountName": "John Smith",
            "accountNumber": "12345678",
            "sortCode": "123456",
            "buildingSocietyNumber": "BS123456",
            "IBANReference": "GB29NWBK60161331926819",
            "SWIFTNo": "NWBKGB2L",
            "author": "admin"
        },
        "payrollSetting": {
            "paymentModel": "CIS",
            "cisStatus": "GROSS_0%",
            "personalVerificationNumber": null,
            "verificationDate": null,
            "matchDate": null,
            "UTRNo": null,
            "companyName": null,
            "registrationNumber": null,
            "paymentTerm": "ON_INVOICING",
            "marginMethod": "FIXED_FEE",
            "margin": 0,
            "marginCapped": 0,
            "assignmentRequired": true,
            "timesheetApprovalNeeded": "NOT_AVAILABLE",
            "timesheetApprover": null,
            "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,
            "previousPayrollNo": "string",
            "haveStudentLoan": true,
            "studentLoanPlan1StartDate": "2019-08-24T14:15:22.123Z",
            "studentLoanPlan1EndDate": "2019-08-24T14:15:22.123Z",
            "studentLoanPlan2StartDate": "2019-08-24T14:15:22.123Z",
            "studentLoanPlan2EndDate": "2019-08-24T14:15:22.123Z",
            "studentLoanPlan4StartDate": "2019-08-24T14:15:22.123Z",
            "studentLoanPlan4EndDate": "2019-08-24T14:15:22.123Z",
            "studentLoanPostGraStartDate": "2019-08-24T14:15:22.123Z",
            "studentLoanPostGraEndDate": "2019-08-24T14:15:22.123Z",
            "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": 0,
                "erNI": 0,
                "eePension": 0,
                "erPension": 0,
                "stLoan": 0,
                "pgLoan": 0,
                "ssp": 0,
                "smp": 0,
                "sap": 0,
                "sncp": 0,
                "shpp": 0,
                "sppa": 0,
                "spp": 0,
                "grossToLel": 0,
                "grossLelToPt": 0,
                "grossPtToUEL": 0,
                "gross": 0,
                "grossForTax": 0,
                "grossForNI": 0,
                "tax": 0
            },
            "isSendEmailSelfBill": true,
            "isSendEmailP45": true,
            "isSendEmailP60": true,
            "isNIDirector": true,
            "NIDirectorStartDate": "2019-08-24T14:15:22.123Z"
        }
    }
    Built with