xero-node 4.34.0 → 4.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/dist/gen/api/accountingApi.d.ts +245 -100
  2. package/dist/gen/api/accountingApi.js +506 -101
  3. package/dist/gen/api/accountingApi.js.map +1 -1
  4. package/dist/gen/api/appStoreApi.d.ts +5 -3
  5. package/dist/gen/api/appStoreApi.js +8 -4
  6. package/dist/gen/api/appStoreApi.js.map +1 -1
  7. package/dist/gen/api/assetApi.d.ts +5 -3
  8. package/dist/gen/api/assetApi.js +8 -4
  9. package/dist/gen/api/assetApi.js.map +1 -1
  10. package/dist/gen/api/bankfeedsApi.d.ts +7 -4
  11. package/dist/gen/api/bankfeedsApi.js +11 -5
  12. package/dist/gen/api/bankfeedsApi.js.map +1 -1
  13. package/dist/gen/api/filesApi.d.ts +13 -7
  14. package/dist/gen/api/filesApi.js +20 -8
  15. package/dist/gen/api/filesApi.js.map +1 -1
  16. package/dist/gen/api/financeApi.d.ts +1 -1
  17. package/dist/gen/api/financeApi.js +2 -2
  18. package/dist/gen/api/payrollAUApi.d.ts +74 -14
  19. package/dist/gen/api/payrollAUApi.js +242 -15
  20. package/dist/gen/api/payrollAUApi.js.map +1 -1
  21. package/dist/gen/api/payrollNZApi.d.ts +59 -30
  22. package/dist/gen/api/payrollNZApi.js +89 -31
  23. package/dist/gen/api/payrollNZApi.js.map +1 -1
  24. package/dist/gen/api/payrollUKApi.d.ts +55 -28
  25. package/dist/gen/api/payrollUKApi.js +83 -29
  26. package/dist/gen/api/payrollUKApi.js.map +1 -1
  27. package/dist/gen/api/projectApi.d.ts +15 -8
  28. package/dist/gen/api/projectApi.js +23 -9
  29. package/dist/gen/api/projectApi.js.map +1 -1
  30. package/dist/gen/model/accounting/accountType.d.ts +1 -5
  31. package/dist/gen/model/accounting/accountType.js +0 -4
  32. package/dist/gen/model/accounting/accountType.js.map +1 -1
  33. package/dist/gen/model/accounting/allocation.d.ts +8 -0
  34. package/dist/gen/model/accounting/allocation.js +10 -0
  35. package/dist/gen/model/accounting/allocation.js.map +1 -1
  36. package/dist/gen/model/accounting/contact.d.ts +0 -4
  37. package/dist/gen/model/accounting/contact.js +0 -5
  38. package/dist/gen/model/accounting/contact.js.map +1 -1
  39. package/dist/gen/model/accounting/models.js +1 -0
  40. package/dist/gen/model/accounting/models.js.map +1 -1
  41. package/dist/gen/model/accounting/taxRate.d.ts +6 -1
  42. package/dist/gen/model/accounting/taxRate.js +5 -0
  43. package/dist/gen/model/accounting/taxRate.js.map +1 -1
  44. package/dist/gen/model/accounting/taxType.d.ts +11 -1
  45. package/dist/gen/model/accounting/taxType.js +10 -0
  46. package/dist/gen/model/accounting/taxType.js.map +1 -1
  47. package/dist/gen/model/accounting/tenNinetyNineContact.d.ts +23 -0
  48. package/dist/gen/model/accounting/tenNinetyNineContact.js +28 -0
  49. package/dist/gen/model/accounting/tenNinetyNineContact.js.map +1 -1
  50. package/dist/gen/model/finance/problemType.d.ts +2 -1
  51. package/dist/gen/model/finance/problemType.js +1 -0
  52. package/dist/gen/model/finance/problemType.js.map +1 -1
  53. package/dist/gen/model/payroll-au/leavePeriodStatus.d.ts +3 -1
  54. package/dist/gen/model/payroll-au/leavePeriodStatus.js +2 -0
  55. package/dist/gen/model/payroll-au/leavePeriodStatus.js.map +1 -1
  56. package/package.json +1 -1
@@ -2,7 +2,7 @@
2
2
  * Xero Accounting API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * The version of the OpenAPI document: 2.37.0
5
+ * The version of the OpenAPI document: 2.40.0
6
6
  * Contact: api@xero.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,6 +17,7 @@ import fs = require('fs');
17
17
  import { Account } from '../model/accounting/account';
18
18
  import { Accounts } from '../model/accounting/accounts';
19
19
  import { Actions } from '../model/accounting/actions';
20
+ import { Allocation } from '../model/accounting/allocation';
20
21
  import { Allocations } from '../model/accounting/allocations';
21
22
  import { Attachments } from '../model/accounting/attachments';
22
23
  import { BankTransactions } from '../model/accounting/bankTransactions';
@@ -91,8 +92,9 @@ export declare class AccountingApi {
91
92
  * @summary Creates a new chart of accounts
92
93
  * @param xeroTenantId Xero identifier for Tenant
93
94
  * @param account Account object in body of request
95
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
94
96
  */
95
- createAccount(xeroTenantId: string, account: Account, options?: {
97
+ createAccount(xeroTenantId: string, account: Account, idempotencyKey?: string, options?: {
96
98
  headers: {
97
99
  [name: string]: string;
98
100
  };
@@ -107,8 +109,9 @@ export declare class AccountingApi {
107
109
  * @param accountID Unique identifier for Account object
108
110
  * @param fileName Name of the attachment
109
111
  * @param body Byte array of file in body of request
112
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
110
113
  */
111
- createAccountAttachmentByFileName(xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream, options?: {
114
+ createAccountAttachmentByFileName(xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
112
115
  headers: {
113
116
  [name: string]: string;
114
117
  };
@@ -123,8 +126,9 @@ export declare class AccountingApi {
123
126
  * @param bankTransactionID Xero generated unique identifier for a bank transaction
124
127
  * @param fileName Name of the attachment
125
128
  * @param body Byte array of file in body of request
129
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
126
130
  */
127
- createBankTransactionAttachmentByFileName(xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream, options?: {
131
+ createBankTransactionAttachmentByFileName(xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
128
132
  headers: {
129
133
  [name: string]: string;
130
134
  };
@@ -138,8 +142,9 @@ export declare class AccountingApi {
138
142
  * @param xeroTenantId Xero identifier for Tenant
139
143
  * @param bankTransactionID Xero generated unique identifier for a bank transaction
140
144
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
145
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
141
146
  */
142
- createBankTransactionHistoryRecord(xeroTenantId: string, bankTransactionID: string, historyRecords: HistoryRecords, options?: {
147
+ createBankTransactionHistoryRecord(xeroTenantId: string, bankTransactionID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
143
148
  headers: {
144
149
  [name: string]: string;
145
150
  };
@@ -152,10 +157,11 @@ export declare class AccountingApi {
152
157
  * @summary Creates one or more spent or received money transaction
153
158
  * @param xeroTenantId Xero identifier for Tenant
154
159
  * @param bankTransactions BankTransactions with an array of BankTransaction objects in body of request
160
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
155
161
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
156
162
  * @param unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
157
163
  */
158
- createBankTransactions(xeroTenantId: string, bankTransactions: BankTransactions, summarizeErrors?: boolean, unitdp?: number, options?: {
164
+ createBankTransactions(xeroTenantId: string, bankTransactions: BankTransactions, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options?: {
159
165
  headers: {
160
166
  [name: string]: string;
161
167
  };
@@ -168,8 +174,9 @@ export declare class AccountingApi {
168
174
  * @summary Creates a bank transfer
169
175
  * @param xeroTenantId Xero identifier for Tenant
170
176
  * @param bankTransfers BankTransfers with array of BankTransfer objects in request body
177
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
171
178
  */
172
- createBankTransfer(xeroTenantId: string, bankTransfers: BankTransfers, options?: {
179
+ createBankTransfer(xeroTenantId: string, bankTransfers: BankTransfers, idempotencyKey?: string, options?: {
173
180
  headers: {
174
181
  [name: string]: string;
175
182
  };
@@ -183,8 +190,9 @@ export declare class AccountingApi {
183
190
  * @param bankTransferID Xero generated unique identifier for a bank transfer
184
191
  * @param fileName Name of the attachment
185
192
  * @param body Byte array of file in body of request
193
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
186
194
  */
187
- createBankTransferAttachmentByFileName(xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream, options?: {
195
+ createBankTransferAttachmentByFileName(xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
188
196
  headers: {
189
197
  [name: string]: string;
190
198
  };
@@ -198,8 +206,9 @@ export declare class AccountingApi {
198
206
  * @param xeroTenantId Xero identifier for Tenant
199
207
  * @param bankTransferID Xero generated unique identifier for a bank transfer
200
208
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
209
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
201
210
  */
202
- createBankTransferHistoryRecord(xeroTenantId: string, bankTransferID: string, historyRecords: HistoryRecords, options?: {
211
+ createBankTransferHistoryRecord(xeroTenantId: string, bankTransferID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
203
212
  headers: {
204
213
  [name: string]: string;
205
214
  };
@@ -213,8 +222,9 @@ export declare class AccountingApi {
213
222
  * @param xeroTenantId Xero identifier for Tenant
214
223
  * @param batchPayments BatchPayments with an array of Payments in body of request
215
224
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
225
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
216
226
  */
217
- createBatchPayment(xeroTenantId: string, batchPayments: BatchPayments, summarizeErrors?: boolean, options?: {
227
+ createBatchPayment(xeroTenantId: string, batchPayments: BatchPayments, summarizeErrors?: boolean, idempotencyKey?: string, options?: {
218
228
  headers: {
219
229
  [name: string]: string;
220
230
  };
@@ -228,8 +238,9 @@ export declare class AccountingApi {
228
238
  * @param xeroTenantId Xero identifier for Tenant
229
239
  * @param batchPaymentID Unique identifier for BatchPayment
230
240
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
241
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
231
242
  */
232
- createBatchPaymentHistoryRecord(xeroTenantId: string, batchPaymentID: string, historyRecords: HistoryRecords, options?: {
243
+ createBatchPaymentHistoryRecord(xeroTenantId: string, batchPaymentID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
233
244
  headers: {
234
245
  [name: string]: string;
235
246
  };
@@ -243,8 +254,9 @@ export declare class AccountingApi {
243
254
  * @param xeroTenantId Xero identifier for Tenant
244
255
  * @param brandingThemeID Unique identifier for a Branding Theme
245
256
  * @param paymentServices PaymentServices array with PaymentService object in body of request
257
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
246
258
  */
247
- createBrandingThemePaymentServices(xeroTenantId: string, brandingThemeID: string, paymentServices: PaymentServices, options?: {
259
+ createBrandingThemePaymentServices(xeroTenantId: string, brandingThemeID: string, paymentServices: PaymentServices, idempotencyKey?: string, options?: {
248
260
  headers: {
249
261
  [name: string]: string;
250
262
  };
@@ -258,8 +270,9 @@ export declare class AccountingApi {
258
270
  * @param contactID Unique identifier for a Contact
259
271
  * @param fileName Name of the attachment
260
272
  * @param body Byte array of file in body of request
273
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
261
274
  */
262
- createContactAttachmentByFileName(xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream, options?: {
275
+ createContactAttachmentByFileName(xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
263
276
  headers: {
264
277
  [name: string]: string;
265
278
  };
@@ -272,8 +285,9 @@ export declare class AccountingApi {
272
285
  * @summary Creates a contact group
273
286
  * @param xeroTenantId Xero identifier for Tenant
274
287
  * @param contactGroups ContactGroups with an array of names in request body
288
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
275
289
  */
276
- createContactGroup(xeroTenantId: string, contactGroups: ContactGroups, options?: {
290
+ createContactGroup(xeroTenantId: string, contactGroups: ContactGroups, idempotencyKey?: string, options?: {
277
291
  headers: {
278
292
  [name: string]: string;
279
293
  };
@@ -287,8 +301,9 @@ export declare class AccountingApi {
287
301
  * @param xeroTenantId Xero identifier for Tenant
288
302
  * @param contactGroupID Unique identifier for a Contact Group
289
303
  * @param contacts Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request
304
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
290
305
  */
291
- createContactGroupContacts(xeroTenantId: string, contactGroupID: string, contacts: Contacts, options?: {
306
+ createContactGroupContacts(xeroTenantId: string, contactGroupID: string, contacts: Contacts, idempotencyKey?: string, options?: {
292
307
  headers: {
293
308
  [name: string]: string;
294
309
  };
@@ -302,8 +317,9 @@ export declare class AccountingApi {
302
317
  * @param xeroTenantId Xero identifier for Tenant
303
318
  * @param contactID Unique identifier for a Contact
304
319
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
320
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
305
321
  */
306
- createContactHistory(xeroTenantId: string, contactID: string, historyRecords: HistoryRecords, options?: {
322
+ createContactHistory(xeroTenantId: string, contactID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
307
323
  headers: {
308
324
  [name: string]: string;
309
325
  };
@@ -316,9 +332,10 @@ export declare class AccountingApi {
316
332
  * @summary Creates multiple contacts (bulk) in a Xero organisation
317
333
  * @param xeroTenantId Xero identifier for Tenant
318
334
  * @param contacts Contacts with an array of Contact objects to create in body of request
335
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
319
336
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
320
337
  */
321
- createContacts(xeroTenantId: string, contacts: Contacts, summarizeErrors?: boolean, options?: {
338
+ createContacts(xeroTenantId: string, contacts: Contacts, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
322
339
  headers: {
323
340
  [name: string]: string;
324
341
  };
@@ -332,9 +349,10 @@ export declare class AccountingApi {
332
349
  * @param xeroTenantId Xero identifier for Tenant
333
350
  * @param creditNoteID Unique identifier for a Credit Note
334
351
  * @param allocations Allocations with array of Allocation object in body of request.
352
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
335
353
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
336
354
  */
337
- createCreditNoteAllocation(xeroTenantId: string, creditNoteID: string, allocations: Allocations, summarizeErrors?: boolean, options?: {
355
+ createCreditNoteAllocation(xeroTenantId: string, creditNoteID: string, allocations: Allocations, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
338
356
  headers: {
339
357
  [name: string]: string;
340
358
  };
@@ -349,9 +367,10 @@ export declare class AccountingApi {
349
367
  * @param creditNoteID Unique identifier for a Credit Note
350
368
  * @param fileName Name of the attachment
351
369
  * @param body Byte array of file in body of request
370
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
352
371
  * @param includeOnline Allows an attachment to be seen by the end customer within their online invoice
353
372
  */
354
- createCreditNoteAttachmentByFileName(xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream, includeOnline?: boolean, options?: {
373
+ createCreditNoteAttachmentByFileName(xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, includeOnline?: boolean, options?: {
355
374
  headers: {
356
375
  [name: string]: string;
357
376
  };
@@ -365,8 +384,9 @@ export declare class AccountingApi {
365
384
  * @param xeroTenantId Xero identifier for Tenant
366
385
  * @param creditNoteID Unique identifier for a Credit Note
367
386
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
387
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
368
388
  */
369
- createCreditNoteHistory(xeroTenantId: string, creditNoteID: string, historyRecords: HistoryRecords, options?: {
389
+ createCreditNoteHistory(xeroTenantId: string, creditNoteID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
370
390
  headers: {
371
391
  [name: string]: string;
372
392
  };
@@ -379,10 +399,11 @@ export declare class AccountingApi {
379
399
  * @summary Creates a new credit note
380
400
  * @param xeroTenantId Xero identifier for Tenant
381
401
  * @param creditNotes Credit Notes with array of CreditNote object in body of request
402
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
382
403
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
383
404
  * @param unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
384
405
  */
385
- createCreditNotes(xeroTenantId: string, creditNotes: CreditNotes, summarizeErrors?: boolean, unitdp?: number, options?: {
406
+ createCreditNotes(xeroTenantId: string, creditNotes: CreditNotes, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options?: {
386
407
  headers: {
387
408
  [name: string]: string;
388
409
  };
@@ -395,8 +416,9 @@ export declare class AccountingApi {
395
416
  * @summary Create a new currency for a Xero organisation
396
417
  * @param xeroTenantId Xero identifier for Tenant
397
418
  * @param currency Currency object in the body of request
419
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
398
420
  */
399
- createCurrency(xeroTenantId: string, currency: Currency, options?: {
421
+ createCurrency(xeroTenantId: string, currency: Currency, idempotencyKey?: string, options?: {
400
422
  headers: {
401
423
  [name: string]: string;
402
424
  };
@@ -409,9 +431,10 @@ export declare class AccountingApi {
409
431
  * @summary Creates new employees used in Xero payrun
410
432
  * @param xeroTenantId Xero identifier for Tenant
411
433
  * @param employees Employees with array of Employee object in body of request
434
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
412
435
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
413
436
  */
414
- createEmployees(xeroTenantId: string, employees: Employees, summarizeErrors?: boolean, options?: {
437
+ createEmployees(xeroTenantId: string, employees: Employees, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
415
438
  headers: {
416
439
  [name: string]: string;
417
440
  };
@@ -425,8 +448,9 @@ export declare class AccountingApi {
425
448
  * @param xeroTenantId Xero identifier for Tenant
426
449
  * @param expenseClaimID Unique identifier for a ExpenseClaim
427
450
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
451
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
428
452
  */
429
- createExpenseClaimHistory(xeroTenantId: string, expenseClaimID: string, historyRecords: HistoryRecords, options?: {
453
+ createExpenseClaimHistory(xeroTenantId: string, expenseClaimID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
430
454
  headers: {
431
455
  [name: string]: string;
432
456
  };
@@ -439,8 +463,9 @@ export declare class AccountingApi {
439
463
  * @summary Creates expense claims
440
464
  * @param xeroTenantId Xero identifier for Tenant
441
465
  * @param expenseClaims ExpenseClaims with array of ExpenseClaim object in body of request
466
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
442
467
  */
443
- createExpenseClaims(xeroTenantId: string, expenseClaims: ExpenseClaims, options?: {
468
+ createExpenseClaims(xeroTenantId: string, expenseClaims: ExpenseClaims, idempotencyKey?: string, options?: {
444
469
  headers: {
445
470
  [name: string]: string;
446
471
  };
@@ -455,9 +480,10 @@ export declare class AccountingApi {
455
480
  * @param invoiceID Unique identifier for an Invoice
456
481
  * @param fileName Name of the attachment
457
482
  * @param body Byte array of file in body of request
483
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
458
484
  * @param includeOnline Allows an attachment to be seen by the end customer within their online invoice
459
485
  */
460
- createInvoiceAttachmentByFileName(xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream, includeOnline?: boolean, options?: {
486
+ createInvoiceAttachmentByFileName(xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, includeOnline?: boolean, options?: {
461
487
  headers: {
462
488
  [name: string]: string;
463
489
  };
@@ -471,8 +497,9 @@ export declare class AccountingApi {
471
497
  * @param xeroTenantId Xero identifier for Tenant
472
498
  * @param invoiceID Unique identifier for an Invoice
473
499
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
500
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
474
501
  */
475
- createInvoiceHistory(xeroTenantId: string, invoiceID: string, historyRecords: HistoryRecords, options?: {
502
+ createInvoiceHistory(xeroTenantId: string, invoiceID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
476
503
  headers: {
477
504
  [name: string]: string;
478
505
  };
@@ -485,10 +512,11 @@ export declare class AccountingApi {
485
512
  * @summary Creates one or more sales invoices or purchase bills
486
513
  * @param xeroTenantId Xero identifier for Tenant
487
514
  * @param invoices Invoices with an array of invoice objects in body of request
515
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
488
516
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
489
517
  * @param unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
490
518
  */
491
- createInvoices(xeroTenantId: string, invoices: Invoices, summarizeErrors?: boolean, unitdp?: number, options?: {
519
+ createInvoices(xeroTenantId: string, invoices: Invoices, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options?: {
492
520
  headers: {
493
521
  [name: string]: string;
494
522
  };
@@ -502,8 +530,9 @@ export declare class AccountingApi {
502
530
  * @param xeroTenantId Xero identifier for Tenant
503
531
  * @param itemID Unique identifier for an Item
504
532
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
533
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
505
534
  */
506
- createItemHistory(xeroTenantId: string, itemID: string, historyRecords: HistoryRecords, options?: {
535
+ createItemHistory(xeroTenantId: string, itemID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
507
536
  headers: {
508
537
  [name: string]: string;
509
538
  };
@@ -516,10 +545,11 @@ export declare class AccountingApi {
516
545
  * @summary Creates one or more items
517
546
  * @param xeroTenantId Xero identifier for Tenant
518
547
  * @param items Items with an array of Item objects in body of request
548
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
519
549
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
520
550
  * @param unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
521
551
  */
522
- createItems(xeroTenantId: string, items: Items, summarizeErrors?: boolean, unitdp?: number, options?: {
552
+ createItems(xeroTenantId: string, items: Items, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options?: {
523
553
  headers: {
524
554
  [name: string]: string;
525
555
  };
@@ -532,8 +562,9 @@ export declare class AccountingApi {
532
562
  * @summary Creates linked transactions (billable expenses)
533
563
  * @param xeroTenantId Xero identifier for Tenant
534
564
  * @param linkedTransaction LinkedTransaction object in body of request
565
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
535
566
  */
536
- createLinkedTransaction(xeroTenantId: string, linkedTransaction: LinkedTransaction, options?: {
567
+ createLinkedTransaction(xeroTenantId: string, linkedTransaction: LinkedTransaction, idempotencyKey?: string, options?: {
537
568
  headers: {
538
569
  [name: string]: string;
539
570
  };
@@ -548,8 +579,9 @@ export declare class AccountingApi {
548
579
  * @param manualJournalID Unique identifier for a ManualJournal
549
580
  * @param fileName Name of the attachment
550
581
  * @param body Byte array of file in body of request
582
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
551
583
  */
552
- createManualJournalAttachmentByFileName(xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream, options?: {
584
+ createManualJournalAttachmentByFileName(xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
553
585
  headers: {
554
586
  [name: string]: string;
555
587
  };
@@ -563,8 +595,9 @@ export declare class AccountingApi {
563
595
  * @param xeroTenantId Xero identifier for Tenant
564
596
  * @param manualJournalID Unique identifier for a ManualJournal
565
597
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
598
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
566
599
  */
567
- createManualJournalHistoryRecord(xeroTenantId: string, manualJournalID: string, historyRecords: HistoryRecords, options?: {
600
+ createManualJournalHistoryRecord(xeroTenantId: string, manualJournalID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
568
601
  headers: {
569
602
  [name: string]: string;
570
603
  };
@@ -577,9 +610,10 @@ export declare class AccountingApi {
577
610
  * @summary Creates one or more manual journals
578
611
  * @param xeroTenantId Xero identifier for Tenant
579
612
  * @param manualJournals ManualJournals array with ManualJournal object in body of request
613
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
580
614
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
581
615
  */
582
- createManualJournals(xeroTenantId: string, manualJournals: ManualJournals, summarizeErrors?: boolean, options?: {
616
+ createManualJournals(xeroTenantId: string, manualJournals: ManualJournals, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
583
617
  headers: {
584
618
  [name: string]: string;
585
619
  };
@@ -593,9 +627,10 @@ export declare class AccountingApi {
593
627
  * @param xeroTenantId Xero identifier for Tenant
594
628
  * @param overpaymentID Unique identifier for a Overpayment
595
629
  * @param allocations Allocations array with Allocation object in body of request
630
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
596
631
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
597
632
  */
598
- createOverpaymentAllocations(xeroTenantId: string, overpaymentID: string, allocations: Allocations, summarizeErrors?: boolean, options?: {
633
+ createOverpaymentAllocations(xeroTenantId: string, overpaymentID: string, allocations: Allocations, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
599
634
  headers: {
600
635
  [name: string]: string;
601
636
  };
@@ -609,8 +644,9 @@ export declare class AccountingApi {
609
644
  * @param xeroTenantId Xero identifier for Tenant
610
645
  * @param overpaymentID Unique identifier for a Overpayment
611
646
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
647
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
612
648
  */
613
- createOverpaymentHistory(xeroTenantId: string, overpaymentID: string, historyRecords: HistoryRecords, options?: {
649
+ createOverpaymentHistory(xeroTenantId: string, overpaymentID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
614
650
  headers: {
615
651
  [name: string]: string;
616
652
  };
@@ -623,8 +659,9 @@ export declare class AccountingApi {
623
659
  * @summary Creates a single payment for invoice or credit notes
624
660
  * @param xeroTenantId Xero identifier for Tenant
625
661
  * @param payment Request body with a single Payment object
662
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
626
663
  */
627
- createPayment(xeroTenantId: string, payment: Payment, options?: {
664
+ createPayment(xeroTenantId: string, payment: Payment, idempotencyKey?: string, options?: {
628
665
  headers: {
629
666
  [name: string]: string;
630
667
  };
@@ -638,8 +675,9 @@ export declare class AccountingApi {
638
675
  * @param xeroTenantId Xero identifier for Tenant
639
676
  * @param paymentID Unique identifier for a Payment
640
677
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
678
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
641
679
  */
642
- createPaymentHistory(xeroTenantId: string, paymentID: string, historyRecords: HistoryRecords, options?: {
680
+ createPaymentHistory(xeroTenantId: string, paymentID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
643
681
  headers: {
644
682
  [name: string]: string;
645
683
  };
@@ -652,8 +690,9 @@ export declare class AccountingApi {
652
690
  * @summary Creates a payment service
653
691
  * @param xeroTenantId Xero identifier for Tenant
654
692
  * @param paymentServices PaymentServices array with PaymentService object in body of request
693
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
655
694
  */
656
- createPaymentService(xeroTenantId: string, paymentServices: PaymentServices, options?: {
695
+ createPaymentService(xeroTenantId: string, paymentServices: PaymentServices, idempotencyKey?: string, options?: {
657
696
  headers: {
658
697
  [name: string]: string;
659
698
  };
@@ -666,9 +705,10 @@ export declare class AccountingApi {
666
705
  * @summary Creates multiple payments for invoices or credit notes
667
706
  * @param xeroTenantId Xero identifier for Tenant
668
707
  * @param payments Payments array with Payment object in body of request
708
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
669
709
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
670
710
  */
671
- createPayments(xeroTenantId: string, payments: Payments, summarizeErrors?: boolean, options?: {
711
+ createPayments(xeroTenantId: string, payments: Payments, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
672
712
  headers: {
673
713
  [name: string]: string;
674
714
  };
@@ -682,9 +722,10 @@ export declare class AccountingApi {
682
722
  * @param xeroTenantId Xero identifier for Tenant
683
723
  * @param prepaymentID Unique identifier for a PrePayment
684
724
  * @param allocations Allocations with an array of Allocation object in body of request
725
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
685
726
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
686
727
  */
687
- createPrepaymentAllocations(xeroTenantId: string, prepaymentID: string, allocations: Allocations, summarizeErrors?: boolean, options?: {
728
+ createPrepaymentAllocations(xeroTenantId: string, prepaymentID: string, allocations: Allocations, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
688
729
  headers: {
689
730
  [name: string]: string;
690
731
  };
@@ -698,8 +739,9 @@ export declare class AccountingApi {
698
739
  * @param xeroTenantId Xero identifier for Tenant
699
740
  * @param prepaymentID Unique identifier for a PrePayment
700
741
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
742
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
701
743
  */
702
- createPrepaymentHistory(xeroTenantId: string, prepaymentID: string, historyRecords: HistoryRecords, options?: {
744
+ createPrepaymentHistory(xeroTenantId: string, prepaymentID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
703
745
  headers: {
704
746
  [name: string]: string;
705
747
  };
@@ -714,8 +756,9 @@ export declare class AccountingApi {
714
756
  * @param purchaseOrderID Unique identifier for an Purchase Order
715
757
  * @param fileName Name of the attachment
716
758
  * @param body Byte array of file in body of request
759
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
717
760
  */
718
- createPurchaseOrderAttachmentByFileName(xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream, options?: {
761
+ createPurchaseOrderAttachmentByFileName(xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
719
762
  headers: {
720
763
  [name: string]: string;
721
764
  };
@@ -729,8 +772,9 @@ export declare class AccountingApi {
729
772
  * @param xeroTenantId Xero identifier for Tenant
730
773
  * @param purchaseOrderID Unique identifier for an Purchase Order
731
774
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
775
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
732
776
  */
733
- createPurchaseOrderHistory(xeroTenantId: string, purchaseOrderID: string, historyRecords: HistoryRecords, options?: {
777
+ createPurchaseOrderHistory(xeroTenantId: string, purchaseOrderID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
734
778
  headers: {
735
779
  [name: string]: string;
736
780
  };
@@ -743,9 +787,10 @@ export declare class AccountingApi {
743
787
  * @summary Creates one or more purchase orders
744
788
  * @param xeroTenantId Xero identifier for Tenant
745
789
  * @param purchaseOrders PurchaseOrders with an array of PurchaseOrder object in body of request
790
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
746
791
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
747
792
  */
748
- createPurchaseOrders(xeroTenantId: string, purchaseOrders: PurchaseOrders, summarizeErrors?: boolean, options?: {
793
+ createPurchaseOrders(xeroTenantId: string, purchaseOrders: PurchaseOrders, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
749
794
  headers: {
750
795
  [name: string]: string;
751
796
  };
@@ -760,8 +805,9 @@ export declare class AccountingApi {
760
805
  * @param quoteID Unique identifier for an Quote
761
806
  * @param fileName Name of the attachment
762
807
  * @param body Byte array of file in body of request
808
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
763
809
  */
764
- createQuoteAttachmentByFileName(xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream, options?: {
810
+ createQuoteAttachmentByFileName(xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
765
811
  headers: {
766
812
  [name: string]: string;
767
813
  };
@@ -775,8 +821,9 @@ export declare class AccountingApi {
775
821
  * @param xeroTenantId Xero identifier for Tenant
776
822
  * @param quoteID Unique identifier for an Quote
777
823
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
824
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
778
825
  */
779
- createQuoteHistory(xeroTenantId: string, quoteID: string, historyRecords: HistoryRecords, options?: {
826
+ createQuoteHistory(xeroTenantId: string, quoteID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
780
827
  headers: {
781
828
  [name: string]: string;
782
829
  };
@@ -789,9 +836,10 @@ export declare class AccountingApi {
789
836
  * @summary Create one or more quotes
790
837
  * @param xeroTenantId Xero identifier for Tenant
791
838
  * @param quotes Quotes with an array of Quote object in body of request
839
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
792
840
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
793
841
  */
794
- createQuotes(xeroTenantId: string, quotes: Quotes, summarizeErrors?: boolean, options?: {
842
+ createQuotes(xeroTenantId: string, quotes: Quotes, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
795
843
  headers: {
796
844
  [name: string]: string;
797
845
  };
@@ -804,9 +852,10 @@ export declare class AccountingApi {
804
852
  * @summary Creates draft expense claim receipts for any user
805
853
  * @param xeroTenantId Xero identifier for Tenant
806
854
  * @param receipts Receipts with an array of Receipt object in body of request
855
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
807
856
  * @param unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
808
857
  */
809
- createReceipt(xeroTenantId: string, receipts: Receipts, unitdp?: number, options?: {
858
+ createReceipt(xeroTenantId: string, receipts: Receipts, idempotencyKey?: string, unitdp?: number, options?: {
810
859
  headers: {
811
860
  [name: string]: string;
812
861
  };
@@ -821,8 +870,9 @@ export declare class AccountingApi {
821
870
  * @param receiptID Unique identifier for a Receipt
822
871
  * @param fileName Name of the attachment
823
872
  * @param body Byte array of file in body of request
873
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
824
874
  */
825
- createReceiptAttachmentByFileName(xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream, options?: {
875
+ createReceiptAttachmentByFileName(xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
826
876
  headers: {
827
877
  [name: string]: string;
828
878
  };
@@ -836,8 +886,9 @@ export declare class AccountingApi {
836
886
  * @param xeroTenantId Xero identifier for Tenant
837
887
  * @param receiptID Unique identifier for a Receipt
838
888
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
889
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
839
890
  */
840
- createReceiptHistory(xeroTenantId: string, receiptID: string, historyRecords: HistoryRecords, options?: {
891
+ createReceiptHistory(xeroTenantId: string, receiptID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
841
892
  headers: {
842
893
  [name: string]: string;
843
894
  };
@@ -852,8 +903,9 @@ export declare class AccountingApi {
852
903
  * @param repeatingInvoiceID Unique identifier for a Repeating Invoice
853
904
  * @param fileName Name of the attachment
854
905
  * @param body Byte array of file in body of request
906
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
855
907
  */
856
- createRepeatingInvoiceAttachmentByFileName(xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream, options?: {
908
+ createRepeatingInvoiceAttachmentByFileName(xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
857
909
  headers: {
858
910
  [name: string]: string;
859
911
  };
@@ -867,8 +919,9 @@ export declare class AccountingApi {
867
919
  * @param xeroTenantId Xero identifier for Tenant
868
920
  * @param repeatingInvoiceID Unique identifier for a Repeating Invoice
869
921
  * @param historyRecords HistoryRecords containing an array of HistoryRecord objects in body of request
922
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
870
923
  */
871
- createRepeatingInvoiceHistory(xeroTenantId: string, repeatingInvoiceID: string, historyRecords: HistoryRecords, options?: {
924
+ createRepeatingInvoiceHistory(xeroTenantId: string, repeatingInvoiceID: string, historyRecords: HistoryRecords, idempotencyKey?: string, options?: {
872
925
  headers: {
873
926
  [name: string]: string;
874
927
  };
@@ -881,9 +934,10 @@ export declare class AccountingApi {
881
934
  * @summary Creates one or more repeating invoice templates
882
935
  * @param xeroTenantId Xero identifier for Tenant
883
936
  * @param repeatingInvoices RepeatingInvoices with an array of repeating invoice objects in body of request
937
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
884
938
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
885
939
  */
886
- createRepeatingInvoices(xeroTenantId: string, repeatingInvoices: RepeatingInvoices, summarizeErrors?: boolean, options?: {
940
+ createRepeatingInvoices(xeroTenantId: string, repeatingInvoices: RepeatingInvoices, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
887
941
  headers: {
888
942
  [name: string]: string;
889
943
  };
@@ -896,8 +950,9 @@ export declare class AccountingApi {
896
950
  * @summary Creates one or more tax rates
897
951
  * @param xeroTenantId Xero identifier for Tenant
898
952
  * @param taxRates TaxRates array with TaxRate object in body of request
953
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
899
954
  */
900
- createTaxRates(xeroTenantId: string, taxRates: TaxRates, options?: {
955
+ createTaxRates(xeroTenantId: string, taxRates: TaxRates, idempotencyKey?: string, options?: {
901
956
  headers: {
902
957
  [name: string]: string;
903
958
  };
@@ -910,8 +965,9 @@ export declare class AccountingApi {
910
965
  * @summary Create tracking categories
911
966
  * @param xeroTenantId Xero identifier for Tenant
912
967
  * @param trackingCategory TrackingCategory object in body of request
968
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
913
969
  */
914
- createTrackingCategory(xeroTenantId: string, trackingCategory: TrackingCategory, options?: {
970
+ createTrackingCategory(xeroTenantId: string, trackingCategory: TrackingCategory, idempotencyKey?: string, options?: {
915
971
  headers: {
916
972
  [name: string]: string;
917
973
  };
@@ -925,8 +981,9 @@ export declare class AccountingApi {
925
981
  * @param xeroTenantId Xero identifier for Tenant
926
982
  * @param trackingCategoryID Unique identifier for a TrackingCategory
927
983
  * @param trackingOption TrackingOption object in body of request
984
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
928
985
  */
929
- createTrackingOptions(xeroTenantId: string, trackingCategoryID: string, trackingOption: TrackingOption, options?: {
986
+ createTrackingOptions(xeroTenantId: string, trackingCategoryID: string, trackingOption: TrackingOption, idempotencyKey?: string, options?: {
930
987
  headers: {
931
988
  [name: string]: string;
932
989
  };
@@ -953,8 +1010,9 @@ export declare class AccountingApi {
953
1010
  * @summary Updates a specific batch payment for invoices and credit notes
954
1011
  * @param xeroTenantId Xero identifier for Tenant
955
1012
  * @param batchPaymentDelete
1013
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
956
1014
  */
957
- deleteBatchPayment(xeroTenantId: string, batchPaymentDelete: BatchPaymentDelete, options?: {
1015
+ deleteBatchPayment(xeroTenantId: string, batchPaymentDelete: BatchPaymentDelete, idempotencyKey?: string, options?: {
958
1016
  headers: {
959
1017
  [name: string]: string;
960
1018
  };
@@ -968,8 +1026,9 @@ export declare class AccountingApi {
968
1026
  * @param xeroTenantId Xero identifier for Tenant
969
1027
  * @param batchPaymentID Unique identifier for BatchPayment
970
1028
  * @param batchPaymentDeleteByUrlParam
1029
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
971
1030
  */
972
- deleteBatchPaymentByUrlParam(xeroTenantId: string, batchPaymentID: string, batchPaymentDeleteByUrlParam: BatchPaymentDeleteByUrlParam, options?: {
1031
+ deleteBatchPaymentByUrlParam(xeroTenantId: string, batchPaymentID: string, batchPaymentDeleteByUrlParam: BatchPaymentDeleteByUrlParam, idempotencyKey?: string, options?: {
973
1032
  headers: {
974
1033
  [name: string]: string;
975
1034
  };
@@ -1006,6 +1065,21 @@ export declare class AccountingApi {
1006
1065
  response: http.IncomingMessage;
1007
1066
  body?: any;
1008
1067
  }>;
1068
+ /**
1069
+ *
1070
+ * @summary Deletes an Allocation from a Credit Note
1071
+ * @param xeroTenantId Xero identifier for Tenant
1072
+ * @param creditNoteID Unique identifier for a Credit Note
1073
+ * @param allocationID Unique identifier for Allocation object
1074
+ */
1075
+ deleteCreditNoteAllocations(xeroTenantId: string, creditNoteID: string, allocationID: string, options?: {
1076
+ headers: {
1077
+ [name: string]: string;
1078
+ };
1079
+ }): Promise<{
1080
+ response: http.IncomingMessage;
1081
+ body: Allocation;
1082
+ }>;
1009
1083
  /**
1010
1084
  *
1011
1085
  * @summary Deletes a specific item
@@ -1034,14 +1108,30 @@ export declare class AccountingApi {
1034
1108
  response: http.IncomingMessage;
1035
1109
  body?: any;
1036
1110
  }>;
1111
+ /**
1112
+ *
1113
+ * @summary Deletes an Allocation from an overpayment
1114
+ * @param xeroTenantId Xero identifier for Tenant
1115
+ * @param overpaymentID Unique identifier for a Overpayment
1116
+ * @param allocationID Unique identifier for Allocation object
1117
+ */
1118
+ deleteOverpaymentAllocations(xeroTenantId: string, overpaymentID: string, allocationID: string, options?: {
1119
+ headers: {
1120
+ [name: string]: string;
1121
+ };
1122
+ }): Promise<{
1123
+ response: http.IncomingMessage;
1124
+ body: Allocation;
1125
+ }>;
1037
1126
  /**
1038
1127
  *
1039
1128
  * @summary Updates a specific payment for invoices and credit notes
1040
1129
  * @param xeroTenantId Xero identifier for Tenant
1041
1130
  * @param paymentID Unique identifier for a Payment
1042
1131
  * @param paymentDelete
1132
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1043
1133
  */
1044
- deletePayment(xeroTenantId: string, paymentID: string, paymentDelete: PaymentDelete, options?: {
1134
+ deletePayment(xeroTenantId: string, paymentID: string, paymentDelete: PaymentDelete, idempotencyKey?: string, options?: {
1045
1135
  headers: {
1046
1136
  [name: string]: string;
1047
1137
  };
@@ -1049,6 +1139,21 @@ export declare class AccountingApi {
1049
1139
  response: http.IncomingMessage;
1050
1140
  body: Payments;
1051
1141
  }>;
1142
+ /**
1143
+ *
1144
+ * @summary Deletes an Allocation from a Prepayment
1145
+ * @param xeroTenantId Xero identifier for Tenant
1146
+ * @param prepaymentID Unique identifier for a PrePayment
1147
+ * @param allocationID Unique identifier for Allocation object
1148
+ */
1149
+ deletePrepaymentAllocations(xeroTenantId: string, prepaymentID: string, allocationID: string, options?: {
1150
+ headers: {
1151
+ [name: string]: string;
1152
+ };
1153
+ }): Promise<{
1154
+ response: http.IncomingMessage;
1155
+ body: Allocation;
1156
+ }>;
1052
1157
  /**
1053
1158
  *
1054
1159
  * @summary Deletes a specific tracking category
@@ -1084,8 +1189,9 @@ export declare class AccountingApi {
1084
1189
  * @param xeroTenantId Xero identifier for Tenant
1085
1190
  * @param invoiceID Unique identifier for an Invoice
1086
1191
  * @param requestEmpty
1192
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1087
1193
  */
1088
- emailInvoice(xeroTenantId: string, invoiceID: string, requestEmpty: RequestEmpty, options?: {
1194
+ emailInvoice(xeroTenantId: string, invoiceID: string, requestEmpty: RequestEmpty, idempotencyKey?: string, options?: {
1089
1195
  headers: {
1090
1196
  [name: string]: string;
1091
1197
  };
@@ -3034,8 +3140,9 @@ export declare class AccountingApi {
3034
3140
  * @summary Sets the chart of accounts, the conversion date and conversion balances
3035
3141
  * @param xeroTenantId Xero identifier for Tenant
3036
3142
  * @param setup Object including an accounts array, a conversion balances array and a conversion date object in body of request
3143
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3037
3144
  */
3038
- postSetup(xeroTenantId: string, setup: Setup, options?: {
3145
+ postSetup(xeroTenantId: string, setup: Setup, idempotencyKey?: string, options?: {
3039
3146
  headers: {
3040
3147
  [name: string]: string;
3041
3148
  };
@@ -3049,8 +3156,9 @@ export declare class AccountingApi {
3049
3156
  * @param xeroTenantId Xero identifier for Tenant
3050
3157
  * @param accountID Unique identifier for Account object
3051
3158
  * @param accounts Request of type Accounts array with one Account
3159
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3052
3160
  */
3053
- updateAccount(xeroTenantId: string, accountID: string, accounts: Accounts, options?: {
3161
+ updateAccount(xeroTenantId: string, accountID: string, accounts: Accounts, idempotencyKey?: string, options?: {
3054
3162
  headers: {
3055
3163
  [name: string]: string;
3056
3164
  };
@@ -3065,8 +3173,9 @@ export declare class AccountingApi {
3065
3173
  * @param accountID Unique identifier for Account object
3066
3174
  * @param fileName Name of the attachment
3067
3175
  * @param body Byte array of file in body of request
3176
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3068
3177
  */
3069
- updateAccountAttachmentByFileName(xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream, options?: {
3178
+ updateAccountAttachmentByFileName(xeroTenantId: string, accountID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3070
3179
  headers: {
3071
3180
  [name: string]: string;
3072
3181
  };
@@ -3080,9 +3189,10 @@ export declare class AccountingApi {
3080
3189
  * @param xeroTenantId Xero identifier for Tenant
3081
3190
  * @param bankTransactionID Xero generated unique identifier for a bank transaction
3082
3191
  * @param bankTransactions
3192
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3083
3193
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3084
3194
  */
3085
- updateBankTransaction(xeroTenantId: string, bankTransactionID: string, bankTransactions: BankTransactions, unitdp?: number, options?: {
3195
+ updateBankTransaction(xeroTenantId: string, bankTransactionID: string, bankTransactions: BankTransactions, idempotencyKey?: string, unitdp?: number, options?: {
3086
3196
  headers: {
3087
3197
  [name: string]: string;
3088
3198
  };
@@ -3097,8 +3207,9 @@ export declare class AccountingApi {
3097
3207
  * @param bankTransactionID Xero generated unique identifier for a bank transaction
3098
3208
  * @param fileName Name of the attachment
3099
3209
  * @param body Byte array of file in body of request
3210
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3100
3211
  */
3101
- updateBankTransactionAttachmentByFileName(xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream, options?: {
3212
+ updateBankTransactionAttachmentByFileName(xeroTenantId: string, bankTransactionID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3102
3213
  headers: {
3103
3214
  [name: string]: string;
3104
3215
  };
@@ -3112,8 +3223,9 @@ export declare class AccountingApi {
3112
3223
  * @param bankTransferID Xero generated unique identifier for a bank transfer
3113
3224
  * @param fileName Name of the attachment
3114
3225
  * @param body Byte array of file in body of request
3226
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3115
3227
  */
3116
- updateBankTransferAttachmentByFileName(xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream, options?: {
3228
+ updateBankTransferAttachmentByFileName(xeroTenantId: string, bankTransferID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3117
3229
  headers: {
3118
3230
  [name: string]: string;
3119
3231
  };
@@ -3127,8 +3239,9 @@ export declare class AccountingApi {
3127
3239
  * @param xeroTenantId Xero identifier for Tenant
3128
3240
  * @param contactID Unique identifier for a Contact
3129
3241
  * @param contacts an array of Contacts containing single Contact object with properties to update
3242
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3130
3243
  */
3131
- updateContact(xeroTenantId: string, contactID: string, contacts: Contacts, options?: {
3244
+ updateContact(xeroTenantId: string, contactID: string, contacts: Contacts, idempotencyKey?: string, options?: {
3132
3245
  headers: {
3133
3246
  [name: string]: string;
3134
3247
  };
@@ -3142,8 +3255,9 @@ export declare class AccountingApi {
3142
3255
  * @param contactID Unique identifier for a Contact
3143
3256
  * @param fileName Name of the attachment
3144
3257
  * @param body Byte array of file in body of request
3258
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3145
3259
  */
3146
- updateContactAttachmentByFileName(xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream, options?: {
3260
+ updateContactAttachmentByFileName(xeroTenantId: string, contactID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3147
3261
  headers: {
3148
3262
  [name: string]: string;
3149
3263
  };
@@ -3157,8 +3271,9 @@ export declare class AccountingApi {
3157
3271
  * @param xeroTenantId Xero identifier for Tenant
3158
3272
  * @param contactGroupID Unique identifier for a Contact Group
3159
3273
  * @param contactGroups an array of Contact groups with Name of specific group to update
3274
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3160
3275
  */
3161
- updateContactGroup(xeroTenantId: string, contactGroupID: string, contactGroups: ContactGroups, options?: {
3276
+ updateContactGroup(xeroTenantId: string, contactGroupID: string, contactGroups: ContactGroups, idempotencyKey?: string, options?: {
3162
3277
  headers: {
3163
3278
  [name: string]: string;
3164
3279
  };
@@ -3172,9 +3287,10 @@ export declare class AccountingApi {
3172
3287
  * @param xeroTenantId Xero identifier for Tenant
3173
3288
  * @param creditNoteID Unique identifier for a Credit Note
3174
3289
  * @param creditNotes an array of Credit Notes containing credit note details to update
3290
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3175
3291
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3176
3292
  */
3177
- updateCreditNote(xeroTenantId: string, creditNoteID: string, creditNotes: CreditNotes, unitdp?: number, options?: {
3293
+ updateCreditNote(xeroTenantId: string, creditNoteID: string, creditNotes: CreditNotes, idempotencyKey?: string, unitdp?: number, options?: {
3178
3294
  headers: {
3179
3295
  [name: string]: string;
3180
3296
  };
@@ -3189,8 +3305,9 @@ export declare class AccountingApi {
3189
3305
  * @param creditNoteID Unique identifier for a Credit Note
3190
3306
  * @param fileName Name of the attachment
3191
3307
  * @param body Byte array of file in body of request
3308
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3192
3309
  */
3193
- updateCreditNoteAttachmentByFileName(xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream, options?: {
3310
+ updateCreditNoteAttachmentByFileName(xeroTenantId: string, creditNoteID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3194
3311
  headers: {
3195
3312
  [name: string]: string;
3196
3313
  };
@@ -3204,8 +3321,9 @@ export declare class AccountingApi {
3204
3321
  * @param xeroTenantId Xero identifier for Tenant
3205
3322
  * @param expenseClaimID Unique identifier for a ExpenseClaim
3206
3323
  * @param expenseClaims
3324
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3207
3325
  */
3208
- updateExpenseClaim(xeroTenantId: string, expenseClaimID: string, expenseClaims: ExpenseClaims, options?: {
3326
+ updateExpenseClaim(xeroTenantId: string, expenseClaimID: string, expenseClaims: ExpenseClaims, idempotencyKey?: string, options?: {
3209
3327
  headers: {
3210
3328
  [name: string]: string;
3211
3329
  };
@@ -3219,9 +3337,10 @@ export declare class AccountingApi {
3219
3337
  * @param xeroTenantId Xero identifier for Tenant
3220
3338
  * @param invoiceID Unique identifier for an Invoice
3221
3339
  * @param invoices
3340
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3222
3341
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3223
3342
  */
3224
- updateInvoice(xeroTenantId: string, invoiceID: string, invoices: Invoices, unitdp?: number, options?: {
3343
+ updateInvoice(xeroTenantId: string, invoiceID: string, invoices: Invoices, idempotencyKey?: string, unitdp?: number, options?: {
3225
3344
  headers: {
3226
3345
  [name: string]: string;
3227
3346
  };
@@ -3236,8 +3355,9 @@ export declare class AccountingApi {
3236
3355
  * @param invoiceID Unique identifier for an Invoice
3237
3356
  * @param fileName Name of the attachment
3238
3357
  * @param body Byte array of file in body of request
3358
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3239
3359
  */
3240
- updateInvoiceAttachmentByFileName(xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream, options?: {
3360
+ updateInvoiceAttachmentByFileName(xeroTenantId: string, invoiceID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3241
3361
  headers: {
3242
3362
  [name: string]: string;
3243
3363
  };
@@ -3251,9 +3371,10 @@ export declare class AccountingApi {
3251
3371
  * @param xeroTenantId Xero identifier for Tenant
3252
3372
  * @param itemID Unique identifier for an Item
3253
3373
  * @param items
3374
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3254
3375
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3255
3376
  */
3256
- updateItem(xeroTenantId: string, itemID: string, items: Items, unitdp?: number, options?: {
3377
+ updateItem(xeroTenantId: string, itemID: string, items: Items, idempotencyKey?: string, unitdp?: number, options?: {
3257
3378
  headers: {
3258
3379
  [name: string]: string;
3259
3380
  };
@@ -3267,8 +3388,9 @@ export declare class AccountingApi {
3267
3388
  * @param xeroTenantId Xero identifier for Tenant
3268
3389
  * @param linkedTransactionID Unique identifier for a LinkedTransaction
3269
3390
  * @param linkedTransactions
3391
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3270
3392
  */
3271
- updateLinkedTransaction(xeroTenantId: string, linkedTransactionID: string, linkedTransactions: LinkedTransactions, options?: {
3393
+ updateLinkedTransaction(xeroTenantId: string, linkedTransactionID: string, linkedTransactions: LinkedTransactions, idempotencyKey?: string, options?: {
3272
3394
  headers: {
3273
3395
  [name: string]: string;
3274
3396
  };
@@ -3282,8 +3404,9 @@ export declare class AccountingApi {
3282
3404
  * @param xeroTenantId Xero identifier for Tenant
3283
3405
  * @param manualJournalID Unique identifier for a ManualJournal
3284
3406
  * @param manualJournals
3407
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3285
3408
  */
3286
- updateManualJournal(xeroTenantId: string, manualJournalID: string, manualJournals: ManualJournals, options?: {
3409
+ updateManualJournal(xeroTenantId: string, manualJournalID: string, manualJournals: ManualJournals, idempotencyKey?: string, options?: {
3287
3410
  headers: {
3288
3411
  [name: string]: string;
3289
3412
  };
@@ -3298,8 +3421,9 @@ export declare class AccountingApi {
3298
3421
  * @param manualJournalID Unique identifier for a ManualJournal
3299
3422
  * @param fileName Name of the attachment
3300
3423
  * @param body Byte array of file in body of request
3424
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3301
3425
  */
3302
- updateManualJournalAttachmentByFileName(xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream, options?: {
3426
+ updateManualJournalAttachmentByFileName(xeroTenantId: string, manualJournalID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3303
3427
  headers: {
3304
3428
  [name: string]: string;
3305
3429
  };
@@ -3312,10 +3436,11 @@ export declare class AccountingApi {
3312
3436
  * @summary Updates or creates one or more spent or received money transaction
3313
3437
  * @param xeroTenantId Xero identifier for Tenant
3314
3438
  * @param bankTransactions
3439
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3315
3440
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3316
3441
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3317
3442
  */
3318
- updateOrCreateBankTransactions(xeroTenantId: string, bankTransactions: BankTransactions, summarizeErrors?: boolean, unitdp?: number, options?: {
3443
+ updateOrCreateBankTransactions(xeroTenantId: string, bankTransactions: BankTransactions, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options?: {
3319
3444
  headers: {
3320
3445
  [name: string]: string;
3321
3446
  };
@@ -3328,9 +3453,10 @@ export declare class AccountingApi {
3328
3453
  * @summary Updates or creates one or more contacts in a Xero organisation
3329
3454
  * @param xeroTenantId Xero identifier for Tenant
3330
3455
  * @param contacts
3456
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3331
3457
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3332
3458
  */
3333
- updateOrCreateContacts(xeroTenantId: string, contacts: Contacts, summarizeErrors?: boolean, options?: {
3459
+ updateOrCreateContacts(xeroTenantId: string, contacts: Contacts, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
3334
3460
  headers: {
3335
3461
  [name: string]: string;
3336
3462
  };
@@ -3343,10 +3469,11 @@ export declare class AccountingApi {
3343
3469
  * @summary Updates or creates one or more credit notes
3344
3470
  * @param xeroTenantId Xero identifier for Tenant
3345
3471
  * @param creditNotes an array of Credit Notes with a single CreditNote object.
3472
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3346
3473
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3347
3474
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3348
3475
  */
3349
- updateOrCreateCreditNotes(xeroTenantId: string, creditNotes: CreditNotes, summarizeErrors?: boolean, unitdp?: number, options?: {
3476
+ updateOrCreateCreditNotes(xeroTenantId: string, creditNotes: CreditNotes, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options?: {
3350
3477
  headers: {
3351
3478
  [name: string]: string;
3352
3479
  };
@@ -3359,9 +3486,10 @@ export declare class AccountingApi {
3359
3486
  * @summary Creates a single new employees used in Xero payrun
3360
3487
  * @param xeroTenantId Xero identifier for Tenant
3361
3488
  * @param employees Employees with array of Employee object in body of request
3489
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3362
3490
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3363
3491
  */
3364
- updateOrCreateEmployees(xeroTenantId: string, employees: Employees, summarizeErrors?: boolean, options?: {
3492
+ updateOrCreateEmployees(xeroTenantId: string, employees: Employees, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
3365
3493
  headers: {
3366
3494
  [name: string]: string;
3367
3495
  };
@@ -3374,10 +3502,11 @@ export declare class AccountingApi {
3374
3502
  * @summary Updates or creates one or more sales invoices or purchase bills
3375
3503
  * @param xeroTenantId Xero identifier for Tenant
3376
3504
  * @param invoices
3505
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3377
3506
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3378
3507
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3379
3508
  */
3380
- updateOrCreateInvoices(xeroTenantId: string, invoices: Invoices, summarizeErrors?: boolean, unitdp?: number, options?: {
3509
+ updateOrCreateInvoices(xeroTenantId: string, invoices: Invoices, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options?: {
3381
3510
  headers: {
3382
3511
  [name: string]: string;
3383
3512
  };
@@ -3390,10 +3519,11 @@ export declare class AccountingApi {
3390
3519
  * @summary Updates or creates one or more items
3391
3520
  * @param xeroTenantId Xero identifier for Tenant
3392
3521
  * @param items
3522
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3393
3523
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3394
3524
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3395
3525
  */
3396
- updateOrCreateItems(xeroTenantId: string, items: Items, summarizeErrors?: boolean, unitdp?: number, options?: {
3526
+ updateOrCreateItems(xeroTenantId: string, items: Items, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options?: {
3397
3527
  headers: {
3398
3528
  [name: string]: string;
3399
3529
  };
@@ -3406,9 +3536,10 @@ export declare class AccountingApi {
3406
3536
  * @summary Updates or creates a single manual journal
3407
3537
  * @param xeroTenantId Xero identifier for Tenant
3408
3538
  * @param manualJournals ManualJournals array with ManualJournal object in body of request
3539
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3409
3540
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3410
3541
  */
3411
- updateOrCreateManualJournals(xeroTenantId: string, manualJournals: ManualJournals, summarizeErrors?: boolean, options?: {
3542
+ updateOrCreateManualJournals(xeroTenantId: string, manualJournals: ManualJournals, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
3412
3543
  headers: {
3413
3544
  [name: string]: string;
3414
3545
  };
@@ -3421,9 +3552,10 @@ export declare class AccountingApi {
3421
3552
  * @summary Updates or creates one or more purchase orders
3422
3553
  * @param xeroTenantId Xero identifier for Tenant
3423
3554
  * @param purchaseOrders
3555
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3424
3556
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3425
3557
  */
3426
- updateOrCreatePurchaseOrders(xeroTenantId: string, purchaseOrders: PurchaseOrders, summarizeErrors?: boolean, options?: {
3558
+ updateOrCreatePurchaseOrders(xeroTenantId: string, purchaseOrders: PurchaseOrders, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
3427
3559
  headers: {
3428
3560
  [name: string]: string;
3429
3561
  };
@@ -3436,9 +3568,10 @@ export declare class AccountingApi {
3436
3568
  * @summary Updates or creates one or more quotes
3437
3569
  * @param xeroTenantId Xero identifier for Tenant
3438
3570
  * @param quotes
3571
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3439
3572
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3440
3573
  */
3441
- updateOrCreateQuotes(xeroTenantId: string, quotes: Quotes, summarizeErrors?: boolean, options?: {
3574
+ updateOrCreateQuotes(xeroTenantId: string, quotes: Quotes, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
3442
3575
  headers: {
3443
3576
  [name: string]: string;
3444
3577
  };
@@ -3451,9 +3584,10 @@ export declare class AccountingApi {
3451
3584
  * @summary Creates or deletes one or more repeating invoice templates
3452
3585
  * @param xeroTenantId Xero identifier for Tenant
3453
3586
  * @param repeatingInvoices RepeatingInvoices with an array of repeating invoice objects in body of request
3587
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3454
3588
  * @param summarizeErrors If false return 200 OK and mix of successfully created objects and any with validation errors
3455
3589
  */
3456
- updateOrCreateRepeatingInvoices(xeroTenantId: string, repeatingInvoices: RepeatingInvoices, summarizeErrors?: boolean, options?: {
3590
+ updateOrCreateRepeatingInvoices(xeroTenantId: string, repeatingInvoices: RepeatingInvoices, idempotencyKey?: string, summarizeErrors?: boolean, options?: {
3457
3591
  headers: {
3458
3592
  [name: string]: string;
3459
3593
  };
@@ -3467,8 +3601,9 @@ export declare class AccountingApi {
3467
3601
  * @param xeroTenantId Xero identifier for Tenant
3468
3602
  * @param purchaseOrderID Unique identifier for an Purchase Order
3469
3603
  * @param purchaseOrders
3604
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3470
3605
  */
3471
- updatePurchaseOrder(xeroTenantId: string, purchaseOrderID: string, purchaseOrders: PurchaseOrders, options?: {
3606
+ updatePurchaseOrder(xeroTenantId: string, purchaseOrderID: string, purchaseOrders: PurchaseOrders, idempotencyKey?: string, options?: {
3472
3607
  headers: {
3473
3608
  [name: string]: string;
3474
3609
  };
@@ -3483,8 +3618,9 @@ export declare class AccountingApi {
3483
3618
  * @param purchaseOrderID Unique identifier for an Purchase Order
3484
3619
  * @param fileName Name of the attachment
3485
3620
  * @param body Byte array of file in body of request
3621
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3486
3622
  */
3487
- updatePurchaseOrderAttachmentByFileName(xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream, options?: {
3623
+ updatePurchaseOrderAttachmentByFileName(xeroTenantId: string, purchaseOrderID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3488
3624
  headers: {
3489
3625
  [name: string]: string;
3490
3626
  };
@@ -3498,8 +3634,9 @@ export declare class AccountingApi {
3498
3634
  * @param xeroTenantId Xero identifier for Tenant
3499
3635
  * @param quoteID Unique identifier for an Quote
3500
3636
  * @param quotes
3637
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3501
3638
  */
3502
- updateQuote(xeroTenantId: string, quoteID: string, quotes: Quotes, options?: {
3639
+ updateQuote(xeroTenantId: string, quoteID: string, quotes: Quotes, idempotencyKey?: string, options?: {
3503
3640
  headers: {
3504
3641
  [name: string]: string;
3505
3642
  };
@@ -3514,8 +3651,9 @@ export declare class AccountingApi {
3514
3651
  * @param quoteID Unique identifier for an Quote
3515
3652
  * @param fileName Name of the attachment
3516
3653
  * @param body Byte array of file in body of request
3654
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3517
3655
  */
3518
- updateQuoteAttachmentByFileName(xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream, options?: {
3656
+ updateQuoteAttachmentByFileName(xeroTenantId: string, quoteID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3519
3657
  headers: {
3520
3658
  [name: string]: string;
3521
3659
  };
@@ -3529,9 +3667,10 @@ export declare class AccountingApi {
3529
3667
  * @param xeroTenantId Xero identifier for Tenant
3530
3668
  * @param receiptID Unique identifier for a Receipt
3531
3669
  * @param receipts
3670
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3532
3671
  * @param unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
3533
3672
  */
3534
- updateReceipt(xeroTenantId: string, receiptID: string, receipts: Receipts, unitdp?: number, options?: {
3673
+ updateReceipt(xeroTenantId: string, receiptID: string, receipts: Receipts, idempotencyKey?: string, unitdp?: number, options?: {
3535
3674
  headers: {
3536
3675
  [name: string]: string;
3537
3676
  };
@@ -3546,8 +3685,9 @@ export declare class AccountingApi {
3546
3685
  * @param receiptID Unique identifier for a Receipt
3547
3686
  * @param fileName Name of the attachment
3548
3687
  * @param body Byte array of file in body of request
3688
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3549
3689
  */
3550
- updateReceiptAttachmentByFileName(xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream, options?: {
3690
+ updateReceiptAttachmentByFileName(xeroTenantId: string, receiptID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3551
3691
  headers: {
3552
3692
  [name: string]: string;
3553
3693
  };
@@ -3561,8 +3701,9 @@ export declare class AccountingApi {
3561
3701
  * @param xeroTenantId Xero identifier for Tenant
3562
3702
  * @param repeatingInvoiceID Unique identifier for a Repeating Invoice
3563
3703
  * @param repeatingInvoices
3704
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3564
3705
  */
3565
- updateRepeatingInvoice(xeroTenantId: string, repeatingInvoiceID: string, repeatingInvoices: RepeatingInvoices, options?: {
3706
+ updateRepeatingInvoice(xeroTenantId: string, repeatingInvoiceID: string, repeatingInvoices: RepeatingInvoices, idempotencyKey?: string, options?: {
3566
3707
  headers: {
3567
3708
  [name: string]: string;
3568
3709
  };
@@ -3577,8 +3718,9 @@ export declare class AccountingApi {
3577
3718
  * @param repeatingInvoiceID Unique identifier for a Repeating Invoice
3578
3719
  * @param fileName Name of the attachment
3579
3720
  * @param body Byte array of file in body of request
3721
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3580
3722
  */
3581
- updateRepeatingInvoiceAttachmentByFileName(xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream, options?: {
3723
+ updateRepeatingInvoiceAttachmentByFileName(xeroTenantId: string, repeatingInvoiceID: string, fileName: string, body: fs.ReadStream, idempotencyKey?: string, options?: {
3582
3724
  headers: {
3583
3725
  [name: string]: string;
3584
3726
  };
@@ -3591,8 +3733,9 @@ export declare class AccountingApi {
3591
3733
  * @summary Updates tax rates
3592
3734
  * @param xeroTenantId Xero identifier for Tenant
3593
3735
  * @param taxRates
3736
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3594
3737
  */
3595
- updateTaxRate(xeroTenantId: string, taxRates: TaxRates, options?: {
3738
+ updateTaxRate(xeroTenantId: string, taxRates: TaxRates, idempotencyKey?: string, options?: {
3596
3739
  headers: {
3597
3740
  [name: string]: string;
3598
3741
  };
@@ -3606,8 +3749,9 @@ export declare class AccountingApi {
3606
3749
  * @param xeroTenantId Xero identifier for Tenant
3607
3750
  * @param trackingCategoryID Unique identifier for a TrackingCategory
3608
3751
  * @param trackingCategory
3752
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3609
3753
  */
3610
- updateTrackingCategory(xeroTenantId: string, trackingCategoryID: string, trackingCategory: TrackingCategory, options?: {
3754
+ updateTrackingCategory(xeroTenantId: string, trackingCategoryID: string, trackingCategory: TrackingCategory, idempotencyKey?: string, options?: {
3611
3755
  headers: {
3612
3756
  [name: string]: string;
3613
3757
  };
@@ -3622,8 +3766,9 @@ export declare class AccountingApi {
3622
3766
  * @param trackingCategoryID Unique identifier for a TrackingCategory
3623
3767
  * @param trackingOptionID Unique identifier for a Tracking Option
3624
3768
  * @param trackingOption
3769
+ * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
3625
3770
  */
3626
- updateTrackingOptions(xeroTenantId: string, trackingCategoryID: string, trackingOptionID: string, trackingOption: TrackingOption, options?: {
3771
+ updateTrackingOptions(xeroTenantId: string, trackingCategoryID: string, trackingOptionID: string, trackingOption: TrackingOption, idempotencyKey?: string, options?: {
3627
3772
  headers: {
3628
3773
  [name: string]: string;
3629
3774
  };