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

GeneralSettingUpdateDTO

{
    "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,
    "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"
    }
}
Built with