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

    UpdateIrelandGeneralSettingDTO

    {
        "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": "0831234567",
        "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": "0851234567",
        "emergencyEmail": "emergency@domain.com",
        "rightToWorkStatus": "APPEAL",
        "documentType": "BIOMETRIC_RESIDENCE_PERMIT",
        "documentExpiryDate": null,
        "document": null,
        "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"
        },
        "eircode": "D02 Y006",
        "emergencyEircode": "D02 Y006",
        "shareCodeVerified": null
    }
    Built with