The API uses REST. All data sent to it or received from it will be in a JSON format.
\nIf you want to clear the value you must pass an empty string as the value. missing properties or null values will be ignored to prevent data loss by customers that accidentally miss a field, maybe from having an older version of the API.
\nOther optional types can either be omitted completely or set to null.
\nThe API requires all requests to have an AuthToken Header with the customers unique token in each request or a 403 forbidden error will be thrown.
Please contact Hyperext support via support@hyperext.com to obtain your unique token if you do not already have it.
\nChanges to endpoint - api/employee to return error 404 on invalid employees
\nChanges to endpoint - api/employee/{employeeReference}/payments to return error 404 on invalid employees
\nChanges to endpoint - api/employee/{employeeReference}/deductions to return error 404 on invalid employees
\nChanges to endpoint - api/employee/{employeeReference}/absences to return error 404 on invalid employees
\nFix on endpoint - api/employee/{{id}}/payments to return correct reference of pay element after update
\nChanges to API user to disconnect after 15 seconds
\nPerformance & Reliability improvements across all endpoints
\nBug fixed on endpoint - api/employee
\nBug fixed on endpoint - api/allPayslips?TaxYearStart={{yyyy}}&TaxMonth={M}&TaxWeek={{WW}}
\nBug fixed on endpoint - api/employee
\nBug fixed on endpoint - api/department
\nBug fixed on endpoint - api/payment
\nBug fixed on endpoint - api/deduction/
\nBug fixed on endpoint - api/employee/{{id}}/deductions/
\nAdded field \"totalGrossTD\" to endpoint- api/payslips
\nAdded field \"taxGrossTD\" to endpoint- api/payslips
\nAdded endpoint - api/p45/{{WorksNumber}}
\nBug fixed on allPayslips endpoint
\nAdded field \"ssp\" to endpoint - api/payslips
\nAdded field \"smp\" to endpoint - api/payslips
\nAdded field \"employeePension\" to endpoint - api/payslips
\nAdded field \"studentLoan\" to endpoint - api/payslips
\nUpdate response for endpoint - api/payslips
\nAdded new endpoint - api/esubmissionLog
\nAdded field \"employeePensionTD\" to endpoint - api/payslips
\nAdded field \"employerPensionTD\" to endpoint - api/payslips
\nUpdate to support V28 of Payroll
\nAdded \"departmentRef\" field to endpoint - api/payslips
\nAdded “grossForNIC” field to endpoint - api/payslips
\nAdded “employerNIC” field to endpoint - api/payslips
\nFixed issue on endpoint - api/employee
\nAdded \"department\" new field to api/employee
\nAdded new endpoint - api/department
\nAdded new endpoint - api/paymentSummary1
\nAdded new endpoint - api/paymentSummary2
\nImplemented multi-company across all controllers and also ODBC
\nAdded P11 endpoint
\nDescription: Returns API Version.
\nEndpoint URL: api/version
Method: GET
Parameters: none
\nDescription: Returns Company Information.
\nEndpoint URL: api/company/
Method: GET
Parameters: none
\nDescription: Creates a new cost centre
\nURL: /api/costCentre
Method: POST
Parameters:
\ndescription // String, max 30 chars, required\nreference: // String, max 3 chars, required\n\nURL: /api/costCentre
Method: GET
Description: Lists all cost centres
\nParameters: none
\nDescription: Updates an existing cost centre
\nURL: /api/costCentre
Method: PATCH
Parameters:
\ndescription // String, max 30 chars, required\nreference: // String, max 3 chars, required\n\nDescription: Returns Departments
\nURL: api/department
Method: GET
Parameters: none
\nDescription: Creates new department
\nURL: api/department
Method: POST
Parameters:
\ninstanceReference // Int, max 2 chars, required\ndescription // String, max 30 chars, optional\nreference // String, max 3 chars, required\n\nDescription: Updates department
\nURL: api/department
Method: PATCH
Parameters:
\nindex // Int, max 2 chars, required\ninstanceReference // Int, max 2 chars, required\ndescription // String, max 30 chars, optional\nreference // String, max 3 chars, required\n\nDescription: Creates company payment
\nURL: /api/payment
Method: POST
Parameters:
\ndefaultHours // Double, max 8 chars, required\ndefaultRate // Double, max 8 chars, required\ndescription // String, max 30 chars, required\nemployerPays // Int, max 2 chars, required\nincludeIn12WeeksAverage // Int, max 2 chars 0=no 1=yes, required\nincludeInAutoAdvance // Int, max 2 chars 0=no 1=yes, required\nincludeInHolidayFundAccrual // Int, max 2 chars 0=no 1=yes, required\nreference // ONLY REQUIRED FOR PATCH\nstatus // ENUM, See Enums/Types below\nsubjectToAVC // Int, max 2 chars 0=no 1=yes, required\nsubjectToCCAEO // Int, max 2 chars 0=no 1=yes, required\nsubjectToCTAEO // Int, max 2 chars 0=no 1=yes, required\nsubjectToNI // Int, max 2 chars 0=no 1=yes, required\nsubjectToOtherAttachments // Int, max 2 chars 0=no 1=yes, required\nsubjectToPension // Int, max 2 chars 0=no 1=yes, required\nsubjectToTax // Int, max 2 chars 0=no 1=yes, required\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Read company payments
\nURL: /api/payment
Method: GET
Parameters: none
\nDescription: Updates company payment
\nURL: /api/payment
Method: PATCH
Parameters:
\ndefaultHours // Double, max 8 chars, required\ndefaultRate // Double, max 8 chars, required\ndescription // String, max 30 chars, required\nemployerPays // Int, max 2 chars, required\nincludeIn12WeeksAverage // Int, max 2 chars 0=no 1=yes, required\nincludeInAutoAdvance // Int, max 2 chars 0=no 1=yes, required\nincludeInHolidayFundAccrual // Int, max 2 chars 0=no 1=yes, required\nreference // ONLY REQUIRED FOR PATCH\nstatus // ENUM, See Enums/Types below\nsubjectToAVC // Int, max 2 chars 0=no 1=yes, required\nsubjectToCCAEO // Int, max 2 chars 0=no 1=yes, required\nsubjectToCTAEO // Int, max 2 chars 0=no 1=yes, required\nsubjectToNI // Int, max 2 chars 0=no 1=yes, required\nsubjectToOtherAttachments // Int, max 2 chars 0=no 1=yes, required\nsubjectToPension // Int, max 2 chars 0=no 1=yes, required\nsubjectToTax // Int, max 2 chars 0=no 1=yes, required\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Creates company deduction
\nURL: /api/deduction
Method: POST
Parameters:
\ndefaultHours // Double, max 8 chars, required\ndefaultRate // Double, max 8 chars, required\ndescription // String, max 30 chars, required\nemployerPays // Int, max 2 chars, required\nincludeIn12WeeksAverage // Int, max 2 chars 0=no 1=yes, required\nincludeInAutoAdvance // Int, max 2 chars 0=no 1=yes, required\nincludeInHolidayFundAccrual // Int, max 2 chars 0=no 1=yes, required\nreference // ONLY REQUIRED FOR PATCH\nstatus // ENUM, See Enums/Types below\nsubjectToAVC // Int, max 2 chars 0=no 1=yes, required\nsubjectToCCAEO // Int, max 2 chars 0=no 1=yes, required\nsubjectToCTAEO // Int, max 2 chars 0=no 1=yes, required\nsubjectToNI // Int, max 2 chars 0=no 1=yes, required\nsubjectToOtherAttachments // Int, max 2 chars 0=no 1=yes, required\nsubjectToPension // Int, max 2 chars 0=no 1=yes, required\nsubjectToTax // Int, max 2 chars 0=no 1=yes, required\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Read company deductions
\nURL: /api/deduction
Method: GET
Parameters: none
\nDescription: Updatescompany deduction
\nURL: /api/deduction
Method: POST
Parameters:
\ndefaultHours // Double, max 8 chars, required\ndefaultRate // Double, max 8 chars, required\ndescription // String, max 30 chars, required\nemployerPays // Int, max 2 chars, required\nincludeIn12WeeksAverage // Int, max 2 chars 0=no 1=yes, required\nincludeInAutoAdvance // Int, max 2 chars 0=no 1=yes, required\nincludeInHolidayFundAccrual // Int, max 2 chars 0=no 1=yes, required\nreference // ONLY REQUIRED FOR PATCH\nstatus // ENUM, See Enums/Types below\nsubjectToAVC // Int, max 2 chars 0=no 1=yes, required\nsubjectToCCAEO // Int, max 2 chars 0=no 1=yes, required\nsubjectToCTAEO // Int, max 2 chars 0=no 1=yes, required\nsubjectToNI // Int, max 2 chars 0=no 1=yes, required\nsubjectToOtherAttachments // Int, max 2 chars 0=no 1=yes, required\nsubjectToPension // Int, max 2 chars 0=no 1=yes, required\nsubjectToTax // Int, max 2 chars 0=no 1=yes, required\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Creates 1 new employee
\nURL: /api/employee
Method: POST
Parameters:
\ntitle // String, max 10 chars, required\nforename // String, max 30 chars, required\nsurname // String, max 30 chars, required\ndateOfBirth // Date (dd/mm/yyyy), max 8 chars, required\naddressLine1 // String, max 30 chars, optional\naddressLine2 // String, max 30 chars, optional\naddressLine3 // String, max 30 chars, optional\naddressLine4 // String, max 30 chars, optional\naddressLine5 // String, max 30 chars, optional\npostcode // String, max 8 chars, optional\ngender // Int, max 2 chars, required 0 = Male 1 = Female\ninitials // String, max 2 chars, required\nemailAddress // String, max 255 chars, optional\nmaritalStatus // Enum, see ENUMS/TYPES below\ngender // Int, max 2 chars, required\ndisabled // Int, 0 = no 1 = yes, optional\nethnicOrigin // String, max 30 chars, optional\ninitialForm // Enum, max 2 chars, optional\nnationality // String, max 30 chars, optional\nmobileTelephoneNumber // String, max 30 chars, optional\nemployeeJobTitle // String, max 50 chars, optional\njobTitle // String, max 30 chars, optional\nstartDate // Date (dd/mm/yyyy), max 8 chars, required\nendDate // Date (dd/mm/yyyy), max 8 chars, optional\npaymentFrequency // Enum, see ENUMS/TYPES below\npaymentMethod // Enum, see ENUMS/TYPES below\npayStatus // Enum, see ENUMS/TYPES below\nweeek1BasisFlag // Int, max 2 chars, optional\nweek1basicFlagPrevEmp // Bool, max 2 chars, optional\nworksNumber // String, max 30 chars, optional\ndirectorStatus // Int, max 2 chars, optional\ndepartment // Int, max 2 chars, optional \ncontact // String, max 30 chars, optional\ncontactRelationShip // String, max 30 chars, optional\ncontactTel // String, max 30 chars, optional\ncontactAddressLine1 // String, max 30 chars, optional\ncontactAddressLine2 // String, max 30 chars, optional\ncontactAddressLine3 // String, max 30 chars, optional\ncontactAddressLine4 // String, max 30 chars, optional\ncontactAddressLine5 // String, max 30 chars, optional\ncontactEmail // String, max 30 chars, optional\ncontactMobile // String, max 30 chars, optional\ncontactPostcode // String, max 30 chars, optional\nniCategory // Int, max 2 chars, optional\nniNumber // String, max 9 chars, optional\nNIContractedOutFlag // Int, max 2 chars, optional\ntaxCode // String, max 7 chars, optional\ntaxCodePrevEmp // String, max 9 chars, optional\np46StatementD // Bool, max 2 chars, optional\np46Statements // Enum, max 2 chars, optional\naccountNumber // String, max 8 chars, optional\nsortCode // String, max 8 chars, optional\naccountName // String, max 40 chars, optional\naccountType // String, max 8 chars, optional\nenterPaymentNotes // String, max 255 chars, optional\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\npublic enum payStatus\n{\n0 = Fortnightly\n1 = Four Weekly\n2 = Monthly\n3 = Weekly\n}\n\n\nDescripton: Returns all employees.
\nURL: /api/employee
Method: GET
Parameters: none
\nDescription: Updates 1 employee record
\nURL: /api/employee
Method: PATCH
Parameters: reference
\nreference // Int, max 2 chars, required\ntitle // String, max 10 chars, required\nforename // String, max 30 chars, required\nsurname // String, max 30 chars, required\ndateOfBirth // Date (dd/mm/yyyy), max 8 chars, required\naddressLine1 // String, max 30 chars, optional\naddressLine2 // String, max 30 chars, optional\naddressLine3 // String, max 30 chars, optional\naddressLine4 // String, max 30 chars, optional\naddressLine5 // String, max 30 chars, optional\npostcode // String, max 8 chars, optional\ngender // Int, max 2 chars, required 0 = Male 1 = Female\ninitials // String, max 2 chars, required\nemailAddress // String, max 255 chars, optional\nmaritalStatus // Enum, see ENUMS/TYPES below\ngender // Int, max 2 chars, required\ndisabled // Int, 0 = no 1 = yes, optional\nethnicOrigin // String, max 30 chars, optional\ninitialForm // Enum, max 2 chars, optional\nnationality // String, max 30 chars, optional\nmobileTelephoneNumber // String, max 30 chars, optional\nemployeeJobTitle // String, max 50 chars, optional\njobTitle // String, max 30 chars, optional\nstartDate // Date (dd/mm/yyyy), max 8 chars, required\nendDate // Date (dd/mm/yyyy), max 8 chars, optional\npaymentFrequency // Enum, see ENUMS/TYPES below\npaymentMethod // Enum, see ENUMS/TYPES below\npayStatus // Enum, see ENUMS/TYPES below\nweeek1BasisFlag // Int, max 2 chars, optional\nweek1basicFlagPrevEmp // Bool, max 2 chars, optional\nworksNumber // String, max 30 chars, optional\ndirectorStatus // Int, max 2 chars, optional\ndepartment // Int, max 2 chars, optional \ncontact // String, max 30 chars, optional\ncontactRelationShip // String, max 30 chars, optional\ncontactTel // String, max 30 chars, optional\ncontactAddressLine1 // String, max 30 chars, optional\ncontactAddressLine2 // String, max 30 chars, optional\ncontactAddressLine3 // String, max 30 chars, optional\ncontactAddressLine4 // String, max 30 chars, optional\ncontactAddressLine5 // String, max 30 chars, optional\ncontactEmail // String, max 30 chars, optional\ncontactMobile // String, max 30 chars, optional\ncontactPostcode // String, max 30 chars, optional\nniCategory // Int, max 2 chars, optional\nniNumber // String, max 9 chars, optional\nNIContractedOutFlag // Int, max 2 chars, optional\ntaxCode // String, max 7 chars, optional\ntaxCodePrevEmp // String, max 9 chars, optional\np46StatementD // Bool, max 2 chars, optional\np46Statements // Enum, max 2 chars, optional\naccountNumber // String, max 8 chars, optional\nsortCode // String, max 8 chars, optional\naccountName // String, max 40 chars, optional\naccountType // String, max 8 chars, optional\nenterPaymentNotes // String, max 255 chars, optional\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\npublic enum payStatus\n{\n0 = Fortnightly\n1 = Four Weekly\n2 = Monthly\n3 = Weekly\n}\n\n\nDescription: Creates new employee payment
\nURL: /api/employee/{employeeReference}/payments
Method: POST
Parameters:
\npaymentReference // Int, max 2 chars, required - Cant enter same reference that has already been used\nhours // Int, max 3 chars, required\nrate // Int, max 3 chars, optional - If you dont enter rate, it will use the default rate from the selected Pay Element to set the employee payment rate.\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Reads Employee Payments
\nURL: /api/employee/{employeeReference}/payments
Method: GET
Parameters: Employee Reference
\nDescription: Updates employee payment
\nURL: /api/employee/{employeeReference}/payments
Method: PATCH
Parameters:
\npaymentReference // Int, max 2 chars, required - Cant enter same reference that has already been used\nhours // Int, max 3 chars, required\nrate // Int, max 1 char, optional - If you dont enter rate, it will use the default rate from the selected Pay Element to set the employee payment rate.\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Creates new employee deduction
\nURL: /api/employee/{employeeReference}/deductions
Method: POST
Parameters:
\npaymentReference // Int, required\nhours // Int, required\nRate // double, required\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Reads Employee Deductions
\nURL: /api/employee/{employeeReference}/deductions
Method: GET
Parameters: Employee Reference
\nDescription: Updatesemployee deduction
\nURL: /api/employee/{employeeReference}/deductions
Method: PATCH
Parameters:
\npaymentReference // Int, required\nhours // Int, required\nRate // double, required\n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Creates a new absence record for the employee
\nURL: /api/employee/{employeeReference}/absences
Method: POST
Parameters:
\nabsenceCode // Int, max 2 chars, required\ncomment // String, max 30 chars, optional\nabsenceStartDate // Date (dd/mm/yyyy), max 8 chars, required\nabsenceEndDate // Date (dd/mm/yyyy), max 8 chars, required\nhalfDayType // Int, max 2 chars, required \n\npublic enum eAbsenceCode\n{\n SspWaitingDay = 0,\n SspQualifyingDay = 1,\n SspNonQualifyingDay = 2,\n SspGeneral = 3,\n SspWithheld = 4,\n HolidayTaken = 5,\n HolidayBooked = 6,\n Authorised = 7,\n Unauthorised = 8,\n Medical = 9,\n Educational = 10,\n Compassionate = 11,\n Maternity = 12,\n Paternity = 13,\n JuryService = 14,\n Suspension = 15,\n Punctuality = 16,\n Custom1 = 17,\n Custom2 = 18,\n Custom3 = 19,\n Custom4 = 20,\n Custom5 = 21,\n Custom6 = 22,\n Custom7 = 23,\n Custom8 = 24,\n Custom9 = 25\n}\npublic enum eHalfDayType\n{\n FullDay = 0,\n Morning = 1,\n Afternoon = 2\n}\npublic enum eBankAccountType\n{\n BankAccount = 0,\n BuildingSocietyAccount = 1\n}\npublic enum eP46StatementsSelected\n{\n NoneSelected = 0,\n AOnly = 1,\n AandB_or_AandD = 2,\n BOnly = 3,\n BandC_or_BandD = 4,\n COnly = 5,\n AandC_or_CandD = 6\n}\npublic enum eInitialForm\n{\n NoForm = 0,\n P45 = 1,\n P46 = 2\n}\npublic enum eNICategory\n{\n A = 0,\n B = 1,\n C = 2,\n D = 3,\n E = 4,\n F = 5,\n G = 6,\n H = 7,\n I = 8,\n J = 9,\n K = 10,\n L = 11,\n M = 12,\n S = 13,\n X = 14,\n Z = 15\n}\npublic enum eGender\n{\n Male = 0,\n Female = 1\n}\npublic enum eEmploymentStatus\n{\n OK = 0,\n OnHold = 1,\n TradeDispute = 2,\n NoPay = 3\n}\npublic enum ePaymentMethod\n{\n BACS = 0,\n Cash = 1,\n Cheque = 2,\n CreditTransfer = 3,\n DirectBACS = 4,\n SagePayments = 5\n}\npublic enum eMaritalStatus\n{\n Single = 0,\n Married = 1,\n Divorced = 2,\n Widowed = 3,\n CivilPartnership = 4,\n OtherStatus = 5\n}\npublic enum ePaymentType\n{\n Variable = 0,\n Fixed = 1,\n Global = 2\n}\npublic enum eEmployerPays\n{\n Neither = 0,\n PAYE = 1,\n Both = 2\n}\n\nDescription: Gets a list of absences for an employee
\nURL: /api/employee/{employeeReference}/absences
Method: GET
Parameters: employee reference
\nDescription: Reads Latest Payslips
\nEndpoint URL: api/payslips
Method: GET
Parameters: none
\nDescription: Read Payment Summary Part 1
\nEndpoint URL: api/paymentSummary1
Method: GET
Parameters: none
\nDescription: Read Payment Summary Part 2
\nEndpoint URL: api/paymentSummary2
Method: GET
Parameters: none
\nDescription: Read's P11.
\nEndpoint URL: api/reportP11Summary
Method: GET
Parameters: none
\nNote: Will return current Year To Date totals for all employees who have been paid in the current Tax Year.
\nDescription: Searches P32.
\nEndpoint URL: api/searchP32
Method: POST
Parameters: none
\nDescription: Reads FPS Record
\nEndpoint URL: api/esubmissionLog
Method: GET
Note: Returns 10 most recent submission logs.
\nDescription: Gets Payslips By Tax Year
\nEndpoint URL: api/allPayslips/{year}
Method: GET
Notes:
\nRequires a tax year start as parameter (eg: api/allPayslips/2021)
\nLarge JSON return that lists all payslips for that given year ordered by customer reference
\nDescription: Gets Payslips By Tax Year
\nEndpoint URL: api/allPayslips?TaxYearStart={{yyyy}}&TaxMonth={M}&TaxWeek={{WW}}
Method: GET
Notes:
\nDescription: Reads P45
\nEndpoint URL: api/api/p45/{{WorksNumber}}
Method: GET
Parameters: worksNumber
\n