{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:xero-payroll-uk/get-employees":{"get":{"operationId":"finance_xero_payroll_uk_get_employees","summary":"Retrieves employees","description":"GET /Employees","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"filter","in":"query","required":false,"description":"Filter by first name, lastname, and/or whether they are an off-payroll worker","schema":{"type":"string","description":"Filter by first name, lastname, and/or whether they are an off-payroll worker"},"example":"firstName==John,lastName==Smith,isOffPayrollWorker==false"},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."},"example":5}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employee":{"post":{"operationId":"finance_xero_payroll_uk_create_employee","summary":"Creates employees","description":"POST /Employees","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee":{"get":{"operationId":"finance_xero_payroll_uk_get_employee","summary":"Retrieves specific employees by using a unique employee ID","description":"GET /Employees/{EmployeeID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/update-employee":{"post":{"operationId":"finance_xero_payroll_uk_update_employee","summary":"Updates a specific employee's detail","description":"PUT /Employees/{EmployeeID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employment":{"post":{"operationId":"finance_xero_payroll_uk_create_employment","summary":"Creates employment detail for a specific employee using a unique employee ID","description":"POST /Employees/{EmployeeID}/Employment","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-tax":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_tax","summary":"Retrieves tax records for a specific employee using a unique employee ID","description":"GET /Employees/{EmployeeID}/Tax","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-opening-balances":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_opening_balances","summary":"Retrieves a specific employee's openingbalances using a unique employee ID","description":"GET /Employees/{EmployeeID}/ukopeningbalances","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employee-opening-balances":{"post":{"operationId":"finance_xero_payroll_uk_create_employee_opening_balances","summary":"Creates an opening balance for a specific employee","description":"POST /Employees/{EmployeeID}/ukopeningbalances","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/update-employee-opening-balances":{"post":{"operationId":"finance_xero_payroll_uk_update_employee_opening_balances","summary":"Updates a specific employee's opening balances","description":"PUT /Employees/{EmployeeID}/ukopeningbalances","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-leaves":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_leaves","summary":"Retrieves a specific employee's leave records using a unique employee ID","description":"GET /Employees/{EmployeeID}/Leave","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employee-leave":{"post":{"operationId":"finance_xero_payroll_uk_create_employee_leave","summary":"Creates leave records for a specific employee","description":"POST /Employees/{EmployeeID}/Leave","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-leave":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_leave","summary":"Retrieves a specific employee's leave record using a unique employee ID","description":"GET /Employees/{EmployeeID}/Leave/{LeaveID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}},{"name":"LeaveID","in":"query","required":true,"description":"Leave id for single object","schema":{"type":"string","description":"Leave id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/update-employee-leave":{"post":{"operationId":"finance_xero_payroll_uk_update_employee_leave","summary":"Updates a specific employee's leave records","description":"PUT /Employees/{EmployeeID}/Leave/{LeaveID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","LeaveID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"LeaveID":{"type":"string","description":"Leave id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/delete-employee-leave":{"post":{"operationId":"finance_xero_payroll_uk_delete_employee_leave","summary":"Deletes a specific employee's leave record","description":"DELETE /Employees/{EmployeeID}/Leave/{LeaveID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","LeaveID"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"EmployeeID":{"type":"string","description":"Employee id for single object"},"LeaveID":{"type":"string","description":"Leave id for single object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-leave-balances":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_leave_balances","summary":"Retrieves a specific employee's leave balances using a unique employee ID","description":"GET /Employees/{EmployeeID}/LeaveBalances","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-statutory-leave-balances":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_statutory_leave_balances","summary":"Retrieves a specific employee's leave balances using a unique employee ID","description":"GET /Employees/{EmployeeID}/StatutoryLeaveBalance","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}},{"name":"LeaveType","in":"query","required":false,"description":"Filter by the type of statutory leave","schema":{"type":"string","description":"Filter by the type of statutory leave"},"example":"sick"},{"name":"AsOfDate","in":"query","required":false,"description":"The date from which to calculate balance remaining. If not specified, current date UTC is used.","schema":{"type":"string","description":"The date from which to calculate balance remaining. If not specified, current date UTC is used."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-statutory-leave-summary":{"get":{"operationId":"finance_xero_payroll_uk_get_statutory_leave_summary","summary":"Retrieves a specific employee's summary of statutory leaves using a unique employee ID","description":"GET /StatutoryLeaves/Summary/{EmployeeID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}},{"name":"activeOnly","in":"query","required":false,"description":"Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future…","schema":{"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employee-statutory-sick-leave":{"post":{"operationId":"finance_xero_payroll_uk_create_employee_statutory_sick_leave","summary":"Creates statutory sick leave records","description":"POST /StatutoryLeaves/Sick","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-statutory-sick-leave":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_statutory_sick_leave","summary":"Retrieves a statutory sick leave for an employee","description":"GET /StatutoryLeaves/Sick/{StatutorySickLeaveID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"StatutorySickLeaveID","in":"query","required":true,"description":"Statutory sick leave id for single object","schema":{"type":"string","description":"Statutory sick leave id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-leave-periods":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_leave_periods","summary":"Retrieves a specific employee's leave periods using a unique employee ID","description":"GET /Employees/{EmployeeID}/LeavePeriods","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}},{"name":"startDate","in":"query","required":false,"description":"Filter by start date","schema":{"type":"string","description":"Filter by start date"}},{"name":"endDate","in":"query","required":false,"description":"Filter by end date","schema":{"type":"string","description":"Filter by end date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-leave-types":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_leave_types","summary":"Retrieves a specific employee's leave types using a unique employee ID","description":"GET /Employees/{EmployeeID}/LeaveTypes","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employee-leave-type":{"post":{"operationId":"finance_xero_payroll_uk_create_employee_leave_type","summary":"Creates employee leave type records","description":"POST /Employees/{EmployeeID}/LeaveTypes","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-payment-method":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_payment_method","summary":"Retrieves a specific employee's payment method using a unique employee ID","description":"GET /Employees/{EmployeeID}/PaymentMethods","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employee-payment-method":{"post":{"operationId":"finance_xero_payroll_uk_create_employee_payment_method","summary":"Creates an employee payment method","description":"POST /Employees/{EmployeeID}/PaymentMethods","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-pay-template":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_pay_template","summary":"Retrieves a specific employee pay templates using a unique employee ID","description":"GET /Employees/{EmployeeID}/PayTemplates","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employee-earnings-template":{"post":{"operationId":"finance_xero_payroll_uk_create_employee_earnings_template","summary":"Creates an earnings template records for a specific employee","description":"POST /Employees/{EmployeeID}/PayTemplates/earnings","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/update-employee-earnings-template":{"post":{"operationId":"finance_xero_payroll_uk_update_employee_earnings_template","summary":"Updates a specific employee's earnings template records","description":"PUT /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","PayTemplateEarningID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"PayTemplateEarningID":{"type":"string","description":"Id for single pay template earnings object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/delete-employee-earnings-template":{"post":{"operationId":"finance_xero_payroll_uk_delete_employee_earnings_template","summary":"Deletes a specific employee's earnings template record","description":"DELETE /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","PayTemplateEarningID"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"EmployeeID":{"type":"string","description":"Employee id for single object"},"PayTemplateEarningID":{"type":"string","description":"Id for single pay template earnings object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-multiple-employee-earnings-template":{"post":{"operationId":"finance_xero_payroll_uk_create_multiple_employee_earnings_template","summary":"Creates multiple earnings template records for a specific employee using a unique employee ID","description":"POST /Employees/{EmployeeID}/paytemplateearnings","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-benefits":{"get":{"operationId":"finance_xero_payroll_uk_get_benefits","summary":"Retrieves employee benefits","description":"GET /Benefits","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-benefit":{"post":{"operationId":"finance_xero_payroll_uk_create_benefit","summary":"Creates a new employee benefit","description":"POST /Benefits","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-benefit":{"get":{"operationId":"finance_xero_payroll_uk_get_benefit","summary":"Retrieves a specific benefit by using a unique benefit ID","description":"GET /Benefits/{id}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"id","in":"query","required":true,"description":"Identifier for the benefit","schema":{"type":"string","description":"Identifier for the benefit"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-deductions":{"get":{"operationId":"finance_xero_payroll_uk_get_deductions","summary":"Retrieves deductions","description":"GET /Deductions","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-deduction":{"post":{"operationId":"finance_xero_payroll_uk_create_deduction","summary":"Creates a new deduction","description":"POST /Deductions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-deduction":{"get":{"operationId":"finance_xero_payroll_uk_get_deduction","summary":"Retrieves a specific deduction by using a unique deduction ID","description":"GET /Deductions/{deductionId}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"deductionId","in":"query","required":true,"description":"Identifier for the deduction","schema":{"type":"string","description":"Identifier for the deduction"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-earnings-orders":{"get":{"operationId":"finance_xero_payroll_uk_get_earnings_orders","summary":"Retrieves earnings orders","description":"GET /EarningsOrders","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-earnings-order":{"get":{"operationId":"finance_xero_payroll_uk_get_earnings_order","summary":"Retrieves a specific earnings orders by using a unique earnings orders id","description":"GET /EarningsOrders/{id}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"id","in":"query","required":true,"description":"Identifier for the deduction","schema":{"type":"string","description":"Identifier for the deduction"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-earnings-rates":{"get":{"operationId":"finance_xero_payroll_uk_get_earnings_rates","summary":"Retrieves earnings rates","description":"GET /EarningsRates","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-earnings-rate":{"post":{"operationId":"finance_xero_payroll_uk_create_earnings_rate","summary":"Creates a new earnings rate","description":"POST /EarningsRates","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-earnings-rate":{"get":{"operationId":"finance_xero_payroll_uk_get_earnings_rate","summary":"Retrieves a specific earnings rates by using a unique earnings rate id","description":"GET /EarningsRates/{EarningsRateID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EarningsRateID","in":"query","required":true,"description":"Identifier for the earnings rate","schema":{"type":"string","description":"Identifier for the earnings rate"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-leave-types":{"get":{"operationId":"finance_xero_payroll_uk_get_leave_types","summary":"Retrieves leave types","description":"GET /LeaveTypes","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"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","required":false,"description":"Filters leave types by active status. By default the API returns all leave types.","schema":{"type":"boolean","description":"Filters leave types by active status. By default the API returns all leave types."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-leave-type":{"post":{"operationId":"finance_xero_payroll_uk_create_leave_type","summary":"Creates a new leave type","description":"POST /LeaveTypes","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-leave-type":{"get":{"operationId":"finance_xero_payroll_uk_get_leave_type","summary":"Retrieves a specific leave type by using a unique leave type ID","description":"GET /LeaveTypes/{LeaveTypeID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"LeaveTypeID","in":"query","required":true,"description":"Identifier for the leave type","schema":{"type":"string","description":"Identifier for the leave type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-reimbursements":{"get":{"operationId":"finance_xero_payroll_uk_get_reimbursements","summary":"Retrieves reimbursements","description":"GET /Reimbursements","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-reimbursement":{"post":{"operationId":"finance_xero_payroll_uk_create_reimbursement","summary":"Creates a new reimbursement","description":"POST /Reimbursements","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-reimbursement":{"get":{"operationId":"finance_xero_payroll_uk_get_reimbursement","summary":"Retrieves a specific reimbursement by using a unique reimbursement id","description":"GET /Reimbursements/{ReimbursementID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"ReimbursementID","in":"query","required":true,"description":"Identifier for the reimbursement","schema":{"type":"string","description":"Identifier for the reimbursement"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-timesheets":{"get":{"operationId":"finance_xero_payroll_uk_get_timesheets","summary":"Retrieves timesheets","description":"GET /Timesheets","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."},"example":5},{"name":"filter","in":"query","required":false,"description":"Filter by employeeId and/or payrollCalendarId","schema":{"type":"string","description":"Filter by employeeId and/or payrollCalendarId"},"example":"employeeId==00000000-0000-0000-0000-000000000000,payrollCalendarId==00000000-0000-0000-0000-000000000000"},{"name":"status","in":"query","required":false,"description":"filter results by any timesheets with a matching timesheet status","schema":{"type":"string","description":"filter results by any timesheets with a matching timesheet status"},"example":"Draft"},{"name":"startDate","in":"query","required":false,"description":"filter results by any timesheets with a startDate on or after the provided date","schema":{"type":"string","description":"filter results by any timesheets with a startDate on or after the provided date"},"example":"2019-01-02"},{"name":"endDate","in":"query","required":false,"description":"filter results by any timesheets with a endDate on or before the provided date","schema":{"type":"string","description":"filter results by any timesheets with a endDate on or before the provided date"},"example":"2020-01-02"},{"name":"sort","in":"query","required":false,"description":"sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only…","schema":{"type":"string","description":"sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only…"},"example":"startDate"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-timesheet":{"post":{"operationId":"finance_xero_payroll_uk_create_timesheet","summary":"Creates a new timesheet","description":"POST /Timesheets","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-timesheet":{"get":{"operationId":"finance_xero_payroll_uk_get_timesheet","summary":"Retrieve a specific timesheet by using a unique timesheet ID","description":"GET /Timesheets/{TimesheetID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"TimesheetID","in":"query","required":true,"description":"Identifier for the timesheet","schema":{"type":"string","description":"Identifier for the timesheet"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/delete-timesheet":{"post":{"operationId":"finance_xero_payroll_uk_delete_timesheet","summary":"Deletes a specific timesheet","description":"DELETE /Timesheets/{TimesheetID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","TimesheetID"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"TimesheetID":{"type":"string","description":"Identifier for the timesheet"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-timesheet-line":{"post":{"operationId":"finance_xero_payroll_uk_create_timesheet_line","summary":"Creates a new timesheet line for a specific timesheet using a unique timesheet ID","description":"POST /Timesheets/{TimesheetID}/Lines","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","TimesheetID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"TimesheetID":{"type":"string","description":"Identifier for the timesheet"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/approve-timesheet":{"post":{"operationId":"finance_xero_payroll_uk_approve_timesheet","summary":"Approves a specific timesheet","description":"POST /Timesheets/{TimesheetID}/Approve","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","TimesheetID"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"TimesheetID":{"type":"string","description":"Identifier for the timesheet"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/revert-timesheet":{"post":{"operationId":"finance_xero_payroll_uk_revert_timesheet","summary":"Reverts a specific timesheet to draft","description":"POST /Timesheets/{TimesheetID}/RevertToDraft","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","TimesheetID"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"TimesheetID":{"type":"string","description":"Identifier for the timesheet"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/update-timesheet-line":{"post":{"operationId":"finance_xero_payroll_uk_update_timesheet_line","summary":"Updates a specific timesheet line for a specific timesheet","description":"PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","TimesheetID","TimesheetLineID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"TimesheetID":{"type":"string","description":"Identifier for the timesheet"},"TimesheetLineID":{"type":"string","description":"Identifier for the timesheet line"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/delete-timesheet-line":{"post":{"operationId":"finance_xero_payroll_uk_delete_timesheet_line","summary":"Deletes a specific timesheet line","description":"DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","TimesheetID","TimesheetLineID"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"TimesheetID":{"type":"string","description":"Identifier for the timesheet"},"TimesheetLineID":{"type":"string","description":"Identifier for the timesheet line"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-pay-run-calendars":{"get":{"operationId":"finance_xero_payroll_uk_get_pay_run_calendars","summary":"Retrieves payrun calendars","description":"GET /PayRunCalendars","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-pay-run-calendar":{"post":{"operationId":"finance_xero_payroll_uk_create_pay_run_calendar","summary":"Creates a new payrun calendar","description":"POST /PayRunCalendars","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-pay-run-calendar":{"get":{"operationId":"finance_xero_payroll_uk_get_pay_run_calendar","summary":"Retrieves a specific payrun calendar by using a unique payrun calendar ID","description":"GET /PayRunCalendars/{PayRunCalendarID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"PayRunCalendarID","in":"query","required":true,"description":"Identifier for the payrun calendars","schema":{"type":"string","description":"Identifier for the payrun calendars"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-salary-and-wages":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_salary_and_wages","summary":"Retrieves a specific employee's salary and wages by using a unique employee ID","description":"GET /Employees/{EmployeeID}/SalaryAndWages","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"type":"integer","description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/create-employee-salary-and-wage":{"post":{"operationId":"finance_xero_payroll_uk_create_employee_salary_and_wage","summary":"Creates a salary and wage record for a specific employee","description":"POST /Employees/{EmployeeID}/SalaryAndWages","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-employee-salary-and-wage":{"get":{"operationId":"finance_xero_payroll_uk_get_employee_salary_and_wage","summary":"Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id","description":"GET /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"EmployeeID","in":"query","required":true,"description":"Employee id for single object","schema":{"type":"string","description":"Employee id for single object"}},{"name":"SalaryAndWagesID","in":"query","required":true,"description":"Id for single pay template earnings object","schema":{"type":"string","description":"Id for single pay template earnings object"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/update-employee-salary-and-wage":{"post":{"operationId":"finance_xero_payroll_uk_update_employee_salary_and_wage","summary":"Updates salary and wages record for a specific employee","description":"PUT /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","SalaryAndWagesID","body"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"Idempotency-Key":{"type":"string","description":"This allows you to safely retry requests without the risk of duplicate processing. 128 character max."},"EmployeeID":{"type":"string","description":"Employee id for single object"},"SalaryAndWagesID":{"type":"string","description":"Id for single pay template earnings object"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/delete-employee-salary-and-wage":{"post":{"operationId":"finance_xero_payroll_uk_delete_employee_salary_and_wage","summary":"Deletes a salary and wages record for a specific employee","description":"DELETE /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Xero-Tenant-Id","EmployeeID","SalaryAndWagesID"],"properties":{"Xero-Tenant-Id":{"type":"string","description":"Xero identifier for Tenant"},"EmployeeID":{"type":"string","description":"Employee id for single object"},"SalaryAndWagesID":{"type":"string","description":"Id for single salary and wages object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-pay-runs":{"get":{"operationId":"finance_xero_payroll_uk_get_pay_runs","summary":"Retrieves pay runs","description":"GET /PayRuns","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"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","required":false,"description":"By default get payruns will return all the payruns for an organization. You can add GET…","schema":{"type":"string","enum":["Draft","Posted"],"description":"By default get payruns will return all the payruns for an organization. You can add GET…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-pay-run":{"get":{"operationId":"finance_xero_payroll_uk_get_pay_run","summary":"Retrieves a specific pay run by using a unique pay run ID","description":"GET /PayRuns/{PayRunID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"PayRunID","in":"query","required":true,"description":"Identifier for the pay run","schema":{"type":"string","description":"Identifier for the pay run"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-pay-slips":{"get":{"operationId":"finance_xero_payroll_uk_get_pay_slips","summary":"Retrieves payslips","description":"GET /Payslips","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"page","in":"query","required":false,"description":"Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.","schema":{"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","required":true,"description":"PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.","schema":{"type":"string","description":"PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-pay-slip":{"get":{"operationId":"finance_xero_payroll_uk_get_pay_slip","summary":"Retrieves a specific payslip by using a unique payslip ID","description":"GET /Payslips/{PayslipID}","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}},{"name":"PayslipID","in":"query","required":true,"description":"Identifier for the payslip","schema":{"type":"string","description":"Identifier for the payslip"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-settings":{"get":{"operationId":"finance_xero_payroll_uk_get_settings","summary":"Retrieves payroll settings","description":"GET /Settings","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:xero-payroll-uk/get-tracking-categories":{"get":{"operationId":"finance_xero_payroll_uk_get_tracking_categories","summary":"Retrieves tracking categories","description":"GET /Settings/trackingCategories","tags":["finance"],"parameters":[{"name":"Xero-Tenant-Id","in":"query","required":true,"description":"Xero identifier for Tenant","schema":{"type":"string","description":"Xero identifier for Tenant"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}