xero-node 4.35.0 → 4.37.0

package/dist/gen/api/payrollNZApi.d.ts

@@ -2,7 +2,7 @@
  * Xero Payroll NZ
  * This is the Xero Payroll API for orgs in the NZ region.
  *
- * The version of the OpenAPI document: 2.38.0
+ * The version of the OpenAPI document: 2.40.1
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -97,8 +97,9 @@ export declare class PayrollNzApi {
      * @summary Approves a timesheet
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheetID Identifier for the timesheet
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    approveTimesheet(xeroTenantId: string, timesheetID: string, options?: {
+    approveTimesheet(xeroTenantId: string, timesheetID: string, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -111,8 +112,9 @@ export declare class PayrollNzApi {
      * @summary Creates a new deduction for a specific employee
      * @param xeroTenantId Xero identifier for Tenant
      * @param deduction
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createDeduction(xeroTenantId: string, deduction: Deduction, options?: {
+    createDeduction(xeroTenantId: string, deduction: Deduction, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -125,8 +127,9 @@ export declare class PayrollNzApi {
      * @summary Creates a new earnings rate
      * @param xeroTenantId Xero identifier for Tenant
      * @param earningsRate
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEarningsRate(xeroTenantId: string, earningsRate: EarningsRate, options?: {
+    createEarningsRate(xeroTenantId: string, earningsRate: EarningsRate, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -139,8 +142,9 @@ export declare class PayrollNzApi {
      * @summary Creates an employees
      * @param xeroTenantId Xero identifier for Tenant
      * @param employee
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployee(xeroTenantId: string, employee: Employee, options?: {
+    createEmployee(xeroTenantId: string, employee: Employee, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -154,8 +158,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param earningsTemplate
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, earningsTemplate: EarningsTemplate, options?: {
+    createEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, earningsTemplate: EarningsTemplate, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -169,8 +174,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeLeave
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeLeave(xeroTenantId: string, employeeID: string, employeeLeave: EmployeeLeave, options?: {
+    createEmployeeLeave(xeroTenantId: string, employeeID: string, employeeLeave: EmployeeLeave, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -184,8 +190,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeLeaveSetup
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeLeaveSetup(xeroTenantId: string, employeeID: string, employeeLeaveSetup: EmployeeLeaveSetup, options?: {
+    createEmployeeLeaveSetup(xeroTenantId: string, employeeID: string, employeeLeaveSetup: EmployeeLeaveSetup, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -199,8 +206,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeLeaveType
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeLeaveType(xeroTenantId: string, employeeID: string, employeeLeaveType: EmployeeLeaveType, options?: {
+    createEmployeeLeaveType(xeroTenantId: string, employeeID: string, employeeLeaveType: EmployeeLeaveType, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -214,8 +222,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeOpeningBalance
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeOpeningBalances(xeroTenantId: string, employeeID: string, employeeOpeningBalance: Array<EmployeeOpeningBalance>, options?: {
+    createEmployeeOpeningBalances(xeroTenantId: string, employeeID: string, employeeOpeningBalance: Array<EmployeeOpeningBalance>, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -229,8 +238,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param paymentMethod
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeePaymentMethod(xeroTenantId: string, employeeID: string, paymentMethod: PaymentMethod, options?: {
+    createEmployeePaymentMethod(xeroTenantId: string, employeeID: string, paymentMethod: PaymentMethod, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -244,8 +254,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param salaryAndWage
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeSalaryAndWage(xeroTenantId: string, employeeID: string, salaryAndWage: SalaryAndWage, options?: {
+    createEmployeeSalaryAndWage(xeroTenantId: string, employeeID: string, salaryAndWage: SalaryAndWage, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -259,8 +270,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employment
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployment(xeroTenantId: string, employeeID: string, employment: Employment, options?: {
+    createEmployment(xeroTenantId: string, employeeID: string, employment: Employment, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -273,8 +285,9 @@ export declare class PayrollNzApi {
      * @summary Creates a new leave type
      * @param xeroTenantId Xero identifier for Tenant
      * @param leaveType
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createLeaveType(xeroTenantId: string, leaveType: LeaveType, options?: {
+    createLeaveType(xeroTenantId: string, leaveType: LeaveType, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -288,8 +301,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param earningsTemplate
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createMultipleEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, earningsTemplate: Array<EarningsTemplate>, options?: {
+    createMultipleEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, earningsTemplate: Array<EarningsTemplate>, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -302,8 +316,9 @@ export declare class PayrollNzApi {
      * @summary Creates a pay run
      * @param xeroTenantId Xero identifier for Tenant
      * @param payRun
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createPayRun(xeroTenantId: string, payRun: PayRun, options?: {
+    createPayRun(xeroTenantId: string, payRun: PayRun, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -316,8 +331,9 @@ export declare class PayrollNzApi {
      * @summary Creates a new payrun calendar
      * @param xeroTenantId Xero identifier for Tenant
      * @param payRunCalendar
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createPayRunCalendar(xeroTenantId: string, payRunCalendar: PayRunCalendar, options?: {
+    createPayRunCalendar(xeroTenantId: string, payRunCalendar: PayRunCalendar, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -330,8 +346,9 @@ export declare class PayrollNzApi {
      * @summary Creates a new reimbursement
      * @param xeroTenantId Xero identifier for Tenant
      * @param reimbursement
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createReimbursement(xeroTenantId: string, reimbursement: Reimbursement, options?: {
+    createReimbursement(xeroTenantId: string, reimbursement: Reimbursement, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -344,8 +361,9 @@ export declare class PayrollNzApi {
      * @summary Creates a new superannuation
      * @param xeroTenantId Xero identifier for Tenant
      * @param benefit
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createSuperannuation(xeroTenantId: string, benefit: Benefit, options?: {
+    createSuperannuation(xeroTenantId: string, benefit: Benefit, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -358,8 +376,9 @@ export declare class PayrollNzApi {
      * @summary Creates a new timesheet
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheet
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createTimesheet(xeroTenantId: string, timesheet: Timesheet, options?: {
+    createTimesheet(xeroTenantId: string, timesheet: Timesheet, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -373,8 +392,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheetID Identifier for the timesheet
      * @param timesheetLine
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createTimesheetLine(xeroTenantId: string, timesheetID: string, timesheetLine: TimesheetLine, options?: {
+    createTimesheetLine(xeroTenantId: string, timesheetID: string, timesheetLine: TimesheetLine, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -948,8 +968,9 @@ export declare class PayrollNzApi {
      * @summary Reverts a timesheet to draft
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheetID Identifier for the timesheet
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    revertTimesheet(xeroTenantId: string, timesheetID: string, options?: {
+    revertTimesheet(xeroTenantId: string, timesheetID: string, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -963,8 +984,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employee
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployee(xeroTenantId: string, employeeID: string, employee: Employee, options?: {
+    updateEmployee(xeroTenantId: string, employeeID: string, employee: Employee, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -979,8 +1001,9 @@ export declare class PayrollNzApi {
      * @param employeeID Employee id for single object
      * @param payTemplateEarningID Id for single pay template earnings object
      * @param earningsTemplate
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, payTemplateEarningID: string, earningsTemplate: EarningsTemplate, options?: {
+    updateEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, payTemplateEarningID: string, earningsTemplate: EarningsTemplate, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -995,8 +1018,9 @@ export declare class PayrollNzApi {
      * @param employeeID Employee id for single object
      * @param leaveID Leave id for single object
      * @param employeeLeave
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployeeLeave(xeroTenantId: string, employeeID: string, leaveID: string, employeeLeave: EmployeeLeave, options?: {
+    updateEmployeeLeave(xeroTenantId: string, employeeID: string, leaveID: string, employeeLeave: EmployeeLeave, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1011,8 +1035,9 @@ export declare class PayrollNzApi {
      * @param employeeID Employee id for single object
      * @param salaryAndWagesID Id for single pay template earnings object
      * @param salaryAndWage
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployeeSalaryAndWage(xeroTenantId: string, employeeID: string, salaryAndWagesID: string, salaryAndWage: SalaryAndWage, options?: {
+    updateEmployeeSalaryAndWage(xeroTenantId: string, employeeID: string, salaryAndWagesID: string, salaryAndWage: SalaryAndWage, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1026,8 +1051,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeTax
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployeeTax(xeroTenantId: string, employeeID: string, employeeTax: EmployeeTax, options?: {
+    updateEmployeeTax(xeroTenantId: string, employeeID: string, employeeTax: EmployeeTax, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1041,8 +1067,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param payRunID Identifier for the pay run
      * @param payRun
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updatePayRun(xeroTenantId: string, payRunID: string, payRun: PayRun, options?: {
+    updatePayRun(xeroTenantId: string, payRunID: string, payRun: PayRun, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1056,8 +1083,9 @@ export declare class PayrollNzApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param paySlipID Identifier for the payslip
      * @param paySlip
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updatePaySlipLineItems(xeroTenantId: string, paySlipID: string, paySlip: PaySlip, options?: {
+    updatePaySlipLineItems(xeroTenantId: string, paySlipID: string, paySlip: PaySlip, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1072,8 +1100,9 @@ export declare class PayrollNzApi {
      * @param timesheetID Identifier for the timesheet
      * @param timesheetLineID Identifier for the timesheet line
      * @param timesheetLine
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateTimesheetLine(xeroTenantId: string, timesheetID: string, timesheetLineID: string, timesheetLine: TimesheetLine, options?: {
+    updateTimesheetLine(xeroTenantId: string, timesheetID: string, timesheetLineID: string, timesheetLine: TimesheetLine, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };