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

AgencyCreateDto

{
    "name": "Agency Name",
    "reference": null,
    "timesheetApprovalNeeded": "TRUE",
    "timesheetApprover": null,
    "agencyPrefix": null,
    "allowPortalAccess": true,
    "currency": "GBP",
    "isRequiredAttachmentExpenses": false,
    "isSendEmailSelfBill": true,
    "isSendEmailP45": true,
    "isSendEmailP60": true,
    "isRestrictedHours": false,
    "paymentModel": [
        "CIS"
    ],
    "payeHolidayPayRate": 5,
    "umbrellaHolidayPayRate": 5,
    "convertRate": null,
    "emergencyContactName": "Emergency contact person",
    "emergencyEmail": "agency+1@gmail.com",
    "emergencyTelephone": null,
    "emergencyMobile": null,
    "contactName": "Contact name",
    "address": [
        "12",
        "St",
        "Wall"
    ],
    "city": null,
    "county": null,
    "country": {
        "AF": "AFG",
        "AL": "ALB",
        "DZ": "DZA",
        "AS": "ASM",
        "AD": "AND",
        "AO": "AGO",
        "AI": "AIA",
        "AQ": "ATA",
        "AG": "ATG",
        "AR": "ARG",
        "AM": "ARM",
        "AU": "AUS",
        "AT": "AUT",
        "AZ": "AZE",
        "BS": "BHS",
        "BH": "BHR",
        "BD": "BGD",
        "BB": "BRB",
        "BY": "BLR",
        "BE": "BEL",
        "BZ": "BLZ",
        "BJ": "BEN",
        "BM": "BMU",
        "BT": "BTN",
        "BO": "BOL",
        "BA": "BIH",
        "BW": "BWA",
        "BR": "BRA",
        "BN": "BRN",
        "BG": "BGR",
        "BF": "BFA",
        "BI": "BDI",
        "CV": "CPV",
        "KH": "KHM",
        "CM": "CMR",
        "CA": "CAN",
        "KY": "CYM",
        "CF": "CAF",
        "TD": "TCD",
        "CL": "CHL",
        "CN": "CHN",
        "CO": "COL",
        "KM": "COM",
        "CG": "COG",
        "CR": "CRI",
        "HR": "HRV",
        "CU": "CUB",
        "CY": "CYP",
        "CZ": "CZE",
        "DK": "DNK",
        "DJ": "DJI",
        "DM": "DMA",
        "DO": "DOM",
        "EC": "ECU",
        "EG": "EGY",
        "SV": "SLV",
        "GQ": "GNQ",
        "ER": "ERI",
        "EE": "EST",
        "ET": "ETH",
        "FJ": "FJI",
        "FI": "FIN",
        "FR": "FRA",
        "GA": "GAB",
        "GM": "GMB",
        "GE": "GEO",
        "DE": "DEU",
        "GH": "GHA",
        "GR": "GRC",
        "GD": "GRD",
        "GT": "GTM",
        "GN": "GIN",
        "GW": "GNB",
        "GY": "GUY",
        "HT": "HTI",
        "HN": "HND",
        "HU": "HUN",
        "IS": "ISL",
        "IN": "IND",
        "ID": "IDN",
        "IR": "IRL",
        "IQ": "IRQ",
        "IE": "IRL",
        "IL": "ISR",
        "IT": "ITA",
        "JM": "JAM",
        "JP": "JPN",
        "JO": "JOR",
        "KZ": "KAZ",
        "KE": "KEN",
        "KI": "KIR",
        "KP": "PRK",
        "KR": "KOR",
        "KW": "KWT",
        "KG": "KGZ",
        "LA": "LAO",
        "LV": "LVA",
        "LB": "LBN",
        "LS": "LSO",
        "LR": "LBR",
        "LY": "LBY",
        "LI": "LIE",
        "LT": "LTU",
        "LU": "LUX",
        "MG": "MDG",
        "MW": "MWI",
        "MY": "MYS",
        "MV": "MDV",
        "ML": "MLI",
        "MT": "MLT",
        "MH": "MHL",
        "MR": "MRT",
        "MU": "MUS",
        "MX": "MEX",
        "FM": "FSM",
        "MD": "MDA",
        "MC": "MCO",
        "MN": "MNG",
        "ME": "MNE",
        "MA": "MAR",
        "MZ": "MOZ",
        "MM": "MMR",
        "NA": "NAM",
        "NR": "NRU",
        "NP": "NPL",
        "NL": "NLD",
        "NZ": "NZL",
        "NI": "NIC",
        "NE": "NER",
        "NG": "NGA",
        "NO": "NOR",
        "OM": "OMN",
        "PK": "PAK",
        "PW": "PLW",
        "PA": "PAN",
        "PG": "PNG",
        "PY": "PRY",
        "PE": "PER",
        "PH": "PHL",
        "PL": "POL",
        "PT": "PRT",
        "QA": "QAT",
        "RO": "ROU",
        "RU": "RUS",
        "RW": "RWA",
        "WS": "WSM",
        "SM": "SMR",
        "ST": "STP",
        "SA": "SAU",
        "SN": "SEN",
        "RS": "SRB",
        "SC": "SYC",
        "SL": "SLE",
        "SG": "SGP",
        "SK": "SVK",
        "SI": "SVN",
        "SB": "SLB",
        "SO": "SOM",
        "ZA": "ZAF",
        "SS": "SSD",
        "ES": "ESP",
        "LK": "LKA",
        "SD": "SDN",
        "SR": "SUR",
        "SE": "SWE",
        "CH": "CHE",
        "SY": "SYR",
        "TW": "TWN",
        "TJ": "TJK",
        "TZ": "TZA",
        "TH": "THA",
        "TL": "TLS",
        "TG": "TGO",
        "TO": "TON",
        "TT": "TTO",
        "TN": "TUN",
        "TR": "TUR",
        "TM": "TKM",
        "TV": "TUV",
        "UG": "UGA",
        "UA": "UKR",
        "AE": "ARE",
        "GB": "GBR",
        "US": "USA",
        "UY": "URY",
        "UZ": "UZB",
        "VU": "VUT",
        "VE": "VEN",
        "VN": "VNM",
        "YE": "YEM",
        "ZM": "ZMB",
        "ZW": "ZWE"
    },
    "postCode": "W113JE",
    "mobile": null,
    "email": "demoagency@gmail.com",
    "permissions": null,
    "holidayPayMethod": "ROLLED_UP",
    "includeInTimesheetRate": false,
    "showHPEntitlement": false,
    "isSalarySacrifice": false,
    "showHPEmployerCostsYTD": false,
    "showEmployerBranding": false,
    "accrueEmploymentCosts": false,
    "payeFthManualAdjustment": false,
    "enableBenefits": false
}
Built with