xero-ruby 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +6 -6
- data/git_push.sh +1 -1
- data/lib/xero-ruby/models/account.rb +1 -1
- data/lib/xero-ruby/models/accounts.rb +1 -1
- data/lib/xero-ruby/models/accounts_payable.rb +1 -1
- data/lib/xero-ruby/models/accounts_receivable.rb +1 -1
- data/lib/xero-ruby/models/address.rb +1 -1
- data/lib/xero-ruby/models/allocation.rb +1 -1
- data/lib/xero-ruby/models/allocations.rb +1 -1
- data/lib/xero-ruby/models/attachment.rb +1 -1
- data/lib/xero-ruby/models/attachments.rb +1 -1
- data/lib/xero-ruby/models/balances.rb +1 -1
- data/lib/xero-ruby/models/bank_transaction.rb +1 -1
- data/lib/xero-ruby/models/bank_transactions.rb +1 -1
- data/lib/xero-ruby/models/bank_transfer.rb +1 -1
- data/lib/xero-ruby/models/bank_transfers.rb +1 -1
- data/lib/xero-ruby/models/batch_payment.rb +1 -1
- data/lib/xero-ruby/models/batch_payment_details.rb +1 -1
- data/lib/xero-ruby/models/batch_payments.rb +1 -1
- data/lib/xero-ruby/models/bill.rb +1 -1
- data/lib/xero-ruby/models/branding_theme.rb +1 -1
- data/lib/xero-ruby/models/branding_themes.rb +1 -1
- data/lib/xero-ruby/models/cis_org_setting.rb +1 -1
- data/lib/xero-ruby/models/cis_setting.rb +1 -1
- data/lib/xero-ruby/models/cis_settings.rb +1 -1
- data/lib/xero-ruby/models/contact.rb +1 -1
- data/lib/xero-ruby/models/contact_group.rb +1 -1
- data/lib/xero-ruby/models/contact_groups.rb +1 -1
- data/lib/xero-ruby/models/contact_person.rb +1 -1
- data/lib/xero-ruby/models/contacts.rb +1 -1
- data/lib/xero-ruby/models/credit_note.rb +1 -1
- data/lib/xero-ruby/models/credit_notes.rb +1 -1
- data/lib/xero-ruby/models/currencies.rb +1 -1
- data/lib/xero-ruby/models/currency.rb +1 -1
- data/lib/xero-ruby/models/element.rb +1 -1
- data/lib/xero-ruby/models/employee.rb +1 -1
- data/lib/xero-ruby/models/employees.rb +1 -1
- data/lib/xero-ruby/models/error.rb +1 -1
- data/lib/xero-ruby/models/expense_claim.rb +1 -1
- data/lib/xero-ruby/models/expense_claims.rb +1 -1
- data/lib/xero-ruby/models/external_link.rb +1 -1
- data/lib/xero-ruby/models/history_record.rb +1 -1
- data/lib/xero-ruby/models/history_records.rb +1 -1
- data/lib/xero-ruby/models/invoice.rb +1 -1
- data/lib/xero-ruby/models/invoice_reminder.rb +1 -1
- data/lib/xero-ruby/models/invoice_reminders.rb +1 -1
- data/lib/xero-ruby/models/invoices.rb +1 -1
- data/lib/xero-ruby/models/item.rb +1 -1
- data/lib/xero-ruby/models/items.rb +1 -1
- data/lib/xero-ruby/models/journal.rb +1 -1
- data/lib/xero-ruby/models/journal_line.rb +1 -1
- data/lib/xero-ruby/models/journals.rb +1 -1
- data/lib/xero-ruby/models/line_item.rb +1 -1
- data/lib/xero-ruby/models/line_item_tracking.rb +1 -1
- data/lib/xero-ruby/models/linked_transaction.rb +1 -1
- data/lib/xero-ruby/models/linked_transactions.rb +1 -1
- data/lib/xero-ruby/models/manual_journal.rb +1 -1
- data/lib/xero-ruby/models/manual_journal_line.rb +1 -1
- data/lib/xero-ruby/models/manual_journals.rb +1 -1
- data/lib/xero-ruby/models/online_invoice.rb +1 -1
- data/lib/xero-ruby/models/online_invoices.rb +1 -1
- data/lib/xero-ruby/models/organisation.rb +1 -1
- data/lib/xero-ruby/models/organisations.rb +1 -1
- data/lib/xero-ruby/models/overpayment.rb +1 -1
- data/lib/xero-ruby/models/overpayments.rb +1 -1
- data/lib/xero-ruby/models/payment.rb +1 -1
- data/lib/xero-ruby/models/payment_service.rb +1 -1
- data/lib/xero-ruby/models/payment_services.rb +1 -1
- data/lib/xero-ruby/models/payment_term.rb +1 -1
- data/lib/xero-ruby/models/payments.rb +1 -1
- data/lib/xero-ruby/models/phone.rb +1 -1
- data/lib/xero-ruby/models/prepayment.rb +1 -1
- data/lib/xero-ruby/models/prepayments.rb +1 -1
- data/lib/xero-ruby/models/purchase.rb +1 -1
- data/lib/xero-ruby/models/purchase_order.rb +1 -1
- data/lib/xero-ruby/models/purchase_orders.rb +1 -1
- data/lib/xero-ruby/models/receipt.rb +1 -1
- data/lib/xero-ruby/models/receipts.rb +1 -1
- data/lib/xero-ruby/models/repeating_invoice.rb +1 -1
- data/lib/xero-ruby/models/repeating_invoices.rb +1 -1
- data/lib/xero-ruby/models/report.rb +1 -1
- data/lib/xero-ruby/models/report_attribute.rb +1 -1
- data/lib/xero-ruby/models/report_cell.rb +1 -1
- data/lib/xero-ruby/models/report_fields.rb +1 -1
- data/lib/xero-ruby/models/report_row.rb +1 -1
- data/lib/xero-ruby/models/report_rows.rb +1 -1
- data/lib/xero-ruby/models/report_with_row.rb +1 -1
- data/lib/xero-ruby/models/report_with_rows.rb +1 -1
- data/lib/xero-ruby/models/reports.rb +1 -1
- data/lib/xero-ruby/models/request_empty.rb +1 -1
- data/lib/xero-ruby/models/sales_tracking_category.rb +1 -1
- data/lib/xero-ruby/models/schedule.rb +1 -1
- data/lib/xero-ruby/models/tax_component.rb +1 -1
- data/lib/xero-ruby/models/tax_rate.rb +1 -1
- data/lib/xero-ruby/models/tax_rates.rb +1 -1
- data/lib/xero-ruby/models/ten_nintey_nine_contact.rb +1 -1
- data/lib/xero-ruby/models/tracking_categories.rb +1 -1
- data/lib/xero-ruby/models/tracking_category.rb +1 -1
- data/lib/xero-ruby/models/tracking_option.rb +1 -1
- data/lib/xero-ruby/models/tracking_options.rb +1 -1
- data/lib/xero-ruby/models/user.rb +1 -1
- data/lib/xero-ruby/models/users.rb +1 -1
- data/lib/xero-ruby/models/validation_error.rb +1 -1
- data/lib/xero-ruby/version.rb +1 -1
- data/pkg/xero-ruby-0.1.2.gem +0 -0
- data/spec/api/accounting_api_spec.rb +410 -58
- data/spec/api_client_spec.rb +31 -31
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/account_spec.rb +6 -6
- data/spec/models/account_type_spec.rb +5 -5
- data/spec/models/accounts_payable_spec.rb +5 -5
- data/spec/models/accounts_receivable_spec.rb +5 -5
- data/spec/models/accounts_spec.rb +5 -5
- data/spec/models/address_spec.rb +5 -5
- data/spec/models/allocation_spec.rb +5 -5
- data/spec/models/allocations_spec.rb +5 -5
- data/spec/models/attachment_spec.rb +5 -5
- data/spec/models/attachments_spec.rb +5 -5
- data/spec/models/balances_spec.rb +5 -5
- data/spec/models/bank_transaction_spec.rb +7 -7
- data/spec/models/bank_transactions_spec.rb +5 -5
- data/spec/models/bank_transfer_spec.rb +5 -5
- data/spec/models/bank_transfers_spec.rb +5 -5
- data/spec/models/batch_payment_details_spec.rb +5 -5
- data/spec/models/batch_payment_spec.rb +5 -5
- data/spec/models/batch_payments_spec.rb +5 -5
- data/spec/models/bill_spec.rb +5 -5
- data/spec/models/branding_theme_spec.rb +5 -5
- data/spec/models/branding_themes_spec.rb +5 -5
- data/spec/models/cis_org_setting_spec.rb +5 -5
- data/spec/models/cis_setting_spec.rb +5 -5
- data/spec/models/cis_settings_spec.rb +5 -5
- data/spec/models/contact_group_spec.rb +5 -5
- data/spec/models/contact_groups_spec.rb +5 -5
- data/spec/models/contact_person_spec.rb +5 -5
- data/spec/models/contact_spec.rb +5 -5
- data/spec/models/contacts_spec.rb +5 -5
- data/spec/models/country_code_spec.rb +5 -5
- data/spec/models/credit_note_spec.rb +5 -5
- data/spec/models/credit_notes_spec.rb +5 -5
- data/spec/models/currencies_spec.rb +5 -5
- data/spec/models/currency_code_spec.rb +5 -5
- data/spec/models/currency_spec.rb +5 -5
- data/spec/models/element_spec.rb +5 -5
- data/spec/models/employee_spec.rb +5 -5
- data/spec/models/employees_spec.rb +5 -5
- data/spec/models/error_spec.rb +5 -5
- data/spec/models/expense_claim_spec.rb +5 -5
- data/spec/models/expense_claims_spec.rb +5 -5
- data/spec/models/external_link_spec.rb +5 -5
- data/spec/models/history_record_spec.rb +5 -5
- data/spec/models/history_records_spec.rb +5 -5
- data/spec/models/invoice_reminder_spec.rb +5 -5
- data/spec/models/invoice_reminders_spec.rb +5 -5
- data/spec/models/invoice_spec.rb +12 -6
- data/spec/models/invoices_spec.rb +5 -5
- data/spec/models/item_spec.rb +5 -5
- data/spec/models/items_spec.rb +5 -5
- data/spec/models/journal_line_spec.rb +5 -5
- data/spec/models/journal_spec.rb +5 -5
- data/spec/models/journals_spec.rb +5 -5
- data/spec/models/line_amount_types_spec.rb +5 -5
- data/spec/models/line_item_spec.rb +11 -5
- data/spec/models/line_item_tracking_spec.rb +5 -5
- data/spec/models/linked_transaction_spec.rb +5 -5
- data/spec/models/linked_transactions_spec.rb +5 -5
- data/spec/models/manual_journal_line_spec.rb +5 -5
- data/spec/models/manual_journal_spec.rb +5 -5
- data/spec/models/manual_journals_spec.rb +5 -5
- data/spec/models/online_invoice_spec.rb +5 -5
- data/spec/models/online_invoices_spec.rb +5 -5
- data/spec/models/organisation_spec.rb +7 -7
- data/spec/models/organisations_spec.rb +5 -5
- data/spec/models/overpayment_spec.rb +6 -6
- data/spec/models/overpayments_spec.rb +5 -5
- data/spec/models/payment_service_spec.rb +5 -5
- data/spec/models/payment_services_spec.rb +5 -5
- data/spec/models/payment_spec.rb +5 -5
- data/spec/models/payment_term_spec.rb +5 -5
- data/spec/models/payment_term_type_spec.rb +5 -5
- data/spec/models/payments_spec.rb +5 -5
- data/spec/models/phone_spec.rb +5 -5
- data/spec/models/prepayment_spec.rb +6 -6
- data/spec/models/prepayments_spec.rb +5 -5
- data/spec/models/purchase_order_spec.rb +5 -5
- data/spec/models/purchase_orders_spec.rb +5 -5
- data/spec/models/purchase_spec.rb +5 -5
- data/spec/models/receipt_spec.rb +7 -7
- data/spec/models/receipts_spec.rb +5 -5
- data/spec/models/repeating_invoice_spec.rb +5 -5
- data/spec/models/repeating_invoices_spec.rb +5 -5
- data/spec/models/report_attribute_spec.rb +5 -5
- data/spec/models/report_cell_spec.rb +5 -5
- data/spec/models/report_fields_spec.rb +5 -5
- data/spec/models/report_row_spec.rb +5 -5
- data/spec/models/report_rows_spec.rb +5 -5
- data/spec/models/report_spec.rb +5 -5
- data/spec/models/report_with_row_spec.rb +5 -5
- data/spec/models/report_with_rows_spec.rb +5 -5
- data/spec/models/reports_spec.rb +5 -5
- data/spec/models/request_empty_spec.rb +5 -5
- data/spec/models/row_type_spec.rb +5 -5
- data/spec/models/schedule_spec.rb +5 -5
- data/spec/models/tax_component_spec.rb +5 -5
- data/spec/models/tax_rate_spec.rb +6 -6
- data/spec/models/tax_rates_spec.rb +5 -5
- data/spec/models/tax_type_spec.rb +5 -5
- data/spec/models/ten_nintey_nine_contact_spec.rb +5 -5
- data/spec/models/time_zone_spec.rb +5 -5
- data/spec/models/tracking_categories_spec.rb +5 -5
- data/spec/models/tracking_category_spec.rb +6 -6
- data/spec/models/tracking_option_spec.rb +6 -6
- data/spec/models/tracking_options_spec.rb +5 -5
- data/spec/models/user_spec.rb +6 -6
- data/spec/models/users_spec.rb +5 -5
- data/spec/models/validation_error_spec.rb +5 -5
- data/spec/spec_helper.rb +3 -3
- data/xero-ruby.gemspec +2 -2
- metadata +5 -7
- data/lib/.DS_Store +0 -0
- data/pkg/xero-ruby-0.1.0.gem +0 -0
- data/pkg/xero-ruby-1.0.0.gem +0 -0
data/lib/xero-ruby/version.rb
CHANGED
|
Binary file
|
|
@@ -3,23 +3,23 @@
|
|
|
3
3
|
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
7
|
Contact: api@xero.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version:
|
|
9
|
+
OpenAPI Generator version: 4.0.3
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
require 'spec_helper'
|
|
14
14
|
require 'json'
|
|
15
15
|
|
|
16
|
-
# Unit tests for
|
|
16
|
+
# Unit tests for XeroRuby::AccountingApi
|
|
17
17
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
18
|
# Please update as you see appropriate
|
|
19
19
|
describe 'AccountingApi' do
|
|
20
20
|
before do
|
|
21
21
|
# run before each test
|
|
22
|
-
@
|
|
22
|
+
@api_instance = XeroRuby::AccountingApi.new
|
|
23
23
|
end
|
|
24
24
|
|
|
25
25
|
after do
|
|
@@ -28,12 +28,13 @@ describe 'AccountingApi' do
|
|
|
28
28
|
|
|
29
29
|
describe 'test an instance of AccountingApi' do
|
|
30
30
|
it 'should create an instance of AccountingApi' do
|
|
31
|
-
expect(@
|
|
31
|
+
expect(@api_instance).to be_instance_of(XeroRuby::AccountingApi)
|
|
32
32
|
end
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
# unit tests for create_account
|
|
36
36
|
# Allows you to create a new chart of accounts
|
|
37
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
37
38
|
# @param account Request of type Account
|
|
38
39
|
# @param [Hash] opts the optional parameters
|
|
39
40
|
# @return [Accounts]
|
|
@@ -45,6 +46,7 @@ describe 'AccountingApi' do
|
|
|
45
46
|
|
|
46
47
|
# unit tests for create_account_attachment_by_file_name
|
|
47
48
|
# Allows you to create Attachment on Account
|
|
49
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
48
50
|
# @param account_id Unique identifier for Account object
|
|
49
51
|
# @param file_name Name of the attachment
|
|
50
52
|
# @param body Byte array of file in body of request
|
|
@@ -58,9 +60,9 @@ describe 'AccountingApi' do
|
|
|
58
60
|
|
|
59
61
|
# unit tests for create_bank_transaction
|
|
60
62
|
# Allows you to create a spend or receive money transaction
|
|
61
|
-
# @param
|
|
63
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
64
|
+
# @param bank_transaction
|
|
62
65
|
# @param [Hash] opts the optional parameters
|
|
63
|
-
# @option opts [BOOLEAN] :summarize_errors response format that shows validation errors for each bank transaction
|
|
64
66
|
# @return [BankTransactions]
|
|
65
67
|
describe 'create_bank_transaction test' do
|
|
66
68
|
it 'should work' do
|
|
@@ -70,6 +72,7 @@ describe 'AccountingApi' do
|
|
|
70
72
|
|
|
71
73
|
# unit tests for create_bank_transaction_attachment_by_file_name
|
|
72
74
|
# Allows you to createa an Attachment on BankTransaction by Filename
|
|
75
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
73
76
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
74
77
|
# @param file_name The name of the file being attached
|
|
75
78
|
# @param body Byte array of file in body of request
|
|
@@ -83,6 +86,7 @@ describe 'AccountingApi' do
|
|
|
83
86
|
|
|
84
87
|
# unit tests for create_bank_transaction_history_record
|
|
85
88
|
# Allows you to create history record for a bank transactions
|
|
89
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
86
90
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
87
91
|
# @param history_records
|
|
88
92
|
# @param [Hash] opts the optional parameters
|
|
@@ -93,8 +97,22 @@ describe 'AccountingApi' do
|
|
|
93
97
|
end
|
|
94
98
|
end
|
|
95
99
|
|
|
100
|
+
# unit tests for create_bank_transactions
|
|
101
|
+
# Allows you to create a spend or receive money transaction
|
|
102
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
103
|
+
# @param bank_transactions
|
|
104
|
+
# @param [Hash] opts the optional parameters
|
|
105
|
+
# @option opts [Boolean] :summarize_errors response format that shows validation errors for each bank transaction
|
|
106
|
+
# @return [BankTransactions]
|
|
107
|
+
describe 'create_bank_transactions test' do
|
|
108
|
+
it 'should work' do
|
|
109
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
110
|
+
end
|
|
111
|
+
end
|
|
112
|
+
|
|
96
113
|
# unit tests for create_bank_transfer
|
|
97
114
|
# Allows you to create a bank transfers
|
|
115
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
98
116
|
# @param bank_transfers
|
|
99
117
|
# @param [Hash] opts the optional parameters
|
|
100
118
|
# @return [BankTransfers]
|
|
@@ -105,6 +123,7 @@ describe 'AccountingApi' do
|
|
|
105
123
|
end
|
|
106
124
|
|
|
107
125
|
# unit tests for create_bank_transfer_attachment_by_file_name
|
|
126
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
108
127
|
# @param bank_transfer_id Xero generated unique identifier for a bank transfer
|
|
109
128
|
# @param file_name The name of the file being attached to a Bank Transfer
|
|
110
129
|
# @param body Byte array of file in body of request
|
|
@@ -117,6 +136,7 @@ describe 'AccountingApi' do
|
|
|
117
136
|
end
|
|
118
137
|
|
|
119
138
|
# unit tests for create_bank_transfer_history_record
|
|
139
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
120
140
|
# @param bank_transfer_id Xero generated unique identifier for a bank transfer
|
|
121
141
|
# @param history_records
|
|
122
142
|
# @param [Hash] opts the optional parameters
|
|
@@ -129,6 +149,7 @@ describe 'AccountingApi' do
|
|
|
129
149
|
|
|
130
150
|
# unit tests for create_batch_payment
|
|
131
151
|
# Create one or many BatchPayments for invoices
|
|
152
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
132
153
|
# @param batch_payments Request of type BatchPayments containing a Payments array with one or more Payment objects
|
|
133
154
|
# @param [Hash] opts the optional parameters
|
|
134
155
|
# @return [BatchPayments]
|
|
@@ -140,6 +161,7 @@ describe 'AccountingApi' do
|
|
|
140
161
|
|
|
141
162
|
# unit tests for create_batch_payment_history_record
|
|
142
163
|
# Allows you to create a history record for a Batch Payment
|
|
164
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
143
165
|
# @param batch_payment_id Unique identifier for BatchPayment
|
|
144
166
|
# @param history_records
|
|
145
167
|
# @param [Hash] opts the optional parameters
|
|
@@ -152,6 +174,7 @@ describe 'AccountingApi' do
|
|
|
152
174
|
|
|
153
175
|
# unit tests for create_branding_theme_payment_services
|
|
154
176
|
# Allow for the creation of new custom payment service for specified Branding Theme
|
|
177
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
155
178
|
# @param branding_theme_id Unique identifier for a Branding Theme
|
|
156
179
|
# @param payment_service
|
|
157
180
|
# @param [Hash] opts the optional parameters
|
|
@@ -163,6 +186,7 @@ describe 'AccountingApi' do
|
|
|
163
186
|
end
|
|
164
187
|
|
|
165
188
|
# unit tests for create_contact
|
|
189
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
166
190
|
# @param contact
|
|
167
191
|
# @param [Hash] opts the optional parameters
|
|
168
192
|
# @return [Contacts]
|
|
@@ -173,6 +197,7 @@ describe 'AccountingApi' do
|
|
|
173
197
|
end
|
|
174
198
|
|
|
175
199
|
# unit tests for create_contact_attachment_by_file_name
|
|
200
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
176
201
|
# @param contact_id Unique identifier for a Contact
|
|
177
202
|
# @param file_name Name for the file you are attaching
|
|
178
203
|
# @param body Byte array of file in body of request
|
|
@@ -186,8 +211,9 @@ describe 'AccountingApi' do
|
|
|
186
211
|
|
|
187
212
|
# unit tests for create_contact_group
|
|
188
213
|
# Allows you to create a contact group
|
|
214
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
215
|
+
# @param contact_groups an array of contact groups with names specified
|
|
189
216
|
# @param [Hash] opts the optional parameters
|
|
190
|
-
# @option opts [ContactGroups] :contact_groups
|
|
191
217
|
# @return [ContactGroups]
|
|
192
218
|
describe 'create_contact_group test' do
|
|
193
219
|
it 'should work' do
|
|
@@ -197,9 +223,10 @@ describe 'AccountingApi' do
|
|
|
197
223
|
|
|
198
224
|
# unit tests for create_contact_group_contacts
|
|
199
225
|
# Allows you to add Contacts to a Contract Group
|
|
226
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
200
227
|
# @param contact_group_id Unique identifier for a Contact Group
|
|
228
|
+
# @param contacts an array of contacts with ContactID to be added to ContactGroup
|
|
201
229
|
# @param [Hash] opts the optional parameters
|
|
202
|
-
# @option opts [Contacts] :contacts
|
|
203
230
|
# @return [Contacts]
|
|
204
231
|
describe 'create_contact_group_contacts test' do
|
|
205
232
|
it 'should work' do
|
|
@@ -209,6 +236,7 @@ describe 'AccountingApi' do
|
|
|
209
236
|
|
|
210
237
|
# unit tests for create_contact_history
|
|
211
238
|
# Allows you to retrieve a history records of an Contact
|
|
239
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
212
240
|
# @param contact_id Unique identifier for a Contact
|
|
213
241
|
# @param history_records
|
|
214
242
|
# @param [Hash] opts the optional parameters
|
|
@@ -219,11 +247,22 @@ describe 'AccountingApi' do
|
|
|
219
247
|
end
|
|
220
248
|
end
|
|
221
249
|
|
|
250
|
+
# unit tests for create_contacts
|
|
251
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
252
|
+
# @param contacts
|
|
253
|
+
# @param [Hash] opts the optional parameters
|
|
254
|
+
# @return [Contacts]
|
|
255
|
+
describe 'create_contacts test' do
|
|
256
|
+
it 'should work' do
|
|
257
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
258
|
+
end
|
|
259
|
+
end
|
|
260
|
+
|
|
222
261
|
# unit tests for create_credit_note
|
|
223
262
|
# Allows you to create a credit note
|
|
263
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
264
|
+
# @param credit_note an array of Credit Notes with a single CreditNote object.
|
|
224
265
|
# @param [Hash] opts the optional parameters
|
|
225
|
-
# @option opts [BOOLEAN] :summarize_errors shows validation errors for each credit note
|
|
226
|
-
# @option opts [CreditNotes] :credit_notes
|
|
227
266
|
# @return [CreditNotes]
|
|
228
267
|
describe 'create_credit_note test' do
|
|
229
268
|
it 'should work' do
|
|
@@ -233,9 +272,10 @@ describe 'AccountingApi' do
|
|
|
233
272
|
|
|
234
273
|
# unit tests for create_credit_note_allocation
|
|
235
274
|
# Allows you to create Allocation on CreditNote
|
|
275
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
236
276
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
277
|
+
# @param allocations an array of Allocations with single Allocation object defined.
|
|
237
278
|
# @param [Hash] opts the optional parameters
|
|
238
|
-
# @option opts [Allocations] :allocations
|
|
239
279
|
# @return [Allocations]
|
|
240
280
|
describe 'create_credit_note_allocation test' do
|
|
241
281
|
it 'should work' do
|
|
@@ -245,6 +285,7 @@ describe 'AccountingApi' do
|
|
|
245
285
|
|
|
246
286
|
# unit tests for create_credit_note_attachment_by_file_name
|
|
247
287
|
# Allows you to create Attachments on CreditNote by file name
|
|
288
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
248
289
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
249
290
|
# @param file_name Name of the file you are attaching to Credit Note
|
|
250
291
|
# @param body Byte array of file in body of request
|
|
@@ -258,6 +299,7 @@ describe 'AccountingApi' do
|
|
|
258
299
|
|
|
259
300
|
# unit tests for create_credit_note_history
|
|
260
301
|
# Allows you to retrieve a history records of an CreditNote
|
|
302
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
261
303
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
262
304
|
# @param history_records
|
|
263
305
|
# @param [Hash] opts the optional parameters
|
|
@@ -268,8 +310,22 @@ describe 'AccountingApi' do
|
|
|
268
310
|
end
|
|
269
311
|
end
|
|
270
312
|
|
|
313
|
+
# unit tests for create_credit_notes
|
|
314
|
+
# Allows you to create a credit note
|
|
315
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
316
|
+
# @param credit_notes an array of Credit Notes with a single CreditNote object.
|
|
317
|
+
# @param [Hash] opts the optional parameters
|
|
318
|
+
# @option opts [Boolean] :summarize_errors shows validation errors for each credit note
|
|
319
|
+
# @return [CreditNotes]
|
|
320
|
+
describe 'create_credit_notes test' do
|
|
321
|
+
it 'should work' do
|
|
322
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
323
|
+
end
|
|
324
|
+
end
|
|
325
|
+
|
|
271
326
|
# unit tests for create_currency
|
|
272
|
-
# @param
|
|
327
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
328
|
+
# @param currency
|
|
273
329
|
# @param [Hash] opts the optional parameters
|
|
274
330
|
# @return [Currencies]
|
|
275
331
|
describe 'create_currency test' do
|
|
@@ -280,7 +336,8 @@ describe 'AccountingApi' do
|
|
|
280
336
|
|
|
281
337
|
# unit tests for create_employee
|
|
282
338
|
# Allows you to create new employees used in Xero payrun
|
|
283
|
-
# @param
|
|
339
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
340
|
+
# @param employee
|
|
284
341
|
# @param [Hash] opts the optional parameters
|
|
285
342
|
# @return [Employees]
|
|
286
343
|
describe 'create_employee test' do
|
|
@@ -289,13 +346,13 @@ describe 'AccountingApi' do
|
|
|
289
346
|
end
|
|
290
347
|
end
|
|
291
348
|
|
|
292
|
-
# unit tests for
|
|
293
|
-
# Allows you to
|
|
294
|
-
# @param
|
|
349
|
+
# unit tests for create_employees
|
|
350
|
+
# Allows you to create new employees used in Xero payrun
|
|
351
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
352
|
+
# @param employees
|
|
295
353
|
# @param [Hash] opts the optional parameters
|
|
296
|
-
# @
|
|
297
|
-
|
|
298
|
-
describe 'create_expense_claim test' do
|
|
354
|
+
# @return [Employees]
|
|
355
|
+
describe 'create_employees test' do
|
|
299
356
|
it 'should work' do
|
|
300
357
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
301
358
|
end
|
|
@@ -303,6 +360,7 @@ describe 'AccountingApi' do
|
|
|
303
360
|
|
|
304
361
|
# unit tests for create_expense_claim_history
|
|
305
362
|
# Allows you to create a history records of an ExpenseClaim
|
|
363
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
306
364
|
# @param expense_claim_id Unique identifier for a ExpenseClaim
|
|
307
365
|
# @param history_records
|
|
308
366
|
# @param [Hash] opts the optional parameters
|
|
@@ -313,11 +371,23 @@ describe 'AccountingApi' do
|
|
|
313
371
|
end
|
|
314
372
|
end
|
|
315
373
|
|
|
374
|
+
# unit tests for create_expense_claims
|
|
375
|
+
# Allows you to retrieve expense claims
|
|
376
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
377
|
+
# @param expense_claims
|
|
378
|
+
# @param [Hash] opts the optional parameters
|
|
379
|
+
# @return [ExpenseClaims]
|
|
380
|
+
describe 'create_expense_claims test' do
|
|
381
|
+
it 'should work' do
|
|
382
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
383
|
+
end
|
|
384
|
+
end
|
|
385
|
+
|
|
316
386
|
# unit tests for create_invoice
|
|
317
387
|
# Allows you to create any sales invoices or purchase bills
|
|
318
|
-
# @param
|
|
388
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
389
|
+
# @param invoice
|
|
319
390
|
# @param [Hash] opts the optional parameters
|
|
320
|
-
# @option opts [BOOLEAN] :summarize_errors shows validation errors for each invoice
|
|
321
391
|
# @return [Invoices]
|
|
322
392
|
describe 'create_invoice test' do
|
|
323
393
|
it 'should work' do
|
|
@@ -327,6 +397,7 @@ describe 'AccountingApi' do
|
|
|
327
397
|
|
|
328
398
|
# unit tests for create_invoice_attachment_by_file_name
|
|
329
399
|
# Allows you to create an Attachment on invoices or purchase bills by it's filename
|
|
400
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
330
401
|
# @param invoice_id Unique identifier for an Invoice
|
|
331
402
|
# @param file_name Name of the file you are attaching
|
|
332
403
|
# @param body Byte array of file in body of request
|
|
@@ -340,6 +411,7 @@ describe 'AccountingApi' do
|
|
|
340
411
|
|
|
341
412
|
# unit tests for create_invoice_history
|
|
342
413
|
# Allows you to retrieve a history records of an invoice
|
|
414
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
343
415
|
# @param invoice_id Unique identifier for an Invoice
|
|
344
416
|
# @param history_records
|
|
345
417
|
# @param [Hash] opts the optional parameters
|
|
@@ -350,9 +422,23 @@ describe 'AccountingApi' do
|
|
|
350
422
|
end
|
|
351
423
|
end
|
|
352
424
|
|
|
425
|
+
# unit tests for create_invoices
|
|
426
|
+
# Allows you to create any sales invoices or purchase bills
|
|
427
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
428
|
+
# @param invoices
|
|
429
|
+
# @param [Hash] opts the optional parameters
|
|
430
|
+
# @option opts [Boolean] :summarize_errors shows validation errors for each invoice
|
|
431
|
+
# @return [Invoices]
|
|
432
|
+
describe 'create_invoices test' do
|
|
433
|
+
it 'should work' do
|
|
434
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
435
|
+
end
|
|
436
|
+
end
|
|
437
|
+
|
|
353
438
|
# unit tests for create_item
|
|
354
439
|
# Allows you to create an item
|
|
355
|
-
# @param
|
|
440
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
441
|
+
# @param item
|
|
356
442
|
# @param [Hash] opts the optional parameters
|
|
357
443
|
# @return [Items]
|
|
358
444
|
describe 'create_item test' do
|
|
@@ -363,6 +449,7 @@ describe 'AccountingApi' do
|
|
|
363
449
|
|
|
364
450
|
# unit tests for create_item_history
|
|
365
451
|
# Allows you to create a history record for items
|
|
452
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
366
453
|
# @param item_id Unique identifier for an Item
|
|
367
454
|
# @param history_records
|
|
368
455
|
# @param [Hash] opts the optional parameters
|
|
@@ -373,9 +460,22 @@ describe 'AccountingApi' do
|
|
|
373
460
|
end
|
|
374
461
|
end
|
|
375
462
|
|
|
463
|
+
# unit tests for create_items
|
|
464
|
+
# Allows you to create an item
|
|
465
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
466
|
+
# @param items
|
|
467
|
+
# @param [Hash] opts the optional parameters
|
|
468
|
+
# @return [Items]
|
|
469
|
+
describe 'create_items test' do
|
|
470
|
+
it 'should work' do
|
|
471
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
472
|
+
end
|
|
473
|
+
end
|
|
474
|
+
|
|
376
475
|
# unit tests for create_linked_transaction
|
|
377
476
|
# Allows you to create linked transactions (billable expenses)
|
|
378
|
-
# @param
|
|
477
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
478
|
+
# @param linked_transaction
|
|
379
479
|
# @param [Hash] opts the optional parameters
|
|
380
480
|
# @return [LinkedTransactions]
|
|
381
481
|
describe 'create_linked_transaction test' do
|
|
@@ -384,9 +484,22 @@ describe 'AccountingApi' do
|
|
|
384
484
|
end
|
|
385
485
|
end
|
|
386
486
|
|
|
487
|
+
# unit tests for create_linked_transactions
|
|
488
|
+
# Allows you to create linked transactions (billable expenses)
|
|
489
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
490
|
+
# @param linked_transactions
|
|
491
|
+
# @param [Hash] opts the optional parameters
|
|
492
|
+
# @return [LinkedTransactions]
|
|
493
|
+
describe 'create_linked_transactions test' do
|
|
494
|
+
it 'should work' do
|
|
495
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
496
|
+
end
|
|
497
|
+
end
|
|
498
|
+
|
|
387
499
|
# unit tests for create_manual_journal
|
|
388
500
|
# Allows you to create a manual journal
|
|
389
|
-
# @param
|
|
501
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
502
|
+
# @param manual_journal
|
|
390
503
|
# @param [Hash] opts the optional parameters
|
|
391
504
|
# @return [ManualJournals]
|
|
392
505
|
describe 'create_manual_journal test' do
|
|
@@ -397,6 +510,7 @@ describe 'AccountingApi' do
|
|
|
397
510
|
|
|
398
511
|
# unit tests for create_manual_journal_attachment_by_file_name
|
|
399
512
|
# Allows you to create a specified Attachment on ManualJournal by file name
|
|
513
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
400
514
|
# @param manual_journal_id Unique identifier for a ManualJournal
|
|
401
515
|
# @param file_name The name of the file being attached to a ManualJournal
|
|
402
516
|
# @param body Byte array of file in body of request
|
|
@@ -408,10 +522,23 @@ describe 'AccountingApi' do
|
|
|
408
522
|
end
|
|
409
523
|
end
|
|
410
524
|
|
|
525
|
+
# unit tests for create_manual_journals
|
|
526
|
+
# Allows you to create a manual journal
|
|
527
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
528
|
+
# @param manual_journals
|
|
529
|
+
# @param [Hash] opts the optional parameters
|
|
530
|
+
# @return [ManualJournals]
|
|
531
|
+
describe 'create_manual_journals test' do
|
|
532
|
+
it 'should work' do
|
|
533
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
534
|
+
end
|
|
535
|
+
end
|
|
536
|
+
|
|
411
537
|
# unit tests for create_overpayment_allocation
|
|
412
538
|
# Allows you to retrieve Allocations for overpayments
|
|
539
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
413
540
|
# @param overpayment_id Unique identifier for a Overpayment
|
|
414
|
-
# @param
|
|
541
|
+
# @param allocation
|
|
415
542
|
# @param [Hash] opts the optional parameters
|
|
416
543
|
# @return [Allocations]
|
|
417
544
|
describe 'create_overpayment_allocation test' do
|
|
@@ -420,8 +547,22 @@ describe 'AccountingApi' do
|
|
|
420
547
|
end
|
|
421
548
|
end
|
|
422
549
|
|
|
550
|
+
# unit tests for create_overpayment_allocations
|
|
551
|
+
# Allows you to retrieve Allocations for overpayments
|
|
552
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
553
|
+
# @param overpayment_id Unique identifier for a Overpayment
|
|
554
|
+
# @param allocations
|
|
555
|
+
# @param [Hash] opts the optional parameters
|
|
556
|
+
# @return [Allocations]
|
|
557
|
+
describe 'create_overpayment_allocations test' do
|
|
558
|
+
it 'should work' do
|
|
559
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
560
|
+
end
|
|
561
|
+
end
|
|
562
|
+
|
|
423
563
|
# unit tests for create_overpayment_history
|
|
424
564
|
# Allows you to create history records of an Overpayment
|
|
565
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
425
566
|
# @param overpayment_id Unique identifier for a Overpayment
|
|
426
567
|
# @param history_records
|
|
427
568
|
# @param [Hash] opts the optional parameters
|
|
@@ -434,7 +575,8 @@ describe 'AccountingApi' do
|
|
|
434
575
|
|
|
435
576
|
# unit tests for create_payment
|
|
436
577
|
# Allows you to create payments for invoices and credit notes
|
|
437
|
-
# @param
|
|
578
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
579
|
+
# @param payment
|
|
438
580
|
# @param [Hash] opts the optional parameters
|
|
439
581
|
# @return [Payments]
|
|
440
582
|
describe 'create_payment test' do
|
|
@@ -445,6 +587,7 @@ describe 'AccountingApi' do
|
|
|
445
587
|
|
|
446
588
|
# unit tests for create_payment_history
|
|
447
589
|
# Allows you to create a history record for a payment
|
|
590
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
448
591
|
# @param payment_id Unique identifier for a Payment
|
|
449
592
|
# @param history_records
|
|
450
593
|
# @param [Hash] opts the optional parameters
|
|
@@ -457,6 +600,7 @@ describe 'AccountingApi' do
|
|
|
457
600
|
|
|
458
601
|
# unit tests for create_payment_service
|
|
459
602
|
# Allows you to create payment services
|
|
603
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
460
604
|
# @param payment_services
|
|
461
605
|
# @param [Hash] opts the optional parameters
|
|
462
606
|
# @return [PaymentServices]
|
|
@@ -466,8 +610,21 @@ describe 'AccountingApi' do
|
|
|
466
610
|
end
|
|
467
611
|
end
|
|
468
612
|
|
|
613
|
+
# unit tests for create_payments
|
|
614
|
+
# Allows you to create payments for invoices and credit notes
|
|
615
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
616
|
+
# @param payments
|
|
617
|
+
# @param [Hash] opts the optional parameters
|
|
618
|
+
# @return [Payments]
|
|
619
|
+
describe 'create_payments test' do
|
|
620
|
+
it 'should work' do
|
|
621
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
622
|
+
end
|
|
623
|
+
end
|
|
624
|
+
|
|
469
625
|
# unit tests for create_prepayment_allocation
|
|
470
626
|
# Allows you to create an Allocation for prepayments
|
|
627
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
471
628
|
# @param prepayment_id
|
|
472
629
|
# @param allocations
|
|
473
630
|
# @param [Hash] opts the optional parameters
|
|
@@ -480,6 +637,7 @@ describe 'AccountingApi' do
|
|
|
480
637
|
|
|
481
638
|
# unit tests for create_prepayment_history
|
|
482
639
|
# Allows you to create a history record for an Prepayment
|
|
640
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
483
641
|
# @param prepayment_id Unique identifier for a PrePayment
|
|
484
642
|
# @param history_records
|
|
485
643
|
# @param [Hash] opts the optional parameters
|
|
@@ -492,9 +650,9 @@ describe 'AccountingApi' do
|
|
|
492
650
|
|
|
493
651
|
# unit tests for create_purchase_order
|
|
494
652
|
# Allows you to create purchase orders
|
|
495
|
-
# @param
|
|
653
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
654
|
+
# @param purchase_order
|
|
496
655
|
# @param [Hash] opts the optional parameters
|
|
497
|
-
# @option opts [BOOLEAN] :summarize_errors shows validation errors for each purchase order.
|
|
498
656
|
# @return [PurchaseOrders]
|
|
499
657
|
describe 'create_purchase_order test' do
|
|
500
658
|
it 'should work' do
|
|
@@ -504,6 +662,7 @@ describe 'AccountingApi' do
|
|
|
504
662
|
|
|
505
663
|
# unit tests for create_purchase_order_history
|
|
506
664
|
# Allows you to create HistoryRecord for purchase orders
|
|
665
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
507
666
|
# @param purchase_order_id Unique identifier for a PurchaseOrder
|
|
508
667
|
# @param history_records
|
|
509
668
|
# @param [Hash] opts the optional parameters
|
|
@@ -514,8 +673,22 @@ describe 'AccountingApi' do
|
|
|
514
673
|
end
|
|
515
674
|
end
|
|
516
675
|
|
|
676
|
+
# unit tests for create_purchase_orders
|
|
677
|
+
# Allows you to create purchase orders
|
|
678
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
679
|
+
# @param purchase_orders
|
|
680
|
+
# @param [Hash] opts the optional parameters
|
|
681
|
+
# @option opts [Boolean] :summarize_errors shows validation errors for each purchase order.
|
|
682
|
+
# @return [PurchaseOrders]
|
|
683
|
+
describe 'create_purchase_orders test' do
|
|
684
|
+
it 'should work' do
|
|
685
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
686
|
+
end
|
|
687
|
+
end
|
|
688
|
+
|
|
517
689
|
# unit tests for create_receipt
|
|
518
690
|
# Allows you to create draft expense claim receipts for any user
|
|
691
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
519
692
|
# @param receipts
|
|
520
693
|
# @param [Hash] opts the optional parameters
|
|
521
694
|
# @return [Receipts]
|
|
@@ -527,6 +700,7 @@ describe 'AccountingApi' do
|
|
|
527
700
|
|
|
528
701
|
# unit tests for create_receipt_attachment_by_file_name
|
|
529
702
|
# Allows you to create Attachment on expense claim receipts by file name
|
|
703
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
530
704
|
# @param receipt_id Unique identifier for a Receipt
|
|
531
705
|
# @param file_name The name of the file being attached to the Receipt
|
|
532
706
|
# @param body Byte array of file in body of request
|
|
@@ -540,6 +714,7 @@ describe 'AccountingApi' do
|
|
|
540
714
|
|
|
541
715
|
# unit tests for create_receipt_history
|
|
542
716
|
# Allows you to retrieve a history records of an Receipt
|
|
717
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
543
718
|
# @param receipt_id Unique identifier for a Receipt
|
|
544
719
|
# @param history_records
|
|
545
720
|
# @param [Hash] opts the optional parameters
|
|
@@ -552,6 +727,7 @@ describe 'AccountingApi' do
|
|
|
552
727
|
|
|
553
728
|
# unit tests for create_repeating_invoice_attachment_by_file_name
|
|
554
729
|
# Allows you to create attachment on repeating invoices by file name
|
|
730
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
555
731
|
# @param repeating_invoice_id Unique identifier for a Repeating Invoice
|
|
556
732
|
# @param file_name The name of the file being attached to a Repeating Invoice
|
|
557
733
|
# @param body Byte array of file in body of request
|
|
@@ -565,6 +741,7 @@ describe 'AccountingApi' do
|
|
|
565
741
|
|
|
566
742
|
# unit tests for create_repeating_invoice_history
|
|
567
743
|
# Allows you to create history for a repeating invoice
|
|
744
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
568
745
|
# @param repeating_invoice_id Unique identifier for a Repeating Invoice
|
|
569
746
|
# @param history_records
|
|
570
747
|
# @param [Hash] opts the optional parameters
|
|
@@ -577,7 +754,8 @@ describe 'AccountingApi' do
|
|
|
577
754
|
|
|
578
755
|
# unit tests for create_tax_rate
|
|
579
756
|
# Allows you to create Tax Rates
|
|
580
|
-
# @param
|
|
757
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
758
|
+
# @param tax_rate
|
|
581
759
|
# @param [Hash] opts the optional parameters
|
|
582
760
|
# @return [TaxRates]
|
|
583
761
|
describe 'create_tax_rate test' do
|
|
@@ -586,8 +764,21 @@ describe 'AccountingApi' do
|
|
|
586
764
|
end
|
|
587
765
|
end
|
|
588
766
|
|
|
767
|
+
# unit tests for create_tax_rates
|
|
768
|
+
# Allows you to create Tax Rates
|
|
769
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
770
|
+
# @param tax_rates
|
|
771
|
+
# @param [Hash] opts the optional parameters
|
|
772
|
+
# @return [TaxRates]
|
|
773
|
+
describe 'create_tax_rates test' do
|
|
774
|
+
it 'should work' do
|
|
775
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
776
|
+
end
|
|
777
|
+
end
|
|
778
|
+
|
|
589
779
|
# unit tests for create_tracking_category
|
|
590
780
|
# Allows you to create tracking categories
|
|
781
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
591
782
|
# @param tracking_category
|
|
592
783
|
# @param [Hash] opts the optional parameters
|
|
593
784
|
# @return [TrackingCategories]
|
|
@@ -599,6 +790,7 @@ describe 'AccountingApi' do
|
|
|
599
790
|
|
|
600
791
|
# unit tests for create_tracking_options
|
|
601
792
|
# Allows you to create options for a specified tracking category
|
|
793
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
602
794
|
# @param tracking_category_id Unique identifier for a TrackingCategory
|
|
603
795
|
# @param tracking_option
|
|
604
796
|
# @param [Hash] opts the optional parameters
|
|
@@ -611,6 +803,7 @@ describe 'AccountingApi' do
|
|
|
611
803
|
|
|
612
804
|
# unit tests for delete_account
|
|
613
805
|
# Allows you to delete a chart of accounts
|
|
806
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
614
807
|
# @param account_id Unique identifier for retrieving single object
|
|
615
808
|
# @param [Hash] opts the optional parameters
|
|
616
809
|
# @return [Accounts]
|
|
@@ -622,6 +815,7 @@ describe 'AccountingApi' do
|
|
|
622
815
|
|
|
623
816
|
# unit tests for delete_contact_group_contact
|
|
624
817
|
# Allows you to delete a specific Contact from a Contract Group
|
|
818
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
625
819
|
# @param contact_group_id Unique identifier for a Contact Group
|
|
626
820
|
# @param contact_id Unique identifier for a Contact
|
|
627
821
|
# @param [Hash] opts the optional parameters
|
|
@@ -634,6 +828,7 @@ describe 'AccountingApi' do
|
|
|
634
828
|
|
|
635
829
|
# unit tests for delete_contact_group_contacts
|
|
636
830
|
# Allows you to delete all Contacts from a Contract Group
|
|
831
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
637
832
|
# @param contact_group_id Unique identifier for a Contact Group
|
|
638
833
|
# @param [Hash] opts the optional parameters
|
|
639
834
|
# @return [nil]
|
|
@@ -645,6 +840,7 @@ describe 'AccountingApi' do
|
|
|
645
840
|
|
|
646
841
|
# unit tests for delete_item
|
|
647
842
|
# Allows you to delete a specified item
|
|
843
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
648
844
|
# @param item_id Unique identifier for an Item
|
|
649
845
|
# @param [Hash] opts the optional parameters
|
|
650
846
|
# @return [nil]
|
|
@@ -656,6 +852,7 @@ describe 'AccountingApi' do
|
|
|
656
852
|
|
|
657
853
|
# unit tests for delete_linked_transaction
|
|
658
854
|
# Allows you to delete a specified linked transactions (billable expenses)
|
|
855
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
659
856
|
# @param linked_transaction_id Unique identifier for a LinkedTransaction
|
|
660
857
|
# @param [Hash] opts the optional parameters
|
|
661
858
|
# @return [nil]
|
|
@@ -667,6 +864,7 @@ describe 'AccountingApi' do
|
|
|
667
864
|
|
|
668
865
|
# unit tests for delete_payment
|
|
669
866
|
# Allows you to update a specified payment for invoices and credit notes
|
|
867
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
670
868
|
# @param payment_id Unique identifier for a Payment
|
|
671
869
|
# @param payments
|
|
672
870
|
# @param [Hash] opts the optional parameters
|
|
@@ -679,6 +877,7 @@ describe 'AccountingApi' do
|
|
|
679
877
|
|
|
680
878
|
# unit tests for delete_tracking_category
|
|
681
879
|
# Allows you to delete tracking categories
|
|
880
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
682
881
|
# @param tracking_category_id Unique identifier for a TrackingCategory
|
|
683
882
|
# @param [Hash] opts the optional parameters
|
|
684
883
|
# @return [TrackingCategories]
|
|
@@ -690,6 +889,7 @@ describe 'AccountingApi' do
|
|
|
690
889
|
|
|
691
890
|
# unit tests for delete_tracking_options
|
|
692
891
|
# Allows you to delete a specified option for a specified tracking category
|
|
892
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
693
893
|
# @param tracking_category_id Unique identifier for a TrackingCategory
|
|
694
894
|
# @param tracking_option_id Unique identifier for a Tracking Option
|
|
695
895
|
# @param [Hash] opts the optional parameters
|
|
@@ -702,6 +902,7 @@ describe 'AccountingApi' do
|
|
|
702
902
|
|
|
703
903
|
# unit tests for email_invoice
|
|
704
904
|
# Allows you to email a copy of invoice to related Contact
|
|
905
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
705
906
|
# @param invoice_id Unique identifier for an Invoice
|
|
706
907
|
# @param request_empty
|
|
707
908
|
# @param [Hash] opts the optional parameters
|
|
@@ -714,6 +915,7 @@ describe 'AccountingApi' do
|
|
|
714
915
|
|
|
715
916
|
# unit tests for get_account
|
|
716
917
|
# Allows you to retrieve a single chart of accounts
|
|
918
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
717
919
|
# @param account_id Unique identifier for retrieving single object
|
|
718
920
|
# @param [Hash] opts the optional parameters
|
|
719
921
|
# @return [Accounts]
|
|
@@ -725,6 +927,7 @@ describe 'AccountingApi' do
|
|
|
725
927
|
|
|
726
928
|
# unit tests for get_account_attachment_by_file_name
|
|
727
929
|
# Allows you to retrieve Attachment on Account by Filename
|
|
930
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
728
931
|
# @param account_id Unique identifier for Account object
|
|
729
932
|
# @param file_name Name of the attachment
|
|
730
933
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -738,6 +941,7 @@ describe 'AccountingApi' do
|
|
|
738
941
|
|
|
739
942
|
# unit tests for get_account_attachment_by_id
|
|
740
943
|
# Allows you to retrieve specific Attachment on Account
|
|
944
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
741
945
|
# @param account_id Unique identifier for Account object
|
|
742
946
|
# @param attachment_id Unique identifier for Attachment object
|
|
743
947
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -751,6 +955,7 @@ describe 'AccountingApi' do
|
|
|
751
955
|
|
|
752
956
|
# unit tests for get_account_attachments
|
|
753
957
|
# Allows you to retrieve Attachments for accounts
|
|
958
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
754
959
|
# @param account_id Unique identifier for Account object
|
|
755
960
|
# @param [Hash] opts the optional parameters
|
|
756
961
|
# @return [Attachments]
|
|
@@ -762,6 +967,7 @@ describe 'AccountingApi' do
|
|
|
762
967
|
|
|
763
968
|
# unit tests for get_accounts
|
|
764
969
|
# Allows you to retrieve the full chart of accounts
|
|
970
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
765
971
|
# @param [Hash] opts the optional parameters
|
|
766
972
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
767
973
|
# @option opts [String] :where Filter by an any element
|
|
@@ -775,6 +981,7 @@ describe 'AccountingApi' do
|
|
|
775
981
|
|
|
776
982
|
# unit tests for get_bank_transaction
|
|
777
983
|
# Allows you to retrieve a single spend or receive money transaction
|
|
984
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
778
985
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
779
986
|
# @param [Hash] opts the optional parameters
|
|
780
987
|
# @return [BankTransactions]
|
|
@@ -786,6 +993,7 @@ describe 'AccountingApi' do
|
|
|
786
993
|
|
|
787
994
|
# unit tests for get_bank_transaction_attachment_by_file_name
|
|
788
995
|
# Allows you to retrieve Attachments on BankTransaction by Filename
|
|
996
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
789
997
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
790
998
|
# @param file_name The name of the file being attached
|
|
791
999
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -799,6 +1007,7 @@ describe 'AccountingApi' do
|
|
|
799
1007
|
|
|
800
1008
|
# unit tests for get_bank_transaction_attachment_by_id
|
|
801
1009
|
# Allows you to retrieve Attachments on a specific BankTransaction
|
|
1010
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
802
1011
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
803
1012
|
# @param attachment_id Xero generated unique identifier for an attachment
|
|
804
1013
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -812,6 +1021,7 @@ describe 'AccountingApi' do
|
|
|
812
1021
|
|
|
813
1022
|
# unit tests for get_bank_transaction_attachments
|
|
814
1023
|
# Allows you to retrieve any attachments to bank transactions
|
|
1024
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
815
1025
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
816
1026
|
# @param [Hash] opts the optional parameters
|
|
817
1027
|
# @return [Attachments]
|
|
@@ -823,11 +1033,13 @@ describe 'AccountingApi' do
|
|
|
823
1033
|
|
|
824
1034
|
# unit tests for get_bank_transactions
|
|
825
1035
|
# Allows you to retrieve any spend or receive money transactions
|
|
1036
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
826
1037
|
# @param [Hash] opts the optional parameters
|
|
827
1038
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
828
1039
|
# @option opts [String] :where Filter by an any element
|
|
829
1040
|
# @option opts [String] :order Order by an any element
|
|
830
1041
|
# @option opts [Integer] :page e.g. page=1 – Up to 100 bank transactions will be returned in a single API call with line items shown for each bank transaction
|
|
1042
|
+
# @option opts [Integer] :unitdp e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
|
|
831
1043
|
# @return [BankTransactions]
|
|
832
1044
|
describe 'get_bank_transactions test' do
|
|
833
1045
|
it 'should work' do
|
|
@@ -837,6 +1049,7 @@ describe 'AccountingApi' do
|
|
|
837
1049
|
|
|
838
1050
|
# unit tests for get_bank_transactions_history
|
|
839
1051
|
# Allows you to retrieve history from a bank transactions
|
|
1052
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
840
1053
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
841
1054
|
# @param [Hash] opts the optional parameters
|
|
842
1055
|
# @return [HistoryRecords]
|
|
@@ -848,6 +1061,7 @@ describe 'AccountingApi' do
|
|
|
848
1061
|
|
|
849
1062
|
# unit tests for get_bank_transfer
|
|
850
1063
|
# Allows you to retrieve any bank transfers
|
|
1064
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
851
1065
|
# @param bank_transfer_id Xero generated unique identifier for a bank transfer
|
|
852
1066
|
# @param [Hash] opts the optional parameters
|
|
853
1067
|
# @return [BankTransfers]
|
|
@@ -859,6 +1073,7 @@ describe 'AccountingApi' do
|
|
|
859
1073
|
|
|
860
1074
|
# unit tests for get_bank_transfer_attachment_by_file_name
|
|
861
1075
|
# Allows you to retrieve Attachments on BankTransfer by file name
|
|
1076
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
862
1077
|
# @param bank_transfer_id Xero generated unique identifier for a bank transfer
|
|
863
1078
|
# @param file_name The name of the file being attached to a Bank Transfer
|
|
864
1079
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -872,6 +1087,7 @@ describe 'AccountingApi' do
|
|
|
872
1087
|
|
|
873
1088
|
# unit tests for get_bank_transfer_attachment_by_id
|
|
874
1089
|
# Allows you to retrieve Attachments on BankTransfer
|
|
1090
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
875
1091
|
# @param bank_transfer_id Xero generated unique identifier for a bank transfer
|
|
876
1092
|
# @param attachment_id Xero generated unique identifier for an Attachment to a bank transfer
|
|
877
1093
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -885,6 +1101,7 @@ describe 'AccountingApi' do
|
|
|
885
1101
|
|
|
886
1102
|
# unit tests for get_bank_transfer_attachments
|
|
887
1103
|
# Allows you to retrieve Attachments from bank transfers
|
|
1104
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
888
1105
|
# @param bank_transfer_id Xero generated unique identifier for a bank transfer
|
|
889
1106
|
# @param [Hash] opts the optional parameters
|
|
890
1107
|
# @return [Attachments]
|
|
@@ -896,6 +1113,7 @@ describe 'AccountingApi' do
|
|
|
896
1113
|
|
|
897
1114
|
# unit tests for get_bank_transfer_history
|
|
898
1115
|
# Allows you to retrieve history from a bank transfers
|
|
1116
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
899
1117
|
# @param bank_transfer_id Xero generated unique identifier for a bank transfer
|
|
900
1118
|
# @param [Hash] opts the optional parameters
|
|
901
1119
|
# @return [HistoryRecords]
|
|
@@ -907,6 +1125,7 @@ describe 'AccountingApi' do
|
|
|
907
1125
|
|
|
908
1126
|
# unit tests for get_bank_transfers
|
|
909
1127
|
# Allows you to retrieve all bank transfers
|
|
1128
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
910
1129
|
# @param [Hash] opts the optional parameters
|
|
911
1130
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
912
1131
|
# @option opts [String] :where Filter by an any element
|
|
@@ -920,6 +1139,7 @@ describe 'AccountingApi' do
|
|
|
920
1139
|
|
|
921
1140
|
# unit tests for get_batch_payment_history
|
|
922
1141
|
# Allows you to retrieve history from a Batch Payment
|
|
1142
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
923
1143
|
# @param batch_payment_id Unique identifier for BatchPayment
|
|
924
1144
|
# @param [Hash] opts the optional parameters
|
|
925
1145
|
# @return [HistoryRecords]
|
|
@@ -931,6 +1151,7 @@ describe 'AccountingApi' do
|
|
|
931
1151
|
|
|
932
1152
|
# unit tests for get_batch_payments
|
|
933
1153
|
# Retrieve either one or many BatchPayments for invoices
|
|
1154
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
934
1155
|
# @param [Hash] opts the optional parameters
|
|
935
1156
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
936
1157
|
# @option opts [String] :where Filter by an any element
|
|
@@ -944,6 +1165,7 @@ describe 'AccountingApi' do
|
|
|
944
1165
|
|
|
945
1166
|
# unit tests for get_branding_theme
|
|
946
1167
|
# Allows you to retrieve a specific BrandingThemes
|
|
1168
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
947
1169
|
# @param branding_theme_id Unique identifier for a Branding Theme
|
|
948
1170
|
# @param [Hash] opts the optional parameters
|
|
949
1171
|
# @return [BrandingThemes]
|
|
@@ -955,6 +1177,7 @@ describe 'AccountingApi' do
|
|
|
955
1177
|
|
|
956
1178
|
# unit tests for get_branding_theme_payment_services
|
|
957
1179
|
# Allows you to retrieve the Payment services for a Branding Theme
|
|
1180
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
958
1181
|
# @param branding_theme_id Unique identifier for a Branding Theme
|
|
959
1182
|
# @param [Hash] opts the optional parameters
|
|
960
1183
|
# @return [PaymentServices]
|
|
@@ -966,6 +1189,7 @@ describe 'AccountingApi' do
|
|
|
966
1189
|
|
|
967
1190
|
# unit tests for get_branding_themes
|
|
968
1191
|
# Allows you to retrieve all the BrandingThemes
|
|
1192
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
969
1193
|
# @param [Hash] opts the optional parameters
|
|
970
1194
|
# @return [BrandingThemes]
|
|
971
1195
|
describe 'get_branding_themes test' do
|
|
@@ -976,6 +1200,7 @@ describe 'AccountingApi' do
|
|
|
976
1200
|
|
|
977
1201
|
# unit tests for get_contact
|
|
978
1202
|
# Allows you to retrieve, add and update contacts in a Xero organisation
|
|
1203
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
979
1204
|
# @param contact_id Unique identifier for a Contact
|
|
980
1205
|
# @param [Hash] opts the optional parameters
|
|
981
1206
|
# @return [Contacts]
|
|
@@ -987,6 +1212,7 @@ describe 'AccountingApi' do
|
|
|
987
1212
|
|
|
988
1213
|
# unit tests for get_contact_attachment_by_file_name
|
|
989
1214
|
# Allows you to retrieve Attachments on Contacts by file name
|
|
1215
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
990
1216
|
# @param contact_id Unique identifier for a Contact
|
|
991
1217
|
# @param file_name Name for the file you are attaching
|
|
992
1218
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1000,6 +1226,7 @@ describe 'AccountingApi' do
|
|
|
1000
1226
|
|
|
1001
1227
|
# unit tests for get_contact_attachment_by_id
|
|
1002
1228
|
# Allows you to retrieve Attachments on Contacts
|
|
1229
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1003
1230
|
# @param contact_id Unique identifier for a Contact
|
|
1004
1231
|
# @param attachment_id Unique identifier for a Attachment
|
|
1005
1232
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1013,6 +1240,7 @@ describe 'AccountingApi' do
|
|
|
1013
1240
|
|
|
1014
1241
|
# unit tests for get_contact_attachments
|
|
1015
1242
|
# Allows you to retrieve, add and update contacts in a Xero organisation
|
|
1243
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1016
1244
|
# @param contact_id Unique identifier for a Contact
|
|
1017
1245
|
# @param [Hash] opts the optional parameters
|
|
1018
1246
|
# @return [Attachments]
|
|
@@ -1024,6 +1252,7 @@ describe 'AccountingApi' do
|
|
|
1024
1252
|
|
|
1025
1253
|
# unit tests for get_contact_cis_settings
|
|
1026
1254
|
# Allows you to retrieve CISSettings for a contact in a Xero organisation
|
|
1255
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1027
1256
|
# @param contact_id Unique identifier for a Contact
|
|
1028
1257
|
# @param [Hash] opts the optional parameters
|
|
1029
1258
|
# @return [CISSettings]
|
|
@@ -1035,6 +1264,7 @@ describe 'AccountingApi' do
|
|
|
1035
1264
|
|
|
1036
1265
|
# unit tests for get_contact_group
|
|
1037
1266
|
# Allows you to retrieve a unique Contract Group by ID
|
|
1267
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1038
1268
|
# @param contact_group_id Unique identifier for a Contact Group
|
|
1039
1269
|
# @param [Hash] opts the optional parameters
|
|
1040
1270
|
# @return [ContactGroups]
|
|
@@ -1046,6 +1276,7 @@ describe 'AccountingApi' do
|
|
|
1046
1276
|
|
|
1047
1277
|
# unit tests for get_contact_groups
|
|
1048
1278
|
# Allows you to retrieve the ContactID and Name of all the contacts in a contact group
|
|
1279
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1049
1280
|
# @param [Hash] opts the optional parameters
|
|
1050
1281
|
# @option opts [String] :where Filter by an any element
|
|
1051
1282
|
# @option opts [String] :order Order by an any element
|
|
@@ -1058,6 +1289,7 @@ describe 'AccountingApi' do
|
|
|
1058
1289
|
|
|
1059
1290
|
# unit tests for get_contact_history
|
|
1060
1291
|
# Allows you to retrieve a history records of an Contact
|
|
1292
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1061
1293
|
# @param contact_id Unique identifier for a Contact
|
|
1062
1294
|
# @param [Hash] opts the optional parameters
|
|
1063
1295
|
# @return [HistoryRecords]
|
|
@@ -1069,13 +1301,14 @@ describe 'AccountingApi' do
|
|
|
1069
1301
|
|
|
1070
1302
|
# unit tests for get_contacts
|
|
1071
1303
|
# Allows you to retrieve, add and update contacts in a Xero organisation
|
|
1304
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1072
1305
|
# @param [Hash] opts the optional parameters
|
|
1073
1306
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1074
1307
|
# @option opts [String] :where Filter by an any element
|
|
1075
1308
|
# @option opts [String] :order Order by an any element
|
|
1076
|
-
# @option opts [String] :i_ds Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
|
|
1309
|
+
# @option opts [Array<String>] :i_ds Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
|
|
1077
1310
|
# @option opts [Integer] :page e.g. page=1 - Up to 100 contacts will be returned in a single API call.
|
|
1078
|
-
# @option opts [
|
|
1311
|
+
# @option opts [Boolean] :include_archived e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
|
|
1079
1312
|
# @return [Contacts]
|
|
1080
1313
|
describe 'get_contacts test' do
|
|
1081
1314
|
it 'should work' do
|
|
@@ -1085,6 +1318,7 @@ describe 'AccountingApi' do
|
|
|
1085
1318
|
|
|
1086
1319
|
# unit tests for get_credit_note
|
|
1087
1320
|
# Allows you to retrieve a specific credit note
|
|
1321
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1088
1322
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
1089
1323
|
# @param [Hash] opts the optional parameters
|
|
1090
1324
|
# @return [CreditNotes]
|
|
@@ -1096,6 +1330,7 @@ describe 'AccountingApi' do
|
|
|
1096
1330
|
|
|
1097
1331
|
# unit tests for get_credit_note_as_pdf
|
|
1098
1332
|
# Allows you to retrieve Credit Note as PDF files
|
|
1333
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1099
1334
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
1100
1335
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
1101
1336
|
# @param [Hash] opts the optional parameters
|
|
@@ -1108,6 +1343,7 @@ describe 'AccountingApi' do
|
|
|
1108
1343
|
|
|
1109
1344
|
# unit tests for get_credit_note_attachment_by_file_name
|
|
1110
1345
|
# Allows you to retrieve Attachments on CreditNote by file name
|
|
1346
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1111
1347
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
1112
1348
|
# @param file_name Name of the file you are attaching to Credit Note
|
|
1113
1349
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1121,6 +1357,7 @@ describe 'AccountingApi' do
|
|
|
1121
1357
|
|
|
1122
1358
|
# unit tests for get_credit_note_attachment_by_id
|
|
1123
1359
|
# Allows you to retrieve Attachments on CreditNote
|
|
1360
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1124
1361
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
1125
1362
|
# @param attachment_id Unique identifier for a Attachment
|
|
1126
1363
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1134,6 +1371,7 @@ describe 'AccountingApi' do
|
|
|
1134
1371
|
|
|
1135
1372
|
# unit tests for get_credit_note_attachments
|
|
1136
1373
|
# Allows you to retrieve Attachments for credit notes
|
|
1374
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1137
1375
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
1138
1376
|
# @param [Hash] opts the optional parameters
|
|
1139
1377
|
# @return [Attachments]
|
|
@@ -1145,6 +1383,7 @@ describe 'AccountingApi' do
|
|
|
1145
1383
|
|
|
1146
1384
|
# unit tests for get_credit_note_history
|
|
1147
1385
|
# Allows you to retrieve a history records of an CreditNote
|
|
1386
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1148
1387
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
1149
1388
|
# @param [Hash] opts the optional parameters
|
|
1150
1389
|
# @return [HistoryRecords]
|
|
@@ -1156,6 +1395,7 @@ describe 'AccountingApi' do
|
|
|
1156
1395
|
|
|
1157
1396
|
# unit tests for get_credit_notes
|
|
1158
1397
|
# Allows you to retrieve any credit notes
|
|
1398
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1159
1399
|
# @param [Hash] opts the optional parameters
|
|
1160
1400
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1161
1401
|
# @option opts [String] :where Filter by an any element
|
|
@@ -1170,6 +1410,7 @@ describe 'AccountingApi' do
|
|
|
1170
1410
|
|
|
1171
1411
|
# unit tests for get_currencies
|
|
1172
1412
|
# Allows you to retrieve currencies for your organisation
|
|
1413
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1173
1414
|
# @param [Hash] opts the optional parameters
|
|
1174
1415
|
# @option opts [String] :where Filter by an any element
|
|
1175
1416
|
# @option opts [String] :order Order by an any element
|
|
@@ -1182,6 +1423,7 @@ describe 'AccountingApi' do
|
|
|
1182
1423
|
|
|
1183
1424
|
# unit tests for get_employee
|
|
1184
1425
|
# Allows you to retrieve a specific employee used in Xero payrun
|
|
1426
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1185
1427
|
# @param employee_id Unique identifier for a Employee
|
|
1186
1428
|
# @param [Hash] opts the optional parameters
|
|
1187
1429
|
# @return [Employees]
|
|
@@ -1193,6 +1435,7 @@ describe 'AccountingApi' do
|
|
|
1193
1435
|
|
|
1194
1436
|
# unit tests for get_employees
|
|
1195
1437
|
# Allows you to retrieve employees used in Xero payrun
|
|
1438
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1196
1439
|
# @param [Hash] opts the optional parameters
|
|
1197
1440
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1198
1441
|
# @option opts [String] :where Filter by an any element
|
|
@@ -1206,6 +1449,7 @@ describe 'AccountingApi' do
|
|
|
1206
1449
|
|
|
1207
1450
|
# unit tests for get_expense_claim
|
|
1208
1451
|
# Allows you to retrieve a specified expense claim
|
|
1452
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1209
1453
|
# @param expense_claim_id Unique identifier for a ExpenseClaim
|
|
1210
1454
|
# @param [Hash] opts the optional parameters
|
|
1211
1455
|
# @return [ExpenseClaims]
|
|
@@ -1217,6 +1461,7 @@ describe 'AccountingApi' do
|
|
|
1217
1461
|
|
|
1218
1462
|
# unit tests for get_expense_claim_history
|
|
1219
1463
|
# Allows you to retrieve a history records of an ExpenseClaim
|
|
1464
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1220
1465
|
# @param expense_claim_id Unique identifier for a ExpenseClaim
|
|
1221
1466
|
# @param [Hash] opts the optional parameters
|
|
1222
1467
|
# @return [HistoryRecords]
|
|
@@ -1228,6 +1473,7 @@ describe 'AccountingApi' do
|
|
|
1228
1473
|
|
|
1229
1474
|
# unit tests for get_expense_claims
|
|
1230
1475
|
# Allows you to retrieve expense claims
|
|
1476
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1231
1477
|
# @param [Hash] opts the optional parameters
|
|
1232
1478
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1233
1479
|
# @option opts [String] :where Filter by an any element
|
|
@@ -1241,6 +1487,7 @@ describe 'AccountingApi' do
|
|
|
1241
1487
|
|
|
1242
1488
|
# unit tests for get_invoice
|
|
1243
1489
|
# Allows you to retrieve a specified sales invoice or purchase bill
|
|
1490
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1244
1491
|
# @param invoice_id Unique identifier for an Invoice
|
|
1245
1492
|
# @param [Hash] opts the optional parameters
|
|
1246
1493
|
# @return [Invoices]
|
|
@@ -1252,6 +1499,7 @@ describe 'AccountingApi' do
|
|
|
1252
1499
|
|
|
1253
1500
|
# unit tests for get_invoice_as_pdf
|
|
1254
1501
|
# Allows you to retrieve invoices or purchase bills as PDF files
|
|
1502
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1255
1503
|
# @param invoice_id Unique identifier for an Invoice
|
|
1256
1504
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
1257
1505
|
# @param [Hash] opts the optional parameters
|
|
@@ -1264,6 +1512,7 @@ describe 'AccountingApi' do
|
|
|
1264
1512
|
|
|
1265
1513
|
# unit tests for get_invoice_attachment_by_file_name
|
|
1266
1514
|
# Allows you to retrieve Attachment on invoices or purchase bills by it's filename
|
|
1515
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1267
1516
|
# @param invoice_id Unique identifier for an Invoice
|
|
1268
1517
|
# @param file_name Name of the file you are attaching
|
|
1269
1518
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1277,6 +1526,7 @@ describe 'AccountingApi' do
|
|
|
1277
1526
|
|
|
1278
1527
|
# unit tests for get_invoice_attachment_by_id
|
|
1279
1528
|
# Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID
|
|
1529
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1280
1530
|
# @param invoice_id Unique identifier for an Invoice
|
|
1281
1531
|
# @param attachment_id Unique identifier for an Attachment
|
|
1282
1532
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1290,6 +1540,7 @@ describe 'AccountingApi' do
|
|
|
1290
1540
|
|
|
1291
1541
|
# unit tests for get_invoice_attachments
|
|
1292
1542
|
# Allows you to retrieve Attachments on invoices or purchase bills
|
|
1543
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1293
1544
|
# @param invoice_id Unique identifier for an Invoice
|
|
1294
1545
|
# @param [Hash] opts the optional parameters
|
|
1295
1546
|
# @return [Attachments]
|
|
@@ -1301,6 +1552,7 @@ describe 'AccountingApi' do
|
|
|
1301
1552
|
|
|
1302
1553
|
# unit tests for get_invoice_history
|
|
1303
1554
|
# Allows you to retrieve a history records of an invoice
|
|
1555
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1304
1556
|
# @param invoice_id Unique identifier for an Invoice
|
|
1305
1557
|
# @param [Hash] opts the optional parameters
|
|
1306
1558
|
# @return [HistoryRecords]
|
|
@@ -1312,6 +1564,7 @@ describe 'AccountingApi' do
|
|
|
1312
1564
|
|
|
1313
1565
|
# unit tests for get_invoice_reminders
|
|
1314
1566
|
# Allows you to retrieve invoice reminder settings
|
|
1567
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1315
1568
|
# @param [Hash] opts the optional parameters
|
|
1316
1569
|
# @return [InvoiceReminders]
|
|
1317
1570
|
describe 'get_invoice_reminders test' do
|
|
@@ -1322,18 +1575,19 @@ describe 'AccountingApi' do
|
|
|
1322
1575
|
|
|
1323
1576
|
# unit tests for get_invoices
|
|
1324
1577
|
# Allows you to retrieve any sales invoices or purchase bills
|
|
1578
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1325
1579
|
# @param [Hash] opts the optional parameters
|
|
1326
|
-
# @option opts [String] :xero_tenant_id Xero identifier for Tenant
|
|
1327
1580
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1328
1581
|
# @option opts [String] :where Filter by an any element
|
|
1329
1582
|
# @option opts [String] :order Order by an any element
|
|
1330
|
-
# @option opts [String] :i_ds Filter by a comma-separated list of InvoicesIDs. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
|
|
1331
|
-
# @option opts [String] :invoice_numbers Filter by a comma-separated list of InvoiceNumbers. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
|
|
1332
|
-
# @option opts [String] :contact_i_ds Filter by a comma-separated list of ContactIDs. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
|
|
1333
|
-
# @option opts [String] :statuses Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
|
|
1583
|
+
# @option opts [Array<String>] :i_ds Filter by a comma-separated list of InvoicesIDs. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
|
|
1584
|
+
# @option opts [Array<String>] :invoice_numbers Filter by a comma-separated list of InvoiceNumbers. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
|
|
1585
|
+
# @option opts [Array<String>] :contact_i_ds Filter by a comma-separated list of ContactIDs. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
|
|
1586
|
+
# @option opts [Array<String>] :statuses Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.
|
|
1334
1587
|
# @option opts [Integer] :page e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice
|
|
1335
|
-
# @option opts [
|
|
1336
|
-
# @option opts [
|
|
1588
|
+
# @option opts [Boolean] :include_archived e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
|
|
1589
|
+
# @option opts [Boolean] :created_by_my_app When set to true you'll only retrieve Invoices created by your app
|
|
1590
|
+
# @option opts [Integer] :unitdp e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
|
|
1337
1591
|
# @return [Invoices]
|
|
1338
1592
|
describe 'get_invoices test' do
|
|
1339
1593
|
it 'should work' do
|
|
@@ -1343,6 +1597,7 @@ describe 'AccountingApi' do
|
|
|
1343
1597
|
|
|
1344
1598
|
# unit tests for get_item
|
|
1345
1599
|
# Allows you to retrieve a specified item
|
|
1600
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1346
1601
|
# @param item_id Unique identifier for an Item
|
|
1347
1602
|
# @param [Hash] opts the optional parameters
|
|
1348
1603
|
# @return [Items]
|
|
@@ -1354,6 +1609,7 @@ describe 'AccountingApi' do
|
|
|
1354
1609
|
|
|
1355
1610
|
# unit tests for get_item_history
|
|
1356
1611
|
# Allows you to retrieve history for items
|
|
1612
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1357
1613
|
# @param item_id Unique identifier for an Item
|
|
1358
1614
|
# @param [Hash] opts the optional parameters
|
|
1359
1615
|
# @return [HistoryRecords]
|
|
@@ -1365,10 +1621,12 @@ describe 'AccountingApi' do
|
|
|
1365
1621
|
|
|
1366
1622
|
# unit tests for get_items
|
|
1367
1623
|
# Allows you to retrieve any items
|
|
1624
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1368
1625
|
# @param [Hash] opts the optional parameters
|
|
1369
1626
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1370
1627
|
# @option opts [String] :where Filter by an any element
|
|
1371
1628
|
# @option opts [String] :order Order by an any element
|
|
1629
|
+
# @option opts [Integer] :unitdp e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
|
|
1372
1630
|
# @return [Items]
|
|
1373
1631
|
describe 'get_items test' do
|
|
1374
1632
|
it 'should work' do
|
|
@@ -1378,6 +1636,7 @@ describe 'AccountingApi' do
|
|
|
1378
1636
|
|
|
1379
1637
|
# unit tests for get_journal
|
|
1380
1638
|
# Allows you to retrieve a specified journals.
|
|
1639
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1381
1640
|
# @param journal_id Unique identifier for a Journal
|
|
1382
1641
|
# @param [Hash] opts the optional parameters
|
|
1383
1642
|
# @return [Journals]
|
|
@@ -1389,10 +1648,11 @@ describe 'AccountingApi' do
|
|
|
1389
1648
|
|
|
1390
1649
|
# unit tests for get_journals
|
|
1391
1650
|
# Allows you to retrieve any journals.
|
|
1651
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1392
1652
|
# @param [Hash] opts the optional parameters
|
|
1393
1653
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1394
1654
|
# @option opts [Integer] :offset Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
|
|
1395
|
-
# @option opts [
|
|
1655
|
+
# @option opts [Boolean] :payments_only Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.
|
|
1396
1656
|
# @return [Journals]
|
|
1397
1657
|
describe 'get_journals test' do
|
|
1398
1658
|
it 'should work' do
|
|
@@ -1402,6 +1662,7 @@ describe 'AccountingApi' do
|
|
|
1402
1662
|
|
|
1403
1663
|
# unit tests for get_linked_transaction
|
|
1404
1664
|
# Allows you to retrieve a specified linked transactions (billable expenses)
|
|
1665
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1405
1666
|
# @param linked_transaction_id Unique identifier for a LinkedTransaction
|
|
1406
1667
|
# @param [Hash] opts the optional parameters
|
|
1407
1668
|
# @return [LinkedTransactions]
|
|
@@ -1413,6 +1674,7 @@ describe 'AccountingApi' do
|
|
|
1413
1674
|
|
|
1414
1675
|
# unit tests for get_linked_transactions
|
|
1415
1676
|
# Retrieve linked transactions (billable expenses)
|
|
1677
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1416
1678
|
# @param [Hash] opts the optional parameters
|
|
1417
1679
|
# @option opts [Integer] :page Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1.
|
|
1418
1680
|
# @option opts [String] :linked_transaction_id The Xero identifier for an Linked Transaction
|
|
@@ -1429,6 +1691,7 @@ describe 'AccountingApi' do
|
|
|
1429
1691
|
|
|
1430
1692
|
# unit tests for get_manual_journal
|
|
1431
1693
|
# Allows you to retrieve a specified manual journals
|
|
1694
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1432
1695
|
# @param manual_journal_id Unique identifier for a ManualJournal
|
|
1433
1696
|
# @param [Hash] opts the optional parameters
|
|
1434
1697
|
# @return [ManualJournals]
|
|
@@ -1440,6 +1703,7 @@ describe 'AccountingApi' do
|
|
|
1440
1703
|
|
|
1441
1704
|
# unit tests for get_manual_journal_attachment_by_file_name
|
|
1442
1705
|
# Allows you to retrieve specified Attachment on ManualJournal by file name
|
|
1706
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1443
1707
|
# @param manual_journal_id Unique identifier for a ManualJournal
|
|
1444
1708
|
# @param file_name The name of the file being attached to a ManualJournal
|
|
1445
1709
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1453,6 +1717,7 @@ describe 'AccountingApi' do
|
|
|
1453
1717
|
|
|
1454
1718
|
# unit tests for get_manual_journal_attachment_by_id
|
|
1455
1719
|
# Allows you to retrieve specified Attachment on ManualJournals
|
|
1720
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1456
1721
|
# @param manual_journal_id Unique identifier for a ManualJournal
|
|
1457
1722
|
# @param attachment_id Unique identifier for a Attachment
|
|
1458
1723
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1466,6 +1731,7 @@ describe 'AccountingApi' do
|
|
|
1466
1731
|
|
|
1467
1732
|
# unit tests for get_manual_journal_attachments
|
|
1468
1733
|
# Allows you to retrieve Attachment for manual journals
|
|
1734
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1469
1735
|
# @param manual_journal_id Unique identifier for a ManualJournal
|
|
1470
1736
|
# @param [Hash] opts the optional parameters
|
|
1471
1737
|
# @return [Attachments]
|
|
@@ -1477,6 +1743,7 @@ describe 'AccountingApi' do
|
|
|
1477
1743
|
|
|
1478
1744
|
# unit tests for get_manual_journals
|
|
1479
1745
|
# Allows you to retrieve any manual journals
|
|
1746
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1480
1747
|
# @param [Hash] opts the optional parameters
|
|
1481
1748
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1482
1749
|
# @option opts [String] :where Filter by an any element
|
|
@@ -1491,6 +1758,7 @@ describe 'AccountingApi' do
|
|
|
1491
1758
|
|
|
1492
1759
|
# unit tests for get_online_invoice
|
|
1493
1760
|
# Allows you to retrieve a URL to an online invoice
|
|
1761
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1494
1762
|
# @param invoice_id Unique identifier for an Invoice
|
|
1495
1763
|
# @param [Hash] opts the optional parameters
|
|
1496
1764
|
# @return [OnlineInvoices]
|
|
@@ -1502,6 +1770,7 @@ describe 'AccountingApi' do
|
|
|
1502
1770
|
|
|
1503
1771
|
# unit tests for get_organisation_cis_settings
|
|
1504
1772
|
# Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion.
|
|
1773
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1505
1774
|
# @param organisation_id
|
|
1506
1775
|
# @param [Hash] opts the optional parameters
|
|
1507
1776
|
# @return [CISOrgSetting]
|
|
@@ -1513,6 +1782,7 @@ describe 'AccountingApi' do
|
|
|
1513
1782
|
|
|
1514
1783
|
# unit tests for get_organisations
|
|
1515
1784
|
# Allows you to retrieve Organisation details
|
|
1785
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1516
1786
|
# @param [Hash] opts the optional parameters
|
|
1517
1787
|
# @return [Organisations]
|
|
1518
1788
|
describe 'get_organisations test' do
|
|
@@ -1523,6 +1793,7 @@ describe 'AccountingApi' do
|
|
|
1523
1793
|
|
|
1524
1794
|
# unit tests for get_overpayment
|
|
1525
1795
|
# Allows you to retrieve a specified overpayments
|
|
1796
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1526
1797
|
# @param overpayment_id Unique identifier for a Overpayment
|
|
1527
1798
|
# @param [Hash] opts the optional parameters
|
|
1528
1799
|
# @return [Overpayments]
|
|
@@ -1534,6 +1805,7 @@ describe 'AccountingApi' do
|
|
|
1534
1805
|
|
|
1535
1806
|
# unit tests for get_overpayment_history
|
|
1536
1807
|
# Allows you to retrieve a history records of an Overpayment
|
|
1808
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1537
1809
|
# @param overpayment_id Unique identifier for a Overpayment
|
|
1538
1810
|
# @param [Hash] opts the optional parameters
|
|
1539
1811
|
# @return [HistoryRecords]
|
|
@@ -1545,11 +1817,13 @@ describe 'AccountingApi' do
|
|
|
1545
1817
|
|
|
1546
1818
|
# unit tests for get_overpayments
|
|
1547
1819
|
# Allows you to retrieve overpayments
|
|
1820
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1548
1821
|
# @param [Hash] opts the optional parameters
|
|
1549
1822
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1550
1823
|
# @option opts [String] :where Filter by an any element
|
|
1551
1824
|
# @option opts [String] :order Order by an any element
|
|
1552
1825
|
# @option opts [Integer] :page e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
|
|
1826
|
+
# @option opts [Integer] :unitdp e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
|
|
1553
1827
|
# @return [Overpayments]
|
|
1554
1828
|
describe 'get_overpayments test' do
|
|
1555
1829
|
it 'should work' do
|
|
@@ -1559,6 +1833,7 @@ describe 'AccountingApi' do
|
|
|
1559
1833
|
|
|
1560
1834
|
# unit tests for get_payment
|
|
1561
1835
|
# Allows you to retrieve a specified payment for invoices and credit notes
|
|
1836
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1562
1837
|
# @param payment_id Unique identifier for a Payment
|
|
1563
1838
|
# @param [Hash] opts the optional parameters
|
|
1564
1839
|
# @return [Payments]
|
|
@@ -1570,6 +1845,7 @@ describe 'AccountingApi' do
|
|
|
1570
1845
|
|
|
1571
1846
|
# unit tests for get_payment_history
|
|
1572
1847
|
# Allows you to retrieve history records of a payment
|
|
1848
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1573
1849
|
# @param payment_id Unique identifier for a Payment
|
|
1574
1850
|
# @param [Hash] opts the optional parameters
|
|
1575
1851
|
# @return [HistoryRecords]
|
|
@@ -1581,6 +1857,7 @@ describe 'AccountingApi' do
|
|
|
1581
1857
|
|
|
1582
1858
|
# unit tests for get_payment_services
|
|
1583
1859
|
# Allows you to retrieve payment services
|
|
1860
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1584
1861
|
# @param [Hash] opts the optional parameters
|
|
1585
1862
|
# @return [PaymentServices]
|
|
1586
1863
|
describe 'get_payment_services test' do
|
|
@@ -1591,6 +1868,7 @@ describe 'AccountingApi' do
|
|
|
1591
1868
|
|
|
1592
1869
|
# unit tests for get_payments
|
|
1593
1870
|
# Allows you to retrieve payments for invoices and credit notes
|
|
1871
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1594
1872
|
# @param [Hash] opts the optional parameters
|
|
1595
1873
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1596
1874
|
# @option opts [String] :where Filter by an any element
|
|
@@ -1604,6 +1882,7 @@ describe 'AccountingApi' do
|
|
|
1604
1882
|
|
|
1605
1883
|
# unit tests for get_prepayment
|
|
1606
1884
|
# Allows you to retrieve a specified prepayments
|
|
1885
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1607
1886
|
# @param prepayment_id Unique identifier for a PrePayment
|
|
1608
1887
|
# @param [Hash] opts the optional parameters
|
|
1609
1888
|
# @return [Prepayments]
|
|
@@ -1615,6 +1894,7 @@ describe 'AccountingApi' do
|
|
|
1615
1894
|
|
|
1616
1895
|
# unit tests for get_prepayment_history
|
|
1617
1896
|
# Allows you to retrieve a history records of an Prepayment
|
|
1897
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1618
1898
|
# @param prepayment_id Unique identifier for a PrePayment
|
|
1619
1899
|
# @param [Hash] opts the optional parameters
|
|
1620
1900
|
# @return [HistoryRecords]
|
|
@@ -1626,11 +1906,13 @@ describe 'AccountingApi' do
|
|
|
1626
1906
|
|
|
1627
1907
|
# unit tests for get_prepayments
|
|
1628
1908
|
# Allows you to retrieve prepayments
|
|
1909
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1629
1910
|
# @param [Hash] opts the optional parameters
|
|
1630
1911
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1631
1912
|
# @option opts [String] :where Filter by an any element
|
|
1632
1913
|
# @option opts [String] :order Order by an any element
|
|
1633
1914
|
# @option opts [Integer] :page e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
|
|
1915
|
+
# @option opts [Integer] :unitdp e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
|
|
1634
1916
|
# @return [Prepayments]
|
|
1635
1917
|
describe 'get_prepayments test' do
|
|
1636
1918
|
it 'should work' do
|
|
@@ -1640,6 +1922,7 @@ describe 'AccountingApi' do
|
|
|
1640
1922
|
|
|
1641
1923
|
# unit tests for get_purchase_order
|
|
1642
1924
|
# Allows you to retrieve a specified purchase orders
|
|
1925
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1643
1926
|
# @param purchase_order_id Unique identifier for a PurchaseOrder
|
|
1644
1927
|
# @param [Hash] opts the optional parameters
|
|
1645
1928
|
# @return [PurchaseOrders]
|
|
@@ -1651,6 +1934,7 @@ describe 'AccountingApi' do
|
|
|
1651
1934
|
|
|
1652
1935
|
# unit tests for get_purchase_order_history
|
|
1653
1936
|
# Allows you to retrieve history for PurchaseOrder
|
|
1937
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1654
1938
|
# @param purchase_order_id Unique identifier for a PurchaseOrder
|
|
1655
1939
|
# @param [Hash] opts the optional parameters
|
|
1656
1940
|
# @return [HistoryRecords]
|
|
@@ -1662,6 +1946,7 @@ describe 'AccountingApi' do
|
|
|
1662
1946
|
|
|
1663
1947
|
# unit tests for get_purchase_orders
|
|
1664
1948
|
# Allows you to retrieve purchase orders
|
|
1949
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1665
1950
|
# @param [Hash] opts the optional parameters
|
|
1666
1951
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1667
1952
|
# @option opts [String] :status Filter by purchase order status
|
|
@@ -1678,6 +1963,7 @@ describe 'AccountingApi' do
|
|
|
1678
1963
|
|
|
1679
1964
|
# unit tests for get_receipt
|
|
1680
1965
|
# Allows you to retrieve a specified draft expense claim receipts
|
|
1966
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1681
1967
|
# @param receipt_id Unique identifier for a Receipt
|
|
1682
1968
|
# @param [Hash] opts the optional parameters
|
|
1683
1969
|
# @return [Receipts]
|
|
@@ -1689,6 +1975,7 @@ describe 'AccountingApi' do
|
|
|
1689
1975
|
|
|
1690
1976
|
# unit tests for get_receipt_attachment_by_file_name
|
|
1691
1977
|
# Allows you to retrieve Attachments on expense claim receipts by file name
|
|
1978
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1692
1979
|
# @param receipt_id Unique identifier for a Receipt
|
|
1693
1980
|
# @param file_name The name of the file being attached to the Receipt
|
|
1694
1981
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1702,6 +1989,7 @@ describe 'AccountingApi' do
|
|
|
1702
1989
|
|
|
1703
1990
|
# unit tests for get_receipt_attachment_by_id
|
|
1704
1991
|
# Allows you to retrieve Attachments on expense claim receipts by ID
|
|
1992
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1705
1993
|
# @param receipt_id Unique identifier for a Receipt
|
|
1706
1994
|
# @param attachment_id Unique identifier for a Attachment
|
|
1707
1995
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1715,6 +2003,7 @@ describe 'AccountingApi' do
|
|
|
1715
2003
|
|
|
1716
2004
|
# unit tests for get_receipt_attachments
|
|
1717
2005
|
# Allows you to retrieve Attachments for expense claim receipts
|
|
2006
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1718
2007
|
# @param receipt_id Unique identifier for a Receipt
|
|
1719
2008
|
# @param [Hash] opts the optional parameters
|
|
1720
2009
|
# @return [Attachments]
|
|
@@ -1726,6 +2015,7 @@ describe 'AccountingApi' do
|
|
|
1726
2015
|
|
|
1727
2016
|
# unit tests for get_receipt_history
|
|
1728
2017
|
# Allows you to retrieve a history records of an Receipt
|
|
2018
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1729
2019
|
# @param receipt_id Unique identifier for a Receipt
|
|
1730
2020
|
# @param [Hash] opts the optional parameters
|
|
1731
2021
|
# @return [HistoryRecords]
|
|
@@ -1737,10 +2027,12 @@ describe 'AccountingApi' do
|
|
|
1737
2027
|
|
|
1738
2028
|
# unit tests for get_receipts
|
|
1739
2029
|
# Allows you to retrieve draft expense claim receipts for any user
|
|
2030
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1740
2031
|
# @param [Hash] opts the optional parameters
|
|
1741
2032
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
1742
2033
|
# @option opts [String] :where Filter by an any element
|
|
1743
2034
|
# @option opts [String] :order Order by an any element
|
|
2035
|
+
# @option opts [Integer] :unitdp e.g. unitdp=4 – You can opt in to use four decimal places for unit amounts
|
|
1744
2036
|
# @return [Receipts]
|
|
1745
2037
|
describe 'get_receipts test' do
|
|
1746
2038
|
it 'should work' do
|
|
@@ -1750,6 +2042,7 @@ describe 'AccountingApi' do
|
|
|
1750
2042
|
|
|
1751
2043
|
# unit tests for get_repeating_invoice
|
|
1752
2044
|
# Allows you to retrieve a specified repeating invoice
|
|
2045
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1753
2046
|
# @param repeating_invoice_id Unique identifier for a Repeating Invoice
|
|
1754
2047
|
# @param [Hash] opts the optional parameters
|
|
1755
2048
|
# @return [RepeatingInvoices]
|
|
@@ -1761,6 +2054,7 @@ describe 'AccountingApi' do
|
|
|
1761
2054
|
|
|
1762
2055
|
# unit tests for get_repeating_invoice_attachment_by_file_name
|
|
1763
2056
|
# Allows you to retrieve specified attachment on repeating invoices by file name
|
|
2057
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1764
2058
|
# @param repeating_invoice_id Unique identifier for a Repeating Invoice
|
|
1765
2059
|
# @param file_name The name of the file being attached to a Repeating Invoice
|
|
1766
2060
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1774,6 +2068,7 @@ describe 'AccountingApi' do
|
|
|
1774
2068
|
|
|
1775
2069
|
# unit tests for get_repeating_invoice_attachment_by_id
|
|
1776
2070
|
# Allows you to retrieve a specified Attachments on repeating invoices
|
|
2071
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1777
2072
|
# @param repeating_invoice_id Unique identifier for a Repeating Invoice
|
|
1778
2073
|
# @param attachment_id Unique identifier for a Attachment
|
|
1779
2074
|
# @param content_type The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf
|
|
@@ -1787,6 +2082,7 @@ describe 'AccountingApi' do
|
|
|
1787
2082
|
|
|
1788
2083
|
# unit tests for get_repeating_invoice_attachments
|
|
1789
2084
|
# Allows you to retrieve Attachments on repeating invoice
|
|
2085
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1790
2086
|
# @param repeating_invoice_id Unique identifier for a Repeating Invoice
|
|
1791
2087
|
# @param [Hash] opts the optional parameters
|
|
1792
2088
|
# @return [Attachments]
|
|
@@ -1798,6 +2094,7 @@ describe 'AccountingApi' do
|
|
|
1798
2094
|
|
|
1799
2095
|
# unit tests for get_repeating_invoice_history
|
|
1800
2096
|
# Allows you to retrieve history for a repeating invoice
|
|
2097
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1801
2098
|
# @param repeating_invoice_id Unique identifier for a Repeating Invoice
|
|
1802
2099
|
# @param [Hash] opts the optional parameters
|
|
1803
2100
|
# @return [HistoryRecords]
|
|
@@ -1809,6 +2106,7 @@ describe 'AccountingApi' do
|
|
|
1809
2106
|
|
|
1810
2107
|
# unit tests for get_repeating_invoices
|
|
1811
2108
|
# Allows you to retrieve any repeating invoices
|
|
2109
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1812
2110
|
# @param [Hash] opts the optional parameters
|
|
1813
2111
|
# @option opts [String] :where Filter by an any element
|
|
1814
2112
|
# @option opts [String] :order Order by an any element
|
|
@@ -1821,6 +2119,7 @@ describe 'AccountingApi' do
|
|
|
1821
2119
|
|
|
1822
2120
|
# unit tests for get_report_aged_payables_by_contact
|
|
1823
2121
|
# Allows you to retrieve report for AgedPayablesByContact
|
|
2122
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1824
2123
|
# @param contact_id Unique identifier for a Contact
|
|
1825
2124
|
# @param [Hash] opts the optional parameters
|
|
1826
2125
|
# @option opts [Date] :date The date of the Aged Payables By Contact report
|
|
@@ -1835,11 +2134,12 @@ describe 'AccountingApi' do
|
|
|
1835
2134
|
|
|
1836
2135
|
# unit tests for get_report_aged_receivables_by_contact
|
|
1837
2136
|
# Allows you to retrieve report for AgedReceivablesByContact
|
|
2137
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1838
2138
|
# @param contact_id Unique identifier for a Contact
|
|
1839
2139
|
# @param [Hash] opts the optional parameters
|
|
1840
|
-
# @option opts [
|
|
1841
|
-
# @option opts [
|
|
1842
|
-
# @option opts [
|
|
2140
|
+
# @option opts [Date] :date The date of the Aged Receivables By Contact report
|
|
2141
|
+
# @option opts [Date] :from_date The from date of the Aged Receivables By Contact report
|
|
2142
|
+
# @option opts [Date] :to_date The to date of the Aged Receivables By Contact report
|
|
1843
2143
|
# @return [ReportWithRows]
|
|
1844
2144
|
describe 'get_report_aged_receivables_by_contact test' do
|
|
1845
2145
|
it 'should work' do
|
|
@@ -1849,6 +2149,7 @@ describe 'AccountingApi' do
|
|
|
1849
2149
|
|
|
1850
2150
|
# unit tests for get_report_ba_sor_gst
|
|
1851
2151
|
# Allows you to retrieve report for BAS only valid for AU orgs
|
|
2152
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1852
2153
|
# @param report_id Unique identifier for a Report
|
|
1853
2154
|
# @param [Hash] opts the optional parameters
|
|
1854
2155
|
# @return [ReportWithRows]
|
|
@@ -1860,6 +2161,7 @@ describe 'AccountingApi' do
|
|
|
1860
2161
|
|
|
1861
2162
|
# unit tests for get_report_ba_sor_gst_list
|
|
1862
2163
|
# Allows you to retrieve report for BAS only valid for AU orgs
|
|
2164
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1863
2165
|
# @param [Hash] opts the optional parameters
|
|
1864
2166
|
# @return [ReportWithRows]
|
|
1865
2167
|
describe 'get_report_ba_sor_gst_list test' do
|
|
@@ -1870,14 +2172,15 @@ describe 'AccountingApi' do
|
|
|
1870
2172
|
|
|
1871
2173
|
# unit tests for get_report_balance_sheet
|
|
1872
2174
|
# Allows you to retrieve report for BalanceSheet
|
|
2175
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1873
2176
|
# @param [Hash] opts the optional parameters
|
|
1874
2177
|
# @option opts [String] :date The date of the Balance Sheet report
|
|
1875
2178
|
# @option opts [Integer] :periods The number of periods for the Balance Sheet report
|
|
1876
2179
|
# @option opts [String] :timeframe The period size to compare to (MONTH, QUARTER, YEAR)
|
|
1877
2180
|
# @option opts [String] :tracking_option_id1 The tracking option 1 for the Balance Sheet report
|
|
1878
2181
|
# @option opts [String] :tracking_option_id2 The tracking option 2 for the Balance Sheet report
|
|
1879
|
-
# @option opts [
|
|
1880
|
-
# @option opts [
|
|
2182
|
+
# @option opts [Boolean] :standard_layout The standard layout boolean for the Balance Sheet report
|
|
2183
|
+
# @option opts [Boolean] :payments_only return a cash basis for the Balance Sheet report
|
|
1881
2184
|
# @return [ReportWithRows]
|
|
1882
2185
|
describe 'get_report_balance_sheet test' do
|
|
1883
2186
|
it 'should work' do
|
|
@@ -1887,8 +2190,9 @@ describe 'AccountingApi' do
|
|
|
1887
2190
|
|
|
1888
2191
|
# unit tests for get_report_bank_summary
|
|
1889
2192
|
# Allows you to retrieve report for BankSummary
|
|
2193
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1890
2194
|
# @param [Hash] opts the optional parameters
|
|
1891
|
-
# @option opts [
|
|
2195
|
+
# @option opts [Date] :date The date for the Bank Summary report e.g. 2018-03-31
|
|
1892
2196
|
# @option opts [Integer] :period The number of periods to compare (integer between 1 and 12)
|
|
1893
2197
|
# @option opts [Integer] :timeframe The period size to compare to (1=month, 3=quarter, 12=year)
|
|
1894
2198
|
# @return [ReportWithRows]
|
|
@@ -1900,8 +2204,9 @@ describe 'AccountingApi' do
|
|
|
1900
2204
|
|
|
1901
2205
|
# unit tests for get_report_budget_summary
|
|
1902
2206
|
# Allows you to retrieve report for Budget Summary
|
|
2207
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1903
2208
|
# @param [Hash] opts the optional parameters
|
|
1904
|
-
# @option opts [
|
|
2209
|
+
# @option opts [Date] :date The date for the Bank Summary report e.g. 2018-03-31
|
|
1905
2210
|
# @option opts [Integer] :period The number of periods to compare (integer between 1 and 12)
|
|
1906
2211
|
# @option opts [Integer] :timeframe The period size to compare to (1=month, 3=quarter, 12=year)
|
|
1907
2212
|
# @return [ReportWithRows]
|
|
@@ -1913,8 +2218,9 @@ describe 'AccountingApi' do
|
|
|
1913
2218
|
|
|
1914
2219
|
# unit tests for get_report_executive_summary
|
|
1915
2220
|
# Allows you to retrieve report for ExecutiveSummary
|
|
2221
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1916
2222
|
# @param [Hash] opts the optional parameters
|
|
1917
|
-
# @option opts [
|
|
2223
|
+
# @option opts [Date] :date The date for the Bank Summary report e.g. 2018-03-31
|
|
1918
2224
|
# @return [ReportWithRows]
|
|
1919
2225
|
describe 'get_report_executive_summary test' do
|
|
1920
2226
|
it 'should work' do
|
|
@@ -1924,17 +2230,18 @@ describe 'AccountingApi' do
|
|
|
1924
2230
|
|
|
1925
2231
|
# unit tests for get_report_profit_and_loss
|
|
1926
2232
|
# Allows you to retrieve report for ProfitAndLoss
|
|
2233
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1927
2234
|
# @param [Hash] opts the optional parameters
|
|
1928
|
-
# @option opts [
|
|
1929
|
-
# @option opts [
|
|
2235
|
+
# @option opts [Date] :from_date The from date for the ProfitAndLoss report e.g. 2018-03-31
|
|
2236
|
+
# @option opts [Date] :to_date The to date for the ProfitAndLoss report e.g. 2018-03-31
|
|
1930
2237
|
# @option opts [Integer] :periods The number of periods to compare (integer between 1 and 12)
|
|
1931
2238
|
# @option opts [String] :timeframe The period size to compare to (MONTH, QUARTER, YEAR)
|
|
1932
2239
|
# @option opts [String] :tracking_category_id The trackingCategory 1 for the ProfitAndLoss report
|
|
1933
2240
|
# @option opts [String] :tracking_category_id2 The trackingCategory 2 for the ProfitAndLoss report
|
|
1934
2241
|
# @option opts [String] :tracking_option_id The tracking option 1 for the ProfitAndLoss report
|
|
1935
2242
|
# @option opts [String] :tracking_option_id2 The tracking option 2 for the ProfitAndLoss report
|
|
1936
|
-
# @option opts [
|
|
1937
|
-
# @option opts [
|
|
2243
|
+
# @option opts [Boolean] :standard_layout Return the standard layout for the ProfitAndLoss report
|
|
2244
|
+
# @option opts [Boolean] :payments_only Return cash only basis for the ProfitAndLoss report
|
|
1938
2245
|
# @return [ReportWithRows]
|
|
1939
2246
|
describe 'get_report_profit_and_loss test' do
|
|
1940
2247
|
it 'should work' do
|
|
@@ -1944,6 +2251,7 @@ describe 'AccountingApi' do
|
|
|
1944
2251
|
|
|
1945
2252
|
# unit tests for get_report_ten_ninety_nine
|
|
1946
2253
|
# Allows you to retrieve report for TenNinetyNine
|
|
2254
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1947
2255
|
# @param [Hash] opts the optional parameters
|
|
1948
2256
|
# @option opts [String] :report_year The year of the 1099 report
|
|
1949
2257
|
# @return [Reports]
|
|
@@ -1955,9 +2263,10 @@ describe 'AccountingApi' do
|
|
|
1955
2263
|
|
|
1956
2264
|
# unit tests for get_report_trial_balance
|
|
1957
2265
|
# Allows you to retrieve report for TrialBalance
|
|
2266
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1958
2267
|
# @param [Hash] opts the optional parameters
|
|
1959
|
-
# @option opts [
|
|
1960
|
-
# @option opts [
|
|
2268
|
+
# @option opts [Date] :date The date for the Trial Balance report e.g. 2018-03-31
|
|
2269
|
+
# @option opts [Boolean] :payments_only Return cash only basis for the Trial Balance report
|
|
1961
2270
|
# @return [ReportWithRows]
|
|
1962
2271
|
describe 'get_report_trial_balance test' do
|
|
1963
2272
|
it 'should work' do
|
|
@@ -1967,6 +2276,7 @@ describe 'AccountingApi' do
|
|
|
1967
2276
|
|
|
1968
2277
|
# unit tests for get_tax_rates
|
|
1969
2278
|
# Allows you to retrieve Tax Rates
|
|
2279
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1970
2280
|
# @param [Hash] opts the optional parameters
|
|
1971
2281
|
# @option opts [String] :where Filter by an any element
|
|
1972
2282
|
# @option opts [String] :order Order by an any element
|
|
@@ -1980,10 +2290,11 @@ describe 'AccountingApi' do
|
|
|
1980
2290
|
|
|
1981
2291
|
# unit tests for get_tracking_categories
|
|
1982
2292
|
# Allows you to retrieve tracking categories and options
|
|
2293
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1983
2294
|
# @param [Hash] opts the optional parameters
|
|
1984
2295
|
# @option opts [String] :where Filter by an any element
|
|
1985
2296
|
# @option opts [String] :order Order by an any element
|
|
1986
|
-
# @option opts [
|
|
2297
|
+
# @option opts [Boolean] :include_archived e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response
|
|
1987
2298
|
# @return [TrackingCategories]
|
|
1988
2299
|
describe 'get_tracking_categories test' do
|
|
1989
2300
|
it 'should work' do
|
|
@@ -1993,6 +2304,7 @@ describe 'AccountingApi' do
|
|
|
1993
2304
|
|
|
1994
2305
|
# unit tests for get_tracking_category
|
|
1995
2306
|
# Allows you to retrieve tracking categories and options for specified category
|
|
2307
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
1996
2308
|
# @param tracking_category_id Unique identifier for a TrackingCategory
|
|
1997
2309
|
# @param [Hash] opts the optional parameters
|
|
1998
2310
|
# @return [TrackingCategories]
|
|
@@ -2004,6 +2316,7 @@ describe 'AccountingApi' do
|
|
|
2004
2316
|
|
|
2005
2317
|
# unit tests for get_user
|
|
2006
2318
|
# Allows you to retrieve a specified user
|
|
2319
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2007
2320
|
# @param user_id Unique identifier for a User
|
|
2008
2321
|
# @param [Hash] opts the optional parameters
|
|
2009
2322
|
# @return [Users]
|
|
@@ -2015,6 +2328,7 @@ describe 'AccountingApi' do
|
|
|
2015
2328
|
|
|
2016
2329
|
# unit tests for get_users
|
|
2017
2330
|
# Allows you to retrieve users
|
|
2331
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2018
2332
|
# @param [Hash] opts the optional parameters
|
|
2019
2333
|
# @option opts [DateTime] :if_modified_since Only records created or modified since this timestamp will be returned
|
|
2020
2334
|
# @option opts [String] :where Filter by an any element
|
|
@@ -2028,6 +2342,7 @@ describe 'AccountingApi' do
|
|
|
2028
2342
|
|
|
2029
2343
|
# unit tests for update_account
|
|
2030
2344
|
# Allows you to update a chart of accounts
|
|
2345
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2031
2346
|
# @param account_id Unique identifier for retrieving single object
|
|
2032
2347
|
# @param accounts Request of type Accounts array with one Account
|
|
2033
2348
|
# @param [Hash] opts the optional parameters
|
|
@@ -2040,6 +2355,7 @@ describe 'AccountingApi' do
|
|
|
2040
2355
|
|
|
2041
2356
|
# unit tests for update_account_attachment_by_file_name
|
|
2042
2357
|
# Allows you to update Attachment on Account by Filename
|
|
2358
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2043
2359
|
# @param account_id Unique identifier for Account object
|
|
2044
2360
|
# @param file_name Name of the attachment
|
|
2045
2361
|
# @param body Byte array of file in body of request
|
|
@@ -2053,6 +2369,7 @@ describe 'AccountingApi' do
|
|
|
2053
2369
|
|
|
2054
2370
|
# unit tests for update_bank_transaction
|
|
2055
2371
|
# Allows you to update a single spend or receive money transaction
|
|
2372
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2056
2373
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
2057
2374
|
# @param bank_transactions
|
|
2058
2375
|
# @param [Hash] opts the optional parameters
|
|
@@ -2065,6 +2382,7 @@ describe 'AccountingApi' do
|
|
|
2065
2382
|
|
|
2066
2383
|
# unit tests for update_bank_transaction_attachment_by_file_name
|
|
2067
2384
|
# Allows you to update an Attachment on BankTransaction by Filename
|
|
2385
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2068
2386
|
# @param bank_transaction_id Xero generated unique identifier for a bank transaction
|
|
2069
2387
|
# @param file_name The name of the file being attached
|
|
2070
2388
|
# @param body Byte array of file in body of request
|
|
@@ -2077,6 +2395,7 @@ describe 'AccountingApi' do
|
|
|
2077
2395
|
end
|
|
2078
2396
|
|
|
2079
2397
|
# unit tests for update_bank_transfer_attachment_by_file_name
|
|
2398
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2080
2399
|
# @param bank_transfer_id Xero generated unique identifier for a bank transfer
|
|
2081
2400
|
# @param file_name The name of the file being attached to a Bank Transfer
|
|
2082
2401
|
# @param body Byte array of file in body of request
|
|
@@ -2089,9 +2408,10 @@ describe 'AccountingApi' do
|
|
|
2089
2408
|
end
|
|
2090
2409
|
|
|
2091
2410
|
# unit tests for update_contact
|
|
2411
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2092
2412
|
# @param contact_id Unique identifier for a Contact
|
|
2413
|
+
# @param contacts an array of Contacts containing single Contact object with properties to update
|
|
2093
2414
|
# @param [Hash] opts the optional parameters
|
|
2094
|
-
# @option opts [Contacts] :contacts
|
|
2095
2415
|
# @return [Contacts]
|
|
2096
2416
|
describe 'update_contact test' do
|
|
2097
2417
|
it 'should work' do
|
|
@@ -2100,6 +2420,7 @@ describe 'AccountingApi' do
|
|
|
2100
2420
|
end
|
|
2101
2421
|
|
|
2102
2422
|
# unit tests for update_contact_attachment_by_file_name
|
|
2423
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2103
2424
|
# @param contact_id Unique identifier for a Contact
|
|
2104
2425
|
# @param file_name Name for the file you are attaching
|
|
2105
2426
|
# @param body Byte array of file in body of request
|
|
@@ -2113,9 +2434,10 @@ describe 'AccountingApi' do
|
|
|
2113
2434
|
|
|
2114
2435
|
# unit tests for update_contact_group
|
|
2115
2436
|
# Allows you to update a Contract Group
|
|
2437
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2116
2438
|
# @param contact_group_id Unique identifier for a Contact Group
|
|
2439
|
+
# @param contact_groups an array of Contact groups with Name of specific group to update
|
|
2117
2440
|
# @param [Hash] opts the optional parameters
|
|
2118
|
-
# @option opts [ContactGroups] :contact_groups
|
|
2119
2441
|
# @return [ContactGroups]
|
|
2120
2442
|
describe 'update_contact_group test' do
|
|
2121
2443
|
it 'should work' do
|
|
@@ -2125,9 +2447,10 @@ describe 'AccountingApi' do
|
|
|
2125
2447
|
|
|
2126
2448
|
# unit tests for update_credit_note
|
|
2127
2449
|
# Allows you to update a specific credit note
|
|
2450
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2128
2451
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
2452
|
+
# @param credit_notes an array of Credit Notes containing credit note details to update
|
|
2129
2453
|
# @param [Hash] opts the optional parameters
|
|
2130
|
-
# @option opts [CreditNotes] :credit_notes
|
|
2131
2454
|
# @return [CreditNotes]
|
|
2132
2455
|
describe 'update_credit_note test' do
|
|
2133
2456
|
it 'should work' do
|
|
@@ -2137,6 +2460,7 @@ describe 'AccountingApi' do
|
|
|
2137
2460
|
|
|
2138
2461
|
# unit tests for update_credit_note_attachment_by_file_name
|
|
2139
2462
|
# Allows you to update Attachments on CreditNote by file name
|
|
2463
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2140
2464
|
# @param credit_note_id Unique identifier for a Credit Note
|
|
2141
2465
|
# @param file_name Name of the file you are attaching to Credit Note
|
|
2142
2466
|
# @param body Byte array of file in body of request
|
|
@@ -2150,6 +2474,7 @@ describe 'AccountingApi' do
|
|
|
2150
2474
|
|
|
2151
2475
|
# unit tests for update_employee
|
|
2152
2476
|
# Allows you to update a specific employee used in Xero payrun
|
|
2477
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2153
2478
|
# @param employee_id Unique identifier for a Employee
|
|
2154
2479
|
# @param employees
|
|
2155
2480
|
# @param [Hash] opts the optional parameters
|
|
@@ -2162,6 +2487,7 @@ describe 'AccountingApi' do
|
|
|
2162
2487
|
|
|
2163
2488
|
# unit tests for update_expense_claim
|
|
2164
2489
|
# Allows you to update specified expense claims
|
|
2490
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2165
2491
|
# @param expense_claim_id Unique identifier for a ExpenseClaim
|
|
2166
2492
|
# @param expense_claims
|
|
2167
2493
|
# @param [Hash] opts the optional parameters
|
|
@@ -2174,6 +2500,7 @@ describe 'AccountingApi' do
|
|
|
2174
2500
|
|
|
2175
2501
|
# unit tests for update_invoice
|
|
2176
2502
|
# Allows you to update a specified sales invoices or purchase bills
|
|
2503
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2177
2504
|
# @param invoice_id Unique identifier for an Invoice
|
|
2178
2505
|
# @param invoices
|
|
2179
2506
|
# @param [Hash] opts the optional parameters
|
|
@@ -2186,6 +2513,7 @@ describe 'AccountingApi' do
|
|
|
2186
2513
|
|
|
2187
2514
|
# unit tests for update_invoice_attachment_by_file_name
|
|
2188
2515
|
# Allows you to update Attachment on invoices or purchase bills by it's filename
|
|
2516
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2189
2517
|
# @param invoice_id Unique identifier for an Invoice
|
|
2190
2518
|
# @param file_name Name of the file you are attaching
|
|
2191
2519
|
# @param body Byte array of file in body of request
|
|
@@ -2199,6 +2527,7 @@ describe 'AccountingApi' do
|
|
|
2199
2527
|
|
|
2200
2528
|
# unit tests for update_item
|
|
2201
2529
|
# Allows you to udpate a specified item
|
|
2530
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2202
2531
|
# @param item_id Unique identifier for an Item
|
|
2203
2532
|
# @param items
|
|
2204
2533
|
# @param [Hash] opts the optional parameters
|
|
@@ -2211,6 +2540,7 @@ describe 'AccountingApi' do
|
|
|
2211
2540
|
|
|
2212
2541
|
# unit tests for update_linked_transaction
|
|
2213
2542
|
# Allows you to update a specified linked transactions (billable expenses)
|
|
2543
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2214
2544
|
# @param linked_transaction_id Unique identifier for a LinkedTransaction
|
|
2215
2545
|
# @param linked_transactions
|
|
2216
2546
|
# @param [Hash] opts the optional parameters
|
|
@@ -2223,6 +2553,7 @@ describe 'AccountingApi' do
|
|
|
2223
2553
|
|
|
2224
2554
|
# unit tests for update_manual_journal
|
|
2225
2555
|
# Allows you to update a specified manual journal
|
|
2556
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2226
2557
|
# @param manual_journal_id Unique identifier for a ManualJournal
|
|
2227
2558
|
# @param manual_journals
|
|
2228
2559
|
# @param [Hash] opts the optional parameters
|
|
@@ -2235,6 +2566,7 @@ describe 'AccountingApi' do
|
|
|
2235
2566
|
|
|
2236
2567
|
# unit tests for update_manual_journal_attachment_by_file_name
|
|
2237
2568
|
# Allows you to update a specified Attachment on ManualJournal by file name
|
|
2569
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2238
2570
|
# @param manual_journal_id Unique identifier for a ManualJournal
|
|
2239
2571
|
# @param file_name The name of the file being attached to a ManualJournal
|
|
2240
2572
|
# @param body Byte array of file in body of request
|
|
@@ -2248,6 +2580,7 @@ describe 'AccountingApi' do
|
|
|
2248
2580
|
|
|
2249
2581
|
# unit tests for update_purchase_order
|
|
2250
2582
|
# Allows you to update a specified purchase order
|
|
2583
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2251
2584
|
# @param purchase_order_id Unique identifier for a PurchaseOrder
|
|
2252
2585
|
# @param purchase_orders
|
|
2253
2586
|
# @param [Hash] opts the optional parameters
|
|
@@ -2260,6 +2593,7 @@ describe 'AccountingApi' do
|
|
|
2260
2593
|
|
|
2261
2594
|
# unit tests for update_receipt
|
|
2262
2595
|
# Allows you to retrieve a specified draft expense claim receipts
|
|
2596
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2263
2597
|
# @param receipt_id Unique identifier for a Receipt
|
|
2264
2598
|
# @param receipts
|
|
2265
2599
|
# @param [Hash] opts the optional parameters
|
|
@@ -2272,6 +2606,7 @@ describe 'AccountingApi' do
|
|
|
2272
2606
|
|
|
2273
2607
|
# unit tests for update_receipt_attachment_by_file_name
|
|
2274
2608
|
# Allows you to update Attachment on expense claim receipts by file name
|
|
2609
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2275
2610
|
# @param receipt_id Unique identifier for a Receipt
|
|
2276
2611
|
# @param file_name The name of the file being attached to the Receipt
|
|
2277
2612
|
# @param body Byte array of file in body of request
|
|
@@ -2285,6 +2620,7 @@ describe 'AccountingApi' do
|
|
|
2285
2620
|
|
|
2286
2621
|
# unit tests for update_repeating_invoice_attachment_by_file_name
|
|
2287
2622
|
# Allows you to update specified attachment on repeating invoices by file name
|
|
2623
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2288
2624
|
# @param repeating_invoice_id Unique identifier for a Repeating Invoice
|
|
2289
2625
|
# @param file_name The name of the file being attached to a Repeating Invoice
|
|
2290
2626
|
# @param body Byte array of file in body of request
|
|
@@ -2298,6 +2634,7 @@ describe 'AccountingApi' do
|
|
|
2298
2634
|
|
|
2299
2635
|
# unit tests for update_tax_rate
|
|
2300
2636
|
# Allows you to update Tax Rates
|
|
2637
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2301
2638
|
# @param tax_rates
|
|
2302
2639
|
# @param [Hash] opts the optional parameters
|
|
2303
2640
|
# @return [TaxRates]
|
|
@@ -2309,6 +2646,7 @@ describe 'AccountingApi' do
|
|
|
2309
2646
|
|
|
2310
2647
|
# unit tests for update_tracking_category
|
|
2311
2648
|
# Allows you to update tracking categories
|
|
2649
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2312
2650
|
# @param tracking_category_id Unique identifier for a TrackingCategory
|
|
2313
2651
|
# @param tracking_category
|
|
2314
2652
|
# @param [Hash] opts the optional parameters
|
|
@@ -2319,4 +2657,18 @@ describe 'AccountingApi' do
|
|
|
2319
2657
|
end
|
|
2320
2658
|
end
|
|
2321
2659
|
|
|
2660
|
+
# unit tests for update_tracking_options
|
|
2661
|
+
# Allows you to update options for a specified tracking category
|
|
2662
|
+
# @param xero_tenant_id Xero identifier for Tenant
|
|
2663
|
+
# @param tracking_category_id Unique identifier for a TrackingCategory
|
|
2664
|
+
# @param tracking_option_id Unique identifier for a Tracking Option
|
|
2665
|
+
# @param tracking_option
|
|
2666
|
+
# @param [Hash] opts the optional parameters
|
|
2667
|
+
# @return [TrackingOptions]
|
|
2668
|
+
describe 'update_tracking_options test' do
|
|
2669
|
+
it 'should work' do
|
|
2670
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2671
|
+
end
|
|
2672
|
+
end
|
|
2673
|
+
|
|
2322
2674
|
end
|