naftiko: 1.0.0-alpha2 info: label: Xero Payroll UK — PayrollUk description: 'Xero Payroll UK — PayrollUk. 69 operations. Lead operation: Retrieves employee benefits. Self-contained Naftiko capability covering one Xero business surface.' tags: - Xero - PayrollUk created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: XERO_API_KEY: XERO_API_KEY capability: consumes: - type: http namespace: payroll-uk-payrolluk baseUri: https://api.xero.com/payroll.xro/2.0 description: Xero Payroll UK — PayrollUk business capability. Self-contained, no shared references. resources: - name: Benefits path: /Benefits operations: - name: getbenefits method: GET description: Retrieves employee benefits outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: createbenefit method: POST description: Creates a new employee benefit outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Benefits-id path: /Benefits/{id} operations: - name: getbenefit method: GET description: Retrieves a specific benefit by using a unique benefit ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifier for the benefit required: true - name: Deductions path: /Deductions operations: - name: getdeductions method: GET description: Retrieves deductions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: creatededuction method: POST description: Creates a new deduction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Deductions-deductionId path: /Deductions/{deductionId} operations: - name: getdeduction method: GET description: Retrieves a specific deduction by using a unique deduction ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: deductionId in: path type: string description: Identifier for the deduction required: true - name: EarningsOrders path: /EarningsOrders operations: - name: getearningsorders method: GET description: Retrieves earnings orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: EarningsOrders-id path: /EarningsOrders/{id} operations: - name: getearningsorder method: GET description: Retrieves a specific earnings orders by using a unique earnings orders id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifier for the deduction required: true - name: EarningsRates path: /EarningsRates operations: - name: getearningsrates method: GET description: Retrieves earnings rates outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: createearningsrate method: POST description: Creates a new earnings rate outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: EarningsRates-EarningsRateID path: /EarningsRates/{EarningsRateID} operations: - name: getearningsrate method: GET description: Retrieves a specific earnings rates by using a unique earnings rate id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EarningsRateID in: path type: string description: Identifier for the earnings rate required: true - name: Employees path: /Employees operations: - name: getemployees method: GET description: Retrieves employees outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: filter in: query type: string description: Filter by first name, lastname, and/or whether they are an off-payroll worker - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: createemployee method: POST description: Creates employees outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID path: /Employees/{EmployeeID} operations: - name: getemployee method: GET description: Retrieves specific employees by using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: updateemployee method: PUT description: Updates a specific employee's detail outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID-Employment path: /Employees/{EmployeeID}/Employment operations: - name: createemployment method: POST description: Creates employment detail for a specific employee using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID-Leave path: /Employees/{EmployeeID}/Leave operations: - name: getemployeeleaves method: GET description: Retrieves a specific employee's leave records using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: createemployeeleave method: POST description: Creates leave records for a specific employee outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID-Leave-LeaveID path: /Employees/{EmployeeID}/Leave/{LeaveID} operations: - name: getemployeeleave method: GET description: Retrieves a specific employee's leave record using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: LeaveID in: path type: string description: Leave id for single object required: true - name: updateemployeeleave method: PUT description: Updates a specific employee's leave records outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: LeaveID in: path type: string description: Leave id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: deleteemployeeleave method: DELETE description: Deletes a specific employee's leave record outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: LeaveID in: path type: string description: Leave id for single object required: true - name: Employees-EmployeeID-LeaveBalances path: /Employees/{EmployeeID}/LeaveBalances operations: - name: getemployeeleavebalances method: GET description: Retrieves a specific employee's leave balances using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: Employees-EmployeeID-LeavePeriods path: /Employees/{EmployeeID}/LeavePeriods operations: - name: getemployeeleaveperiods method: GET description: Retrieves a specific employee's leave periods using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: startDate in: query type: string description: Filter by start date - name: endDate in: query type: string description: Filter by end date - name: Employees-EmployeeID-LeaveTypes path: /Employees/{EmployeeID}/LeaveTypes operations: - name: getemployeeleavetypes method: GET description: Retrieves a specific employee's leave types using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: createemployeeleavetype method: POST description: Creates employee leave type records outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID-PayTemplates path: /Employees/{EmployeeID}/PayTemplates operations: - name: getemployeepaytemplate method: GET description: Retrieves a specific employee pay templates using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: Employees-EmployeeID-PayTemplates-earnings path: /Employees/{EmployeeID}/PayTemplates/earnings operations: - name: createemployeeearningstemplate method: POST description: Creates an earnings template records for a specific employee outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID-PayTemplates-earnings-PayTemplateEarningID path: /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} operations: - name: updateemployeeearningstemplate method: PUT description: Updates a specific employee's earnings template records outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: PayTemplateEarningID in: path type: string description: Id for single pay template earnings object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: deleteemployeeearningstemplate method: DELETE description: Deletes a specific employee's earnings template record outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: PayTemplateEarningID in: path type: string description: Id for single pay template earnings object required: true - name: Employees-EmployeeID-PaymentMethods path: /Employees/{EmployeeID}/PaymentMethods operations: - name: getemployeepaymentmethod method: GET description: Retrieves a specific employee's payment method using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: createemployeepaymentmethod method: POST description: Creates an employee payment method outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID-SalaryAndWages path: /Employees/{EmployeeID}/SalaryAndWages operations: - name: getemployeesalaryandwages method: GET description: Retrieves a specific employee's salary and wages by using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: createemployeesalaryandwage method: POST description: Creates a salary and wage record for a specific employee outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID-SalaryAndWages-SalaryAndWagesID path: /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} operations: - name: getemployeesalaryandwage method: GET description: Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: SalaryAndWagesID in: path type: string description: Id for single pay template earnings object required: true - name: updateemployeesalaryandwage method: PUT description: Updates salary and wages record for a specific employee outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: SalaryAndWagesID in: path type: string description: Id for single pay template earnings object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: deleteemployeesalaryandwage method: DELETE description: Deletes a salary and wages record for a specific employee outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: SalaryAndWagesID in: path type: string description: Id for single salary and wages object required: true - name: Employees-EmployeeID-StatutoryLeaveBalance path: /Employees/{EmployeeID}/StatutoryLeaveBalance operations: - name: getemployeestatutoryleavebalances method: GET description: Retrieves a specific employee's leave balances using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: LeaveType in: query type: string description: Filter by the type of statutory leave - name: AsOfDate in: query type: string description: The date from which to calculate balance remaining. If not specified, current date UTC is used. - name: Employees-EmployeeID-Tax path: /Employees/{EmployeeID}/Tax operations: - name: getemployeetax method: GET description: Retrieves tax records for a specific employee using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: Employees-EmployeeID-paytemplateearnings path: /Employees/{EmployeeID}/paytemplateearnings operations: - name: createmultipleemployeeearningstemplate method: POST description: Creates multiple earnings template records for a specific employee using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Employees-EmployeeID-ukopeningbalances path: /Employees/{EmployeeID}/ukopeningbalances operations: - name: getemployeeopeningbalances method: GET description: Retrieves a specific employee's openingbalances using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: createemployeeopeningbalances method: POST description: Creates an opening balance for a specific employee outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: updateemployeeopeningbalances method: PUT description: Updates a specific employee's opening balances outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: body in: body type: object description: Request body (JSON). required: true - name: LeaveTypes path: /LeaveTypes operations: - name: getleavetypes method: GET description: Retrieves leave types outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: ActiveOnly in: query type: boolean description: Filters leave types by active status. By default the API returns all leave types. - name: createleavetype method: POST description: Creates a new leave type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: LeaveTypes-LeaveTypeID path: /LeaveTypes/{LeaveTypeID} operations: - name: getleavetype method: GET description: Retrieves a specific leave type by using a unique leave type ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: LeaveTypeID in: path type: string description: Identifier for the leave type required: true - name: PayRunCalendars path: /PayRunCalendars operations: - name: getpayruncalendars method: GET description: Retrieves payrun calendars outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: createpayruncalendar method: POST description: Creates a new payrun calendar outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: PayRunCalendars-PayRunCalendarID path: /PayRunCalendars/{PayRunCalendarID} operations: - name: getpayruncalendar method: GET description: Retrieves a specific payrun calendar by using a unique payrun calendar ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: PayRunCalendarID in: path type: string description: Identifier for the payrun calendars required: true - name: PayRuns path: /PayRuns operations: - name: getpayruns method: GET description: Retrieves pay runs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: status in: query type: string description: By default get payruns will return all the payruns for an organization. You can add GET https://api.xero.com/payroll.xro/2.0/payRuns?statu={PayRunStatus} to fil - name: PayRuns-PayRunID path: /PayRuns/{PayRunID} operations: - name: getpayrun method: GET description: Retrieves a specific pay run by using a unique pay run ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: PayRunID in: path type: string description: Identifier for the pay run required: true - name: Payslips path: /Payslips operations: - name: getpayslips method: GET description: Retrieves payslips outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: PayRunID in: query type: string description: PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun. required: true - name: Payslips-PayslipID path: /Payslips/{PayslipID} operations: - name: getpayslip method: GET description: Retrieves a specific payslip by using a unique payslip ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: PayslipID in: path type: string description: Identifier for the payslip required: true - name: Reimbursements path: /Reimbursements operations: - name: getreimbursements method: GET description: Retrieves reimbursements outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: createreimbursement method: POST description: Creates a new reimbursement outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Reimbursements-ReimbursementID path: /Reimbursements/{ReimbursementID} operations: - name: getreimbursement method: GET description: Retrieves a specific reimbursement by using a unique reimbursement id outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ReimbursementID in: path type: string description: Identifier for the reimbursement required: true - name: Settings path: /Settings operations: - name: getsettings method: GET description: Retrieves payroll settings outputRawFormat: json outputParameters: - name: result type: object value: $. - name: Settings-trackingCategories path: /Settings/trackingCategories operations: - name: gettrackingcategories method: GET description: Retrieves tracking categories outputRawFormat: json outputParameters: - name: result type: object value: $. - name: StatutoryLeaves-Sick path: /StatutoryLeaves/Sick operations: - name: createemployeestatutorysickleave method: POST description: Creates statutory sick leave records outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: StatutoryLeaves-Sick-StatutorySickLeaveID path: /StatutoryLeaves/Sick/{StatutorySickLeaveID} operations: - name: getemployeestatutorysickleave method: GET description: Retrieves a statutory sick leave for an employee outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: StatutorySickLeaveID in: path type: string description: Statutory sick leave id for single object required: true - name: StatutoryLeaves-Summary-EmployeeID path: /StatutoryLeaves/Summary/{EmployeeID} operations: - name: getstatutoryleavesummary method: GET description: Retrieves a specific employee's summary of statutory leaves using a unique employee ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: EmployeeID in: path type: string description: Employee id for single object required: true - name: activeOnly in: query type: boolean description: Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned - name: Timesheets path: /Timesheets operations: - name: gettimesheets method: GET description: Retrieves timesheets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: Page number which specifies the set of records to retrieve. By default the number of the records per set is 100. - name: filter in: query type: string description: Filter by employeeId and/or payrollCalendarId - name: status in: query type: string description: filter results by any timesheets with a matching timesheet status - name: startDate in: query type: string description: filter results by any timesheets with a startDate on or after the provided date - name: endDate in: query type: string description: filter results by any timesheets with a endDate on or before the provided date - name: sort in: query type: string description: sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to rever - name: createtimesheet method: POST description: Creates a new timesheet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: Timesheets-TimesheetID path: /Timesheets/{TimesheetID} operations: - name: gettimesheet method: GET description: Retrieve a specific timesheet by using a unique timesheet ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: TimesheetID in: path type: string description: Identifier for the timesheet required: true - name: deletetimesheet method: DELETE description: Deletes a specific timesheet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: TimesheetID in: path type: string description: Identifier for the timesheet required: true - name: Timesheets-TimesheetID-Approve path: /Timesheets/{TimesheetID}/Approve operations: - name: approvetimesheet method: POST description: Approves a specific timesheet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: TimesheetID in: path type: string description: Identifier for the timesheet required: true - name: Timesheets-TimesheetID-Lines path: /Timesheets/{TimesheetID}/Lines operations: - name: createtimesheetline method: POST description: Creates a new timesheet line for a specific timesheet using a unique timesheet ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: TimesheetID in: path type: string description: Identifier for the timesheet required: true - name: body in: body type: object description: Request body (JSON). required: true - name: Timesheets-TimesheetID-Lines-TimesheetLineID path: /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} operations: - name: updatetimesheetline method: PUT description: Updates a specific timesheet line for a specific timesheet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: TimesheetID in: path type: string description: Identifier for the timesheet required: true - name: TimesheetLineID in: path type: string description: Identifier for the timesheet line required: true - name: body in: body type: object description: Request body (JSON). required: true - name: deletetimesheetline method: DELETE description: Deletes a specific timesheet line outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: TimesheetID in: path type: string description: Identifier for the timesheet required: true - name: TimesheetLineID in: path type: string description: Identifier for the timesheet line required: true - name: Timesheets-TimesheetID-RevertToDraft path: /Timesheets/{TimesheetID}/RevertToDraft operations: - name: reverttimesheet method: POST description: Reverts a specific timesheet to draft outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: TimesheetID in: path type: string description: Identifier for the timesheet required: true authentication: type: bearer token: '{{env.XERO_API_KEY}}' exposes: - type: rest namespace: payroll-uk-payrolluk-rest port: 8080 description: REST adapter for Xero Payroll UK — PayrollUk. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/benefits name: benefits description: REST surface for Benefits. operations: - method: GET name: getbenefits description: Retrieves employee benefits call: payroll-uk-payrolluk.getbenefits with: page: rest.page outputParameters: - type: object mapping: $. - method: POST name: createbenefit description: Creates a new employee benefit call: payroll-uk-payrolluk.createbenefit with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/benefits/{id} name: benefits-id description: REST surface for Benefits-id. operations: - method: GET name: getbenefit description: Retrieves a specific benefit by using a unique benefit ID call: payroll-uk-payrolluk.getbenefit with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/deductions name: deductions description: REST surface for Deductions. operations: - method: GET name: getdeductions description: Retrieves deductions call: payroll-uk-payrolluk.getdeductions with: page: rest.page outputParameters: - type: object mapping: $. - method: POST name: creatededuction description: Creates a new deduction call: payroll-uk-payrolluk.creatededuction with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/deductions/{deductionid} name: deductions-deductionid description: REST surface for Deductions-deductionId. operations: - method: GET name: getdeduction description: Retrieves a specific deduction by using a unique deduction ID call: payroll-uk-payrolluk.getdeduction with: deductionId: rest.deductionId outputParameters: - type: object mapping: $. - path: /v1/earningsorders name: earningsorders description: REST surface for EarningsOrders. operations: - method: GET name: getearningsorders description: Retrieves earnings orders call: payroll-uk-payrolluk.getearningsorders with: page: rest.page outputParameters: - type: object mapping: $. - path: /v1/earningsorders/{id} name: earningsorders-id description: REST surface for EarningsOrders-id. operations: - method: GET name: getearningsorder description: Retrieves a specific earnings orders by using a unique earnings orders id call: payroll-uk-payrolluk.getearningsorder with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/earningsrates name: earningsrates description: REST surface for EarningsRates. operations: - method: GET name: getearningsrates description: Retrieves earnings rates call: payroll-uk-payrolluk.getearningsrates with: page: rest.page outputParameters: - type: object mapping: $. - method: POST name: createearningsrate description: Creates a new earnings rate call: payroll-uk-payrolluk.createearningsrate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/earningsrates/{earningsrateid} name: earningsrates-earningsrateid description: REST surface for EarningsRates-EarningsRateID. operations: - method: GET name: getearningsrate description: Retrieves a specific earnings rates by using a unique earnings rate id call: payroll-uk-payrolluk.getearningsrate with: EarningsRateID: rest.EarningsRateID outputParameters: - type: object mapping: $. - path: /v1/employees name: employees description: REST surface for Employees. operations: - method: GET name: getemployees description: Retrieves employees call: payroll-uk-payrolluk.getemployees with: filter: rest.filter page: rest.page outputParameters: - type: object mapping: $. - method: POST name: createemployee description: Creates employees call: payroll-uk-payrolluk.createemployee with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid} name: employees-employeeid description: REST surface for Employees-EmployeeID. operations: - method: GET name: getemployee description: Retrieves specific employees by using a unique employee ID call: payroll-uk-payrolluk.getemployee with: EmployeeID: rest.EmployeeID outputParameters: - type: object mapping: $. - method: PUT name: updateemployee description: Updates a specific employee's detail call: payroll-uk-payrolluk.updateemployee with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/employment name: employees-employeeid-employment description: REST surface for Employees-EmployeeID-Employment. operations: - method: POST name: createemployment description: Creates employment detail for a specific employee using a unique employee ID call: payroll-uk-payrolluk.createemployment with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/leave name: employees-employeeid-leave description: REST surface for Employees-EmployeeID-Leave. operations: - method: GET name: getemployeeleaves description: Retrieves a specific employee's leave records using a unique employee ID call: payroll-uk-payrolluk.getemployeeleaves with: EmployeeID: rest.EmployeeID outputParameters: - type: object mapping: $. - method: POST name: createemployeeleave description: Creates leave records for a specific employee call: payroll-uk-payrolluk.createemployeeleave with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/leave/{leaveid} name: employees-employeeid-leave-leaveid description: REST surface for Employees-EmployeeID-Leave-LeaveID. operations: - method: GET name: getemployeeleave description: Retrieves a specific employee's leave record using a unique employee ID call: payroll-uk-payrolluk.getemployeeleave with: EmployeeID: rest.EmployeeID LeaveID: rest.LeaveID outputParameters: - type: object mapping: $. - method: PUT name: updateemployeeleave description: Updates a specific employee's leave records call: payroll-uk-payrolluk.updateemployeeleave with: EmployeeID: rest.EmployeeID LeaveID: rest.LeaveID body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteemployeeleave description: Deletes a specific employee's leave record call: payroll-uk-payrolluk.deleteemployeeleave with: EmployeeID: rest.EmployeeID LeaveID: rest.LeaveID outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/leavebalances name: employees-employeeid-leavebalances description: REST surface for Employees-EmployeeID-LeaveBalances. operations: - method: GET name: getemployeeleavebalances description: Retrieves a specific employee's leave balances using a unique employee ID call: payroll-uk-payrolluk.getemployeeleavebalances with: EmployeeID: rest.EmployeeID outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/leaveperiods name: employees-employeeid-leaveperiods description: REST surface for Employees-EmployeeID-LeavePeriods. operations: - method: GET name: getemployeeleaveperiods description: Retrieves a specific employee's leave periods using a unique employee ID call: payroll-uk-payrolluk.getemployeeleaveperiods with: EmployeeID: rest.EmployeeID startDate: rest.startDate endDate: rest.endDate outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/leavetypes name: employees-employeeid-leavetypes description: REST surface for Employees-EmployeeID-LeaveTypes. operations: - method: GET name: getemployeeleavetypes description: Retrieves a specific employee's leave types using a unique employee ID call: payroll-uk-payrolluk.getemployeeleavetypes with: EmployeeID: rest.EmployeeID outputParameters: - type: object mapping: $. - method: POST name: createemployeeleavetype description: Creates employee leave type records call: payroll-uk-payrolluk.createemployeeleavetype with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/paytemplates name: employees-employeeid-paytemplates description: REST surface for Employees-EmployeeID-PayTemplates. operations: - method: GET name: getemployeepaytemplate description: Retrieves a specific employee pay templates using a unique employee ID call: payroll-uk-payrolluk.getemployeepaytemplate with: EmployeeID: rest.EmployeeID outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/paytemplates/earnings name: employees-employeeid-paytemplates-earnings description: REST surface for Employees-EmployeeID-PayTemplates-earnings. operations: - method: POST name: createemployeeearningstemplate description: Creates an earnings template records for a specific employee call: payroll-uk-payrolluk.createemployeeearningstemplate with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/paytemplates/earnings/{paytemplateearningid} name: employees-employeeid-paytemplates-earnings-paytemplateearningid description: REST surface for Employees-EmployeeID-PayTemplates-earnings-PayTemplateEarningID. operations: - method: PUT name: updateemployeeearningstemplate description: Updates a specific employee's earnings template records call: payroll-uk-payrolluk.updateemployeeearningstemplate with: EmployeeID: rest.EmployeeID PayTemplateEarningID: rest.PayTemplateEarningID body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteemployeeearningstemplate description: Deletes a specific employee's earnings template record call: payroll-uk-payrolluk.deleteemployeeearningstemplate with: EmployeeID: rest.EmployeeID PayTemplateEarningID: rest.PayTemplateEarningID outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/paymentmethods name: employees-employeeid-paymentmethods description: REST surface for Employees-EmployeeID-PaymentMethods. operations: - method: GET name: getemployeepaymentmethod description: Retrieves a specific employee's payment method using a unique employee ID call: payroll-uk-payrolluk.getemployeepaymentmethod with: EmployeeID: rest.EmployeeID outputParameters: - type: object mapping: $. - method: POST name: createemployeepaymentmethod description: Creates an employee payment method call: payroll-uk-payrolluk.createemployeepaymentmethod with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/salaryandwages name: employees-employeeid-salaryandwages description: REST surface for Employees-EmployeeID-SalaryAndWages. operations: - method: GET name: getemployeesalaryandwages description: Retrieves a specific employee's salary and wages by using a unique employee ID call: payroll-uk-payrolluk.getemployeesalaryandwages with: EmployeeID: rest.EmployeeID page: rest.page outputParameters: - type: object mapping: $. - method: POST name: createemployeesalaryandwage description: Creates a salary and wage record for a specific employee call: payroll-uk-payrolluk.createemployeesalaryandwage with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/salaryandwages/{salaryandwagesid} name: employees-employeeid-salaryandwages-salaryandwagesid description: REST surface for Employees-EmployeeID-SalaryAndWages-SalaryAndWagesID. operations: - method: GET name: getemployeesalaryandwage description: Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id call: payroll-uk-payrolluk.getemployeesalaryandwage with: EmployeeID: rest.EmployeeID SalaryAndWagesID: rest.SalaryAndWagesID outputParameters: - type: object mapping: $. - method: PUT name: updateemployeesalaryandwage description: Updates salary and wages record for a specific employee call: payroll-uk-payrolluk.updateemployeesalaryandwage with: EmployeeID: rest.EmployeeID SalaryAndWagesID: rest.SalaryAndWagesID body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteemployeesalaryandwage description: Deletes a salary and wages record for a specific employee call: payroll-uk-payrolluk.deleteemployeesalaryandwage with: EmployeeID: rest.EmployeeID SalaryAndWagesID: rest.SalaryAndWagesID outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/statutoryleavebalance name: employees-employeeid-statutoryleavebalance description: REST surface for Employees-EmployeeID-StatutoryLeaveBalance. operations: - method: GET name: getemployeestatutoryleavebalances description: Retrieves a specific employee's leave balances using a unique employee ID call: payroll-uk-payrolluk.getemployeestatutoryleavebalances with: EmployeeID: rest.EmployeeID LeaveType: rest.LeaveType AsOfDate: rest.AsOfDate outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/tax name: employees-employeeid-tax description: REST surface for Employees-EmployeeID-Tax. operations: - method: GET name: getemployeetax description: Retrieves tax records for a specific employee using a unique employee ID call: payroll-uk-payrolluk.getemployeetax with: EmployeeID: rest.EmployeeID outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/paytemplateearnings name: employees-employeeid-paytemplateearnings description: REST surface for Employees-EmployeeID-paytemplateearnings. operations: - method: POST name: createmultipleemployeeearningstemplate description: Creates multiple earnings template records for a specific employee using a unique employee ID call: payroll-uk-payrolluk.createmultipleemployeeearningstemplate with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employees/{employeeid}/ukopeningbalances name: employees-employeeid-ukopeningbalances description: REST surface for Employees-EmployeeID-ukopeningbalances. operations: - method: GET name: getemployeeopeningbalances description: Retrieves a specific employee's openingbalances using a unique employee ID call: payroll-uk-payrolluk.getemployeeopeningbalances with: EmployeeID: rest.EmployeeID outputParameters: - type: object mapping: $. - method: POST name: createemployeeopeningbalances description: Creates an opening balance for a specific employee call: payroll-uk-payrolluk.createemployeeopeningbalances with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updateemployeeopeningbalances description: Updates a specific employee's opening balances call: payroll-uk-payrolluk.updateemployeeopeningbalances with: EmployeeID: rest.EmployeeID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/leavetypes name: leavetypes description: REST surface for LeaveTypes. operations: - method: GET name: getleavetypes description: Retrieves leave types call: payroll-uk-payrolluk.getleavetypes with: page: rest.page ActiveOnly: rest.ActiveOnly outputParameters: - type: object mapping: $. - method: POST name: createleavetype description: Creates a new leave type call: payroll-uk-payrolluk.createleavetype with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/leavetypes/{leavetypeid} name: leavetypes-leavetypeid description: REST surface for LeaveTypes-LeaveTypeID. operations: - method: GET name: getleavetype description: Retrieves a specific leave type by using a unique leave type ID call: payroll-uk-payrolluk.getleavetype with: LeaveTypeID: rest.LeaveTypeID outputParameters: - type: object mapping: $. - path: /v1/payruncalendars name: payruncalendars description: REST surface for PayRunCalendars. operations: - method: GET name: getpayruncalendars description: Retrieves payrun calendars call: payroll-uk-payrolluk.getpayruncalendars with: page: rest.page outputParameters: - type: object mapping: $. - method: POST name: createpayruncalendar description: Creates a new payrun calendar call: payroll-uk-payrolluk.createpayruncalendar with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payruncalendars/{payruncalendarid} name: payruncalendars-payruncalendarid description: REST surface for PayRunCalendars-PayRunCalendarID. operations: - method: GET name: getpayruncalendar description: Retrieves a specific payrun calendar by using a unique payrun calendar ID call: payroll-uk-payrolluk.getpayruncalendar with: PayRunCalendarID: rest.PayRunCalendarID outputParameters: - type: object mapping: $. - path: /v1/payruns name: payruns description: REST surface for PayRuns. operations: - method: GET name: getpayruns description: Retrieves pay runs call: payroll-uk-payrolluk.getpayruns with: page: rest.page status: rest.status outputParameters: - type: object mapping: $. - path: /v1/payruns/{payrunid} name: payruns-payrunid description: REST surface for PayRuns-PayRunID. operations: - method: GET name: getpayrun description: Retrieves a specific pay run by using a unique pay run ID call: payroll-uk-payrolluk.getpayrun with: PayRunID: rest.PayRunID outputParameters: - type: object mapping: $. - path: /v1/payslips name: payslips description: REST surface for Payslips. operations: - method: GET name: getpayslips description: Retrieves payslips call: payroll-uk-payrolluk.getpayslips with: page: rest.page PayRunID: rest.PayRunID outputParameters: - type: object mapping: $. - path: /v1/payslips/{payslipid} name: payslips-payslipid description: REST surface for Payslips-PayslipID. operations: - method: GET name: getpayslip description: Retrieves a specific payslip by using a unique payslip ID call: payroll-uk-payrolluk.getpayslip with: PayslipID: rest.PayslipID outputParameters: - type: object mapping: $. - path: /v1/reimbursements name: reimbursements description: REST surface for Reimbursements. operations: - method: GET name: getreimbursements description: Retrieves reimbursements call: payroll-uk-payrolluk.getreimbursements with: page: rest.page outputParameters: - type: object mapping: $. - method: POST name: createreimbursement description: Creates a new reimbursement call: payroll-uk-payrolluk.createreimbursement with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/reimbursements/{reimbursementid} name: reimbursements-reimbursementid description: REST surface for Reimbursements-ReimbursementID. operations: - method: GET name: getreimbursement description: Retrieves a specific reimbursement by using a unique reimbursement id call: payroll-uk-payrolluk.getreimbursement with: ReimbursementID: rest.ReimbursementID outputParameters: - type: object mapping: $. - path: /v1/settings name: settings description: REST surface for Settings. operations: - method: GET name: getsettings description: Retrieves payroll settings call: payroll-uk-payrolluk.getsettings outputParameters: - type: object mapping: $. - path: /v1/settings/trackingcategories name: settings-trackingcategories description: REST surface for Settings-trackingCategories. operations: - method: GET name: gettrackingcategories description: Retrieves tracking categories call: payroll-uk-payrolluk.gettrackingcategories outputParameters: - type: object mapping: $. - path: /v1/statutoryleaves/sick name: statutoryleaves-sick description: REST surface for StatutoryLeaves-Sick. operations: - method: POST name: createemployeestatutorysickleave description: Creates statutory sick leave records call: payroll-uk-payrolluk.createemployeestatutorysickleave with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/statutoryleaves/sick/{statutorysickleaveid} name: statutoryleaves-sick-statutorysickleaveid description: REST surface for StatutoryLeaves-Sick-StatutorySickLeaveID. operations: - method: GET name: getemployeestatutorysickleave description: Retrieves a statutory sick leave for an employee call: payroll-uk-payrolluk.getemployeestatutorysickleave with: StatutorySickLeaveID: rest.StatutorySickLeaveID outputParameters: - type: object mapping: $. - path: /v1/statutoryleaves/summary/{employeeid} name: statutoryleaves-summary-employeeid description: REST surface for StatutoryLeaves-Summary-EmployeeID. operations: - method: GET name: getstatutoryleavesummary description: Retrieves a specific employee's summary of statutory leaves using a unique employee ID call: payroll-uk-payrolluk.getstatutoryleavesummary with: EmployeeID: rest.EmployeeID activeOnly: rest.activeOnly outputParameters: - type: object mapping: $. - path: /v1/timesheets name: timesheets description: REST surface for Timesheets. operations: - method: GET name: gettimesheets description: Retrieves timesheets call: payroll-uk-payrolluk.gettimesheets with: page: rest.page filter: rest.filter status: rest.status startDate: rest.startDate endDate: rest.endDate sort: rest.sort outputParameters: - type: object mapping: $. - method: POST name: createtimesheet description: Creates a new timesheet call: payroll-uk-payrolluk.createtimesheet with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/timesheets/{timesheetid} name: timesheets-timesheetid description: REST surface for Timesheets-TimesheetID. operations: - method: GET name: gettimesheet description: Retrieve a specific timesheet by using a unique timesheet ID call: payroll-uk-payrolluk.gettimesheet with: TimesheetID: rest.TimesheetID outputParameters: - type: object mapping: $. - method: DELETE name: deletetimesheet description: Deletes a specific timesheet call: payroll-uk-payrolluk.deletetimesheet with: TimesheetID: rest.TimesheetID outputParameters: - type: object mapping: $. - path: /v1/timesheets/{timesheetid}/approve name: timesheets-timesheetid-approve description: REST surface for Timesheets-TimesheetID-Approve. operations: - method: POST name: approvetimesheet description: Approves a specific timesheet call: payroll-uk-payrolluk.approvetimesheet with: TimesheetID: rest.TimesheetID outputParameters: - type: object mapping: $. - path: /v1/timesheets/{timesheetid}/lines name: timesheets-timesheetid-lines description: REST surface for Timesheets-TimesheetID-Lines. operations: - method: POST name: createtimesheetline description: Creates a new timesheet line for a specific timesheet using a unique timesheet ID call: payroll-uk-payrolluk.createtimesheetline with: TimesheetID: rest.TimesheetID body: rest.body outputParameters: - type: object mapping: $. - path: /v1/timesheets/{timesheetid}/lines/{timesheetlineid} name: timesheets-timesheetid-lines-timesheetlineid description: REST surface for Timesheets-TimesheetID-Lines-TimesheetLineID. operations: - method: PUT name: updatetimesheetline description: Updates a specific timesheet line for a specific timesheet call: payroll-uk-payrolluk.updatetimesheetline with: TimesheetID: rest.TimesheetID TimesheetLineID: rest.TimesheetLineID body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletetimesheetline description: Deletes a specific timesheet line call: payroll-uk-payrolluk.deletetimesheetline with: TimesheetID: rest.TimesheetID TimesheetLineID: rest.TimesheetLineID outputParameters: - type: object mapping: $. - path: /v1/timesheets/{timesheetid}/reverttodraft name: timesheets-timesheetid-reverttodraft description: REST surface for Timesheets-TimesheetID-RevertToDraft. operations: - method: POST name: reverttimesheet description: Reverts a specific timesheet to draft call: payroll-uk-payrolluk.reverttimesheet with: TimesheetID: rest.TimesheetID outputParameters: - type: object mapping: $. - type: mcp namespace: payroll-uk-payrolluk-mcp port: 9090 transport: http description: MCP adapter for Xero Payroll UK — PayrollUk. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: retrieves-employee-benefits description: Retrieves employee benefits hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getbenefits with: page: tools.page outputParameters: - type: object mapping: $. - name: creates-new-employee-benefit description: Creates a new employee benefit hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createbenefit with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-benefit-using-unique description: Retrieves a specific benefit by using a unique benefit ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getbenefit with: id: tools.id outputParameters: - type: object mapping: $. - name: retrieves-deductions description: Retrieves deductions hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getdeductions with: page: tools.page outputParameters: - type: object mapping: $. - name: creates-new-deduction description: Creates a new deduction hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.creatededuction with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-deduction-using-unique description: Retrieves a specific deduction by using a unique deduction ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getdeduction with: deductionId: tools.deductionId outputParameters: - type: object mapping: $. - name: retrieves-earnings-orders description: Retrieves earnings orders hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getearningsorders with: page: tools.page outputParameters: - type: object mapping: $. - name: retrieves-specific-earnings-orders-using description: Retrieves a specific earnings orders by using a unique earnings orders id hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getearningsorder with: id: tools.id outputParameters: - type: object mapping: $. - name: retrieves-earnings-rates description: Retrieves earnings rates hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getearningsrates with: page: tools.page outputParameters: - type: object mapping: $. - name: creates-new-earnings-rate description: Creates a new earnings rate hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createearningsrate with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-earnings-rates-using description: Retrieves a specific earnings rates by using a unique earnings rate id hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getearningsrate with: EarningsRateID: tools.EarningsRateID outputParameters: - type: object mapping: $. - name: retrieves-employees description: Retrieves employees hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployees with: filter: tools.filter page: tools.page outputParameters: - type: object mapping: $. - name: creates-employees description: Creates employees hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployee with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-employees-using-unique description: Retrieves specific employees by using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployee with: EmployeeID: tools.EmployeeID outputParameters: - type: object mapping: $. - name: updates-specific-employee-s-detail description: Updates a specific employee's detail hints: readOnly: false destructive: false idempotent: true call: payroll-uk-payrolluk.updateemployee with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: creates-employment-detail-specific-employee description: Creates employment detail for a specific employee using a unique employee ID hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployment with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-leave-records description: Retrieves a specific employee's leave records using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeeleaves with: EmployeeID: tools.EmployeeID outputParameters: - type: object mapping: $. - name: creates-leave-records-specific-employee description: Creates leave records for a specific employee hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployeeleave with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-leave-record description: Retrieves a specific employee's leave record using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeeleave with: EmployeeID: tools.EmployeeID LeaveID: tools.LeaveID outputParameters: - type: object mapping: $. - name: updates-specific-employee-s-leave-records description: Updates a specific employee's leave records hints: readOnly: false destructive: false idempotent: true call: payroll-uk-payrolluk.updateemployeeleave with: EmployeeID: tools.EmployeeID LeaveID: tools.LeaveID body: tools.body outputParameters: - type: object mapping: $. - name: deletes-specific-employee-s-leave-record description: Deletes a specific employee's leave record hints: readOnly: false destructive: true idempotent: true call: payroll-uk-payrolluk.deleteemployeeleave with: EmployeeID: tools.EmployeeID LeaveID: tools.LeaveID outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-leave-balances description: Retrieves a specific employee's leave balances using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeeleavebalances with: EmployeeID: tools.EmployeeID outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-leave-periods description: Retrieves a specific employee's leave periods using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeeleaveperiods with: EmployeeID: tools.EmployeeID startDate: tools.startDate endDate: tools.endDate outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-leave-types description: Retrieves a specific employee's leave types using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeeleavetypes with: EmployeeID: tools.EmployeeID outputParameters: - type: object mapping: $. - name: creates-employee-leave-type-records description: Creates employee leave type records hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployeeleavetype with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-pay-templates description: Retrieves a specific employee pay templates using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeepaytemplate with: EmployeeID: tools.EmployeeID outputParameters: - type: object mapping: $. - name: creates-earnings-template-records-specific description: Creates an earnings template records for a specific employee hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployeeearningstemplate with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: updates-specific-employee-s-earnings-template description: Updates a specific employee's earnings template records hints: readOnly: false destructive: false idempotent: true call: payroll-uk-payrolluk.updateemployeeearningstemplate with: EmployeeID: tools.EmployeeID PayTemplateEarningID: tools.PayTemplateEarningID body: tools.body outputParameters: - type: object mapping: $. - name: deletes-specific-employee-s-earnings-template description: Deletes a specific employee's earnings template record hints: readOnly: false destructive: true idempotent: true call: payroll-uk-payrolluk.deleteemployeeearningstemplate with: EmployeeID: tools.EmployeeID PayTemplateEarningID: tools.PayTemplateEarningID outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-payment-method description: Retrieves a specific employee's payment method using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeepaymentmethod with: EmployeeID: tools.EmployeeID outputParameters: - type: object mapping: $. - name: creates-employee-payment-method description: Creates an employee payment method hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployeepaymentmethod with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-salary-and description: Retrieves a specific employee's salary and wages by using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeesalaryandwages with: EmployeeID: tools.EmployeeID page: tools.page outputParameters: - type: object mapping: $. - name: creates-salary-and-wage-record description: Creates a salary and wage record for a specific employee hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployeesalaryandwage with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-salary-and-wages description: Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeesalaryandwage with: EmployeeID: tools.EmployeeID SalaryAndWagesID: tools.SalaryAndWagesID outputParameters: - type: object mapping: $. - name: updates-salary-and-wages-record description: Updates salary and wages record for a specific employee hints: readOnly: false destructive: false idempotent: true call: payroll-uk-payrolluk.updateemployeesalaryandwage with: EmployeeID: tools.EmployeeID SalaryAndWagesID: tools.SalaryAndWagesID body: tools.body outputParameters: - type: object mapping: $. - name: deletes-salary-and-wages-record description: Deletes a salary and wages record for a specific employee hints: readOnly: false destructive: true idempotent: true call: payroll-uk-payrolluk.deleteemployeesalaryandwage with: EmployeeID: tools.EmployeeID SalaryAndWagesID: tools.SalaryAndWagesID outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-leave-balances-2 description: Retrieves a specific employee's leave balances using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeestatutoryleavebalances with: EmployeeID: tools.EmployeeID LeaveType: tools.LeaveType AsOfDate: tools.AsOfDate outputParameters: - type: object mapping: $. - name: retrieves-tax-records-specific-employee description: Retrieves tax records for a specific employee using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeetax with: EmployeeID: tools.EmployeeID outputParameters: - type: object mapping: $. - name: creates-multiple-earnings-template-records description: Creates multiple earnings template records for a specific employee using a unique employee ID hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createmultipleemployeeearningstemplate with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-openingbalances-using description: Retrieves a specific employee's openingbalances using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeeopeningbalances with: EmployeeID: tools.EmployeeID outputParameters: - type: object mapping: $. - name: creates-opening-balance-specific-employee description: Creates an opening balance for a specific employee hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployeeopeningbalances with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: updates-specific-employee-s-opening-balances description: Updates a specific employee's opening balances hints: readOnly: false destructive: false idempotent: true call: payroll-uk-payrolluk.updateemployeeopeningbalances with: EmployeeID: tools.EmployeeID body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-leave-types description: Retrieves leave types hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getleavetypes with: page: tools.page ActiveOnly: tools.ActiveOnly outputParameters: - type: object mapping: $. - name: creates-new-leave-type description: Creates a new leave type hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createleavetype with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-leave-type-using description: Retrieves a specific leave type by using a unique leave type ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getleavetype with: LeaveTypeID: tools.LeaveTypeID outputParameters: - type: object mapping: $. - name: retrieves-payrun-calendars description: Retrieves payrun calendars hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getpayruncalendars with: page: tools.page outputParameters: - type: object mapping: $. - name: creates-new-payrun-calendar description: Creates a new payrun calendar hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createpayruncalendar with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-payrun-calendar-using description: Retrieves a specific payrun calendar by using a unique payrun calendar ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getpayruncalendar with: PayRunCalendarID: tools.PayRunCalendarID outputParameters: - type: object mapping: $. - name: retrieves-pay-runs description: Retrieves pay runs hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getpayruns with: page: tools.page status: tools.status outputParameters: - type: object mapping: $. - name: retrieves-specific-pay-run-using description: Retrieves a specific pay run by using a unique pay run ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getpayrun with: PayRunID: tools.PayRunID outputParameters: - type: object mapping: $. - name: retrieves-payslips description: Retrieves payslips hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getpayslips with: page: tools.page PayRunID: tools.PayRunID outputParameters: - type: object mapping: $. - name: retrieves-specific-payslip-using-unique description: Retrieves a specific payslip by using a unique payslip ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getpayslip with: PayslipID: tools.PayslipID outputParameters: - type: object mapping: $. - name: retrieves-reimbursements description: Retrieves reimbursements hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getreimbursements with: page: tools.page outputParameters: - type: object mapping: $. - name: creates-new-reimbursement description: Creates a new reimbursement hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createreimbursement with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-specific-reimbursement-using-unique description: Retrieves a specific reimbursement by using a unique reimbursement id hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getreimbursement with: ReimbursementID: tools.ReimbursementID outputParameters: - type: object mapping: $. - name: retrieves-payroll-settings description: Retrieves payroll settings hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getsettings outputParameters: - type: object mapping: $. - name: retrieves-tracking-categories description: Retrieves tracking categories hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.gettrackingcategories outputParameters: - type: object mapping: $. - name: creates-statutory-sick-leave-records description: Creates statutory sick leave records hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createemployeestatutorysickleave with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieves-statutory-sick-leave-employee description: Retrieves a statutory sick leave for an employee hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getemployeestatutorysickleave with: StatutorySickLeaveID: tools.StatutorySickLeaveID outputParameters: - type: object mapping: $. - name: retrieves-specific-employee-s-summary-statutory description: Retrieves a specific employee's summary of statutory leaves using a unique employee ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.getstatutoryleavesummary with: EmployeeID: tools.EmployeeID activeOnly: tools.activeOnly outputParameters: - type: object mapping: $. - name: retrieves-timesheets description: Retrieves timesheets hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.gettimesheets with: page: tools.page filter: tools.filter status: tools.status startDate: tools.startDate endDate: tools.endDate sort: tools.sort outputParameters: - type: object mapping: $. - name: creates-new-timesheet description: Creates a new timesheet hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createtimesheet with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieve-specific-timesheet-using-unique description: Retrieve a specific timesheet by using a unique timesheet ID hints: readOnly: true destructive: false idempotent: true call: payroll-uk-payrolluk.gettimesheet with: TimesheetID: tools.TimesheetID outputParameters: - type: object mapping: $. - name: deletes-specific-timesheet description: Deletes a specific timesheet hints: readOnly: false destructive: true idempotent: true call: payroll-uk-payrolluk.deletetimesheet with: TimesheetID: tools.TimesheetID outputParameters: - type: object mapping: $. - name: approves-specific-timesheet description: Approves a specific timesheet hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.approvetimesheet with: TimesheetID: tools.TimesheetID outputParameters: - type: object mapping: $. - name: creates-new-timesheet-line-specific description: Creates a new timesheet line for a specific timesheet using a unique timesheet ID hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.createtimesheetline with: TimesheetID: tools.TimesheetID body: tools.body outputParameters: - type: object mapping: $. - name: updates-specific-timesheet-line-specific description: Updates a specific timesheet line for a specific timesheet hints: readOnly: false destructive: false idempotent: true call: payroll-uk-payrolluk.updatetimesheetline with: TimesheetID: tools.TimesheetID TimesheetLineID: tools.TimesheetLineID body: tools.body outputParameters: - type: object mapping: $. - name: deletes-specific-timesheet-line description: Deletes a specific timesheet line hints: readOnly: false destructive: true idempotent: true call: payroll-uk-payrolluk.deletetimesheetline with: TimesheetID: tools.TimesheetID TimesheetLineID: tools.TimesheetLineID outputParameters: - type: object mapping: $. - name: reverts-specific-timesheet-draft description: Reverts a specific timesheet to draft hints: readOnly: false destructive: false idempotent: false call: payroll-uk-payrolluk.reverttimesheet with: TimesheetID: tools.TimesheetID outputParameters: - type: object mapping: $.