diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index f3b99043..33481caf 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -10,7 +10,7 @@ jobs: - name: Setup Ruby uses: ruby/setup-ruby@v1 with: - ruby-version: '2.7' + ruby-version: '3.0.0' - name: Build and run tests run: | gem install bundler diff --git a/Gemfile.lock b/Gemfile.lock index 640435b3..172853fb 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,10 +1,10 @@ PATH remote: . specs: - xero-ruby (4.0.0) + xero-ruby (5.0.0) faraday (>= 2.0, < 3.0) json (~> 2.1, >= 2.1.0) - json-jwt (~> 1.5, >= 1.5.2) + json-jwt (~> 1.16, >= 1.16.3) GEM remote: https://rubygems.org/ diff --git a/docs/accounting/AccountingApi.md b/docs/accounting/AccountingApi.md index 54cdfdd1..e43662fa 100644 --- a/docs/accounting/AccountingApi.md +++ b/docs/accounting/AccountingApi.md @@ -65,9 +65,12 @@ Method | HTTP request | Description [**delete_batch_payment_by_url_param**](AccountingApi.md#delete_batch_payment_by_url_param) | **POST** /BatchPayments/{BatchPaymentID} | Updates a specific batch payment for invoices and credit notes [**delete_contact_group_contact**](AccountingApi.md#delete_contact_group_contact) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts/{ContactID} | Deletes a specific contact from a contact group using a unique contact Id [**delete_contact_group_contacts**](AccountingApi.md#delete_contact_group_contacts) | **DELETE** /ContactGroups/{ContactGroupID}/Contacts | Deletes all contacts from a specific contact group +[**delete_credit_note_allocations**](AccountingApi.md#delete_credit_note_allocations) | **DELETE** /CreditNotes/{CreditNoteID}/Allocations/{AllocationID} | Deletes an Allocation from a Credit Note [**delete_item**](AccountingApi.md#delete_item) | **DELETE** /Items/{ItemID} | Deletes a specific item [**delete_linked_transaction**](AccountingApi.md#delete_linked_transaction) | **DELETE** /LinkedTransactions/{LinkedTransactionID} | Deletes a specific linked transactions (billable expenses) +[**delete_overpayment_allocations**](AccountingApi.md#delete_overpayment_allocations) | **DELETE** /Overpayments/{OverpaymentID}/Allocations/{AllocationID} | Deletes an Allocation from an overpayment [**delete_payment**](AccountingApi.md#delete_payment) | **POST** /Payments/{PaymentID} | Updates a specific payment for invoices and credit notes +[**delete_prepayment_allocations**](AccountingApi.md#delete_prepayment_allocations) | **DELETE** /Prepayments/{PrepaymentID}/Allocations/{AllocationID} | Deletes an Allocation from a Prepayment [**delete_tracking_category**](AccountingApi.md#delete_tracking_category) | **DELETE** /TrackingCategories/{TrackingCategoryID} | Deletes a specific tracking category [**delete_tracking_options**](AccountingApi.md#delete_tracking_options) | **DELETE** /TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID} | Deletes a specific option for a specific tracking category [**email_invoice**](AccountingApi.md#email_invoice) | **POST** /Invoices/{InvoiceID}/Email | Sends a copy of a specific invoice to related contact via email @@ -242,7 +245,7 @@ Method | HTTP request | Description ## create_account -> Accounts create_account(xero_tenant_id, account) +> Accounts create_account(xero_tenant_id, account, opts) Creates a new chart of accounts @@ -273,9 +276,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant account = { "Code":"123456", "Name":"Foobar", "Type":"EXPENSE", "Description":"Hello World" } # Account | Account object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new chart of accounts - result = api_instance.create_account(xero_tenant_id, account) + result = api_instance.create_account(xero_tenant_id, account, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_account: #{e}" @@ -289,6 +296,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **account** | [**Account**](Account.md)| Account object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -306,7 +314,7 @@ Name | Type | Description | Notes ## create_account_attachment_by_file_name -> Attachments create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) +> Attachments create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts) Creates an attachment on a specific account @@ -339,9 +347,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an attachment on a specific account - result = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) + result = api_instance.create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_account_attachment_by_file_name: #{e}" @@ -357,6 +369,7 @@ Name | Type | Description | Notes **account_id** | [**String**](.md)| Unique identifier for Account object | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -374,7 +387,7 @@ Name | Type | Description | Notes ## create_bank_transaction_attachment_by_file_name -> Attachments create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) +> Attachments create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts) Creates an attachment for a specific bank transaction by filename @@ -407,9 +420,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an attachment for a specific bank transaction by filename - result = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + result = api_instance.create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transaction_attachment_by_file_name: #{e}" @@ -425,6 +442,7 @@ Name | Type | Description | Notes **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -442,7 +460,7 @@ Name | Type | Description | Notes ## create_bank_transaction_history_record -> HistoryRecords create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records) +> HistoryRecords create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, opts) Creates a history record for a specific bank transactions @@ -474,9 +492,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific bank transactions - result = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records) + result = api_instance.create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transaction_history_record: #{e}" @@ -491,6 +513,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -542,7 +565,9 @@ bank_transactions = { bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, opts = { summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -563,6 +588,7 @@ Name | Type | Description | Notes **bank_transactions** | [**BankTransactions**](BankTransactions.md)| BankTransactions with an array of BankTransaction objects in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -580,7 +606,7 @@ Name | Type | Description | Notes ## create_bank_transfer -> BankTransfers create_bank_transfer(xero_tenant_id, bank_transfers) +> BankTransfers create_bank_transfer(xero_tenant_id, bank_transfers, opts) Creates a bank transfer @@ -611,9 +637,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant bank_transfers = { "BankTransfers": [ { "FromBankAccount": { "Code": "090", "Name": "My Savings", "AccountID": "00000000-0000-0000-0000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-10-17T13:45:33.993-07:00" }, "ToBankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000", "Type": "BANK", "BankAccountNumber": "123455", "Status": "ACTIVE", "BankAccountType": "BANK", "CurrencyCode": "USD", "TaxType": "NONE", "EnablePaymentsToAccount": false, "ShowInExpenseClaims": false, "Class": "ASSET", "ReportingCode": "ASS", "ReportingCodeName": "Assets", "HasAttachments": false, "UpdatedDateUTC": "2016-06-03T08:31:14.517-07:00" }, "Amount": "50.00", "FromIsReconciled": true, "ToIsReconciled": true, "Reference": "Sub 098801" } ] } # BankTransfers | BankTransfers with array of BankTransfer objects in request body +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a bank transfer - result = api_instance.create_bank_transfer(xero_tenant_id, bank_transfers) + result = api_instance.create_bank_transfer(xero_tenant_id, bank_transfers, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transfer: #{e}" @@ -627,6 +657,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **bank_transfers** | [**BankTransfers**](BankTransfers.md)| BankTransfers with array of BankTransfer objects in request body | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -644,7 +675,7 @@ Name | Type | Description | Notes ## create_bank_transfer_attachment_by_file_name -> Attachments create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) +> Attachments create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts) @@ -677,8 +708,12 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin - result = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) + result = api_instance.create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transfer_attachment_by_file_name: #{e}" @@ -694,6 +729,7 @@ Name | Type | Description | Notes **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -711,7 +747,7 @@ Name | Type | Description | Notes ## create_bank_transfer_history_record -> HistoryRecords create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records) +> HistoryRecords create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, opts) Creates a history record for a specific bank transfer @@ -743,9 +779,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific bank transfer - result = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records) + result = api_instance.create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_bank_transfer_history_record: #{e}" @@ -760,6 +800,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -809,7 +850,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant batch_payments = { "BatchPayments": [ { "Account": { "AccountID": "00000000-0000-0000-0000-000000000000" }, "Reference": "ref", "Date": "2018-08-01", "Payments": [ { "Account": { "Code": "001" }, "Date": "2019-12-31", "Amount": 500, "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" } } ] } ] } # BatchPayments | BatchPayments with an array of Payments in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -829,6 +872,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **batch_payments** | [**BatchPayments**](BatchPayments.md)| BatchPayments with an array of Payments in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -846,7 +890,7 @@ Name | Type | Description | Notes ## create_batch_payment_history_record -> HistoryRecords create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records) +> HistoryRecords create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, opts) Creates a history record for a specific batch payment @@ -878,9 +922,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant batch_payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for BatchPayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific batch payment - result = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records) + result = api_instance.create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_batch_payment_history_record: #{e}" @@ -895,6 +943,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **batch_payment_id** | [**String**](.md)| Unique identifier for BatchPayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -912,7 +961,7 @@ Name | Type | Description | Notes ## create_branding_theme_payment_services -> PaymentServices create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services) +> PaymentServices create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services, opts) Creates a new custom payment service for a specific branding theme @@ -944,9 +993,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant branding_theme_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Branding Theme payment_services = { "PaymentServices": [ { "PaymentServiceID": "54b3b4f6-0443-4fba-bcd1-61ec0c35ca55", "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PaymentServiceType": "Custom", "PayNowText": "Time To Pay" } ] } # PaymentServices | PaymentServices array with PaymentService object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new custom payment service for a specific branding theme - result = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services) + result = api_instance.create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_services, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_branding_theme_payment_services: #{e}" @@ -961,6 +1014,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **branding_theme_id** | [**String**](.md)| Unique identifier for a Branding Theme | **payment_services** | [**PaymentServices**](PaymentServices.md)| PaymentServices array with PaymentService object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -978,7 +1032,7 @@ Name | Type | Description | Notes ## create_contact_attachment_by_file_name -> Attachments create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) +> Attachments create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts) @@ -1011,8 +1065,12 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin - result = api_instance.create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) + result = api_instance.create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_contact_attachment_by_file_name: #{e}" @@ -1028,6 +1086,7 @@ Name | Type | Description | Notes **contact_id** | [**String**](.md)| Unique identifier for a Contact | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1045,7 +1104,7 @@ Name | Type | Description | Notes ## create_contact_group -> ContactGroups create_contact_group(xero_tenant_id, contact_groups) +> ContactGroups create_contact_group(xero_tenant_id, contact_groups, opts) Creates a contact group @@ -1076,9 +1135,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contact_groups = { "ContactGroups": [{ "Name": "VIPs" }]} # ContactGroups | ContactGroups with an array of names in request body +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a contact group - result = api_instance.create_contact_group(xero_tenant_id, contact_groups) + result = api_instance.create_contact_group(xero_tenant_id, contact_groups, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_contact_group: #{e}" @@ -1092,6 +1155,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **contact_groups** | [**ContactGroups**](ContactGroups.md)| ContactGroups with an array of names in request body | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1109,7 +1173,7 @@ Name | Type | Description | Notes ## create_contact_group_contacts -> Contacts create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts) +> Contacts create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, opts) Creates contacts to a specific contact group @@ -1141,9 +1205,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contact_group_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact Group contacts = { "Contacts": [ { "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7" }, { "ContactID": "4e1753b9-018a-4775-b6aa-1bc7871cfee3" } ] } # Contacts | Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates contacts to a specific contact group - result = api_instance.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts) + result = api_instance.create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_contact_group_contacts: #{e}" @@ -1158,6 +1226,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **contact_group_id** | [**String**](.md)| Unique identifier for a Contact Group | **contacts** | [**Contacts**](Contacts.md)| Contacts with array of contacts specifying the ContactID to be added to ContactGroup in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1175,7 +1244,7 @@ Name | Type | Description | Notes ## create_contact_history -> HistoryRecords create_contact_history(xero_tenant_id, contact_id, history_records) +> HistoryRecords create_contact_history(xero_tenant_id, contact_id, history_records, opts) Creates a new history record for a specific contact @@ -1207,9 +1276,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a new history record for a specific contact - result = api_instance.create_contact_history(xero_tenant_id, contact_id, history_records) + result = api_instance.create_contact_history(xero_tenant_id, contact_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_contact_history: #{e}" @@ -1224,6 +1297,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **contact_id** | [**String**](.md)| Unique identifier for a Contact | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1273,7 +1347,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contacts = { "Contacts": [ { "ContactID": "3ff6d40c-af9a-40a3-89ce-3c1556a25591", "ContactStatus": "ACTIVE", "Name": "Foo9987", "EmailAddress": "sid32476@blah.com", "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "City": "", "Region": "", "PostalCode": "", "Country": "" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "/Date(1551399321043+0000)/", "ContactGroups": [], "IsSupplier": false, "IsCustomer": false, "SalesTrackingCategories": [], "PurchasesTrackingCategories": [], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } }, "ContactPersons": [] } ] } # Contacts | Contacts with an array of Contact objects to create in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -1293,6 +1369,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **contacts** | [**Contacts**](Contacts.md)| Contacts with an array of Contact objects to create in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1343,7 +1420,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841" }, "Amount": 1, "Date": "2019-03-05" } ] } # Allocations | Allocations with array of Allocation object in body of request. opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -1364,6 +1443,7 @@ Name | Type | Description | Notes **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | **allocations** | [**Allocations**](Allocations.md)| Allocations with array of Allocation object in body of request. | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1415,7 +1495,9 @@ credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identi file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request opts = { - include_online: false # Boolean | Allows an attachment to be seen by the end customer within their online invoice + include_online: false, # Boolean | Allows an attachment to be seen by the end customer within their online invoice + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -1437,6 +1519,7 @@ Name | Type | Description | Notes **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | **include_online** | **Boolean**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1454,7 +1537,7 @@ Name | Type | Description | Notes ## create_credit_note_history -> HistoryRecords create_credit_note_history(xero_tenant_id, credit_note_id, history_records) +> HistoryRecords create_credit_note_history(xero_tenant_id, credit_note_id, history_records, opts) Retrieves history records of a specific credit note @@ -1486,9 +1569,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Retrieves history records of a specific credit note - result = api_instance.create_credit_note_history(xero_tenant_id, credit_note_id, history_records) + result = api_instance.create_credit_note_history(xero_tenant_id, credit_note_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_credit_note_history: #{e}" @@ -1503,6 +1590,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1554,7 +1642,9 @@ credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID opts = { summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -1575,6 +1665,7 @@ Name | Type | Description | Notes **credit_notes** | [**CreditNotes**](CreditNotes.md)| Credit Notes with array of CreditNote object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1592,7 +1683,7 @@ Name | Type | Description | Notes ## create_currency -> Currencies create_currency(xero_tenant_id, currency) +> Currencies create_currency(xero_tenant_id, currency, opts) Create a new currency for a Xero organisation @@ -1623,9 +1714,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant currency = { "Code": "USD", "Description": "United States Dollar" } # Currency | Currency object in the body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Create a new currency for a Xero organisation - result = api_instance.create_currency(xero_tenant_id, currency) + result = api_instance.create_currency(xero_tenant_id, currency, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_currency: #{e}" @@ -1639,6 +1734,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **currency** | [**Currency**](Currency.md)| Currency object in the body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1688,7 +1784,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -1708,6 +1806,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1725,7 +1824,7 @@ Name | Type | Description | Notes ## create_expense_claim_history -> HistoryRecords create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records) +> HistoryRecords create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, opts) Creates a history record for a specific expense claim @@ -1757,9 +1856,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant expense_claim_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ExpenseClaim history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific expense claim - result = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records) + result = api_instance.create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_expense_claim_history: #{e}" @@ -1774,6 +1877,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **expense_claim_id** | [**String**](.md)| Unique identifier for a ExpenseClaim | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1791,7 +1895,7 @@ Name | Type | Description | Notes ## create_expense_claims -> ExpenseClaims create_expense_claims(xero_tenant_id, expense_claims) +> ExpenseClaims create_expense_claims(xero_tenant_id, expense_claims, opts) Creates expense claims @@ -1822,9 +1926,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | ExpenseClaims with array of ExpenseClaim object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates expense claims - result = api_instance.create_expense_claims(xero_tenant_id, expense_claims) + result = api_instance.create_expense_claims(xero_tenant_id, expense_claims, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_expense_claims: #{e}" @@ -1838,6 +1946,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **expense_claims** | [**ExpenseClaims**](ExpenseClaims.md)| ExpenseClaims with array of ExpenseClaim object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1889,7 +1998,9 @@ invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request opts = { - include_online: false # Boolean | Allows an attachment to be seen by the end customer within their online invoice + include_online: false, # Boolean | Allows an attachment to be seen by the end customer within their online invoice + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -1911,6 +2022,7 @@ Name | Type | Description | Notes **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | **include_online** | **Boolean**| Allows an attachment to be seen by the end customer within their online invoice | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -1928,7 +2040,7 @@ Name | Type | Description | Notes ## create_invoice_history -> HistoryRecords create_invoice_history(xero_tenant_id, invoice_id, history_records) +> HistoryRecords create_invoice_history(xero_tenant_id, invoice_id, history_records, opts) Creates a history record for a specific invoice @@ -1960,9 +2072,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific invoice - result = api_instance.create_invoice_history(xero_tenant_id, invoice_id, history_records) + result = api_instance.create_invoice_history(xero_tenant_id, invoice_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_invoice_history: #{e}" @@ -1977,6 +2093,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2028,7 +2145,9 @@ invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa1 opts = { summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -2049,6 +2168,7 @@ Name | Type | Description | Notes **invoices** | [**Invoices**](Invoices.md)| Invoices with an array of invoice objects in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2066,7 +2186,7 @@ Name | Type | Description | Notes ## create_item_history -> HistoryRecords create_item_history(xero_tenant_id, item_id, history_records) +> HistoryRecords create_item_history(xero_tenant_id, item_id, history_records, opts) Creates a history record for a specific item @@ -2098,9 +2218,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant item_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Item history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific item - result = api_instance.create_item_history(xero_tenant_id, item_id, history_records) + result = api_instance.create_item_history(xero_tenant_id, item_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_item_history: #{e}" @@ -2115,6 +2239,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **item_id** | [**String**](.md)| Unique identifier for an Item | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2166,7 +2291,9 @@ items = { "Items": [ { "Code": "code123", "Name": "Item Name XYZ", "Description" opts = { summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -2187,6 +2314,7 @@ Name | Type | Description | Notes **items** | [**Items**](Items.md)| Items with an array of Item objects in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2204,7 +2332,7 @@ Name | Type | Description | Notes ## create_linked_transaction -> LinkedTransactions create_linked_transaction(xero_tenant_id, linked_transaction) +> LinkedTransactions create_linked_transaction(xero_tenant_id, linked_transaction, opts) Creates linked transactions (billable expenses) @@ -2235,9 +2363,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant linked_transaction = { "LinkedTransactions": [ { "SourceTransactionID": "a848644a-f20f-4630-98c3-386bd7505631", "SourceLineItemID": "b0df260d-3cc8-4ced-9bd6-41924f624ed3" } ] } # LinkedTransaction | LinkedTransaction object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates linked transactions (billable expenses) - result = api_instance.create_linked_transaction(xero_tenant_id, linked_transaction) + result = api_instance.create_linked_transaction(xero_tenant_id, linked_transaction, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_linked_transaction: #{e}" @@ -2251,6 +2383,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **linked_transaction** | [**LinkedTransaction**](LinkedTransaction.md)| LinkedTransaction object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2268,7 +2401,7 @@ Name | Type | Description | Notes ## create_manual_journal_attachment_by_file_name -> Attachments create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) +> Attachments create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts) Creates a specific attachment for a specific manual journal by file name @@ -2301,9 +2434,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a specific attachment for a specific manual journal by file name - result = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) + result = api_instance.create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_manual_journal_attachment_by_file_name: #{e}" @@ -2319,6 +2456,7 @@ Name | Type | Description | Notes **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2336,7 +2474,7 @@ Name | Type | Description | Notes ## create_manual_journal_history_record -> HistoryRecords create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records) +> HistoryRecords create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records, opts) Creates a history record for a specific manual journal @@ -2368,9 +2506,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific manual journal - result = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records) + result = api_instance.create_manual_journal_history_record(xero_tenant_id, manual_journal_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_manual_journal_history_record: #{e}" @@ -2385,6 +2527,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2434,7 +2577,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -2454,6 +2599,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2504,7 +2650,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant overpayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Overpayment allocations = { "Allocations": [ { "Invoice": { "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }, "Amount": 10.00, "Date": "2019-03-12" } ] } # Allocations | Allocations array with Allocation object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -2525,6 +2673,7 @@ Name | Type | Description | Notes **overpayment_id** | [**String**](.md)| Unique identifier for a Overpayment | **allocations** | [**Allocations**](Allocations.md)| Allocations array with Allocation object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2542,7 +2691,7 @@ Name | Type | Description | Notes ## create_overpayment_history -> HistoryRecords create_overpayment_history(xero_tenant_id, overpayment_id, history_records) +> HistoryRecords create_overpayment_history(xero_tenant_id, overpayment_id, history_records, opts) Creates a history record for a specific overpayment @@ -2574,9 +2723,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant overpayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Overpayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific overpayment - result = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, history_records) + result = api_instance.create_overpayment_history(xero_tenant_id, overpayment_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_overpayment_history: #{e}" @@ -2591,6 +2744,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **overpayment_id** | [**String**](.md)| Unique identifier for a Overpayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2608,7 +2762,7 @@ Name | Type | Description | Notes ## create_payment -> Payments create_payment(xero_tenant_id, payment) +> Payments create_payment(xero_tenant_id, payment, opts) Creates a single payment for invoice or credit notes @@ -2639,9 +2793,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant payment = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payment | Request body with a single Payment object +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a single payment for invoice or credit notes - result = api_instance.create_payment(xero_tenant_id, payment) + result = api_instance.create_payment(xero_tenant_id, payment, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_payment: #{e}" @@ -2655,6 +2813,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **payment** | [**Payment**](Payment.md)| Request body with a single Payment object | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2672,7 +2831,7 @@ Name | Type | Description | Notes ## create_payment_history -> HistoryRecords create_payment_history(xero_tenant_id, payment_id, history_records) +> HistoryRecords create_payment_history(xero_tenant_id, payment_id, history_records, opts) Creates a history record for a specific payment @@ -2704,9 +2863,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Payment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific payment - result = api_instance.create_payment_history(xero_tenant_id, payment_id, history_records) + result = api_instance.create_payment_history(xero_tenant_id, payment_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_payment_history: #{e}" @@ -2721,6 +2884,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **payment_id** | [**String**](.md)| Unique identifier for a Payment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2738,7 +2902,7 @@ Name | Type | Description | Notes ## create_payment_service -> PaymentServices create_payment_service(xero_tenant_id, payment_services) +> PaymentServices create_payment_service(xero_tenant_id, payment_services, opts) Creates a payment service @@ -2769,9 +2933,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant payment_services = { "PaymentServices": [ { "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PayNowText": "Time To Pay" } ] } # PaymentServices | PaymentServices array with PaymentService object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a payment service - result = api_instance.create_payment_service(xero_tenant_id, payment_services) + result = api_instance.create_payment_service(xero_tenant_id, payment_services, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_payment_service: #{e}" @@ -2785,6 +2953,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **payment_services** | [**PaymentServices**](PaymentServices.md)| PaymentServices array with PaymentService object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2834,7 +3003,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant payments = { "Payments": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Account": { "Code": "970" }, "Date": "2019-03-12", "Amount": 1 } ] } # Payments | Payments array with Payment object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -2854,6 +3025,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **payments** | [**Payments**](Payments.md)| Payments array with Payment object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2904,7 +3076,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant prepayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a PrePayment allocations = { "Allocations": [ { "Invoice": { "LineItems": [], "InvoiceID": "00000000-0000-0000-0000-000000000000" }, "Amount": 1, "Date": "2019-01-10" } ] } # Allocations | Allocations with an array of Allocation object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -2925,6 +3099,7 @@ Name | Type | Description | Notes **prepayment_id** | [**String**](.md)| Unique identifier for a PrePayment | **allocations** | [**Allocations**](Allocations.md)| Allocations with an array of Allocation object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -2942,7 +3117,7 @@ Name | Type | Description | Notes ## create_prepayment_history -> HistoryRecords create_prepayment_history(xero_tenant_id, prepayment_id, history_records) +> HistoryRecords create_prepayment_history(xero_tenant_id, prepayment_id, history_records, opts) Creates a history record for a specific prepayment @@ -2974,9 +3149,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant prepayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a PrePayment history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific prepayment - result = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, history_records) + result = api_instance.create_prepayment_history(xero_tenant_id, prepayment_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_prepayment_history: #{e}" @@ -2991,6 +3170,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **prepayment_id** | [**String**](.md)| Unique identifier for a PrePayment | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3008,7 +3188,7 @@ Name | Type | Description | Notes ## create_purchase_order_attachment_by_file_name -> Attachments create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) +> Attachments create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts) Creates attachment for a specific purchase order @@ -3041,9 +3221,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates attachment for a specific purchase order - result = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) + result = api_instance.create_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_purchase_order_attachment_by_file_name: #{e}" @@ -3059,6 +3243,7 @@ Name | Type | Description | Notes **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3076,7 +3261,7 @@ Name | Type | Description | Notes ## create_purchase_order_history -> HistoryRecords create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records) +> HistoryRecords create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, opts) Creates a history record for a specific purchase orders @@ -3108,9 +3293,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific purchase orders - result = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records) + result = api_instance.create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_purchase_order_history: #{e}" @@ -3125,6 +3314,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3174,7 +3364,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | PurchaseOrders with an array of PurchaseOrder object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -3194,6 +3386,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| PurchaseOrders with an array of PurchaseOrder object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3211,7 +3404,7 @@ Name | Type | Description | Notes ## create_quote_attachment_by_file_name -> Attachments create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) +> Attachments create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts) Creates attachment for a specific quote @@ -3244,9 +3437,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates attachment for a specific quote - result = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) + result = api_instance.create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_quote_attachment_by_file_name: #{e}" @@ -3262,6 +3459,7 @@ Name | Type | Description | Notes **quote_id** | [**String**](.md)| Unique identifier for an Quote | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3279,7 +3477,7 @@ Name | Type | Description | Notes ## create_quote_history -> HistoryRecords create_quote_history(xero_tenant_id, quote_id, history_records) +> HistoryRecords create_quote_history(xero_tenant_id, quote_id, history_records, opts) Creates a history record for a specific quote @@ -3311,9 +3509,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific quote - result = api_instance.create_quote_history(xero_tenant_id, quote_id, history_records) + result = api_instance.create_quote_history(xero_tenant_id, quote_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_quote_history: #{e}" @@ -3328,6 +3530,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **quote_id** | [**String**](.md)| Unique identifier for an Quote | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3377,7 +3580,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | Quotes with an array of Quote object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -3397,6 +3602,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **quotes** | [**Quotes**](Quotes.md)| Quotes with an array of Quote object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3446,7 +3652,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant receipts = { "Receipts": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Lineitems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400", "TaxType": "NONE", "LineAmount": 40 } ], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "LineAmountTypes": "NoTax", "Status": "DRAFT" } ] } # Receipts | Receipts with an array of Receipt object in body of request opts = { - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -3466,6 +3674,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **receipts** | [**Receipts**](Receipts.md)| Receipts with an array of Receipt object in body of request | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3483,7 +3692,7 @@ Name | Type | Description | Notes ## create_receipt_attachment_by_file_name -> Attachments create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) +> Attachments create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts) Creates an attachment on a specific expense claim receipts by file name @@ -3516,9 +3725,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an attachment on a specific expense claim receipts by file name - result = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) + result = api_instance.create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_receipt_attachment_by_file_name: #{e}" @@ -3534,6 +3747,7 @@ Name | Type | Description | Notes **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3551,7 +3765,7 @@ Name | Type | Description | Notes ## create_receipt_history -> HistoryRecords create_receipt_history(xero_tenant_id, receipt_id, history_records) +> HistoryRecords create_receipt_history(xero_tenant_id, receipt_id, history_records, opts) Creates a history record for a specific receipt @@ -3583,9 +3797,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific receipt - result = api_instance.create_receipt_history(xero_tenant_id, receipt_id, history_records) + result = api_instance.create_receipt_history(xero_tenant_id, receipt_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_receipt_history: #{e}" @@ -3600,6 +3818,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3617,7 +3836,7 @@ Name | Type | Description | Notes ## create_repeating_invoice_attachment_by_file_name -> Attachments create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) +> Attachments create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts) Creates an attachment from a specific repeating invoices by file name @@ -3650,9 +3869,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates an attachment from a specific repeating invoices by file name - result = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + result = api_instance.create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_repeating_invoice_attachment_by_file_name: #{e}" @@ -3668,6 +3891,7 @@ Name | Type | Description | Notes **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3685,7 +3909,7 @@ Name | Type | Description | Notes ## create_repeating_invoice_history -> HistoryRecords create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records) +> HistoryRecords create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, opts) Creates a history record for a specific repeating invoice @@ -3717,9 +3941,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice history_records = { "HistoryRecords": [ { "Details": "Hello World" } ] } # HistoryRecords | HistoryRecords containing an array of HistoryRecord objects in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates a history record for a specific repeating invoice - result = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records) + result = api_instance.create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_repeating_invoice_history: #{e}" @@ -3734,6 +3962,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | **history_records** | [**HistoryRecords**](HistoryRecords.md)| HistoryRecords containing an array of HistoryRecord objects in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3783,7 +4012,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant repeating_invoices = { "RepeatingInvoices": [ { "Schedule": { "Period": 1, "Unit": "MONTHLY", "DueDate": 10, "DueDateType": "OFFOLLOWINGMONTH", "StartDate": "\/Date(1555286400000+0000)\/" }, "Type": "ACCREC", "Reference": "[Week]", "ApprovedForSending": false, "SendCopy": false, "MarkAsSent": false, "IncludePDF": false, "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "Name": "Liam Gallagher" }, "Status": "AUTHORISED", "LineAmountTypes": "Exclusive", "LineItems": [ { "Description": "Guitars Fender Strat", "UnitAmount": 5000.00, "TaxType": "OUTPUT2", "TaxAmount": 750.00, "LineAmount": 5000.00, "AccountCode": "200", "Tracking": [], "Quantity": 1.0000, "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900", "DiscountEnteredAsPercent": true } ], "CurrencyCode": "NZD" } ] } # RepeatingInvoices | RepeatingInvoices with an array of repeating invoice objects in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -3803,6 +4034,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| RepeatingInvoices with an array of repeating invoice objects in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3820,7 +4052,7 @@ Name | Type | Description | Notes ## create_tax_rates -> TaxRates create_tax_rates(xero_tenant_id, tax_rates) +> TaxRates create_tax_rates(xero_tenant_id, tax_rates, opts) Creates one or more tax rates @@ -3851,9 +4083,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant tax_rates = { "TaxRates": [ { "Name": "CA State Tax", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ] } ] } # TaxRates | TaxRates array with TaxRate object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates one or more tax rates - result = api_instance.create_tax_rates(xero_tenant_id, tax_rates) + result = api_instance.create_tax_rates(xero_tenant_id, tax_rates, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_tax_rates: #{e}" @@ -3867,6 +4103,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **tax_rates** | [**TaxRates**](TaxRates.md)| TaxRates array with TaxRate object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3884,7 +4121,7 @@ Name | Type | Description | Notes ## create_tracking_category -> TrackingCategories create_tracking_category(xero_tenant_id, tracking_category) +> TrackingCategories create_tracking_category(xero_tenant_id, tracking_category, opts) Create tracking categories @@ -3915,9 +4152,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant tracking_category = { name: "FooBar" } # TrackingCategory | TrackingCategory object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Create tracking categories - result = api_instance.create_tracking_category(xero_tenant_id, tracking_category) + result = api_instance.create_tracking_category(xero_tenant_id, tracking_category, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_tracking_category: #{e}" @@ -3931,6 +4172,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **tracking_category** | [**TrackingCategory**](TrackingCategory.md)| TrackingCategory object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -3948,7 +4190,7 @@ Name | Type | Description | Notes ## create_tracking_options -> TrackingOptions create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option) +> TrackingOptions create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, opts) Creates options for a specific tracking category @@ -3980,9 +4222,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory tracking_option = { name: " Bar" } # TrackingOption | TrackingOption object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Creates options for a specific tracking category - result = api_instance.create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option) + result = api_instance.create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->create_tracking_options: #{e}" @@ -3997,6 +4243,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | **tracking_option** | [**TrackingOption**](TrackingOption.md)| TrackingOption object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4078,7 +4325,7 @@ Name | Type | Description | Notes ## delete_batch_payment -> BatchPayments delete_batch_payment(xero_tenant_id, batch_payment_delete) +> BatchPayments delete_batch_payment(xero_tenant_id, batch_payment_delete, opts) Updates a specific batch payment for invoices and credit notes @@ -4109,9 +4356,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant batch_payment_delete = { "BatchPaymentID": "9bf296e9-0748-4d29-a3dc-24dde1098030", "Status":"DELETED" } # BatchPaymentDelete | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific batch payment for invoices and credit notes - result = api_instance.delete_batch_payment(xero_tenant_id, batch_payment_delete) + result = api_instance.delete_batch_payment(xero_tenant_id, batch_payment_delete, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->delete_batch_payment: #{e}" @@ -4125,6 +4376,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **batch_payment_delete** | [**BatchPaymentDelete**](BatchPaymentDelete.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4142,7 +4394,7 @@ Name | Type | Description | Notes ## delete_batch_payment_by_url_param -> BatchPayments delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param) +> BatchPayments delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, opts) Updates a specific batch payment for invoices and credit notes @@ -4174,9 +4426,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant batch_payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for BatchPayment batch_payment_delete_by_url_param = { "Status":"DELETED" } # BatchPaymentDeleteByUrlParam | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific batch payment for invoices and credit notes - result = api_instance.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param) + result = api_instance.delete_batch_payment_by_url_param(xero_tenant_id, batch_payment_id, batch_payment_delete_by_url_param, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->delete_batch_payment_by_url_param: #{e}" @@ -4191,6 +4447,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **batch_payment_id** | [**String**](.md)| Unique identifier for BatchPayment | **batch_payment_delete_by_url_param** | [**BatchPaymentDeleteByUrlParam**](BatchPaymentDeleteByUrlParam.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4334,6 +4591,72 @@ nil (empty response body) - **Accept**: Not defined +## delete_credit_note_allocations + +> Allocation delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id) + +Deletes an Allocation from a Credit Note + +### Example + +```ruby +# load the gem +require 'xero-ruby' + +creds = { + client_id: ENV['CLIENT_ID'], + client_secret: ENV['CLIENT_SECRET'], + redirect_uri: ENV['REDIRECT_URI'], + scopes: ENV['SCOPES'] +} +xero_client = XeroRuby::ApiClient.new(credentials: creds) + +token_set = fetch_valid_token_set(user) # example + +xero_client.refresh_token_set(token_set) + +# You need to namespace your api method call to one of the following api sets +# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] + +api_instance = xero_client. + + + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note +allocation_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Allocation object +begin + #Deletes an Allocation from a Credit Note + result = api_instance.delete_credit_note_allocations(xero_tenant_id, credit_note_id, allocation_id) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->delete_credit_note_allocations: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | + **allocation_id** | [**String**](.md)| Unique identifier for Allocation object | + +### Return type + +[**Allocation**](Allocation.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## delete_item > delete_item(xero_tenant_id, item_id) @@ -4460,9 +4783,75 @@ nil (empty response body) - **Accept**: application/json +## delete_overpayment_allocations + +> Allocation delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id) + +Deletes an Allocation from an overpayment + +### Example + +```ruby +# load the gem +require 'xero-ruby' + +creds = { + client_id: ENV['CLIENT_ID'], + client_secret: ENV['CLIENT_SECRET'], + redirect_uri: ENV['REDIRECT_URI'], + scopes: ENV['SCOPES'] +} +xero_client = XeroRuby::ApiClient.new(credentials: creds) + +token_set = fetch_valid_token_set(user) # example + +xero_client.refresh_token_set(token_set) + +# You need to namespace your api method call to one of the following api sets +# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] + +api_instance = xero_client. + + + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +overpayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Overpayment +allocation_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Allocation object +begin + #Deletes an Allocation from an overpayment + result = api_instance.delete_overpayment_allocations(xero_tenant_id, overpayment_id, allocation_id) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->delete_overpayment_allocations: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **overpayment_id** | [**String**](.md)| Unique identifier for a Overpayment | + **allocation_id** | [**String**](.md)| Unique identifier for Allocation object | + +### Return type + +[**Allocation**](Allocation.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## delete_payment -> Payments delete_payment(xero_tenant_id, payment_id, payment_delete) +> Payments delete_payment(xero_tenant_id, payment_id, payment_delete, opts) Updates a specific payment for invoices and credit notes @@ -4494,9 +4883,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant payment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Payment payment_delete = { "Payments":[ { "Status":"DELETED" } ] } # PaymentDelete | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific payment for invoices and credit notes - result = api_instance.delete_payment(xero_tenant_id, payment_id, payment_delete) + result = api_instance.delete_payment(xero_tenant_id, payment_id, payment_delete, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->delete_payment: #{e}" @@ -4511,6 +4904,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **payment_id** | [**String**](.md)| Unique identifier for a Payment | **payment_delete** | [**PaymentDelete**](PaymentDelete.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -4526,6 +4920,72 @@ Name | Type | Description | Notes - **Accept**: application/json +## delete_prepayment_allocations + +> Allocation delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id) + +Deletes an Allocation from a Prepayment + +### Example + +```ruby +# load the gem +require 'xero-ruby' + +creds = { + client_id: ENV['CLIENT_ID'], + client_secret: ENV['CLIENT_SECRET'], + redirect_uri: ENV['REDIRECT_URI'], + scopes: ENV['SCOPES'] +} +xero_client = XeroRuby::ApiClient.new(credentials: creds) + +token_set = fetch_valid_token_set(user) # example + +xero_client.refresh_token_set(token_set) + +# You need to namespace your api method call to one of the following api sets +# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api] + +api_instance = xero_client. + + + +xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant +prepayment_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a PrePayment +allocation_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Allocation object +begin + #Deletes an Allocation from a Prepayment + result = api_instance.delete_prepayment_allocations(xero_tenant_id, prepayment_id, allocation_id) + p result +rescue XeroRuby::Accounting::ApiError => e + puts "Exception when calling AccountingApi->delete_prepayment_allocations: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **xero_tenant_id** | **String**| Xero identifier for Tenant | + **prepayment_id** | [**String**](.md)| Unique identifier for a PrePayment | + **allocation_id** | [**String**](.md)| Unique identifier for Allocation object | + +### Return type + +[**Allocation**](Allocation.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + ## delete_tracking_category > TrackingCategories delete_tracking_category(xero_tenant_id, tracking_category_id) @@ -4658,7 +5118,7 @@ Name | Type | Description | Notes ## email_invoice -> email_invoice(xero_tenant_id, invoice_id, request_empty) +> email_invoice(xero_tenant_id, invoice_id, request_empty, opts) Sends a copy of a specific invoice to related contact via email @@ -4690,9 +5150,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice request_empty = {} # RequestEmpty | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Sends a copy of a specific invoice to related contact via email - api_instance.email_invoice(xero_tenant_id, invoice_id, request_empty) + api_instance.email_invoice(xero_tenant_id, invoice_id, request_empty, opts) rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->email_invoice: #{e}" end @@ -4706,6 +5170,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | **request_empty** | [**RequestEmpty**](RequestEmpty.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13402,7 +13867,7 @@ Name | Type | Description | Notes ## post_setup -> ImportSummaryObject post_setup(xero_tenant_id, setup) +> ImportSummaryObject post_setup(xero_tenant_id, setup, opts) Sets the chart of accounts, the conversion date and conversion balances @@ -13433,9 +13898,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant setup = { "ConversionDate": {}, "ConversionBalances": [], "Accounts": [ { "Code": "200", "Name": "Sales", "Type": "SALES", "ReportingCode": "REV.TRA.GOO" }, { "Code": "400", "Name": "Advertising", "Type": "OVERHEADS", "ReportingCode": "EXP" }, { "Code": "610", "Name": "Accounts Receivable", "Type": "CURRENT", "SystemAccount": "DEBTORS", "ReportingCode": "ASS.CUR.REC.TRA" }, { "Code": "800", "Name": "Accounts Payable", "Type": "CURRLIAB", "SystemAccount": "CREDITORS", "ReportingCode": "LIA.CUR.PAY" } ] } # Setup | Object including an accounts array, a conversion balances array and a conversion date object in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Sets the chart of accounts, the conversion date and conversion balances - result = api_instance.post_setup(xero_tenant_id, setup) + result = api_instance.post_setup(xero_tenant_id, setup, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->post_setup: #{e}" @@ -13449,6 +13918,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **setup** | [**Setup**](Setup.md)| Object including an accounts array, a conversion balances array and a conversion date object in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13466,7 +13936,7 @@ Name | Type | Description | Notes ## update_account -> Accounts update_account(xero_tenant_id, account_id, accounts) +> Accounts update_account(xero_tenant_id, account_id, accounts, opts) Updates a chart of accounts @@ -13498,9 +13968,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object accounts = { "Accounts":[ { "Code":"123456", "Name":"BarFoo", "AccountID":"99ce6032-0678-4aa0-8148-240c75fee33a", "Type":"EXPENSE", "Description":"GoodBye World", "TaxType":"INPUT", "EnablePaymentsToAccount":false, "ShowInExpenseClaims":false, "Class":"EXPENSE", "ReportingCode":"EXP", "ReportingCodeName":"Expense", "UpdatedDateUTC":"2019-02-21T16:29:47.96-08:00" } ] } # Accounts | Request of type Accounts array with one Account +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a chart of accounts - result = api_instance.update_account(xero_tenant_id, account_id, accounts) + result = api_instance.update_account(xero_tenant_id, account_id, accounts, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_account: #{e}" @@ -13515,6 +13989,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **account_id** | [**String**](.md)| Unique identifier for Account object | **accounts** | [**Accounts**](Accounts.md)| Request of type Accounts array with one Account | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13532,7 +14007,7 @@ Name | Type | Description | Notes ## update_account_attachment_by_file_name -> Attachments update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) +> Attachments update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts) Updates attachment on a specific account by filename @@ -13565,9 +14040,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant account_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Account object file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates attachment on a specific account by filename - result = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body) + result = api_instance.update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_account_attachment_by_file_name: #{e}" @@ -13583,6 +14062,7 @@ Name | Type | Description | Notes **account_id** | [**String**](.md)| Unique identifier for Account object | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13633,7 +14113,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000", "ContactStatus": "ACTIVE", "Name": "Buzz Lightyear", "FirstName": "Buzz", "LastName": "Lightyear", "EmailAddress": "buzz.Lightyear@email.com", "ContactPersons": [], "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "AddressLine1": "", "AddressLine2": "", "AddressLine3": "", "AddressLine4": "", "City": "Palo Alto", "Region": "CA", "PostalCode": "94020", "Country": "United States" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "847-1294", "PhoneAreaCode": "(626)", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "2017-08-21T13:49:04.227-07:00", "ContactGroups": [] }, "Lineitems": [], "BankAccount": { "Code": "088", "Name": "Business Wells Fargo", "AccountID": "00000000-0000-0000-0000-000000000000" }, "IsReconciled": false, "Date": "2019-02-25", "Reference": "You just updated", "CurrencyCode": "USD", "CurrencyRate": 1, "Status": "AUTHORISED", "LineAmountTypes": "Inclusive", "TotalTax": 1.74, "BankTransactionID": "00000000-0000-0000-0000-000000000000", "UpdatedDateUTC": "2019-02-26T12:39:27.813-08:00" } ] } # BankTransactions | opts = { - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -13654,6 +14136,7 @@ Name | Type | Description | Notes **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13671,7 +14154,7 @@ Name | Type | Description | Notes ## update_bank_transaction_attachment_by_file_name -> Attachments update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) +> Attachments update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts) Updates a specific attachment from a specific bank transaction by filename @@ -13704,9 +14187,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant bank_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transaction file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment from a specific bank transaction by filename - result = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body) + result = api_instance.update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_bank_transaction_attachment_by_file_name: #{e}" @@ -13722,6 +14209,7 @@ Name | Type | Description | Notes **bank_transaction_id** | [**String**](.md)| Xero generated unique identifier for a bank transaction | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13739,7 +14227,7 @@ Name | Type | Description | Notes ## update_bank_transfer_attachment_by_file_name -> Attachments update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) +> Attachments update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts) @@ -13772,8 +14260,12 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant bank_transfer_id = '00000000-0000-0000-0000-000000000000' # String | Xero generated unique identifier for a bank transfer file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin - result = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body) + result = api_instance.update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_bank_transfer_attachment_by_file_name: #{e}" @@ -13789,6 +14281,7 @@ Name | Type | Description | Notes **bank_transfer_id** | [**String**](.md)| Xero generated unique identifier for a bank transfer | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13806,7 +14299,7 @@ Name | Type | Description | Notes ## update_contact -> Contacts update_contact(xero_tenant_id, contact_id, contacts) +> Contacts update_contact(xero_tenant_id, contact_id, contacts, opts) Updates a specific contact in a Xero organisation @@ -13838,9 +14331,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact contacts = { "Contacts": [{ "ContactID": "00000000-0000-0000-0000-000000000000", "Name": "Thanos" }]} # Contacts | an array of Contacts containing single Contact object with properties to update +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific contact in a Xero organisation - result = api_instance.update_contact(xero_tenant_id, contact_id, contacts) + result = api_instance.update_contact(xero_tenant_id, contact_id, contacts, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_contact: #{e}" @@ -13855,6 +14352,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **contact_id** | [**String**](.md)| Unique identifier for a Contact | **contacts** | [**Contacts**](Contacts.md)| an array of Contacts containing single Contact object with properties to update | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13872,7 +14370,7 @@ Name | Type | Description | Notes ## update_contact_attachment_by_file_name -> Attachments update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) +> Attachments update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts) @@ -13905,8 +14403,12 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contact_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin - result = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body) + result = api_instance.update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_contact_attachment_by_file_name: #{e}" @@ -13922,6 +14424,7 @@ Name | Type | Description | Notes **contact_id** | [**String**](.md)| Unique identifier for a Contact | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -13939,7 +14442,7 @@ Name | Type | Description | Notes ## update_contact_group -> ContactGroups update_contact_group(xero_tenant_id, contact_group_id, contact_groups) +> ContactGroups update_contact_group(xero_tenant_id, contact_group_id, contact_groups, opts) Updates a specific contact group @@ -13971,9 +14474,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contact_group_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Contact Group contact_groups = { "ContactGroups":[ { "Name":"Suppliers" } ] } # ContactGroups | an array of Contact groups with Name of specific group to update +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific contact group - result = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contact_groups) + result = api_instance.update_contact_group(xero_tenant_id, contact_group_id, contact_groups, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_contact_group: #{e}" @@ -13988,6 +14495,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **contact_group_id** | [**String**](.md)| Unique identifier for a Contact Group | **contact_groups** | [**ContactGroups**](ContactGroups.md)| an array of Contact groups with Name of specific group to update | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14038,7 +14546,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note credit_notes = { "CreditNotes": [ { "Type": "ACCPAYCREDIT", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8" }, "Date": "2019-01-05", "Status": "AUTHORISED", "Reference": "HelloWorld", "LineItems": [ { "Description": "Foobar", "Quantity": 2, "UnitAmount": 20, "AccountCode": "400" } ] } ] } # CreditNotes | an array of Credit Notes containing credit note details to update opts = { - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -14059,6 +14569,7 @@ Name | Type | Description | Notes **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes containing credit note details to update | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14076,7 +14587,7 @@ Name | Type | Description | Notes ## update_credit_note_attachment_by_file_name -> Attachments update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) +> Attachments update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts) Updates attachments on a specific credit note by file name @@ -14109,9 +14620,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant credit_note_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Credit Note file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates attachments on a specific credit note by file name - result = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body) + result = api_instance.update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_credit_note_attachment_by_file_name: #{e}" @@ -14127,6 +14642,7 @@ Name | Type | Description | Notes **credit_note_id** | [**String**](.md)| Unique identifier for a Credit Note | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14144,7 +14660,7 @@ Name | Type | Description | Notes ## update_expense_claim -> ExpenseClaims update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims) +> ExpenseClaims update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, opts) Updates a specific expense claims @@ -14176,9 +14692,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant expense_claim_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ExpenseClaim expense_claims = { "ExpenseClaims": [ { "Status": "SUBMITTED", "User": { "UserID": "d1164823-0ac1-41ad-987b-b4e30fe0b273" }, "Receipts": [ { "Lineitems": [], "ReceiptID": "dc1c7f6d-0a4c-402f-acac-551d62ce5816" } ] } ] } # ExpenseClaims | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific expense claims - result = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims) + result = api_instance.update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_expense_claim: #{e}" @@ -14193,6 +14713,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **expense_claim_id** | [**String**](.md)| Unique identifier for a ExpenseClaim | **expense_claims** | [**ExpenseClaims**](ExpenseClaims.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14243,7 +14764,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice invoices = { "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]} # Invoices | opts = { - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -14264,6 +14787,7 @@ Name | Type | Description | Notes **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | **invoices** | [**Invoices**](Invoices.md)| | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14281,7 +14805,7 @@ Name | Type | Description | Notes ## update_invoice_attachment_by_file_name -> Attachments update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) +> Attachments update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts) Updates an attachment from a specific invoices or purchase bill by filename @@ -14314,9 +14838,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Invoice file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates an attachment from a specific invoices or purchase bill by filename - result = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body) + result = api_instance.update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_invoice_attachment_by_file_name: #{e}" @@ -14332,6 +14860,7 @@ Name | Type | Description | Notes **invoice_id** | [**String**](.md)| Unique identifier for an Invoice | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14382,7 +14911,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant item_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Item items = { "Items": [ { "Code": "ItemCode123", "Description": "Description 123" } ] } # Items | opts = { - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -14403,6 +14934,7 @@ Name | Type | Description | Notes **item_id** | [**String**](.md)| Unique identifier for an Item | **items** | [**Items**](Items.md)| | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14420,7 +14952,7 @@ Name | Type | Description | Notes ## update_linked_transaction -> LinkedTransactions update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions) +> LinkedTransactions update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, opts) Updates a specific linked transactions (billable expenses) @@ -14452,9 +14984,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant linked_transaction_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a LinkedTransaction linked_transactions = { "LinkedTransactions": [ { "SourceTransactionID": "00000000-0000-0000-0000-000000000000", "SourceLineItemID": "00000000-0000-0000-0000-000000000000" } ] } # LinkedTransactions | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific linked transactions (billable expenses) - result = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions) + result = api_instance.update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_linked_transaction: #{e}" @@ -14469,6 +15005,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **linked_transaction_id** | [**String**](.md)| Unique identifier for a LinkedTransaction | **linked_transactions** | [**LinkedTransactions**](LinkedTransactions.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14486,7 +15023,7 @@ Name | Type | Description | Notes ## update_manual_journal -> ManualJournals update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals) +> ManualJournals update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, opts) Updates a specific manual journal @@ -14518,9 +15055,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal manual_journals = { "ManualJournals": [ { "Narration": "Hello Xero", "ManualJournalID": "00000000-0000-0000-0000-000000000000", "JournalLines": [] } ] } # ManualJournals | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific manual journal - result = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals) + result = api_instance.update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_manual_journal: #{e}" @@ -14535,6 +15076,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | **manual_journals** | [**ManualJournals**](ManualJournals.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14552,7 +15094,7 @@ Name | Type | Description | Notes ## update_manual_journal_attachment_by_file_name -> Attachments update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) +> Attachments update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts) Updates a specific attachment from a specific manual journal by file name @@ -14585,9 +15127,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant manual_journal_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a ManualJournal file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment from a specific manual journal by file name - result = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body) + result = api_instance.update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_manual_journal_attachment_by_file_name: #{e}" @@ -14603,6 +15149,7 @@ Name | Type | Description | Notes **manual_journal_id** | [**String**](.md)| Unique identifier for a ManualJournal | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14654,7 +15201,9 @@ bank_transactions = { "BankTransactions": [ { "Type": "SPEND", "Contact": { "Con opts = { summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -14675,6 +15224,7 @@ Name | Type | Description | Notes **bank_transactions** | [**BankTransactions**](BankTransactions.md)| | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14724,7 +15274,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant contacts = { "Contacts": [ { "Name": "Bruce Banner", "EmailAddress": "hulk@avengers.com", "Phones": [ { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415" } ], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } } } ] } # Contacts | opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -14744,6 +15296,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **contacts** | [**Contacts**](Contacts.md)| | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14795,7 +15348,9 @@ credit_notes = { "CreditNotes":[ { "Type":"ACCPAYCREDIT", "Contact":{ "ContactID opts = { summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -14816,6 +15371,7 @@ Name | Type | Description | Notes **credit_notes** | [**CreditNotes**](CreditNotes.md)| an array of Credit Notes with a single CreditNote object. | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14865,7 +15421,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant employees = { "Employees": [ { "FirstName": "Nick", "LastName": "Fury", "ExternalLink": { "Url": "http://twitter.com/#!/search/Nick+Fury" } } ] } # Employees | Employees with array of Employee object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -14885,6 +15443,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -14936,7 +15495,9 @@ invoices = { "Invoices": [ { "Type": "ACCREC", "Contact": { "ContactID": "430fa1 opts = { summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -14957,6 +15518,7 @@ Name | Type | Description | Notes **invoices** | [**Invoices**](Invoices.md)| | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15008,7 +15570,9 @@ items = { "Items": [ { "Code": "ItemCode123", "Name": "ItemName XYZ", "Descripti opts = { summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -15029,6 +15593,7 @@ Name | Type | Description | Notes **items** | [**Items**](Items.md)| | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15078,7 +15643,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant manual_journals = { "ManualJournals": [ { "Narration": "Journal Desc", "JournalLines": [ { "LineAmount": 100, "AccountCode": "400", "Description": "Money Movement" }, { "LineAmount": -100, "AccountCode": "400", "Description": "Prepayment of things", "Tracking": [ { "Name": "North", "Option": "Region" } ] } ], "Date": "2019-03-14" } ] } # ManualJournals | ManualJournals array with ManualJournal object in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -15098,6 +15665,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **manual_journals** | [**ManualJournals**](ManualJournals.md)| ManualJournals array with ManualJournal object in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15147,7 +15715,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant purchase_orders = { "PurchaseOrders": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "710" } ], "Date": "2019-03-13" } ] } # PurchaseOrders | opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -15167,6 +15737,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15216,7 +15787,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant quotes = { "Quotes": [ { "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "LineItems": [ { "Description": "Foobar", "Quantity": 1, "UnitAmount": 20, "AccountCode": "12775" } ], "Date": "2020-02-01" } ] } # Quotes | opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -15236,6 +15809,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **quotes** | [**Quotes**](Quotes.md)| | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15285,7 +15859,9 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant repeating_invoices = { "RepeatingInvoices": [ { "Schedule": { "Period": 1, "Unit": "MONTHLY", "DueDate": 10, "DueDateType": "OFFOLLOWINGMONTH", "StartDate": "\/Date(1555286400000+0000)\/" }, "Type": "ACCREC", "Reference": "[Week]", "ApprovedForSending": false, "SendCopy": false, "MarkAsSent": false, "IncludePDF": false, "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "Name": "Liam Gallagher" }, "Status": "AUTHORISED", "LineAmountTypes": "Exclusive", "LineItems": [ { "Description": "Guitars Fender Strat", "UnitAmount": 5000.00, "TaxType": "OUTPUT2", "TaxAmount": 750.00, "LineAmount": 5000.00, "AccountCode": "200", "Tracking": [], "Quantity": 1.0000, "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900", "DiscountEnteredAsPercent": true } ], "CurrencyCode": "NZD" } ] } # RepeatingInvoices | RepeatingInvoices with an array of repeating invoice objects in body of request opts = { - summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -15305,6 +15881,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| RepeatingInvoices with an array of repeating invoice objects in body of request | **summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15322,7 +15899,7 @@ Name | Type | Description | Notes ## update_purchase_order -> PurchaseOrders update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) +> PurchaseOrders update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, opts) Updates a specific purchase order @@ -15354,9 +15931,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order purchase_orders = { "PurchaseOrders": [ { "AttentionTo": "Peter Parker", "LineItems": [], "Contact": {} } ] } # PurchaseOrders | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific purchase order - result = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders) + result = api_instance.update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_purchase_order: #{e}" @@ -15371,6 +15952,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | **purchase_orders** | [**PurchaseOrders**](PurchaseOrders.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15388,7 +15970,7 @@ Name | Type | Description | Notes ## update_purchase_order_attachment_by_file_name -> Attachments update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) +> Attachments update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts) Updates a specific attachment for a specific purchase order by filename @@ -15421,9 +16003,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant purchase_order_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Purchase Order file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment for a specific purchase order by filename - result = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body) + result = api_instance.update_purchase_order_attachment_by_file_name(xero_tenant_id, purchase_order_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_purchase_order_attachment_by_file_name: #{e}" @@ -15439,6 +16025,7 @@ Name | Type | Description | Notes **purchase_order_id** | [**String**](.md)| Unique identifier for an Purchase Order | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15456,7 +16043,7 @@ Name | Type | Description | Notes ## update_quote -> Quotes update_quote(xero_tenant_id, quote_id, quotes) +> Quotes update_quote(xero_tenant_id, quote_id, quotes, opts) Updates a specific quote @@ -15488,9 +16075,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote quotes = { "Quotes": [ { "Reference": "I am an update", "Contact": { "ContactID": "00000000-0000-0000-0000-000000000000" }, "Date": "2020-02-01" } ] } # Quotes | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific quote - result = api_instance.update_quote(xero_tenant_id, quote_id, quotes) + result = api_instance.update_quote(xero_tenant_id, quote_id, quotes, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_quote: #{e}" @@ -15505,6 +16096,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **quote_id** | [**String**](.md)| Unique identifier for an Quote | **quotes** | [**Quotes**](Quotes.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15522,7 +16114,7 @@ Name | Type | Description | Notes ## update_quote_attachment_by_file_name -> Attachments update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) +> Attachments update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts) Updates a specific attachment from a specific quote by filename @@ -15555,9 +16147,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant quote_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for an Quote file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment from a specific quote by filename - result = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body) + result = api_instance.update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_quote_attachment_by_file_name: #{e}" @@ -15573,6 +16169,7 @@ Name | Type | Description | Notes **quote_id** | [**String**](.md)| Unique identifier for an Quote | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15623,7 +16220,9 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt receipts = { "Receipts": [ { "Lineitems": [], "User": { "UserID": "00000000-0000-0000-0000-000000000000" }, "Reference": "Foobar" } ] } # Receipts | opts = { - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. } begin @@ -15644,6 +16243,7 @@ Name | Type | Description | Notes **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | **receipts** | [**Receipts**](Receipts.md)| | **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15661,7 +16261,7 @@ Name | Type | Description | Notes ## update_receipt_attachment_by_file_name -> Attachments update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) +> Attachments update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts) Updates a specific attachment on a specific expense claim receipts by file name @@ -15694,9 +16294,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant receipt_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Receipt file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment on a specific expense claim receipts by file name - result = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body) + result = api_instance.update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_receipt_attachment_by_file_name: #{e}" @@ -15712,6 +16316,7 @@ Name | Type | Description | Notes **receipt_id** | [**String**](.md)| Unique identifier for a Receipt | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15729,7 +16334,7 @@ Name | Type | Description | Notes ## update_repeating_invoice -> RepeatingInvoices update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices) +> RepeatingInvoices update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices, opts) Deletes a specific repeating invoice template @@ -15761,9 +16366,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice repeating_invoices = { "Schedule": { "Period": 1, "Unit": "MONTHLY", "DueDate": 10, "DueDateType": "OFFOLLOWINGMONTH", "StartDate": "\/Date(1555286400000+0000)\/", "EndDate": "\/Date(1569801600000+0000)\/", "NextScheduledDate": "\/Date(1555286400000+0000)\/" }, "RepeatingInvoiceID": "428c0d75-909f-4b04-8403-a48dc27283b0", "Type": "ACCREC", "Reference": "[Week]", "HasAttachments": true, "ApprovedForSending": false, "SendCopy": false, "MarkAsSent": false, "IncludePDF": false, "ID": "428c0d75-909f-4b04-8403-a48dc27283b0", "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "Name": "Liam Gallagher", "Addresses": [], "Phones": [], "ContactGroups": [], "ContactPersons": [], "HasValidationErrors": false }, "Status": "DELETED", "LineAmountTypes": "Exclusive", "LineItems": [ { "Description": "Guitars Fender Strat", "UnitAmount": 5000.00, "TaxType": "OUTPUT2", "TaxAmount": 750.00, "LineAmount": 5000.00, "AccountCode": "200", "Tracking": [], "Quantity": 1.0000, "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900", "DiscountEnteredAsPercent": true } ], "SubTotal": 5000.00, "TotalTax": 750.00, "Total": 5750.00, "CurrencyCode": "NZD" } # RepeatingInvoices | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Deletes a specific repeating invoice template - result = api_instance.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices) + result = api_instance.update_repeating_invoice(xero_tenant_id, repeating_invoice_id, repeating_invoices, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_repeating_invoice: #{e}" @@ -15778,6 +16387,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | **repeating_invoices** | [**RepeatingInvoices**](RepeatingInvoices.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15795,7 +16405,7 @@ Name | Type | Description | Notes ## update_repeating_invoice_attachment_by_file_name -> Attachments update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) +> Attachments update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts) Updates a specific attachment from a specific repeating invoices by file name @@ -15828,9 +16438,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant repeating_invoice_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Repeating Invoice file_name = 'xero-dev.jpg' # String | Name of the attachment body = 'body_example' # String | Byte array of file in body of request +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific attachment from a specific repeating invoices by file name - result = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body) + result = api_instance.update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_repeating_invoice_attachment_by_file_name: #{e}" @@ -15846,6 +16460,7 @@ Name | Type | Description | Notes **repeating_invoice_id** | [**String**](.md)| Unique identifier for a Repeating Invoice | **file_name** | **String**| Name of the attachment | **body** | **String**| Byte array of file in body of request | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15863,7 +16478,7 @@ Name | Type | Description | Notes ## update_tax_rate -> TaxRates update_tax_rate(xero_tenant_id, tax_rates) +> TaxRates update_tax_rate(xero_tenant_id, tax_rates, opts) Updates tax rates @@ -15894,9 +16509,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant tax_rates = { "TaxRates": [ { "Name": "State Tax NY", "TaxComponents": [ { "Name": "State Tax", "Rate": 2.25 } ], "Status": "DELETED", "ReportTaxType": "INPUT" } ] } # TaxRates | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates tax rates - result = api_instance.update_tax_rate(xero_tenant_id, tax_rates) + result = api_instance.update_tax_rate(xero_tenant_id, tax_rates, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_tax_rate: #{e}" @@ -15910,6 +16529,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xero_tenant_id** | **String**| Xero identifier for Tenant | **tax_rates** | [**TaxRates**](TaxRates.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15927,7 +16547,7 @@ Name | Type | Description | Notes ## update_tracking_category -> TrackingCategories update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category) +> TrackingCategories update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, opts) Updates a specific tracking category @@ -15959,9 +16579,13 @@ api_instance = xero_client. xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory tracking_category = { "Name": "Avengers" } # TrackingCategory | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific tracking category - result = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category) + result = api_instance.update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_tracking_category: #{e}" @@ -15976,6 +16600,7 @@ Name | Type | Description | Notes **xero_tenant_id** | **String**| Xero identifier for Tenant | **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | **tracking_category** | [**TrackingCategory**](TrackingCategory.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type @@ -15993,7 +16618,7 @@ Name | Type | Description | Notes ## update_tracking_options -> TrackingOptions update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option) +> TrackingOptions update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts) Updates a specific option for a specific tracking category @@ -16026,9 +16651,13 @@ xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant tracking_category_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a TrackingCategory tracking_option_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Tracking Option tracking_option = { name: "Vision" } # TrackingOption | +opts = { + idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. +} + begin #Updates a specific option for a specific tracking category - result = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option) + result = api_instance.update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts) p result rescue XeroRuby::Accounting::ApiError => e puts "Exception when calling AccountingApi->update_tracking_options: #{e}" @@ -16044,6 +16673,7 @@ Name | Type | Description | Notes **tracking_category_id** | [**String**](.md)| Unique identifier for a TrackingCategory | **tracking_option_id** | [**String**](.md)| Unique identifier for a Tracking Option | **tracking_option** | [**TrackingOption**](TrackingOption.md)| | + **idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional] ### Return type diff --git a/docs/accounting/Allocation.md b/docs/accounting/Allocation.md index 19584807..fc0471cd 100644 --- a/docs/accounting/Allocation.md +++ b/docs/accounting/Allocation.md @@ -4,12 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**allocation_id** | **String** | Xero generated unique identifier | [optional] **invoice** | [**Invoice**](Invoice.md) | | **overpayment** | [**Overpayment**](Overpayment.md) | | [optional] **prepayment** | [**Prepayment**](Prepayment.md) | | [optional] **credit_note** | [**CreditNote**](CreditNote.md) | | [optional] **amount** | **BigDecimal** | the amount being applied to the invoice | **date** | **Date** | the date the allocation is applied YYYY-MM-DD. | +**is_deleted** | **Boolean** | A flag that returns true when the allocation is succesfully deleted | [optional] **status_attribute_string** | **String** | A string to indicate if a invoice status | [optional] **validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional] @@ -18,12 +20,14 @@ Name | Type | Description | Notes ```ruby require 'XeroRuby::Accounting' -instance = XeroRuby::Accounting::Allocation.new(invoice: null, +instance = XeroRuby::Accounting::Allocation.new(allocation_id: null, + invoice: null, overpayment: null, prepayment: null, credit_note: null, amount: null, date: null, + is_deleted: null, status_attribute_string: null, validation_errors: null) ``` diff --git a/docs/accounting/Contact.md b/docs/accounting/Contact.md index 189b6e4d..40a79147 100644 --- a/docs/accounting/Contact.md +++ b/docs/accounting/Contact.md @@ -14,7 +14,6 @@ Name | Type | Description | Notes **last_name** | **String** | Last name of contact person (max length = 255) | [optional] **company_number** | **String** | Company registration number (max length = 50) | [optional] **email_address** | **String** | Email address of contact person (umlauts not supported) (max length = 255) | [optional] -**skype_user_name** | **String** | Skype user name of contact | [optional] **contact_persons** | [**Array<ContactPerson>**](ContactPerson.md) | See contact persons | [optional] **bank_account_details** | **String** | Bank account number of contact | [optional] **tax_number** | **String** | Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) | [optional] @@ -63,7 +62,6 @@ instance = XeroRuby::Accounting::Contact.new(contact_id: null, last_name: null, company_number: null, email_address: null, - skype_user_name: null, contact_persons: null, bank_account_details: null, tax_number: null, diff --git a/docs/accounting/TenNinetyNineContact.md b/docs/accounting/TenNinetyNineContact.md index 69bc3ce8..95cfa1a2 100644 --- a/docs/accounting/TenNinetyNineContact.md +++ b/docs/accounting/TenNinetyNineContact.md @@ -26,6 +26,9 @@ Name | Type | Description | Notes **street_address** | **String** | Contact address on 1099 Form | [optional] **tax_id** | **String** | Contact tax id on 1099 Form | [optional] **contact_id** | **String** | Contact contact id | [optional] +**legal_name** | **String** | Contact legal name | [optional] +**business_name** | **String** | Contact business name | [optional] +**federal_tax_classification** | **String** | Contact federal tax classification | [optional] ## Code Sample @@ -53,7 +56,10 @@ instance = XeroRuby::Accounting::TenNinetyNineContact.new(box1: null, email: null, street_address: null, tax_id: null, - contact_id: null) + contact_id: null, + legal_name: null, + business_name: null, + federal_tax_classification: null) ``` diff --git a/docs/accounting/index.html b/docs/accounting/index.html index 229941cd..360f8268 100644 --- a/docs/accounting/index.html +++ b/docs/accounting/index.html @@ -975,7 +975,7 @@ "title" : "", "type" : "string", "description" : "See Account Types", - "enum" : [ "BANK", "CURRENT", "CURRLIAB", "DEPRECIATN", "DIRECTCOSTS", "EQUITY", "EXPENSE", "FIXED", "INVENTORY", "LIABILITY", "NONCURRENT", "OTHERINCOME", "OVERHEADS", "PREPAYMENT", "REVENUE", "SALES", "TERMLIAB", "PAYGLIABILITY", "PAYG", "SUPERANNUATIONEXPENSE", "SUPERANNUATIONLIABILITY", "WAGESEXPENSE" ] + "enum" : [ "BANK", "CURRENT", "CURRLIAB", "DEPRECIATN", "DIRECTCOSTS", "EQUITY", "EXPENSE", "FIXED", "INVENTORY", "LIABILITY", "NONCURRENT", "OTHERINCOME", "OVERHEADS", "PREPAYMENT", "REVENUE", "SALES", "TERMLIAB", "PAYG" ] }; defs["Accounts"] = { "title" : "", @@ -1183,6 +1183,11 @@ "required" : [ "Amount", "Date", "Invoice" ], "type" : "object", "properties" : { + "AllocationID" : { + "type" : "string", + "description" : "Xero generated unique identifier", + "format" : "uuid" + }, "Invoice" : { "$ref" : "#/components/schemas/Invoice" }, @@ -1206,6 +1211,11 @@ "description" : "the date the allocation is applied YYYY-MM-DD.", "x-is-msdate" : true }, + "IsDeleted" : { + "type" : "boolean", + "description" : "A flag that returns true when the allocation is succesfully deleted", + "readOnly" : true + }, "StatusAttributeString" : { "type" : "string", "description" : "A string to indicate if a invoice status" @@ -2068,10 +2078,6 @@ "type" : "string", "description" : "Email address of contact person (umlauts not supported) (max length = 255)" }, - "SkypeUserName" : { - "type" : "string", - "description" : "Skype user name of contact" - }, "ContactPersons" : { "type" : "array", "description" : "See contact persons", @@ -2594,7 +2600,7 @@ "title" : "", "type" : "string", "description" : "3 letter alpha code for the currency – see list of currency codes", - "enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLE", "SLL", "SOS", "SRD", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZMK", "ZWD", "" ], + "enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLE", "SLL", "SOS", "SRD", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZMK", "ZWD" ], "x-enum-varnames" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLE", "SLL", "SOS", "SRD", "STN", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY_LIRA", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZMK", "ZWD", "EMPTY_CURRENCY" ] }; defs["Element"] = { @@ -5626,7 +5632,7 @@ "ReportTaxType" : { "type" : "string", "description" : "See ReportTaxTypes", - "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED", "SROVRRS", "SROVRLVG", "SRLVG", "IM", "IMESS", "IMN33", "IMRE", "BADDEBTRECOVERY" ] + "enum" : [ "AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED", "SROVRRS", "SROVRLVG", "SRLVG", "IM", "IMESS", "IMN33", "IMRE", "BADDEBTRECOVERY", "USSALESTAX" ] }, "CanApplyToAssets" : { "type" : "boolean", @@ -5691,7 +5697,7 @@ "title" : "", "type" : "string", "description" : "See Tax Types – can only be used on update calls", - "enum" : [ "OUTPUT", "INPUT", "CAPEXINPUT", "EXEMPTEXPORT", "EXEMPTEXPENSES", "EXEMPTCAPITAL", "EXEMPTOUTPUT", "INPUTTAXED", "BASEXCLUDED", "GSTONCAPIMPORTS", "GSTONIMPORTS", "NONE", "INPUT2", "ZERORATED", "OUTPUT2", "CAPEXINPUT2", "CAPEXOUTPUT", "CAPEXOUTPUT2", "CAPEXSRINPUT", "CAPEXSROUTPUT", "ECACQUISITIONS", "ECZRINPUT", "ECZROUTPUT", "ECZROUTPUTSERVICES", "EXEMPTINPUT", "REVERSECHARGES", "RRINPUT", "RROUTPUT", "SRINPUT", "SROUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "BLINPUT", "DSOUTPUT", "EPINPUT", "ES33OUTPUT", "ESN33OUTPUT", "IGDSINPUT2", "IMINPUT2", "MEINPUT", "NRINPUT", "OPINPUT", "OSOUTPUT", "TXESSINPUT", "TXN33INPUT", "TXPETINPUT", "TXREINPUT", "INPUT3", "INPUT4", "OUTPUT3", "OUTPUT4", "SROUTPUT2", "TXCA", "SRCAS", "BLINPUT2", "DRCHARGESUPPLY20", "DRCHARGE20", "DRCHARGESUPPLY5", "DRCHARGE5", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "OUTPUTY23", "DSOUTPUTY23", "INPUTY23", "IMINPUT2Y23", "IGDSINPUT2Y23", "TXPETINPUTY23", "TXESSINPUTY23", "TXN33INPUTY23", "TXREINPUTY23", "TXCAY23", "BADDEBTRELIEFY23", "IGDSINPUT3Y23", "SROVRRSY23", "SROVRLVGY23", "SRLVGY23", "TXRCN33Y23", "TXRCREY23", "TXRCESSY23", "TXRCTSY23", "IM", "IMY23", "IMESS", "IMESSY23", "IMN33", "IMN33Y23", "IMRE", "IMREY23", "BADDEBTRECOVERY", "BADDEBTRECOVERYY23" ] + "enum" : [ "OUTPUT", "INPUT", "CAPEXINPUT", "EXEMPTEXPORT", "EXEMPTEXPENSES", "EXEMPTCAPITAL", "EXEMPTOUTPUT", "INPUTTAXED", "BASEXCLUDED", "GSTONCAPIMPORTS", "GSTONIMPORTS", "NONE", "INPUT2", "ZERORATED", "OUTPUT2", "CAPEXINPUT2", "CAPEXOUTPUT", "CAPEXOUTPUT2", "CAPEXSRINPUT", "CAPEXSROUTPUT", "ECACQUISITIONS", "ECZRINPUT", "ECZROUTPUT", "ECZROUTPUTSERVICES", "EXEMPTINPUT", "REVERSECHARGES", "RRINPUT", "RROUTPUT", "SRINPUT", "SROUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "BLINPUT", "DSOUTPUT", "EPINPUT", "ES33OUTPUT", "ESN33OUTPUT", "IGDSINPUT2", "IMINPUT2", "MEINPUT", "NRINPUT", "OPINPUT", "OSOUTPUT", "TXESSINPUT", "TXN33INPUT", "TXPETINPUT", "TXREINPUT", "INPUT3", "INPUT4", "OUTPUT3", "OUTPUT4", "SROUTPUT2", "TXCA", "SRCAS", "BLINPUT2", "DRCHARGESUPPLY20", "DRCHARGE20", "DRCHARGESUPPLY5", "DRCHARGE5", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "OUTPUTY23", "DSOUTPUTY23", "INPUTY23", "IMINPUT2Y23", "IGDSINPUT2Y23", "TXPETINPUTY23", "TXESSINPUTY23", "TXN33INPUTY23", "TXREINPUTY23", "TXCAY23", "BADDEBTRELIEFY23", "IGDSINPUT3Y23", "SROVRRSY23", "SROVRLVGY23", "SRLVGY23", "TXRCN33Y23", "TXRCREY23", "TXRCESSY23", "TXRCTSY23", "IM", "IMY23", "IMESS", "IMESSY23", "IMN33", "IMN33Y23", "IMRE", "IMREY23", "BADDEBTRECOVERY", "BADDEBTRECOVERYY23", "OUTPUTY24", "DSOUTPUTY24", "INPUTY24", "IGDSINPUT2Y24", "TXPETINPUTY24", "TXESSINPUTY24", "TXN33INPUTY24", "TXREINPUTY24", "TXCAY24", "BADDEBTRELIEFY24", "IGDSINPUT3Y24", "SROVRRSY24", "SROVRLVGY24", "SRLVGY24", "TXRCTSY24", "TXRCESSY24", "TXRCN33Y24", "TXRCREY24", "IMY24", "IMESSY24", "IMN33Y24", "IMREY24", "BADDEBTRECOVERYY24", "OSOUTPUT2" ] }; defs["TenNinetyNineContact"] = { "title" : "", @@ -5810,6 +5816,19 @@ "type" : "string", "description" : "Contact contact id", "format" : "uuid" + }, + "LegalName" : { + "type" : "string", + "description" : "Contact legal name" + }, + "BusinessName" : { + "type" : "string", + "description" : "Contact business name" + }, + "FederalTaxClassification" : { + "type" : "string", + "description" : "Contact federal tax classification", + "enum" : [ "SOLE_PROPRIETOR", "PARTNERSHIP", "TRUST_OR_ESTATE", "NONPROFIT", "C_CORP", "S_CORP", "OTHER" ] } }, "description" : "" @@ -6074,7 +6093,7 @@