Nxsys API Documentation
  1. Schemas
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
      • Create Candidate
      • 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
      • PensionSettingDTO
      • GeneralSettingDTO
      • BankSettingDTO
      • OpeningBalanceDTO
      • PayrollSettingDTO
      • CreateCandidateDTO
      • GeneralSettingUpdateDTO
      • PayrollSettingUpdateDTO
      • UpdateCandidateDTO
      • PaymentRateCreateDto
      • IrelandGeneralSettingDTO
      • PaymentRateEditDto
      • IrelandBankSettingDTO
      • OpenAPIRateTimeSheet
      • IrelandPayrollSettingDTO
      • OpenAPITimeSheetCreateDto
      • CreateIrelandCandidateDTO
      • OpenAPITimeSheetEditDto
      • UpdateIrelandGeneralSettingDTO
      • AgencyCreateDto
      • UpdateIrelandBankSettingDTO
      • UpdateIrelandPayrollSettingDTO
      • UpdateIrelandCandidateDTO
  1. Schemas

CreateIrelandCandidateDTO

{
    "generalSetting": {
        "agencyRef": "1234567890",
        "title": "NONE",
        "gender": "MALE",
        "forename": "Michael",
        "surname": "Smith",
        "DOB": "1990-05-15",
        "maritalStatus": "SINGLE",
        "nationality": "British",
        "address": [
            "Address 1",
            "Address 2",
            "Address 3"
        ],
        "city": "London",
        "county": "Greater London",
        "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",
        "emergencyMobile": "07123456789",
        "emergencyEmail": "emergency@domain.com",
        "rightToWorkStatus": "APPEAL",
        "documentType": "BIOMETRIC_RESIDENCE_PERMIT",
        "documentExpiryDate": null,
        "document": null,
        "department": null,
        "pensionSetting": {
            "scheme": "NEST",
            "reference": "PEN123456",
            "outsideUKWorker": true,
            "lastAssessmentOn": "2019-08-24T14:15:22Z",
            "dateOnClassifiedOn": "2019-08-24T14:15:22Z",
            "ejhDate": "2019-08-24T14:15:22Z",
            "postponementEndDate": "2019-08-24T14:15:22Z",
            "memberId": null,
            "membershipStartDate": "2019-08-24T14:15:22Z",
            "optInDate": "2019-08-24T14:15:22Z",
            "optOutDate": "2019-08-24T14:15:22Z",
            "optState": "ignition"
        },
        "eircode": "D02 Y006",
        "emergencyEircode": "D02 Y006",
        "shareCodeVerified": null
    },
    "bankSetting": {
        "bankName": "HSBC",
        "accountName": "John Smith",
        "accountNumber": "12345678",
        "sortCode": "123456",
        "buildingSocietyNumber": "BS123456",
        "IBANReference": "GB29NWBK60161331926819",
        "SWIFTNo": "NWBKGB2L",
        "author": "admin",
        "isInternalAccount": false,
        "country": "AF"
    },
    "payrollSetting": {
        "paymentModel": "PAYEE",
        "cisStatus": "GROSS_0%",
        "companyPayment": "COM-2",
        "timesheetApprovalNeeded": "NOT_AVAILABLE",
        "payrollApproveNeeded": "NOT_AVAILABLE",
        "holidayPayMethod": "ROLLED_UP",
        "holidayPayRate": null,
        "taxBasis": "W1M1",
        "employmentStatus": "THE_EMPLOYEES_FIRST_OR_ONLY_EMPLOYMENT",
        "ppsNumber": "1234567AB",
        "employmentId": "1234",
        "includeInTimesheetRate": false,
        "prsiEeClasses": "A0_A1",
        "prsiExemption": "A1_PORTABLE_DOCUMENT",
        "taxCreditFrequency": "641.02",
        "taxCreditAnnual": "33333.04",
        "taxRateCutOffPoints": [
            "string"
        ],
        "yearlyRateCutOff": "44443.88",
        "yearlyRateCutOffFrequency": "854.69",
        "uscExemption": "NOT_EXEMPT",
        "USCTier": "USE3",
        "frequency_zeroPointFive": "30",
        "frequency_two": "40",
        "frequency_fourPointFive": "50",
        "frequency_eight": "0.00",
        "annual_zeroPointFive": "1560.00",
        "annual_two": "2080.00",
        "annual_fourPointFive": "2600.00",
        "totalLPTToBeDeducted": "1200",
        "ascCalculationMethod": "NOT_APPLICABLE",
        "directorShip": "NONE",
        "cutOffPoints": null,
        "totalPayLiableToTax": 0,
        "totalTax": 0,
        "totalPayLiableToUSC": 0,
        "totalUSC": 0,
        "totalPayLiableToASC": 0,
        "totalASC": 0,
        "openingBalance": {
            "eePRSI": 0,
            "eePension": 0,
            "erPRSI": 0,
            "erPension": 0,
            "uscGross": 0,
            "usc": 0,
            "eePrsiGross": 0,
            "erPrsiGross": 0,
            "grossForTax": 0,
            "pensionGross": 0,
            "lptDeduction": 0,
            "gross": 0,
            "tax": 0,
            "ssp": 0
        },
        "subcontractorRefNumber": "1234567890",
        "holidayPayOpeningBalance": 0
    }
}
Built with