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

    PayrollSettingDTO

    {
        "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