Class: XeroRuby::AccountingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/api/accounting_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.new) ⇒ AccountingApi

Returns a new instance of AccountingApi.



19
20
21
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 19

def initialize(api_client = ApiClient.new)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_account(xero_tenant_id, account, opts = {}) ⇒ Accounts

Allows you to create a new chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account (Account) —

    Account object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Accounts) 


27
28
29
30
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 27

def (xero_tenant_id, , opts = {})
  data, _status_code, _headers = (xero_tenant_id, , opts)
  data
end

#create_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to create Attachment on Account

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • file_name (String) —

    Name of the attachment

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


104
105
106
107
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 104

def (xero_tenant_id, , file_name, body, opts = {})
  data, _status_code, _headers = (xero_tenant_id, , file_name, body, opts)
  data
end

#create_account_attachment_by_file_name_with_http_info(xero_tenant_id, account_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to create Attachment on Account

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • file_name (String) —

    Name of the attachment

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 116

def (xero_tenant_id, , file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_account_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_account_attachment_by_file_name"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountingApi.create_account_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_account_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_account_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Accounts/{AccountID}/Attachments/{FileName}'.sub('{' + 'AccountID' + '}', .to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_account_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_account_with_http_info(xero_tenant_id, account, opts = {}) ⇒ Array<(Accounts, Integer, Hash)>

Allows you to create a new chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account (Account) —

    Account object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Accounts, Integer, Hash)>) —

    Accounts data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 37

def (xero_tenant_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_account ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_account"
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling AccountingApi.create_account"
  end
  # resource path
  local_var_path = '/Accounts'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body() 

  # return_type
  return_type = opts[:return_type] || 'Accounts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to create an Attachment on BankTransaction by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • file_name (String) —

    The name of the file being attached

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


191
192
193
194
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 191

def create_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts = {})
  data, _status_code, _headers = create_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, opts)
  data
end

#create_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to create an Attachment on BankTransaction by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • file_name (String) —

    The name of the file being attached

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 203

def create_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_bank_transaction_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.create_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_bank_transaction_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}/Attachments/{FileName}'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_bank_transaction_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create history record for a bank transactions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


277
278
279
280
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 277

def create_bank_transaction_history_record(xero_tenant_id, bank_transaction_id, history_records, opts = {})
  data, _status_code, _headers = create_bank_transaction_history_record_with_http_info(xero_tenant_id, bank_transaction_id, history_records, opts)
  data
end

#create_bank_transaction_history_record_with_http_info(xero_tenant_id, bank_transaction_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create history record for a bank transactions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 288

def create_bank_transaction_history_record_with_http_info(xero_tenant_id, bank_transaction_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_bank_transaction_history_record ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_bank_transaction_history_record"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.create_bank_transaction_history_record"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_bank_transaction_history_record"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}/History'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_bank_transaction_history_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bank_transactions(xero_tenant_id, bank_transactions, opts = {}) ⇒ BankTransactions

Allows you to create one or more spend or receive money transaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transactions (BankTransactions) —

    BankTransactions with an array of BankTransaction objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (BankTransactions) 


359
360
361
362
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 359

def create_bank_transactions(xero_tenant_id, bank_transactions, opts = {})
  data, _status_code, _headers = create_bank_transactions_with_http_info(xero_tenant_id, bank_transactions, opts)
  data
end

#create_bank_transactions_with_http_info(xero_tenant_id, bank_transactions, opts = {}) ⇒ Array<(BankTransactions, Integer, Hash)>

Allows you to create one or more spend or receive money transaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transactions (BankTransactions) —

    BankTransactions with an array of BankTransaction objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(BankTransactions, Integer, Hash)>) —

    BankTransactions data, response status code and response headers



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 371

def create_bank_transactions_with_http_info(xero_tenant_id, bank_transactions, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_bank_transactions ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_bank_transactions"
  end
  # verify the required parameter 'bank_transactions' is set
  if @api_client.config.client_side_validation && bank_transactions.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transactions' when calling AccountingApi.create_bank_transactions"
  end
  # resource path
  local_var_path = '/BankTransactions'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(bank_transactions) 

  # return_type
  return_type = opts[:return_type] || 'BankTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_bank_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bank_transfer(xero_tenant_id, bank_transfers, opts = {}) ⇒ BankTransfers

Allows you to create a bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfers (BankTransfers) —

    BankTransfers with array of BankTransfer objects in request body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (BankTransfers) 


438
439
440
441
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 438

def create_bank_transfer(xero_tenant_id, bank_transfers, opts = {})
  data, _status_code, _headers = create_bank_transfer_with_http_info(xero_tenant_id, bank_transfers, opts)
  data
end

#create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts = {}) ⇒ Attachments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • file_name (String) —

    The name of the file being attached to a Bank Transfer

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


514
515
516
517
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 514

def create_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts = {})
  data, _status_code, _headers = create_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, opts)
  data
end

#create_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Returns Attachments data, response status code and response headers.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • file_name (String) —

    The name of the file being attached to a Bank Transfer

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 525

def create_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_bank_transfer_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'bank_transfer_id' is set
  if @api_client.config.client_side_validation && bank_transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_id' when calling AccountingApi.create_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_bank_transfer_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/BankTransfers/{BankTransferID}/Attachments/{FileName}'.sub('{' + 'BankTransferID' + '}', bank_transfer_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_bank_transfer_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, opts = {}) ⇒ HistoryRecords

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


598
599
600
601
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 598

def create_bank_transfer_history_record(xero_tenant_id, bank_transfer_id, history_records, opts = {})
  data, _status_code, _headers = create_bank_transfer_history_record_with_http_info(xero_tenant_id, bank_transfer_id, history_records, opts)
  data
end

#create_bank_transfer_history_record_with_http_info(xero_tenant_id, bank_transfer_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Returns HistoryRecords data, response status code and response headers.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 608

def create_bank_transfer_history_record_with_http_info(xero_tenant_id, bank_transfer_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_bank_transfer_history_record ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_bank_transfer_history_record"
  end
  # verify the required parameter 'bank_transfer_id' is set
  if @api_client.config.client_side_validation && bank_transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_id' when calling AccountingApi.create_bank_transfer_history_record"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_bank_transfer_history_record"
  end
  # resource path
  local_var_path = '/BankTransfers/{BankTransferID}/History'.sub('{' + 'BankTransferID' + '}', bank_transfer_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_bank_transfer_history_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_bank_transfer_with_http_info(xero_tenant_id, bank_transfers, opts = {}) ⇒ Array<(BankTransfers, Integer, Hash)>

Allows you to create a bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfers (BankTransfers) —

    BankTransfers with array of BankTransfer objects in request body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BankTransfers, Integer, Hash)>) —

    BankTransfers data, response status code and response headers



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 448

def create_bank_transfer_with_http_info(xero_tenant_id, bank_transfers, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_bank_transfer ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_bank_transfer"
  end
  # verify the required parameter 'bank_transfers' is set
  if @api_client.config.client_side_validation && bank_transfers.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfers' when calling AccountingApi.create_bank_transfer"
  end
  # resource path
  local_var_path = '/BankTransfers'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(bank_transfers) 

  # return_type
  return_type = opts[:return_type] || 'BankTransfers' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_bank_transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_batch_payment(xero_tenant_id, batch_payments, opts = {}) ⇒ BatchPayments

Create one or many BatchPayments for invoices

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • batch_payments (BatchPayments) —

    BatchPayments with an array of Payments in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (BatchPayments) 


678
679
680
681
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 678

def create_batch_payment(xero_tenant_id, batch_payments, opts = {})
  data, _status_code, _headers = create_batch_payment_with_http_info(xero_tenant_id, batch_payments, opts)
  data
end

#create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create a history record for a Batch Payment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • batch_payment_id (String) —

    Unique identifier for BatchPayment

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


756
757
758
759
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 756

def create_batch_payment_history_record(xero_tenant_id, batch_payment_id, history_records, opts = {})
  data, _status_code, _headers = create_batch_payment_history_record_with_http_info(xero_tenant_id, batch_payment_id, history_records, opts)
  data
end

#create_batch_payment_history_record_with_http_info(xero_tenant_id, batch_payment_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create a history record for a Batch Payment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • batch_payment_id (String) —

    Unique identifier for BatchPayment

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 767

def create_batch_payment_history_record_with_http_info(xero_tenant_id, batch_payment_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_batch_payment_history_record ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_batch_payment_history_record"
  end
  # verify the required parameter 'batch_payment_id' is set
  if @api_client.config.client_side_validation && batch_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_payment_id' when calling AccountingApi.create_batch_payment_history_record"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_batch_payment_history_record"
  end
  # resource path
  local_var_path = '/BatchPayments/{BatchPaymentID}/History'.sub('{' + 'BatchPaymentID' + '}', batch_payment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_batch_payment_history_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_batch_payment_with_http_info(xero_tenant_id, batch_payments, opts = {}) ⇒ Array<(BatchPayments, Integer, Hash)>

Create one or many BatchPayments for invoices

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • batch_payments (BatchPayments) —

    BatchPayments with an array of Payments in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(BatchPayments, Integer, Hash)>) —

    BatchPayments data, response status code and response headers



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 689

def create_batch_payment_with_http_info(xero_tenant_id, batch_payments, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_batch_payment ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_batch_payment"
  end
  # verify the required parameter 'batch_payments' is set
  if @api_client.config.client_side_validation && batch_payments.nil?
    fail ArgumentError, "Missing the required parameter 'batch_payments' when calling AccountingApi.create_batch_payment"
  end
  # resource path
  local_var_path = '/BatchPayments'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(batch_payments) 

  # return_type
  return_type = opts[:return_type] || 'BatchPayments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_batch_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_service, opts = {}) ⇒ PaymentServices

Allow for the creation of new custom payment service for specified Branding Theme

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • branding_theme_id (String) —

    Unique identifier for a Branding Theme

  • payment_service (PaymentService) —

    PaymentService object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (PaymentServices) 


837
838
839
840
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 837

def create_branding_theme_payment_services(xero_tenant_id, branding_theme_id, payment_service, opts = {})
  data, _status_code, _headers = create_branding_theme_payment_services_with_http_info(xero_tenant_id, branding_theme_id, payment_service, opts)
  data
end

#create_branding_theme_payment_services_with_http_info(xero_tenant_id, branding_theme_id, payment_service, opts = {}) ⇒ Array<(PaymentServices, Integer, Hash)>

Allow for the creation of new custom payment service for specified Branding Theme

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • branding_theme_id (String) —

    Unique identifier for a Branding Theme

  • payment_service (PaymentService) —

    PaymentService object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PaymentServices, Integer, Hash)>) —

    PaymentServices data, response status code and response headers



848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 848

def create_branding_theme_payment_services_with_http_info(xero_tenant_id, branding_theme_id, payment_service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_branding_theme_payment_services ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_branding_theme_payment_services"
  end
  # verify the required parameter 'branding_theme_id' is set
  if @api_client.config.client_side_validation && branding_theme_id.nil?
    fail ArgumentError, "Missing the required parameter 'branding_theme_id' when calling AccountingApi.create_branding_theme_payment_services"
  end
  # verify the required parameter 'payment_service' is set
  if @api_client.config.client_side_validation && payment_service.nil?
    fail ArgumentError, "Missing the required parameter 'payment_service' when calling AccountingApi.create_branding_theme_payment_services"
  end
  # resource path
  local_var_path = '/BrandingThemes/{BrandingThemeID}/PaymentServices'.sub('{' + 'BrandingThemeID' + '}', branding_theme_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(payment_service) 

  # return_type
  return_type = opts[:return_type] || 'PaymentServices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_branding_theme_payment_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts = {}) ⇒ Attachments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • file_name (String) —

    Name for the file you are attaching

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


918
919
920
921
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 918

def create_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts = {})
  data, _status_code, _headers = create_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, opts)
  data
end

#create_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Returns Attachments data, response status code and response headers.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • file_name (String) —

    Name for the file you are attaching

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 929

def create_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_contact_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_contact_attachment_by_file_name"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.create_contact_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_contact_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_contact_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}/Attachments/{FileName}'.sub('{' + 'ContactID' + '}', contact_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_contact_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_contact_group(xero_tenant_id, contact_groups, opts = {}) ⇒ ContactGroups

Allows you to create a contact group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_groups (ContactGroups) —

    ContactGroups with an array of names in request body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ContactGroups) 


1002
1003
1004
1005
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1002

def create_contact_group(xero_tenant_id, contact_groups, opts = {})
  data, _status_code, _headers = create_contact_group_with_http_info(xero_tenant_id, contact_groups, opts)
  data
end

#create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, opts = {}) ⇒ Contacts

Allows you to add Contacts to a Contact Group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • contacts (Contacts) —

    Contacts with array of contacts specifiying the ContactID to be added to ContactGroup in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Contacts) 


1078
1079
1080
1081
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1078

def create_contact_group_contacts(xero_tenant_id, contact_group_id, contacts, opts = {})
  data, _status_code, _headers = create_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_id, contacts, opts)
  data
end

#create_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_id, contacts, opts = {}) ⇒ Array<(Contacts, Integer, Hash)>

Allows you to add Contacts to a Contact Group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • contacts (Contacts) —

    Contacts with array of contacts specifiying the ContactID to be added to ContactGroup in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Contacts, Integer, Hash)>) —

    Contacts data, response status code and response headers



1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1089

def create_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_id, contacts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_contact_group_contacts ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_contact_group_contacts"
  end
  # verify the required parameter 'contact_group_id' is set
  if @api_client.config.client_side_validation && contact_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_group_id' when calling AccountingApi.create_contact_group_contacts"
  end
  # verify the required parameter 'contacts' is set
  if @api_client.config.client_side_validation && contacts.nil?
    fail ArgumentError, "Missing the required parameter 'contacts' when calling AccountingApi.create_contact_group_contacts"
  end
  # resource path
  local_var_path = '/ContactGroups/{ContactGroupID}/Contacts'.sub('{' + 'ContactGroupID' + '}', contact_group_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(contacts) 

  # return_type
  return_type = opts[:return_type] || 'Contacts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_contact_group_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_contact_group_with_http_info(xero_tenant_id, contact_groups, opts = {}) ⇒ Array<(ContactGroups, Integer, Hash)>

Allows you to create a contact group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_groups (ContactGroups) —

    ContactGroups with an array of names in request body

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactGroups, Integer, Hash)>) —

    ContactGroups data, response status code and response headers



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1012

def create_contact_group_with_http_info(xero_tenant_id, contact_groups, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_contact_group ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_contact_group"
  end
  # verify the required parameter 'contact_groups' is set
  if @api_client.config.client_side_validation && contact_groups.nil?
    fail ArgumentError, "Missing the required parameter 'contact_groups' when calling AccountingApi.create_contact_group"
  end
  # resource path
  local_var_path = '/ContactGroups'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(contact_groups) 

  # return_type
  return_type = opts[:return_type] || 'ContactGroups' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_contact_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_contact_history(xero_tenant_id, contact_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an Contact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


1159
1160
1161
1162
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1159

def create_contact_history(xero_tenant_id, contact_id, history_records, opts = {})
  data, _status_code, _headers = create_contact_history_with_http_info(xero_tenant_id, contact_id, history_records, opts)
  data
end

#create_contact_history_with_http_info(xero_tenant_id, contact_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an Contact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1170

def create_contact_history_with_http_info(xero_tenant_id, contact_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_contact_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_contact_history"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.create_contact_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_contact_history"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}/History'.sub('{' + 'ContactID' + '}', contact_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_contact_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_contacts(xero_tenant_id, contacts, opts = {}) ⇒ Contacts

Allows you to create a multiple contacts (bulk) in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contacts (Contacts) —

    Contacts with an array of Contact objects to create in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Contacts) 


1240
1241
1242
1243
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1240

def create_contacts(xero_tenant_id, contacts, opts = {})
  data, _status_code, _headers = create_contacts_with_http_info(xero_tenant_id, contacts, opts)
  data
end

#create_contacts_with_http_info(xero_tenant_id, contacts, opts = {}) ⇒ Array<(Contacts, Integer, Hash)>

Allows you to create a multiple contacts (bulk) in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contacts (Contacts) —

    Contacts with an array of Contact objects to create in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Contacts, Integer, Hash)>) —

    Contacts data, response status code and response headers



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1251

def create_contacts_with_http_info(xero_tenant_id, contacts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_contacts ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_contacts"
  end
  # verify the required parameter 'contacts' is set
  if @api_client.config.client_side_validation && contacts.nil?
    fail ArgumentError, "Missing the required parameter 'contacts' when calling AccountingApi.create_contacts"
  end
  # resource path
  local_var_path = '/Contacts'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(contacts) 

  # return_type
  return_type = opts[:return_type] || 'Contacts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, opts = {}) ⇒ Allocations

Allows you to create Allocation on CreditNote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • allocations (Allocations) —

    Allocations with array of Allocation object in body of request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Allocations) 


1319
1320
1321
1322
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1319

def create_credit_note_allocation(xero_tenant_id, credit_note_id, allocations, opts = {})
  data, _status_code, _headers = create_credit_note_allocation_with_http_info(xero_tenant_id, credit_note_id, allocations, opts)
  data
end

#create_credit_note_allocation_with_http_info(xero_tenant_id, credit_note_id, allocations, opts = {}) ⇒ Array<(Allocations, Integer, Hash)>

Allows you to create Allocation on CreditNote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • allocations (Allocations) —

    Allocations with array of Allocation object in body of request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Allocations, Integer, Hash)>) —

    Allocations data, response status code and response headers



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1331

def create_credit_note_allocation_with_http_info(xero_tenant_id, credit_note_id, allocations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_credit_note_allocation ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_credit_note_allocation"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.create_credit_note_allocation"
  end
  # verify the required parameter 'allocations' is set
  if @api_client.config.client_side_validation && allocations.nil?
    fail ArgumentError, "Missing the required parameter 'allocations' when calling AccountingApi.create_credit_note_allocation"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}/Allocations'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(allocations) 

  # return_type
  return_type = opts[:return_type] || 'Allocations' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_credit_note_allocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to create Attachments on CreditNote by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • file_name (String) —

    Name of the file you are attaching to Credit Note

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_online (Boolean) —

    Allows an attachment to be seen by the end customer within their online invoice (default to false)

Returns:

  • (Attachments) 


1404
1405
1406
1407
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1404

def create_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts = {})
  data, _status_code, _headers = create_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, opts)
  data
end

#create_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to create Attachments on CreditNote by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • file_name (String) —

    Name of the file you are attaching to Credit Note

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_online (Boolean) —

    Allows an attachment to be seen by the end customer within their online invoice

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1417

def create_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_credit_note_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.create_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_credit_note_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}/Attachments/{FileName}'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'IncludeOnline'] = opts[:'include_online'] if !opts[:'include_online'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_credit_note_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_credit_note_history(xero_tenant_id, credit_note_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an CreditNote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


1492
1493
1494
1495
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1492

def create_credit_note_history(xero_tenant_id, credit_note_id, history_records, opts = {})
  data, _status_code, _headers = create_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, history_records, opts)
  data
end

#create_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an CreditNote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1503

def create_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_credit_note_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_credit_note_history"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.create_credit_note_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_credit_note_history"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}/History'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_credit_note_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_credit_notes(xero_tenant_id, credit_notes, opts = {}) ⇒ CreditNotes

Allows you to create a credit note

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_notes (CreditNotes) —

    Credit Notes with array of CreditNote object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (CreditNotes) 


1574
1575
1576
1577
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1574

def create_credit_notes(xero_tenant_id, credit_notes, opts = {})
  data, _status_code, _headers = create_credit_notes_with_http_info(xero_tenant_id, credit_notes, opts)
  data
end

#create_credit_notes_with_http_info(xero_tenant_id, credit_notes, opts = {}) ⇒ Array<(CreditNotes, Integer, Hash)>

Allows you to create a credit note

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_notes (CreditNotes) —

    Credit Notes with array of CreditNote object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(CreditNotes, Integer, Hash)>) —

    CreditNotes data, response status code and response headers



1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1586

def create_credit_notes_with_http_info(xero_tenant_id, credit_notes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_credit_notes ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_credit_notes"
  end
  # verify the required parameter 'credit_notes' is set
  if @api_client.config.client_side_validation && credit_notes.nil?
    fail ArgumentError, "Missing the required parameter 'credit_notes' when calling AccountingApi.create_credit_notes"
  end
  # resource path
  local_var_path = '/CreditNotes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(credit_notes) 

  # return_type
  return_type = opts[:return_type] || 'CreditNotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_credit_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_currency(xero_tenant_id, currency, opts = {}) ⇒ Currencies

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • currency (Currency) —

    Currency obejct in the body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Currencies) 


1652
1653
1654
1655
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1652

def create_currency(xero_tenant_id, currency, opts = {})
  data, _status_code, _headers = create_currency_with_http_info(xero_tenant_id, currency, opts)
  data
end

#create_currency_with_http_info(xero_tenant_id, currency, opts = {}) ⇒ Array<(Currencies, Integer, Hash)>

Returns Currencies data, response status code and response headers.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • currency (Currency) —

    Currency obejct in the body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Currencies, Integer, Hash)>) —

    Currencies data, response status code and response headers



1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1661

def create_currency_with_http_info(xero_tenant_id, currency, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_currency ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_currency"
  end
  # verify the required parameter 'currency' is set
  if @api_client.config.client_side_validation && currency.nil?
    fail ArgumentError, "Missing the required parameter 'currency' when calling AccountingApi.create_currency"
  end
  # resource path
  local_var_path = '/Currencies'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(currency) 

  # return_type
  return_type = opts[:return_type] || 'Currencies' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_currency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employees(xero_tenant_id, employees, opts = {}) ⇒ Employees

Allows you to create new employees used in Xero payrun

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employees (Employees) —

    Employees with array of Employee object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Employees) 


1727
1728
1729
1730
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1727

def create_employees(xero_tenant_id, employees, opts = {})
  data, _status_code, _headers = create_employees_with_http_info(xero_tenant_id, employees, opts)
  data
end

#create_employees_with_http_info(xero_tenant_id, employees, opts = {}) ⇒ Array<(Employees, Integer, Hash)>

Allows you to create new employees used in Xero payrun

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employees (Employees) —

    Employees with array of Employee object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Employees, Integer, Hash)>) —

    Employees data, response status code and response headers



1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1738

def create_employees_with_http_info(xero_tenant_id, employees, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_employees ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_employees"
  end
  # verify the required parameter 'employees' is set
  if @api_client.config.client_side_validation && employees.nil?
    fail ArgumentError, "Missing the required parameter 'employees' when calling AccountingApi.create_employees"
  end
  # resource path
  local_var_path = '/Employees'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(employees) 

  # return_type
  return_type = opts[:return_type] || 'Employees' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_employees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create a history records of an ExpenseClaim

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claim_id (String) —

    Unique identifier for a ExpenseClaim

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


1805
1806
1807
1808
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1805

def create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, opts = {})
  data, _status_code, _headers = create_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, history_records, opts)
  data
end

#create_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create a history records of an ExpenseClaim

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claim_id (String) —

    Unique identifier for a ExpenseClaim

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1816

def create_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_expense_claim_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_expense_claim_history"
  end
  # verify the required parameter 'expense_claim_id' is set
  if @api_client.config.client_side_validation && expense_claim_id.nil?
    fail ArgumentError, "Missing the required parameter 'expense_claim_id' when calling AccountingApi.create_expense_claim_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_expense_claim_history"
  end
  # resource path
  local_var_path = '/ExpenseClaims/{ExpenseClaimID}/History'.sub('{' + 'ExpenseClaimID' + '}', expense_claim_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_expense_claim_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_expense_claims(xero_tenant_id, expense_claims, opts = {}) ⇒ ExpenseClaims

Allows you to retrieve expense claims

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claims (ExpenseClaims) —

    ExpenseClaims with array of ExpenseClaim object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ExpenseClaims) 


1885
1886
1887
1888
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1885

def create_expense_claims(xero_tenant_id, expense_claims, opts = {})
  data, _status_code, _headers = create_expense_claims_with_http_info(xero_tenant_id, expense_claims, opts)
  data
end

#create_expense_claims_with_http_info(xero_tenant_id, expense_claims, opts = {}) ⇒ Array<(ExpenseClaims, Integer, Hash)>

Allows you to retrieve expense claims

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claims (ExpenseClaims) —

    ExpenseClaims with array of ExpenseClaim object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ExpenseClaims, Integer, Hash)>) —

    ExpenseClaims data, response status code and response headers



1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1895

def create_expense_claims_with_http_info(xero_tenant_id, expense_claims, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_expense_claims ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_expense_claims"
  end
  # verify the required parameter 'expense_claims' is set
  if @api_client.config.client_side_validation && expense_claims.nil?
    fail ArgumentError, "Missing the required parameter 'expense_claims' when calling AccountingApi.create_expense_claims"
  end
  # resource path
  local_var_path = '/ExpenseClaims'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(expense_claims) 

  # return_type
  return_type = opts[:return_type] || 'ExpenseClaims' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_expense_claims\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to create an Attachment on invoices or purchase bills by it's filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • file_name (String) —

    Name of the file you are attaching

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_online (Boolean) —

    Allows an attachment to be seen by the end customer within their online invoice (default to false)

Returns:

  • (Attachments) 


1963
1964
1965
1966
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1963

def create_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts = {})
  data, _status_code, _headers = create_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, opts)
  data
end

#create_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to create an Attachment on invoices or purchase bills by it's filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • file_name (String) —

    Name of the file you are attaching

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_online (Boolean) —

    Allows an attachment to be seen by the end customer within their online invoice

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 1976

def create_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_invoice_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.create_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_invoice_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/Attachments/{FileName}'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'IncludeOnline'] = opts[:'include_online'] if !opts[:'include_online'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_invoice_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_invoice_history(xero_tenant_id, invoice_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


2051
2052
2053
2054
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2051

def create_invoice_history(xero_tenant_id, invoice_id, history_records, opts = {})
  data, _status_code, _headers = create_invoice_history_with_http_info(xero_tenant_id, invoice_id, history_records, opts)
  data
end

#create_invoice_history_with_http_info(xero_tenant_id, invoice_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2062

def create_invoice_history_with_http_info(xero_tenant_id, invoice_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_invoice_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_invoice_history"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.create_invoice_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_invoice_history"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/History'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_invoice_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_invoices(xero_tenant_id, invoices, opts = {}) ⇒ Invoices

Allows you to create one or more sales invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoices (Invoices) —

    Invoices with an array of invoice objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Invoices) 


2133
2134
2135
2136
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2133

def create_invoices(xero_tenant_id, invoices, opts = {})
  data, _status_code, _headers = create_invoices_with_http_info(xero_tenant_id, invoices, opts)
  data
end

#create_invoices_with_http_info(xero_tenant_id, invoices, opts = {}) ⇒ Array<(Invoices, Integer, Hash)>

Allows you to create one or more sales invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoices (Invoices) —

    Invoices with an array of invoice objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Invoices, Integer, Hash)>) —

    Invoices data, response status code and response headers



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2145

def create_invoices_with_http_info(xero_tenant_id, invoices, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_invoices ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_invoices"
  end
  # verify the required parameter 'invoices' is set
  if @api_client.config.client_side_validation && invoices.nil?
    fail ArgumentError, "Missing the required parameter 'invoices' when calling AccountingApi.create_invoices"
  end
  # resource path
  local_var_path = '/Invoices'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(invoices) 

  # return_type
  return_type = opts[:return_type] || 'Invoices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_item_history(xero_tenant_id, item_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create a history record for items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


2213
2214
2215
2216
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2213

def create_item_history(xero_tenant_id, item_id, history_records, opts = {})
  data, _status_code, _headers = create_item_history_with_http_info(xero_tenant_id, item_id, history_records, opts)
  data
end

#create_item_history_with_http_info(xero_tenant_id, item_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create a history record for items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2224

def create_item_history_with_http_info(xero_tenant_id, item_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_item_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_item_history"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling AccountingApi.create_item_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_item_history"
  end
  # resource path
  local_var_path = '/Items/{ItemID}/History'.sub('{' + 'ItemID' + '}', item_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_item_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_items(xero_tenant_id, items, opts = {}) ⇒ Items

Allows you to create one or more items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • items (Items) —

    Items with an array of Item objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Items) 


2295
2296
2297
2298
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2295

def create_items(xero_tenant_id, items, opts = {})
  data, _status_code, _headers = create_items_with_http_info(xero_tenant_id, items, opts)
  data
end

#create_items_with_http_info(xero_tenant_id, items, opts = {}) ⇒ Array<(Items, Integer, Hash)>

Allows you to create one or more items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • items (Items) —

    Items with an array of Item objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Items, Integer, Hash)>) —

    Items data, response status code and response headers



2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2307

def create_items_with_http_info(xero_tenant_id, items, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_items ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_items"
  end
  # verify the required parameter 'items' is set
  if @api_client.config.client_side_validation && items.nil?
    fail ArgumentError, "Missing the required parameter 'items' when calling AccountingApi.create_items"
  end
  # resource path
  local_var_path = '/Items'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(items) 

  # return_type
  return_type = opts[:return_type] || 'Items' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_linked_transaction(xero_tenant_id, linked_transaction, opts = {}) ⇒ LinkedTransactions

Allows you to create linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • linked_transaction (LinkedTransaction) —

    LinkedTransaction object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (LinkedTransactions) 


2374
2375
2376
2377
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2374

def create_linked_transaction(xero_tenant_id, linked_transaction, opts = {})
  data, _status_code, _headers = create_linked_transaction_with_http_info(xero_tenant_id, linked_transaction, opts)
  data
end

#create_linked_transaction_with_http_info(xero_tenant_id, linked_transaction, opts = {}) ⇒ Array<(LinkedTransactions, Integer, Hash)>

Allows you to create linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • linked_transaction (LinkedTransaction) —

    LinkedTransaction object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LinkedTransactions, Integer, Hash)>) —

    LinkedTransactions data, response status code and response headers



2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2384

def create_linked_transaction_with_http_info(xero_tenant_id, linked_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_linked_transaction ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_linked_transaction"
  end
  # verify the required parameter 'linked_transaction' is set
  if @api_client.config.client_side_validation && linked_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'linked_transaction' when calling AccountingApi.create_linked_transaction"
  end
  # resource path
  local_var_path = '/LinkedTransactions'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(linked_transaction) 

  # return_type
  return_type = opts[:return_type] || 'LinkedTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_linked_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to create a specified Attachment on ManualJournal by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • file_name (String) —

    The name of the file being attached to a ManualJournal

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


2451
2452
2453
2454
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2451

def create_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts = {})
  data, _status_code, _headers = create_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, opts)
  data
end

#create_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to create a specified Attachment on ManualJournal by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • file_name (String) —

    The name of the file being attached to a ManualJournal

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2463

def create_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_manual_journal_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'manual_journal_id' is set
  if @api_client.config.client_side_validation && manual_journal_id.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journal_id' when calling AccountingApi.create_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_manual_journal_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/ManualJournals/{ManualJournalID}/Attachments/{FileName}'.sub('{' + 'ManualJournalID' + '}', manual_journal_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_manual_journal_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_manual_journals(xero_tenant_id, manual_journals, opts = {}) ⇒ ManualJournals

Allows you to create one or more manual journals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journals (ManualJournals) —

    ManualJournals array with ManualJournal object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (ManualJournals) 


2537
2538
2539
2540
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2537

def create_manual_journals(xero_tenant_id, manual_journals, opts = {})
  data, _status_code, _headers = create_manual_journals_with_http_info(xero_tenant_id, manual_journals, opts)
  data
end

#create_manual_journals_with_http_info(xero_tenant_id, manual_journals, opts = {}) ⇒ Array<(ManualJournals, Integer, Hash)>

Allows you to create one or more manual journals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journals (ManualJournals) —

    ManualJournals array with ManualJournal object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(ManualJournals, Integer, Hash)>) —

    ManualJournals data, response status code and response headers



2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2548

def create_manual_journals_with_http_info(xero_tenant_id, manual_journals, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_manual_journals ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_manual_journals"
  end
  # verify the required parameter 'manual_journals' is set
  if @api_client.config.client_side_validation && manual_journals.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journals' when calling AccountingApi.create_manual_journals"
  end
  # resource path
  local_var_path = '/ManualJournals'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(manual_journals) 

  # return_type
  return_type = opts[:return_type] || 'ManualJournals' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_manual_journals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, opts = {}) ⇒ Allocations

Allows you to create a single allocation for an overpayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • overpayment_id (String) —

    Unique identifier for a Overpayment

  • allocations (Allocations) —

    Allocations array with Allocation object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Allocations) 


2616
2617
2618
2619
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2616

def create_overpayment_allocations(xero_tenant_id, overpayment_id, allocations, opts = {})
  data, _status_code, _headers = create_overpayment_allocations_with_http_info(xero_tenant_id, overpayment_id, allocations, opts)
  data
end

#create_overpayment_allocations_with_http_info(xero_tenant_id, overpayment_id, allocations, opts = {}) ⇒ Array<(Allocations, Integer, Hash)>

Allows you to create a single allocation for an overpayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • overpayment_id (String) —

    Unique identifier for a Overpayment

  • allocations (Allocations) —

    Allocations array with Allocation object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Allocations, Integer, Hash)>) —

    Allocations data, response status code and response headers



2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2628

def create_overpayment_allocations_with_http_info(xero_tenant_id, overpayment_id, allocations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_overpayment_allocations ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_overpayment_allocations"
  end
  # verify the required parameter 'overpayment_id' is set
  if @api_client.config.client_side_validation && overpayment_id.nil?
    fail ArgumentError, "Missing the required parameter 'overpayment_id' when calling AccountingApi.create_overpayment_allocations"
  end
  # verify the required parameter 'allocations' is set
  if @api_client.config.client_side_validation && allocations.nil?
    fail ArgumentError, "Missing the required parameter 'allocations' when calling AccountingApi.create_overpayment_allocations"
  end
  # resource path
  local_var_path = '/Overpayments/{OverpaymentID}/Allocations'.sub('{' + 'OverpaymentID' + '}', overpayment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(allocations) 

  # return_type
  return_type = opts[:return_type] || 'Allocations' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_overpayment_allocations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_overpayment_history(xero_tenant_id, overpayment_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create history records of an Overpayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • overpayment_id (String) —

    Unique identifier for a Overpayment

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


2699
2700
2701
2702
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2699

def create_overpayment_history(xero_tenant_id, overpayment_id, history_records, opts = {})
  data, _status_code, _headers = create_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, history_records, opts)
  data
end

#create_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create history records of an Overpayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • overpayment_id (String) —

    Unique identifier for a Overpayment

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2710

def create_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_overpayment_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_overpayment_history"
  end
  # verify the required parameter 'overpayment_id' is set
  if @api_client.config.client_side_validation && overpayment_id.nil?
    fail ArgumentError, "Missing the required parameter 'overpayment_id' when calling AccountingApi.create_overpayment_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_overpayment_history"
  end
  # resource path
  local_var_path = '/Overpayments/{OverpaymentID}/History'.sub('{' + 'OverpaymentID' + '}', overpayment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_overpayment_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_payment(xero_tenant_id, payment, opts = {}) ⇒ Payments

Allows you to create a single payment for invoices or credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment (Payment) —

    Request body with a single Payment object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Payments) 


2779
2780
2781
2782
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2779

def create_payment(xero_tenant_id, payment, opts = {})
  data, _status_code, _headers = create_payment_with_http_info(xero_tenant_id, payment, opts)
  data
end

#create_payment_history(xero_tenant_id, payment_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create a history record for a payment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_id (String) —

    Unique identifier for a Payment

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


2855
2856
2857
2858
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2855

def create_payment_history(xero_tenant_id, payment_id, history_records, opts = {})
  data, _status_code, _headers = create_payment_history_with_http_info(xero_tenant_id, payment_id, history_records, opts)
  data
end

#create_payment_history_with_http_info(xero_tenant_id, payment_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create a history record for a payment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_id (String) —

    Unique identifier for a Payment

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2866

def create_payment_history_with_http_info(xero_tenant_id, payment_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_payment_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_payment_history"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling AccountingApi.create_payment_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_payment_history"
  end
  # resource path
  local_var_path = '/Payments/{PaymentID}/History'.sub('{' + 'PaymentID' + '}', payment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_payment_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_payment_service(xero_tenant_id, payment_services, opts = {}) ⇒ PaymentServices

Allows you to create payment services

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_services (PaymentServices) —

    PaymentServices array with PaymentService object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (PaymentServices) 


2935
2936
2937
2938
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2935

def create_payment_service(xero_tenant_id, payment_services, opts = {})
  data, _status_code, _headers = create_payment_service_with_http_info(xero_tenant_id, payment_services, opts)
  data
end

#create_payment_service_with_http_info(xero_tenant_id, payment_services, opts = {}) ⇒ Array<(PaymentServices, Integer, Hash)>

Allows you to create payment services

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_services (PaymentServices) —

    PaymentServices array with PaymentService object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PaymentServices, Integer, Hash)>) —

    PaymentServices data, response status code and response headers



2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2945

def create_payment_service_with_http_info(xero_tenant_id, payment_services, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_payment_service ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_payment_service"
  end
  # verify the required parameter 'payment_services' is set
  if @api_client.config.client_side_validation && payment_services.nil?
    fail ArgumentError, "Missing the required parameter 'payment_services' when calling AccountingApi.create_payment_service"
  end
  # resource path
  local_var_path = '/PaymentServices'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(payment_services) 

  # return_type
  return_type = opts[:return_type] || 'PaymentServices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_payment_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_payment_with_http_info(xero_tenant_id, payment, opts = {}) ⇒ Array<(Payments, Integer, Hash)>

Allows you to create a single payment for invoices or credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment (Payment) —

    Request body with a single Payment object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Payments, Integer, Hash)>) —

    Payments data, response status code and response headers



2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 2789

def create_payment_with_http_info(xero_tenant_id, payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_payment ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_payment"
  end
  # verify the required parameter 'payment' is set
  if @api_client.config.client_side_validation && payment.nil?
    fail ArgumentError, "Missing the required parameter 'payment' when calling AccountingApi.create_payment"
  end
  # resource path
  local_var_path = '/Payments'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(payment) 

  # return_type
  return_type = opts[:return_type] || 'Payments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_payments(xero_tenant_id, payments, opts = {}) ⇒ Payments

Allows you to create multiple payments for invoices or credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payments (Payments) —

    Payments array with Payment object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Payments) 


3011
3012
3013
3014
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3011

def create_payments(xero_tenant_id, payments, opts = {})
  data, _status_code, _headers = create_payments_with_http_info(xero_tenant_id, payments, opts)
  data
end

#create_payments_with_http_info(xero_tenant_id, payments, opts = {}) ⇒ Array<(Payments, Integer, Hash)>

Allows you to create multiple payments for invoices or credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payments (Payments) —

    Payments array with Payment object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Payments, Integer, Hash)>) —

    Payments data, response status code and response headers



3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3022

def create_payments_with_http_info(xero_tenant_id, payments, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_payments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_payments"
  end
  # verify the required parameter 'payments' is set
  if @api_client.config.client_side_validation && payments.nil?
    fail ArgumentError, "Missing the required parameter 'payments' when calling AccountingApi.create_payments"
  end
  # resource path
  local_var_path = '/Payments'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(payments) 

  # return_type
  return_type = opts[:return_type] || 'Payments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, opts = {}) ⇒ Allocations

Allows you to create an Allocation for prepayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • prepayment_id (String) —

    Unique identifier for Prepayment

  • allocations (Allocations) —

    Allocations with an array of Allocation object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Allocations) 


3090
3091
3092
3093
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3090

def create_prepayment_allocations(xero_tenant_id, prepayment_id, allocations, opts = {})
  data, _status_code, _headers = create_prepayment_allocations_with_http_info(xero_tenant_id, prepayment_id, allocations, opts)
  data
end

#create_prepayment_allocations_with_http_info(xero_tenant_id, prepayment_id, allocations, opts = {}) ⇒ Array<(Allocations, Integer, Hash)>

Allows you to create an Allocation for prepayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • prepayment_id (String) —

    Unique identifier for Prepayment

  • allocations (Allocations) —

    Allocations with an array of Allocation object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Allocations, Integer, Hash)>) —

    Allocations data, response status code and response headers



3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3102

def create_prepayment_allocations_with_http_info(xero_tenant_id, prepayment_id, allocations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_prepayment_allocations ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_prepayment_allocations"
  end
  # verify the required parameter 'prepayment_id' is set
  if @api_client.config.client_side_validation && prepayment_id.nil?
    fail ArgumentError, "Missing the required parameter 'prepayment_id' when calling AccountingApi.create_prepayment_allocations"
  end
  # verify the required parameter 'allocations' is set
  if @api_client.config.client_side_validation && allocations.nil?
    fail ArgumentError, "Missing the required parameter 'allocations' when calling AccountingApi.create_prepayment_allocations"
  end
  # resource path
  local_var_path = '/Prepayments/{PrepaymentID}/Allocations'.sub('{' + 'PrepaymentID' + '}', prepayment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(allocations) 

  # return_type
  return_type = opts[:return_type] || 'Allocations' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_prepayment_allocations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_prepayment_history(xero_tenant_id, prepayment_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create a history record for an Prepayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • prepayment_id (String) —

    Unique identifier for a PrePayment

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


3173
3174
3175
3176
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3173

def create_prepayment_history(xero_tenant_id, prepayment_id, history_records, opts = {})
  data, _status_code, _headers = create_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, history_records, opts)
  data
end

#create_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create a history record for an Prepayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • prepayment_id (String) —

    Unique identifier for a PrePayment

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3184

def create_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_prepayment_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_prepayment_history"
  end
  # verify the required parameter 'prepayment_id' is set
  if @api_client.config.client_side_validation && prepayment_id.nil?
    fail ArgumentError, "Missing the required parameter 'prepayment_id' when calling AccountingApi.create_prepayment_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_prepayment_history"
  end
  # resource path
  local_var_path = '/Prepayments/{PrepaymentID}/History'.sub('{' + 'PrepaymentID' + '}', prepayment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_prepayment_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create HistoryRecord for purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for a PurchaseOrder

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


3254
3255
3256
3257
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3254

def create_purchase_order_history(xero_tenant_id, purchase_order_id, history_records, opts = {})
  data, _status_code, _headers = create_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, history_records, opts)
  data
end

#create_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create HistoryRecord for purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for a PurchaseOrder

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3265

def create_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_purchase_order_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_purchase_order_history"
  end
  # verify the required parameter 'purchase_order_id' is set
  if @api_client.config.client_side_validation && purchase_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_order_id' when calling AccountingApi.create_purchase_order_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_purchase_order_history"
  end
  # resource path
  local_var_path = '/PurchaseOrders/{PurchaseOrderID}/History'.sub('{' + 'PurchaseOrderID' + '}', purchase_order_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_purchase_order_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_purchase_orders(xero_tenant_id, purchase_orders, opts = {}) ⇒ PurchaseOrders

Allows you to create one or more purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_orders (PurchaseOrders) —

    PurchaseOrders with an array of PurchaseOrder object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (PurchaseOrders) 


3335
3336
3337
3338
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3335

def create_purchase_orders(xero_tenant_id, purchase_orders, opts = {})
  data, _status_code, _headers = create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, opts)
  data
end

#create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, opts = {}) ⇒ Array<(PurchaseOrders, Integer, Hash)>

Allows you to create one or more purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_orders (PurchaseOrders) —

    PurchaseOrders with an array of PurchaseOrder object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(PurchaseOrders, Integer, Hash)>) —

    PurchaseOrders data, response status code and response headers



3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3346

def create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_purchase_orders ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_purchase_orders"
  end
  # verify the required parameter 'purchase_orders' is set
  if @api_client.config.client_side_validation && purchase_orders.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_orders' when calling AccountingApi.create_purchase_orders"
  end
  # resource path
  local_var_path = '/PurchaseOrders'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(purchase_orders) 

  # return_type
  return_type = opts[:return_type] || 'PurchaseOrders' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_purchase_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to create Attachment on Quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • file_name (String) —

    Name of the attachment

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


3414
3415
3416
3417
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3414

def create_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts = {})
  data, _status_code, _headers = create_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, opts)
  data
end

#create_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to create Attachment on Quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • file_name (String) —

    Name of the attachment

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3426

def create_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_quote_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_quote_attachment_by_file_name"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.create_quote_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_quote_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_quote_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}/Attachments/{FileName}'.sub('{' + 'QuoteID' + '}', quote_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_quote_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_quote_history(xero_tenant_id, quote_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


3500
3501
3502
3503
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3500

def create_quote_history(xero_tenant_id, quote_id, history_records, opts = {})
  data, _status_code, _headers = create_quote_history_with_http_info(xero_tenant_id, quote_id, history_records, opts)
  data
end

#create_quote_history_with_http_info(xero_tenant_id, quote_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3511

def create_quote_history_with_http_info(xero_tenant_id, quote_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_quote_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_quote_history"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.create_quote_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_quote_history"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}/History'.sub('{' + 'QuoteID' + '}', quote_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_quote_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_quotes(xero_tenant_id, quotes, opts = {}) ⇒ Quotes

Allows you to create one or more quotes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quotes (Quotes) —

    Quotes with an array of Quote object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Quotes) 


3581
3582
3583
3584
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3581

def create_quotes(xero_tenant_id, quotes, opts = {})
  data, _status_code, _headers = create_quotes_with_http_info(xero_tenant_id, quotes, opts)
  data
end

#create_quotes_with_http_info(xero_tenant_id, quotes, opts = {}) ⇒ Array<(Quotes, Integer, Hash)>

Allows you to create one or more quotes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quotes (Quotes) —

    Quotes with an array of Quote object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Quotes, Integer, Hash)>) —

    Quotes data, response status code and response headers



3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3592

def create_quotes_with_http_info(xero_tenant_id, quotes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_quotes ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_quotes"
  end
  # verify the required parameter 'quotes' is set
  if @api_client.config.client_side_validation && quotes.nil?
    fail ArgumentError, "Missing the required parameter 'quotes' when calling AccountingApi.create_quotes"
  end
  # resource path
  local_var_path = '/Quotes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(quotes) 

  # return_type
  return_type = opts[:return_type] || 'Quotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_quotes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_receipt(xero_tenant_id, receipts, opts = {}) ⇒ Receipts

Allows you to create draft expense claim receipts for any user

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipts (Receipts) —

    Receipts with an array of Receipt object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Receipts) 


3659
3660
3661
3662
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3659

def create_receipt(xero_tenant_id, receipts, opts = {})
  data, _status_code, _headers = create_receipt_with_http_info(xero_tenant_id, receipts, opts)
  data
end

#create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to create Attachment on expense claim receipts by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • file_name (String) —

    The name of the file being attached to the Receipt

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


3738
3739
3740
3741
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3738

def create_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts = {})
  data, _status_code, _headers = create_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, opts)
  data
end

#create_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to create Attachment on expense claim receipts by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • file_name (String) —

    The name of the file being attached to the Receipt

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3750

def create_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_receipt_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.create_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_receipt_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}/Attachments/{FileName}'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_receipt_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_receipt_history(xero_tenant_id, receipt_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an Receipt

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


3824
3825
3826
3827
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3824

def create_receipt_history(xero_tenant_id, receipt_id, history_records, opts = {})
  data, _status_code, _headers = create_receipt_history_with_http_info(xero_tenant_id, receipt_id, history_records, opts)
  data
end

#create_receipt_history_with_http_info(xero_tenant_id, receipt_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an Receipt

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3835

def create_receipt_history_with_http_info(xero_tenant_id, receipt_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_receipt_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_receipt_history"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.create_receipt_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_receipt_history"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}/History'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_receipt_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_receipt_with_http_info(xero_tenant_id, receipts, opts = {}) ⇒ Array<(Receipts, Integer, Hash)>

Allows you to create draft expense claim receipts for any user

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipts (Receipts) —

    Receipts with an array of Receipt object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Receipts, Integer, Hash)>) —

    Receipts data, response status code and response headers



3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3670

def create_receipt_with_http_info(xero_tenant_id, receipts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_receipt ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_receipt"
  end
  # verify the required parameter 'receipts' is set
  if @api_client.config.client_side_validation && receipts.nil?
    fail ArgumentError, "Missing the required parameter 'receipts' when calling AccountingApi.create_receipt"
  end
  # resource path
  local_var_path = '/Receipts'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(receipts) 

  # return_type
  return_type = opts[:return_type] || 'Receipts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to create attachment on repeating invoices by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • file_name (String) —

    The name of the file being attached to a Repeating Invoice

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


3906
3907
3908
3909
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3906

def create_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {})
  data, _status_code, _headers = create_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, opts)
  data
end

#create_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to create attachment on repeating invoices by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • file_name (String) —

    The name of the file being attached to a Repeating Invoice

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3918

def create_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_repeating_invoice_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'repeating_invoice_id' is set
  if @api_client.config.client_side_validation && repeating_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.create_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.create_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.create_repeating_invoice_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_repeating_invoice_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, opts = {}) ⇒ HistoryRecords

Allows you to create history for a repeating invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


3992
3993
3994
3995
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 3992

def create_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, history_records, opts = {})
  data, _status_code, _headers = create_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_invoice_id, history_records, opts)
  data
end

#create_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_invoice_id, history_records, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to create history for a repeating invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • history_records (HistoryRecords) —

    HistoryRecords containing an array of HistoryRecord objects in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4003

def create_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_invoice_id, history_records, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_repeating_invoice_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_repeating_invoice_history"
  end
  # verify the required parameter 'repeating_invoice_id' is set
  if @api_client.config.client_side_validation && repeating_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.create_repeating_invoice_history"
  end
  # verify the required parameter 'history_records' is set
  if @api_client.config.client_side_validation && history_records.nil?
    fail ArgumentError, "Missing the required parameter 'history_records' when calling AccountingApi.create_repeating_invoice_history"
  end
  # resource path
  local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}/History'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(history_records) 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_repeating_invoice_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tax_rates(xero_tenant_id, tax_rates, opts = {}) ⇒ TaxRates

Allows you to create one or more Tax Rates

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tax_rates (TaxRates) —

    TaxRates array with TaxRate object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TaxRates) 


4072
4073
4074
4075
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4072

def create_tax_rates(xero_tenant_id, tax_rates, opts = {})
  data, _status_code, _headers = create_tax_rates_with_http_info(xero_tenant_id, tax_rates, opts)
  data
end

#create_tax_rates_with_http_info(xero_tenant_id, tax_rates, opts = {}) ⇒ Array<(TaxRates, Integer, Hash)>

Allows you to create one or more Tax Rates

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tax_rates (TaxRates) —

    TaxRates array with TaxRate object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TaxRates, Integer, Hash)>) —

    TaxRates data, response status code and response headers



4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4082

def create_tax_rates_with_http_info(xero_tenant_id, tax_rates, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_tax_rates ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_tax_rates"
  end
  # verify the required parameter 'tax_rates' is set
  if @api_client.config.client_side_validation && tax_rates.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rates' when calling AccountingApi.create_tax_rates"
  end
  # resource path
  local_var_path = '/TaxRates'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(tax_rates) 

  # return_type
  return_type = opts[:return_type] || 'TaxRates' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_tax_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tracking_category(xero_tenant_id, tracking_category, opts = {}) ⇒ TrackingCategories

Allows you to create tracking categories

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category (TrackingCategory) —

    TrackingCategory object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TrackingCategories) 


4147
4148
4149
4150
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4147

def create_tracking_category(xero_tenant_id, tracking_category, opts = {})
  data, _status_code, _headers = create_tracking_category_with_http_info(xero_tenant_id, tracking_category, opts)
  data
end

#create_tracking_category_with_http_info(xero_tenant_id, tracking_category, opts = {}) ⇒ Array<(TrackingCategories, Integer, Hash)>

Allows you to create tracking categories

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category (TrackingCategory) —

    TrackingCategory object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrackingCategories, Integer, Hash)>) —

    TrackingCategories data, response status code and response headers



4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4157

def create_tracking_category_with_http_info(xero_tenant_id, tracking_category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_tracking_category ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_tracking_category"
  end
  # verify the required parameter 'tracking_category' is set
  if @api_client.config.client_side_validation && tracking_category.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_category' when calling AccountingApi.create_tracking_category"
  end
  # resource path
  local_var_path = '/TrackingCategories'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(tracking_category) 

  # return_type
  return_type = opts[:return_type] || 'TrackingCategories' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_tracking_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, opts = {}) ⇒ TrackingOptions

Allows you to create options for a specified tracking category

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • tracking_option (TrackingOption) —

    TrackingOption object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TrackingOptions) 


4223
4224
4225
4226
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4223

def create_tracking_options(xero_tenant_id, tracking_category_id, tracking_option, opts = {})
  data, _status_code, _headers = create_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option, opts)
  data
end

#create_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option, opts = {}) ⇒ Array<(TrackingOptions, Integer, Hash)>

Allows you to create options for a specified tracking category

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • tracking_option (TrackingOption) —

    TrackingOption object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrackingOptions, Integer, Hash)>) —

    TrackingOptions data, response status code and response headers



4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4234

def create_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.create_tracking_options ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.create_tracking_options"
  end
  # verify the required parameter 'tracking_category_id' is set
  if @api_client.config.client_side_validation && tracking_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_category_id' when calling AccountingApi.create_tracking_options"
  end
  # verify the required parameter 'tracking_option' is set
  if @api_client.config.client_side_validation && tracking_option.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_option' when calling AccountingApi.create_tracking_options"
  end
  # resource path
  local_var_path = '/TrackingCategories/{TrackingCategoryID}/Options'.sub('{' + 'TrackingCategoryID' + '}', tracking_category_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(tracking_option) 

  # return_type
  return_type = opts[:return_type] || 'TrackingOptions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#create_tracking_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account(xero_tenant_id, account_id, opts = {}) ⇒ Accounts

Allows you to delete a chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for retrieving single object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Accounts) 


4303
4304
4305
4306
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4303

def (xero_tenant_id, , opts = {})
  data, _status_code, _headers = (xero_tenant_id, , opts)
  data
end

#delete_account_with_http_info(xero_tenant_id, account_id, opts = {}) ⇒ Array<(Accounts, Integer, Hash)>

Allows you to delete a chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for retrieving single object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Accounts, Integer, Hash)>) —

    Accounts data, response status code and response headers



4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4313

def (xero_tenant_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_account ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_account"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountingApi.delete_account"
  end
  # resource path
  local_var_path = '/Accounts/{AccountID}'.sub('{' + 'AccountID' + '}', .to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Accounts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id, opts = {}) ⇒ nil

Allows you to delete a specific Contact from a Contact Group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


4377
4378
4379
4380
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4377

def delete_contact_group_contact(xero_tenant_id, contact_group_id, contact_id, opts = {})
  delete_contact_group_contact_with_http_info(xero_tenant_id, contact_group_id, contact_id, opts)
  nil
end

#delete_contact_group_contact_with_http_info(xero_tenant_id, contact_group_id, contact_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to delete a specific Contact from a Contact Group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4388

def delete_contact_group_contact_with_http_info(xero_tenant_id, contact_group_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_contact_group_contact ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_contact_group_contact"
  end
  # verify the required parameter 'contact_group_id' is set
  if @api_client.config.client_side_validation && contact_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_group_id' when calling AccountingApi.delete_contact_group_contact"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.delete_contact_group_contact"
  end
  # resource path
  local_var_path = '/ContactGroups/{ContactGroupID}/Contacts/{ContactID}'.sub('{' + 'ContactGroupID' + '}', contact_group_id.to_s).sub('{' + 'ContactID' + '}', contact_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_contact_group_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contact_group_contacts(xero_tenant_id, contact_group_id, opts = {}) ⇒ nil

Allows you to delete all Contacts from a Contact Group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


4455
4456
4457
4458
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4455

def delete_contact_group_contacts(xero_tenant_id, contact_group_id, opts = {})
  delete_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_id, opts)
  nil
end

#delete_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to delete all Contacts from a Contact Group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4465

def delete_contact_group_contacts_with_http_info(xero_tenant_id, contact_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_contact_group_contacts ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_contact_group_contacts"
  end
  # verify the required parameter 'contact_group_id' is set
  if @api_client.config.client_side_validation && contact_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_group_id' when calling AccountingApi.delete_contact_group_contacts"
  end
  # resource path
  local_var_path = '/ContactGroups/{ContactGroupID}/Contacts'.sub('{' + 'ContactGroupID' + '}', contact_group_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_contact_group_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_item(xero_tenant_id, item_id, opts = {}) ⇒ nil

Allows you to delete a specified item

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


4526
4527
4528
4529
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4526

def delete_item(xero_tenant_id, item_id, opts = {})
  delete_item_with_http_info(xero_tenant_id, item_id, opts)
  nil
end

#delete_item_with_http_info(xero_tenant_id, item_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to delete a specified item

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4536

def delete_item_with_http_info(xero_tenant_id, item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_item ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_item"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling AccountingApi.delete_item"
  end
  # resource path
  local_var_path = '/Items/{ItemID}'.sub('{' + 'ItemID' + '}', item_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_linked_transaction(xero_tenant_id, linked_transaction_id, opts = {}) ⇒ nil

Allows you to delete a specified linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • linked_transaction_id (String) —

    Unique identifier for a LinkedTransaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


4599
4600
4601
4602
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4599

def delete_linked_transaction(xero_tenant_id, linked_transaction_id, opts = {})
  delete_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, opts)
  nil
end

#delete_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to delete a specified linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • linked_transaction_id (String) —

    Unique identifier for a LinkedTransaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4609

def delete_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_linked_transaction ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_linked_transaction"
  end
  # verify the required parameter 'linked_transaction_id' is set
  if @api_client.config.client_side_validation && linked_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'linked_transaction_id' when calling AccountingApi.delete_linked_transaction"
  end
  # resource path
  local_var_path = '/LinkedTransactions/{LinkedTransactionID}'.sub('{' + 'LinkedTransactionID' + '}', linked_transaction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_linked_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_payment(xero_tenant_id, payment_id, payment_delete, opts = {}) ⇒ Payments

Allows you to update a specified payment for invoices and credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_id (String) —

    Unique identifier for a Payment

  • payment_delete (PaymentDelete)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Payments) 


4673
4674
4675
4676
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4673

def delete_payment(xero_tenant_id, payment_id, payment_delete, opts = {})
  data, _status_code, _headers = delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, opts)
  data
end

#delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, opts = {}) ⇒ Array<(Payments, Integer, Hash)>

Allows you to update a specified payment for invoices and credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_id (String) —

    Unique identifier for a Payment

  • payment_delete (PaymentDelete)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Payments, Integer, Hash)>) —

    Payments data, response status code and response headers



4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4684

def delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_payment ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_payment"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling AccountingApi.delete_payment"
  end
  # verify the required parameter 'payment_delete' is set
  if @api_client.config.client_side_validation && payment_delete.nil?
    fail ArgumentError, "Missing the required parameter 'payment_delete' when calling AccountingApi.delete_payment"
  end
  # resource path
  local_var_path = '/Payments/{PaymentID}'.sub('{' + 'PaymentID' + '}', payment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(payment_delete) 

  # return_type
  return_type = opts[:return_type] || 'Payments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tracking_category(xero_tenant_id, tracking_category_id, opts = {}) ⇒ TrackingCategories

Allows you to delete tracking categories

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TrackingCategories) 


4753
4754
4755
4756
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4753

def delete_tracking_category(xero_tenant_id, tracking_category_id, opts = {})
  data, _status_code, _headers = delete_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, opts)
  data
end

#delete_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, opts = {}) ⇒ Array<(TrackingCategories, Integer, Hash)>

Allows you to delete tracking categories

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrackingCategories, Integer, Hash)>) —

    TrackingCategories data, response status code and response headers



4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4763

def delete_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_tracking_category ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_tracking_category"
  end
  # verify the required parameter 'tracking_category_id' is set
  if @api_client.config.client_side_validation && tracking_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_category_id' when calling AccountingApi.delete_tracking_category"
  end
  # resource path
  local_var_path = '/TrackingCategories/{TrackingCategoryID}'.sub('{' + 'TrackingCategoryID' + '}', tracking_category_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'TrackingCategories' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_tracking_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, opts = {}) ⇒ TrackingOptions

Allows you to delete a specified option for a specified tracking category

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • tracking_option_id (String) —

    Unique identifier for a Tracking Option

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TrackingOptions) 


4827
4828
4829
4830
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4827

def delete_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, opts = {})
  data, _status_code, _headers = delete_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option_id, opts)
  data
end

#delete_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option_id, opts = {}) ⇒ Array<(TrackingOptions, Integer, Hash)>

Allows you to delete a specified option for a specified tracking category

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • tracking_option_id (String) —

    Unique identifier for a Tracking Option

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrackingOptions, Integer, Hash)>) —

    TrackingOptions data, response status code and response headers



4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4838

def delete_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.delete_tracking_options ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.delete_tracking_options"
  end
  # verify the required parameter 'tracking_category_id' is set
  if @api_client.config.client_side_validation && tracking_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_category_id' when calling AccountingApi.delete_tracking_options"
  end
  # verify the required parameter 'tracking_option_id' is set
  if @api_client.config.client_side_validation && tracking_option_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_option_id' when calling AccountingApi.delete_tracking_options"
  end
  # resource path
  local_var_path = '/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}'.sub('{' + 'TrackingCategoryID' + '}', tracking_category_id.to_s).sub('{' + 'TrackingOptionID' + '}', tracking_option_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'TrackingOptions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#delete_tracking_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_invoice(xero_tenant_id, invoice_id, request_empty, opts = {}) ⇒ nil

Allows you to email a copy of invoice to related Contact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • request_empty (RequestEmpty)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


4906
4907
4908
4909
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4906

def email_invoice(xero_tenant_id, invoice_id, request_empty, opts = {})
  email_invoice_with_http_info(xero_tenant_id, invoice_id, request_empty, opts)
  nil
end

#email_invoice_with_http_info(xero_tenant_id, invoice_id, request_empty, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Allows you to email a copy of invoice to related Contact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • request_empty (RequestEmpty)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4917

def email_invoice_with_http_info(xero_tenant_id, invoice_id, request_empty, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.email_invoice ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.email_invoice"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.email_invoice"
  end
  # verify the required parameter 'request_empty' is set
  if @api_client.config.client_side_validation && request_empty.nil?
    fail ArgumentError, "Missing the required parameter 'request_empty' when calling AccountingApi.email_invoice"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/Email'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(request_empty) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#email_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account(xero_tenant_id, account_id, opts = {}) ⇒ Accounts

Allows you to retrieve a single chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for retrieving single object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Accounts) 


4986
4987
4988
4989
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4986

def (xero_tenant_id, , opts = {})
  data, _status_code, _headers = (xero_tenant_id, , opts)
  data
end

#get_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachment on Account by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • file_name (String) —

    Name of the attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


5061
5062
5063
5064
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5061

def (xero_tenant_id, , file_name, content_type, opts = {})
  data, _status_code, _headers = (xero_tenant_id, , file_name, content_type, opts)
  data
end

#get_account_attachment_by_file_name_with_http_info(xero_tenant_id, account_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachment on Account by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • file_name (String) —

    Name of the attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5073

def (xero_tenant_id, , file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_account_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_account_attachment_by_file_name"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountingApi.get_account_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_account_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_account_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Accounts/{AccountID}/Attachments/{FileName}'.sub('{' + 'AccountID' + '}', .to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_account_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_attachment_by_id(xero_tenant_id, account_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve specific Attachment on Account

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • attachment_id (String) —

    Unique identifier for Attachment object

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


5147
5148
5149
5150
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5147

def (xero_tenant_id, , attachment_id, content_type, opts = {})
  data, _status_code, _headers = (xero_tenant_id, , attachment_id, content_type, opts)
  data
end

#get_account_attachment_by_id_with_http_info(xero_tenant_id, account_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve specific Attachment on Account

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • attachment_id (String) —

    Unique identifier for Attachment object

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5159

def (xero_tenant_id, , attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_account_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_account_attachment_by_id"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountingApi.get_account_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_account_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_account_attachment_by_id"
  end
  # resource path
  local_var_path = '/Accounts/{AccountID}/Attachments/{AttachmentID}'.sub('{' + 'AccountID' + '}', .to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_account_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_attachments(xero_tenant_id, account_id, opts = {}) ⇒ Attachments

Allows you to retrieve Attachments for accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


5231
5232
5233
5234
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5231

def (xero_tenant_id, , opts = {})
  data, _status_code, _headers = (xero_tenant_id, , opts)
  data
end

#get_account_attachments_with_http_info(xero_tenant_id, account_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve Attachments for accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5241

def (xero_tenant_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_account_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_account_attachments"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountingApi.get_account_attachments"
  end
  # resource path
  local_var_path = '/Accounts/{AccountID}/Attachments'.sub('{' + 'AccountID' + '}', .to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_account_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_with_http_info(xero_tenant_id, account_id, opts = {}) ⇒ Array<(Accounts, Integer, Hash)>

Allows you to retrieve a single chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for retrieving single object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Accounts, Integer, Hash)>) —

    Accounts data, response status code and response headers



4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 4996

def (xero_tenant_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_account ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_account"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountingApi.get_account"
  end
  # resource path
  local_var_path = '/Accounts/{AccountID}'.sub('{' + 'AccountID' + '}', .to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Accounts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_accounts(xero_tenant_id, opts = {}) ⇒ Accounts

Allows you to retrieve the full chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Accounts) 


5306
5307
5308
5309
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5306

def get_accounts(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_accounts_with_http_info(xero_tenant_id, opts)
  data
end

#get_accounts_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Accounts, Integer, Hash)>

Allows you to retrieve the full chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(Accounts, Integer, Hash)>) —

    Accounts data, response status code and response headers



5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5318

def get_accounts_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_accounts ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_accounts"
  end
  # resource path
  local_var_path = '/Accounts'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Accounts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transaction(xero_tenant_id, bank_transaction_id, opts = {}) ⇒ BankTransactions

Allows you to retrieve a single spend or receive money transaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (BankTransactions) 


5381
5382
5383
5384
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5381

def get_bank_transaction(xero_tenant_id, bank_transaction_id, opts = {})
  data, _status_code, _headers = get_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, opts)
  data
end

#get_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on BankTransaction by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • file_name (String) —

    The name of the file being attached

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


5458
5459
5460
5461
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5458

def get_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, content_type, opts)
  data
end

#get_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on BankTransaction by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • file_name (String) —

    The name of the file being attached

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5470

def get_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transaction_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.get_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_bank_transaction_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}/Attachments/{FileName}'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transaction_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transaction_attachment_by_id(xero_tenant_id, bank_transaction_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on a specific BankTransaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • attachment_id (String) —

    Xero generated unique identifier for an attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


5544
5545
5546
5547
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5544

def get_bank_transaction_attachment_by_id(xero_tenant_id, bank_transaction_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_bank_transaction_attachment_by_id_with_http_info(xero_tenant_id, bank_transaction_id, attachment_id, content_type, opts)
  data
end

#get_bank_transaction_attachment_by_id_with_http_info(xero_tenant_id, bank_transaction_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on a specific BankTransaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • attachment_id (String) —

    Xero generated unique identifier for an attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5556

def get_bank_transaction_attachment_by_id_with_http_info(xero_tenant_id, bank_transaction_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transaction_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transaction_attachment_by_id"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.get_bank_transaction_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_bank_transaction_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_bank_transaction_attachment_by_id"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transaction_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transaction_attachments(xero_tenant_id, bank_transaction_id, opts = {}) ⇒ Attachments

Allows you to retrieve any attachments to bank transactions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


5628
5629
5630
5631
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5628

def get_bank_transaction_attachments(xero_tenant_id, bank_transaction_id, opts = {})
  data, _status_code, _headers = get_bank_transaction_attachments_with_http_info(xero_tenant_id, bank_transaction_id, opts)
  data
end

#get_bank_transaction_attachments_with_http_info(xero_tenant_id, bank_transaction_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve any attachments to bank transactions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5638

def get_bank_transaction_attachments_with_http_info(xero_tenant_id, bank_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transaction_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transaction_attachments"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.get_bank_transaction_attachments"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}/Attachments'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transaction_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, opts = {}) ⇒ Array<(BankTransactions, Integer, Hash)>

Allows you to retrieve a single spend or receive money transaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(BankTransactions, Integer, Hash)>) —

    BankTransactions data, response status code and response headers



5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5392

def get_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transaction ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transaction"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.get_bank_transaction"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'BankTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transactions(xero_tenant_id, opts = {}) ⇒ BankTransactions

Allows you to retrieve any spend or receive money transactions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    Up to 100 bank transactions will be returned in a single API call with line items details

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (BankTransactions) 


5705
5706
5707
5708
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5705

def get_bank_transactions(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_bank_transactions_with_http_info(xero_tenant_id, opts)
  data
end

#get_bank_transactions_history(xero_tenant_id, bank_transaction_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve history from a bank transactions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


5783
5784
5785
5786
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5783

def get_bank_transactions_history(xero_tenant_id, bank_transaction_id, opts = {})
  data, _status_code, _headers = get_bank_transactions_history_with_http_info(xero_tenant_id, bank_transaction_id, opts)
  data
end

#get_bank_transactions_history_with_http_info(xero_tenant_id, bank_transaction_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve history from a bank transactions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5793

def get_bank_transactions_history_with_http_info(xero_tenant_id, bank_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transactions_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transactions_history"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.get_bank_transactions_history"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}/History'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transactions_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transactions_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(BankTransactions, Integer, Hash)>

Allows you to retrieve any spend or receive money transactions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    Up to 100 bank transactions will be returned in a single API call with line items details

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(BankTransactions, Integer, Hash)>) —

    BankTransactions data, response status code and response headers



5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5719

def get_bank_transactions_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transactions ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transactions"
  end
  # resource path
  local_var_path = '/BankTransactions'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'BankTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transfer(xero_tenant_id, bank_transfer_id, opts = {}) ⇒ BankTransfers

Allows you to retrieve any bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (BankTransfers) 


5856
5857
5858
5859
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5856

def get_bank_transfer(xero_tenant_id, bank_transfer_id, opts = {})
  data, _status_code, _headers = get_bank_transfer_with_http_info(xero_tenant_id, bank_transfer_id, opts)
  data
end

#get_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on BankTransfer by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • file_name (String) —

    The name of the file being attached to a Bank Transfer

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


5931
5932
5933
5934
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5931

def get_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, content_type, opts)
  data
end

#get_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on BankTransfer by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • file_name (String) —

    The name of the file being attached to a Bank Transfer

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5943

def get_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transfer_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'bank_transfer_id' is set
  if @api_client.config.client_side_validation && bank_transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_id' when calling AccountingApi.get_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_bank_transfer_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/BankTransfers/{BankTransferID}/Attachments/{FileName}'.sub('{' + 'BankTransferID' + '}', bank_transfer_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transfer_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on BankTransfer

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • attachment_id (String) —

    Xero generated unique identifier for an Attachment to a bank transfer

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


6017
6018
6019
6020
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6017

def get_bank_transfer_attachment_by_id(xero_tenant_id, bank_transfer_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_bank_transfer_attachment_by_id_with_http_info(xero_tenant_id, bank_transfer_id, attachment_id, content_type, opts)
  data
end

#get_bank_transfer_attachment_by_id_with_http_info(xero_tenant_id, bank_transfer_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on BankTransfer

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • attachment_id (String) —

    Xero generated unique identifier for an Attachment to a bank transfer

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6029

def get_bank_transfer_attachment_by_id_with_http_info(xero_tenant_id, bank_transfer_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transfer_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transfer_attachment_by_id"
  end
  # verify the required parameter 'bank_transfer_id' is set
  if @api_client.config.client_side_validation && bank_transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_id' when calling AccountingApi.get_bank_transfer_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_bank_transfer_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_bank_transfer_attachment_by_id"
  end
  # resource path
  local_var_path = '/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}'.sub('{' + 'BankTransferID' + '}', bank_transfer_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transfer_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id, opts = {}) ⇒ Attachments

Allows you to retrieve Attachments from bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


6101
6102
6103
6104
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6101

def get_bank_transfer_attachments(xero_tenant_id, bank_transfer_id, opts = {})
  data, _status_code, _headers = get_bank_transfer_attachments_with_http_info(xero_tenant_id, bank_transfer_id, opts)
  data
end

#get_bank_transfer_attachments_with_http_info(xero_tenant_id, bank_transfer_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve Attachments from bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6111

def get_bank_transfer_attachments_with_http_info(xero_tenant_id, bank_transfer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transfer_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transfer_attachments"
  end
  # verify the required parameter 'bank_transfer_id' is set
  if @api_client.config.client_side_validation && bank_transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_id' when calling AccountingApi.get_bank_transfer_attachments"
  end
  # resource path
  local_var_path = '/BankTransfers/{BankTransferID}/Attachments'.sub('{' + 'BankTransferID' + '}', bank_transfer_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transfer_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transfer_history(xero_tenant_id, bank_transfer_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve history from a bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


6174
6175
6176
6177
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6174

def get_bank_transfer_history(xero_tenant_id, bank_transfer_id, opts = {})
  data, _status_code, _headers = get_bank_transfer_history_with_http_info(xero_tenant_id, bank_transfer_id, opts)
  data
end

#get_bank_transfer_history_with_http_info(xero_tenant_id, bank_transfer_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve history from a bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6184

def get_bank_transfer_history_with_http_info(xero_tenant_id, bank_transfer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transfer_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transfer_history"
  end
  # verify the required parameter 'bank_transfer_id' is set
  if @api_client.config.client_side_validation && bank_transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_id' when calling AccountingApi.get_bank_transfer_history"
  end
  # resource path
  local_var_path = '/BankTransfers/{BankTransferID}/History'.sub('{' + 'BankTransferID' + '}', bank_transfer_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transfer_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transfer_with_http_info(xero_tenant_id, bank_transfer_id, opts = {}) ⇒ Array<(BankTransfers, Integer, Hash)>

Allows you to retrieve any bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BankTransfers, Integer, Hash)>) —

    BankTransfers data, response status code and response headers



5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 5866

def get_bank_transfer_with_http_info(xero_tenant_id, bank_transfer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transfer ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transfer"
  end
  # verify the required parameter 'bank_transfer_id' is set
  if @api_client.config.client_side_validation && bank_transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_id' when calling AccountingApi.get_bank_transfer"
  end
  # resource path
  local_var_path = '/BankTransfers/{BankTransferID}'.sub('{' + 'BankTransferID' + '}', bank_transfer_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'BankTransfers' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bank_transfers(xero_tenant_id, opts = {}) ⇒ BankTransfers

Allows you to retrieve all bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (BankTransfers) 


6249
6250
6251
6252
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6249

def get_bank_transfers(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_bank_transfers_with_http_info(xero_tenant_id, opts)
  data
end

#get_bank_transfers_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(BankTransfers, Integer, Hash)>

Allows you to retrieve all bank transfers

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(BankTransfers, Integer, Hash)>) —

    BankTransfers data, response status code and response headers



6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6261

def get_bank_transfers_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_bank_transfers ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_bank_transfers"
  end
  # resource path
  local_var_path = '/BankTransfers'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'BankTransfers' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_bank_transfers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_batch_payment_history(xero_tenant_id, batch_payment_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve history from a Batch Payment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • batch_payment_id (String) —

    Unique identifier for BatchPayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


6323
6324
6325
6326
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6323

def get_batch_payment_history(xero_tenant_id, batch_payment_id, opts = {})
  data, _status_code, _headers = get_batch_payment_history_with_http_info(xero_tenant_id, batch_payment_id, opts)
  data
end

#get_batch_payment_history_with_http_info(xero_tenant_id, batch_payment_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve history from a Batch Payment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • batch_payment_id (String) —

    Unique identifier for BatchPayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6333

def get_batch_payment_history_with_http_info(xero_tenant_id, batch_payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_batch_payment_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_batch_payment_history"
  end
  # verify the required parameter 'batch_payment_id' is set
  if @api_client.config.client_side_validation && batch_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_payment_id' when calling AccountingApi.get_batch_payment_history"
  end
  # resource path
  local_var_path = '/BatchPayments/{BatchPaymentID}/History'.sub('{' + 'BatchPaymentID' + '}', batch_payment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_batch_payment_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_batch_payments(xero_tenant_id, opts = {}) ⇒ BatchPayments

Retrieve either one or many BatchPayments for invoices

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (BatchPayments) 


6398
6399
6400
6401
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6398

def get_batch_payments(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_batch_payments_with_http_info(xero_tenant_id, opts)
  data
end

#get_batch_payments_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(BatchPayments, Integer, Hash)>

Retrieve either one or many BatchPayments for invoices

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(BatchPayments, Integer, Hash)>) —

    BatchPayments data, response status code and response headers



6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6410

def get_batch_payments_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_batch_payments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_batch_payments"
  end
  # resource path
  local_var_path = '/BatchPayments'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'BatchPayments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_batch_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_branding_theme(xero_tenant_id, branding_theme_id, opts = {}) ⇒ BrandingThemes

Allows you to retrieve a specific BrandingThemes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • branding_theme_id (String) —

    Unique identifier for a Branding Theme

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (BrandingThemes) 


6472
6473
6474
6475
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6472

def get_branding_theme(xero_tenant_id, branding_theme_id, opts = {})
  data, _status_code, _headers = get_branding_theme_with_http_info(xero_tenant_id, branding_theme_id, opts)
  data
end

#get_branding_theme_payment_services(xero_tenant_id, branding_theme_id, opts = {}) ⇒ PaymentServices

Allows you to retrieve the Payment services for a Branding Theme

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • branding_theme_id (String) —

    Unique identifier for a Branding Theme

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (PaymentServices) 


6545
6546
6547
6548
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6545

def get_branding_theme_payment_services(xero_tenant_id, branding_theme_id, opts = {})
  data, _status_code, _headers = get_branding_theme_payment_services_with_http_info(xero_tenant_id, branding_theme_id, opts)
  data
end

#get_branding_theme_payment_services_with_http_info(xero_tenant_id, branding_theme_id, opts = {}) ⇒ Array<(PaymentServices, Integer, Hash)>

Allows you to retrieve the Payment services for a Branding Theme

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • branding_theme_id (String) —

    Unique identifier for a Branding Theme

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PaymentServices, Integer, Hash)>) —

    PaymentServices data, response status code and response headers



6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6555

def get_branding_theme_payment_services_with_http_info(xero_tenant_id, branding_theme_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_branding_theme_payment_services ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_branding_theme_payment_services"
  end
  # verify the required parameter 'branding_theme_id' is set
  if @api_client.config.client_side_validation && branding_theme_id.nil?
    fail ArgumentError, "Missing the required parameter 'branding_theme_id' when calling AccountingApi.get_branding_theme_payment_services"
  end
  # resource path
  local_var_path = '/BrandingThemes/{BrandingThemeID}/PaymentServices'.sub('{' + 'BrandingThemeID' + '}', branding_theme_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PaymentServices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_branding_theme_payment_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_branding_theme_with_http_info(xero_tenant_id, branding_theme_id, opts = {}) ⇒ Array<(BrandingThemes, Integer, Hash)>

Allows you to retrieve a specific BrandingThemes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • branding_theme_id (String) —

    Unique identifier for a Branding Theme

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BrandingThemes, Integer, Hash)>) —

    BrandingThemes data, response status code and response headers



6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6482

def get_branding_theme_with_http_info(xero_tenant_id, branding_theme_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_branding_theme ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_branding_theme"
  end
  # verify the required parameter 'branding_theme_id' is set
  if @api_client.config.client_side_validation && branding_theme_id.nil?
    fail ArgumentError, "Missing the required parameter 'branding_theme_id' when calling AccountingApi.get_branding_theme"
  end
  # resource path
  local_var_path = '/BrandingThemes/{BrandingThemeID}'.sub('{' + 'BrandingThemeID' + '}', branding_theme_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'BrandingThemes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_branding_theme\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_branding_themes(xero_tenant_id, opts = {}) ⇒ BrandingThemes

Allows you to retrieve all the BrandingThemes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (BrandingThemes) 


6617
6618
6619
6620
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6617

def get_branding_themes(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_branding_themes_with_http_info(xero_tenant_id, opts)
  data
end

#get_branding_themes_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(BrandingThemes, Integer, Hash)>

Allows you to retrieve all the BrandingThemes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BrandingThemes, Integer, Hash)>) —

    BrandingThemes data, response status code and response headers



6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6626

def get_branding_themes_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_branding_themes ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_branding_themes"
  end
  # resource path
  local_var_path = '/BrandingThemes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'BrandingThemes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_branding_themes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact(xero_tenant_id, contact_id, opts = {}) ⇒ Contacts

Allows you to retrieve a single contacts in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Contacts) 


6685
6686
6687
6688
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6685

def get_contact(xero_tenant_id, contact_id, opts = {})
  data, _status_code, _headers = get_contact_with_http_info(xero_tenant_id, contact_id, opts)
  data
end

#get_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on Contacts by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • file_name (String) —

    Name for the file you are attaching

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


6760
6761
6762
6763
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6760

def get_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, content_type, opts)
  data
end

#get_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on Contacts by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • file_name (String) —

    Name for the file you are attaching

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6772

def get_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_attachment_by_file_name"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.get_contact_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_contact_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_contact_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}/Attachments/{FileName}'.sub('{' + 'ContactID' + '}', contact_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_attachment_by_id(xero_tenant_id, contact_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on Contacts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


6846
6847
6848
6849
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6846

def get_contact_attachment_by_id(xero_tenant_id, contact_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_contact_attachment_by_id_with_http_info(xero_tenant_id, contact_id, attachment_id, content_type, opts)
  data
end

#get_contact_attachment_by_id_with_http_info(xero_tenant_id, contact_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on Contacts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6858

def get_contact_attachment_by_id_with_http_info(xero_tenant_id, contact_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_attachment_by_id"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.get_contact_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_contact_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_contact_attachment_by_id"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}/Attachments/{AttachmentID}'.sub('{' + 'ContactID' + '}', contact_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_attachments(xero_tenant_id, contact_id, opts = {}) ⇒ Attachments

Allows you to retrieve, add and update contacts in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


6930
6931
6932
6933
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6930

def get_contact_attachments(xero_tenant_id, contact_id, opts = {})
  data, _status_code, _headers = get_contact_attachments_with_http_info(xero_tenant_id, contact_id, opts)
  data
end

#get_contact_attachments_with_http_info(xero_tenant_id, contact_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve, add and update contacts in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6940

def get_contact_attachments_with_http_info(xero_tenant_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_attachments"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.get_contact_attachments"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}/Attachments'.sub('{' + 'ContactID' + '}', contact_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_by_contact_number(xero_tenant_id, contact_number, opts = {}) ⇒ Contacts

Allows you to retrieve a single contact by Contact Number in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_number (String) —

    This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Contacts) 


7003
7004
7005
7006
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7003

def get_contact_by_contact_number(xero_tenant_id, contact_number, opts = {})
  data, _status_code, _headers = get_contact_by_contact_number_with_http_info(xero_tenant_id, contact_number, opts)
  data
end

#get_contact_by_contact_number_with_http_info(xero_tenant_id, contact_number, opts = {}) ⇒ Array<(Contacts, Integer, Hash)>

Allows you to retrieve a single contact by Contact Number in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_number (String) —

    This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Contacts, Integer, Hash)>) —

    Contacts data, response status code and response headers



7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7013

def get_contact_by_contact_number_with_http_info(xero_tenant_id, contact_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_by_contact_number ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_by_contact_number"
  end
  # verify the required parameter 'contact_number' is set
  if @api_client.config.client_side_validation && contact_number.nil?
    fail ArgumentError, "Missing the required parameter 'contact_number' when calling AccountingApi.get_contact_by_contact_number"
  end
  # resource path
  local_var_path = '/Contacts/{ContactNumber}'.sub('{' + 'ContactNumber' + '}', contact_number.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Contacts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact_by_contact_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_cis_settings(xero_tenant_id, contact_id, opts = {}) ⇒ CISSettings

Allows you to retrieve CISSettings for a contact in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (CISSettings) 


7076
7077
7078
7079
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7076

def get_contact_cis_settings(xero_tenant_id, contact_id, opts = {})
  data, _status_code, _headers = get_contact_cis_settings_with_http_info(xero_tenant_id, contact_id, opts)
  data
end

#get_contact_cis_settings_with_http_info(xero_tenant_id, contact_id, opts = {}) ⇒ Array<(CISSettings, Integer, Hash)>

Allows you to retrieve CISSettings for a contact in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CISSettings, Integer, Hash)>) —

    CISSettings data, response status code and response headers



7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7086

def get_contact_cis_settings_with_http_info(xero_tenant_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_cis_settings ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_cis_settings"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.get_contact_cis_settings"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}/CISSettings'.sub('{' + 'ContactID' + '}', contact_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CISSettings' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact_cis_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_group(xero_tenant_id, contact_group_id, opts = {}) ⇒ ContactGroups

Allows you to retrieve a unique Contact Group by ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ContactGroups) 


7149
7150
7151
7152
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7149

def get_contact_group(xero_tenant_id, contact_group_id, opts = {})
  data, _status_code, _headers = get_contact_group_with_http_info(xero_tenant_id, contact_group_id, opts)
  data
end

#get_contact_group_with_http_info(xero_tenant_id, contact_group_id, opts = {}) ⇒ Array<(ContactGroups, Integer, Hash)>

Allows you to retrieve a unique Contact Group by ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactGroups, Integer, Hash)>) —

    ContactGroups data, response status code and response headers



7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7159

def get_contact_group_with_http_info(xero_tenant_id, contact_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_group ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_group"
  end
  # verify the required parameter 'contact_group_id' is set
  if @api_client.config.client_side_validation && contact_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_group_id' when calling AccountingApi.get_contact_group"
  end
  # resource path
  local_var_path = '/ContactGroups/{ContactGroupID}'.sub('{' + 'ContactGroupID' + '}', contact_group_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ContactGroups' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_groups(xero_tenant_id, opts = {}) ⇒ ContactGroups

Allows you to retrieve the ContactID and Name of all the contacts in a contact group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (ContactGroups) 


7223
7224
7225
7226
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7223

def get_contact_groups(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_contact_groups_with_http_info(xero_tenant_id, opts)
  data
end

#get_contact_groups_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ContactGroups, Integer, Hash)>

Allows you to retrieve the ContactID and Name of all the contacts in a contact group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(ContactGroups, Integer, Hash)>) —

    ContactGroups data, response status code and response headers



7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7234

def get_contact_groups_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_groups ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_groups"
  end
  # resource path
  local_var_path = '/ContactGroups'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ContactGroups' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_history(xero_tenant_id, contact_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an Contact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


7295
7296
7297
7298
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7295

def get_contact_history(xero_tenant_id, contact_id, opts = {})
  data, _status_code, _headers = get_contact_history_with_http_info(xero_tenant_id, contact_id, opts)
  data
end

#get_contact_history_with_http_info(xero_tenant_id, contact_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an Contact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7305

def get_contact_history_with_http_info(xero_tenant_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact_history"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.get_contact_history"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}/History'.sub('{' + 'ContactID' + '}', contact_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_with_http_info(xero_tenant_id, contact_id, opts = {}) ⇒ Array<(Contacts, Integer, Hash)>

Allows you to retrieve a single contacts in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Contacts, Integer, Hash)>) —

    Contacts data, response status code and response headers



6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 6695

def get_contact_with_http_info(xero_tenant_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contact ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contact"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.get_contact"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}'.sub('{' + 'ContactID' + '}', contact_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Contacts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contacts(xero_tenant_id, opts = {}) ⇒ Contacts

Allows you to retrieve all contacts in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :i_ds (Array<String>) —

    Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.

  • :page (Integer) —

    e.g. page=1 - Up to 100 contacts will be returned in a single API call.

  • :include_archived (Boolean) —

    e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response

Returns:

  • (Contacts) 


7373
7374
7375
7376
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7373

def get_contacts(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_contacts_with_http_info(xero_tenant_id, opts)
  data
end

#get_contacts_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Contacts, Integer, Hash)>

Allows you to retrieve all contacts in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :i_ds (Array<String>) —

    Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.

  • :page (Integer) —

    e.g. page=1 - Up to 100 contacts will be returned in a single API call.

  • :include_archived (Boolean) —

    e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response

Returns:

  • (Array<(Contacts, Integer, Hash)>) —

    Contacts data, response status code and response headers



7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7388

def get_contacts_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_contacts ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_contacts"
  end
  # resource path
  local_var_path = '/Contacts'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'i_ds'], :csv) if !opts[:'i_ds'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Contacts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note(xero_tenant_id, credit_note_id, opts = {}) ⇒ CreditNotes

Allows you to retrieve a specific credit note

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (CreditNotes) 


7454
7455
7456
7457
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7454

def get_credit_note(xero_tenant_id, credit_note_id, opts = {})
  data, _status_code, _headers = get_credit_note_with_http_info(xero_tenant_id, credit_note_id, opts)
  data
end

#get_credit_note_as_pdf(xero_tenant_id, credit_note_id, opts = {}) ⇒ File

Allows you to retrieve Credit Note as PDF files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


7529
7530
7531
7532
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7529

def get_credit_note_as_pdf(xero_tenant_id, credit_note_id, opts = {})
  data, _status_code, _headers = get_credit_note_as_pdf_with_http_info(xero_tenant_id, credit_note_id, opts)
  data
end

#get_credit_note_as_pdf_with_http_info(xero_tenant_id, credit_note_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Credit Note as PDF files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7539

def get_credit_note_as_pdf_with_http_info(xero_tenant_id, credit_note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_credit_note_as_pdf ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_credit_note_as_pdf"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.get_credit_note_as_pdf"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_credit_note_as_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on CreditNote by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • file_name (String) —

    Name of the file you are attaching to Credit Note

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


7604
7605
7606
7607
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7604

def get_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, content_type, opts)
  data
end

#get_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on CreditNote by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • file_name (String) —

    Name of the file you are attaching to Credit Note

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7616

def get_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_credit_note_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.get_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_credit_note_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}/Attachments/{FileName}'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_credit_note_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_attachment_by_id(xero_tenant_id, credit_note_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on CreditNote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


7690
7691
7692
7693
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7690

def get_credit_note_attachment_by_id(xero_tenant_id, credit_note_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_credit_note_attachment_by_id_with_http_info(xero_tenant_id, credit_note_id, attachment_id, content_type, opts)
  data
end

#get_credit_note_attachment_by_id_with_http_info(xero_tenant_id, credit_note_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on CreditNote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7702

def get_credit_note_attachment_by_id_with_http_info(xero_tenant_id, credit_note_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_credit_note_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_credit_note_attachment_by_id"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.get_credit_note_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_credit_note_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_credit_note_attachment_by_id"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_credit_note_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_attachments(xero_tenant_id, credit_note_id, opts = {}) ⇒ Attachments

Allows you to retrieve Attachments for credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


7774
7775
7776
7777
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7774

def get_credit_note_attachments(xero_tenant_id, credit_note_id, opts = {})
  data, _status_code, _headers = get_credit_note_attachments_with_http_info(xero_tenant_id, credit_note_id, opts)
  data
end

#get_credit_note_attachments_with_http_info(xero_tenant_id, credit_note_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve Attachments for credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7784

def get_credit_note_attachments_with_http_info(xero_tenant_id, credit_note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_credit_note_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_credit_note_attachments"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.get_credit_note_attachments"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}/Attachments'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_credit_note_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_history(xero_tenant_id, credit_note_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an CreditNote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


7847
7848
7849
7850
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7847

def get_credit_note_history(xero_tenant_id, credit_note_id, opts = {})
  data, _status_code, _headers = get_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, opts)
  data
end

#get_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an CreditNote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7857

def get_credit_note_history_with_http_info(xero_tenant_id, credit_note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_credit_note_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_credit_note_history"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.get_credit_note_history"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}/History'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_credit_note_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_note_with_http_info(xero_tenant_id, credit_note_id, opts = {}) ⇒ Array<(CreditNotes, Integer, Hash)>

Allows you to retrieve a specific credit note

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(CreditNotes, Integer, Hash)>) —

    CreditNotes data, response status code and response headers



7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7465

def get_credit_note_with_http_info(xero_tenant_id, credit_note_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_credit_note ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_credit_note"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.get_credit_note"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CreditNotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_credit_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_notes(xero_tenant_id, opts = {}) ⇒ CreditNotes

Allows you to retrieve any credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (CreditNotes) 


7924
7925
7926
7927
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7924

def get_credit_notes(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_credit_notes_with_http_info(xero_tenant_id, opts)
  data
end

#get_credit_notes_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(CreditNotes, Integer, Hash)>

Allows you to retrieve any credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(CreditNotes, Integer, Hash)>) —

    CreditNotes data, response status code and response headers



7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 7938

def get_credit_notes_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_credit_notes ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_credit_notes"
  end
  # resource path
  local_var_path = '/CreditNotes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CreditNotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_credit_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_currencies(xero_tenant_id, opts = {}) ⇒ Currencies

Allows you to retrieve currencies for your organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Currencies) 


8003
8004
8005
8006
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8003

def get_currencies(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_currencies_with_http_info(xero_tenant_id, opts)
  data
end

#get_currencies_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Currencies, Integer, Hash)>

Allows you to retrieve currencies for your organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(Currencies, Integer, Hash)>) —

    Currencies data, response status code and response headers



8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8014

def get_currencies_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_currencies ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_currencies"
  end
  # resource path
  local_var_path = '/Currencies'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Currencies' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_currencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee(xero_tenant_id, employee_id, opts = {}) ⇒ Employees

Allows you to retrieve a specific employee used in Xero payrun

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Unique identifier for a Employee

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Employees) 


8075
8076
8077
8078
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8075

def get_employee(xero_tenant_id, employee_id, opts = {})
  data, _status_code, _headers = get_employee_with_http_info(xero_tenant_id, employee_id, opts)
  data
end

#get_employee_with_http_info(xero_tenant_id, employee_id, opts = {}) ⇒ Array<(Employees, Integer, Hash)>

Allows you to retrieve a specific employee used in Xero payrun

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Unique identifier for a Employee

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Employees, Integer, Hash)>) —

    Employees data, response status code and response headers



8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8085

def get_employee_with_http_info(xero_tenant_id, employee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_employee ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_employee"
  end
  # verify the required parameter 'employee_id' is set
  if @api_client.config.client_side_validation && employee_id.nil?
    fail ArgumentError, "Missing the required parameter 'employee_id' when calling AccountingApi.get_employee"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Employees' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employees(xero_tenant_id, opts = {}) ⇒ Employees

Allows you to retrieve employees used in Xero payrun

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Employees) 


8150
8151
8152
8153
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8150

def get_employees(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_employees_with_http_info(xero_tenant_id, opts)
  data
end

#get_employees_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Employees, Integer, Hash)>

Allows you to retrieve employees used in Xero payrun

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(Employees, Integer, Hash)>) —

    Employees data, response status code and response headers



8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8162

def get_employees_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_employees ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_employees"
  end
  # resource path
  local_var_path = '/Employees'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Employees' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_employees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_expense_claim(xero_tenant_id, expense_claim_id, opts = {}) ⇒ ExpenseClaims

Allows you to retrieve a specified expense claim

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claim_id (String) —

    Unique identifier for a ExpenseClaim

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ExpenseClaims) 


8224
8225
8226
8227
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8224

def get_expense_claim(xero_tenant_id, expense_claim_id, opts = {})
  data, _status_code, _headers = get_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, opts)
  data
end

#get_expense_claim_history(xero_tenant_id, expense_claim_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an ExpenseClaim

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claim_id (String) —

    Unique identifier for a ExpenseClaim

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


8297
8298
8299
8300
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8297

def get_expense_claim_history(xero_tenant_id, expense_claim_id, opts = {})
  data, _status_code, _headers = get_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, opts)
  data
end

#get_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an ExpenseClaim

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claim_id (String) —

    Unique identifier for a ExpenseClaim

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8307

def get_expense_claim_history_with_http_info(xero_tenant_id, expense_claim_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_expense_claim_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_expense_claim_history"
  end
  # verify the required parameter 'expense_claim_id' is set
  if @api_client.config.client_side_validation && expense_claim_id.nil?
    fail ArgumentError, "Missing the required parameter 'expense_claim_id' when calling AccountingApi.get_expense_claim_history"
  end
  # resource path
  local_var_path = '/ExpenseClaims/{ExpenseClaimID}/History'.sub('{' + 'ExpenseClaimID' + '}', expense_claim_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_expense_claim_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, opts = {}) ⇒ Array<(ExpenseClaims, Integer, Hash)>

Allows you to retrieve a specified expense claim

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claim_id (String) —

    Unique identifier for a ExpenseClaim

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ExpenseClaims, Integer, Hash)>) —

    ExpenseClaims data, response status code and response headers



8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8234

def get_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_expense_claim ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_expense_claim"
  end
  # verify the required parameter 'expense_claim_id' is set
  if @api_client.config.client_side_validation && expense_claim_id.nil?
    fail ArgumentError, "Missing the required parameter 'expense_claim_id' when calling AccountingApi.get_expense_claim"
  end
  # resource path
  local_var_path = '/ExpenseClaims/{ExpenseClaimID}'.sub('{' + 'ExpenseClaimID' + '}', expense_claim_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ExpenseClaims' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_expense_claim\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_expense_claims(xero_tenant_id, opts = {}) ⇒ ExpenseClaims

Allows you to retrieve expense claims

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (ExpenseClaims) 


8372
8373
8374
8375
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8372

def get_expense_claims(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_expense_claims_with_http_info(xero_tenant_id, opts)
  data
end

#get_expense_claims_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ExpenseClaims, Integer, Hash)>

Allows you to retrieve expense claims

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(ExpenseClaims, Integer, Hash)>) —

    ExpenseClaims data, response status code and response headers



8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8384

def get_expense_claims_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_expense_claims ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_expense_claims"
  end
  # resource path
  local_var_path = '/ExpenseClaims'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ExpenseClaims' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_expense_claims\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice(xero_tenant_id, invoice_id, opts = {}) ⇒ Invoices

Allows you to retrieve a specified sales invoice or purchase bill

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Invoices) 


8447
8448
8449
8450
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8447

def get_invoice(xero_tenant_id, invoice_id, opts = {})
  data, _status_code, _headers = get_invoice_with_http_info(xero_tenant_id, invoice_id, opts)
  data
end

#get_invoice_as_pdf(xero_tenant_id, invoice_id, opts = {}) ⇒ File

Allows you to retrieve invoices or purchase bills as PDF files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


8522
8523
8524
8525
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8522

def get_invoice_as_pdf(xero_tenant_id, invoice_id, opts = {})
  data, _status_code, _headers = get_invoice_as_pdf_with_http_info(xero_tenant_id, invoice_id, opts)
  data
end

#get_invoice_as_pdf_with_http_info(xero_tenant_id, invoice_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve invoices or purchase bills as PDF files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8532

def get_invoice_as_pdf_with_http_info(xero_tenant_id, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_invoice_as_pdf ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_invoice_as_pdf"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.get_invoice_as_pdf"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_invoice_as_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachment on invoices or purchase bills by it's filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • file_name (String) —

    Name of the file you are attaching

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


8597
8598
8599
8600
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8597

def get_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, content_type, opts)
  data
end

#get_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachment on invoices or purchase bills by it's filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • file_name (String) —

    Name of the file you are attaching

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8609

def get_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_invoice_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.get_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_invoice_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/Attachments/{FileName}'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_invoice_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_attachment_by_id(xero_tenant_id, invoice_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • attachment_id (String) —

    Unique identifier for an Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


8683
8684
8685
8686
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8683

def get_invoice_attachment_by_id(xero_tenant_id, invoice_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_invoice_attachment_by_id_with_http_info(xero_tenant_id, invoice_id, attachment_id, content_type, opts)
  data
end

#get_invoice_attachment_by_id_with_http_info(xero_tenant_id, invoice_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve a specified Attachment on invoices or purchase bills by it's ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • attachment_id (String) —

    Unique identifier for an Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8695

def get_invoice_attachment_by_id_with_http_info(xero_tenant_id, invoice_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_invoice_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_invoice_attachment_by_id"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.get_invoice_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_invoice_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_invoice_attachment_by_id"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/Attachments/{AttachmentID}'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_invoice_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_attachments(xero_tenant_id, invoice_id, opts = {}) ⇒ Attachments

Allows you to retrieve Attachments on invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


8767
8768
8769
8770
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8767

def get_invoice_attachments(xero_tenant_id, invoice_id, opts = {})
  data, _status_code, _headers = get_invoice_attachments_with_http_info(xero_tenant_id, invoice_id, opts)
  data
end

#get_invoice_attachments_with_http_info(xero_tenant_id, invoice_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve Attachments on invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8777

def get_invoice_attachments_with_http_info(xero_tenant_id, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_invoice_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_invoice_attachments"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.get_invoice_attachments"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/Attachments'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_invoice_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_history(xero_tenant_id, invoice_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


8840
8841
8842
8843
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8840

def get_invoice_history(xero_tenant_id, invoice_id, opts = {})
  data, _status_code, _headers = get_invoice_history_with_http_info(xero_tenant_id, invoice_id, opts)
  data
end

#get_invoice_history_with_http_info(xero_tenant_id, invoice_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8850

def get_invoice_history_with_http_info(xero_tenant_id, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_invoice_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_invoice_history"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.get_invoice_history"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/History'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_invoice_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_reminders(xero_tenant_id, opts = {}) ⇒ InvoiceReminders

Allows you to retrieve invoice reminder settings

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InvoiceReminders) 


8912
8913
8914
8915
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8912

def get_invoice_reminders(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_invoice_reminders_with_http_info(xero_tenant_id, opts)
  data
end

#get_invoice_reminders_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(InvoiceReminders, Integer, Hash)>

Allows you to retrieve invoice reminder settings

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InvoiceReminders, Integer, Hash)>) —

    InvoiceReminders data, response status code and response headers



8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8921

def get_invoice_reminders_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_invoice_reminders ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_invoice_reminders"
  end
  # resource path
  local_var_path = '/InvoiceReminders/Settings'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InvoiceReminders' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_invoice_reminders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_with_http_info(xero_tenant_id, invoice_id, opts = {}) ⇒ Array<(Invoices, Integer, Hash)>

Allows you to retrieve a specified sales invoice or purchase bill

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Invoices, Integer, Hash)>) —

    Invoices data, response status code and response headers



8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8458

def get_invoice_with_http_info(xero_tenant_id, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_invoice ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_invoice"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.get_invoice"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Invoices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoices(xero_tenant_id, opts = {}) ⇒ Invoices

Allows you to retrieve any sales invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :i_ds (Array<String>) —

    Filter by a comma-separated list of InvoicesIDs.

  • :invoice_numbers (Array<String>) —

    Filter by a comma-separated list of InvoiceNumbers.

  • :contact_i_ds (Array<String>) —

    Filter by a comma-separated list of ContactIDs.

  • :statuses (Array<String>) —

    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.

  • :page (Integer) —

    e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice

  • :include_archived (Boolean) —

    e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response

  • :created_by_my_app (Boolean) —

    When set to true you'll only retrieve Invoices created by your app

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Invoices) 


8990
8991
8992
8993
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 8990

def get_invoices(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_invoices_with_http_info(xero_tenant_id, opts)
  data
end

#get_invoices_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Invoices, Integer, Hash)>

Allows you to retrieve any sales invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :i_ds (Array<String>) —

    Filter by a comma-separated list of InvoicesIDs.

  • :invoice_numbers (Array<String>) —

    Filter by a comma-separated list of InvoiceNumbers.

  • :contact_i_ds (Array<String>) —

    Filter by a comma-separated list of ContactIDs.

  • :statuses (Array<String>) —

    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.

  • :page (Integer) —

    e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice

  • :include_archived (Boolean) —

    e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response

  • :created_by_my_app (Boolean) —

    When set to true you'll only retrieve Invoices created by your app

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Invoices, Integer, Hash)>) —

    Invoices data, response status code and response headers



9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9010

def get_invoices_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_invoices ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_invoices"
  end
  # resource path
  local_var_path = '/Invoices'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'i_ds'], :csv) if !opts[:'i_ds'].nil?
  query_params[:'InvoiceNumbers'] = @api_client.build_collection_param(opts[:'invoice_numbers'], :csv) if !opts[:'invoice_numbers'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_i_ds'], :csv) if !opts[:'contact_i_ds'].nil?
  query_params[:'Statuses'] = @api_client.build_collection_param(opts[:'statuses'], :csv) if !opts[:'statuses'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
  query_params[:'createdByMyApp'] = opts[:'created_by_my_app'] if !opts[:'created_by_my_app'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Invoices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_item(xero_tenant_id, item_id, opts = {}) ⇒ Items

Allows you to retrieve a specified item

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Items) 


9081
9082
9083
9084
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9081

def get_item(xero_tenant_id, item_id, opts = {})
  data, _status_code, _headers = get_item_with_http_info(xero_tenant_id, item_id, opts)
  data
end

#get_item_history(xero_tenant_id, item_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve history for items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


9156
9157
9158
9159
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9156

def get_item_history(xero_tenant_id, item_id, opts = {})
  data, _status_code, _headers = get_item_history_with_http_info(xero_tenant_id, item_id, opts)
  data
end

#get_item_history_with_http_info(xero_tenant_id, item_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve history for items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9166

def get_item_history_with_http_info(xero_tenant_id, item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_item_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_item_history"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling AccountingApi.get_item_history"
  end
  # resource path
  local_var_path = '/Items/{ItemID}/History'.sub('{' + 'ItemID' + '}', item_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_item_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_item_with_http_info(xero_tenant_id, item_id, opts = {}) ⇒ Array<(Items, Integer, Hash)>

Allows you to retrieve a specified item

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Items, Integer, Hash)>) —

    Items data, response status code and response headers



9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9092

def get_item_with_http_info(xero_tenant_id, item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_item ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_item"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling AccountingApi.get_item"
  end
  # resource path
  local_var_path = '/Items/{ItemID}'.sub('{' + 'ItemID' + '}', item_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Items' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_items(xero_tenant_id, opts = {}) ⇒ Items

Allows you to retrieve any items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Items) 


9232
9233
9234
9235
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9232

def get_items(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_items_with_http_info(xero_tenant_id, opts)
  data
end

#get_items_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Items, Integer, Hash)>

Allows you to retrieve any items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Items, Integer, Hash)>) —

    Items data, response status code and response headers



9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9245

def get_items_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_items ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_items"
  end
  # resource path
  local_var_path = '/Items'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Items' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_journal(xero_tenant_id, journal_id, opts = {}) ⇒ Journals

Allows you to retrieve a specified journals.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • journal_id (String) —

    Unique identifier for a Journal

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Journals) 


9308
9309
9310
9311
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9308

def get_journal(xero_tenant_id, journal_id, opts = {})
  data, _status_code, _headers = get_journal_with_http_info(xero_tenant_id, journal_id, opts)
  data
end

#get_journal_with_http_info(xero_tenant_id, journal_id, opts = {}) ⇒ Array<(Journals, Integer, Hash)>

Allows you to retrieve a specified journals.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • journal_id (String) —

    Unique identifier for a Journal

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Journals, Integer, Hash)>) —

    Journals data, response status code and response headers



9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9318

def get_journal_with_http_info(xero_tenant_id, journal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_journal ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_journal"
  end
  # verify the required parameter 'journal_id' is set
  if @api_client.config.client_side_validation && journal_id.nil?
    fail ArgumentError, "Missing the required parameter 'journal_id' when calling AccountingApi.get_journal"
  end
  # resource path
  local_var_path = '/Journals/{JournalID}'.sub('{' + 'JournalID' + '}', journal_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Journals' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_journal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_journals(xero_tenant_id, opts = {}) ⇒ Journals

Allows you to retrieve any journals.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :offset (Integer) —

    Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned

  • :payments_only (Boolean) —

    Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.

Returns:

  • (Journals) 


9383
9384
9385
9386
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9383

def get_journals(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_journals_with_http_info(xero_tenant_id, opts)
  data
end

#get_journals_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Journals, Integer, Hash)>

Allows you to retrieve any journals.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :offset (Integer) —

    Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned

  • :payments_only (Boolean) —

    Filter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.

Returns:

  • (Array<(Journals, Integer, Hash)>) —

    Journals data, response status code and response headers



9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9395

def get_journals_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_journals ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_journals"
  end
  # resource path
  local_var_path = '/Journals'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'paymentsOnly'] = opts[:'payments_only'] if !opts[:'payments_only'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Journals' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_journals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_linked_transaction(xero_tenant_id, linked_transaction_id, opts = {}) ⇒ LinkedTransactions

Allows you to retrieve a specified linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • linked_transaction_id (String) —

    Unique identifier for a LinkedTransaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (LinkedTransactions) 


9457
9458
9459
9460
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9457

def get_linked_transaction(xero_tenant_id, linked_transaction_id, opts = {})
  data, _status_code, _headers = get_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, opts)
  data
end

#get_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, opts = {}) ⇒ Array<(LinkedTransactions, Integer, Hash)>

Allows you to retrieve a specified linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • linked_transaction_id (String) —

    Unique identifier for a LinkedTransaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LinkedTransactions, Integer, Hash)>) —

    LinkedTransactions data, response status code and response headers



9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9467

def get_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_linked_transaction ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_linked_transaction"
  end
  # verify the required parameter 'linked_transaction_id' is set
  if @api_client.config.client_side_validation && linked_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'linked_transaction_id' when calling AccountingApi.get_linked_transaction"
  end
  # resource path
  local_var_path = '/LinkedTransactions/{LinkedTransactionID}'.sub('{' + 'LinkedTransactionID' + '}', linked_transaction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'LinkedTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_linked_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_linked_transactions(xero_tenant_id, opts = {}) ⇒ LinkedTransactions

Retrieve linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    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.

  • :linked_transaction_id (String) —

    The Xero identifier for an Linked Transaction

  • :source_transaction_id (String) —

    Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice

  • :contact_id (String) —

    Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.

  • :status (String) —

    Filter by the combination of ContactID and Status. Get the linked transactions associaed to a customer and with a status

  • :target_transaction_id (String) —

    Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice

Returns:

  • (LinkedTransactions) 


9535
9536
9537
9538
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9535

def get_linked_transactions(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_linked_transactions_with_http_info(xero_tenant_id, opts)
  data
end

#get_linked_transactions_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(LinkedTransactions, Integer, Hash)>

Retrieve linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    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.

  • :linked_transaction_id (String) —

    The Xero identifier for an Linked Transaction

  • :source_transaction_id (String) —

    Filter by the SourceTransactionID. Get the linked transactions created from a particular ACCPAY invoice

  • :contact_id (String) —

    Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.

  • :status (String) —

    Filter by the combination of ContactID and Status. Get the linked transactions associaed to a customer and with a status

  • :target_transaction_id (String) —

    Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice

Returns:

  • (Array<(LinkedTransactions, Integer, Hash)>) —

    LinkedTransactions data, response status code and response headers



9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9550

def get_linked_transactions_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_linked_transactions ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_linked_transactions"
  end
  # resource path
  local_var_path = '/LinkedTransactions'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'LinkedTransactionID'] = opts[:'linked_transaction_id'] if !opts[:'linked_transaction_id'].nil?
  query_params[:'SourceTransactionID'] = opts[:'source_transaction_id'] if !opts[:'source_transaction_id'].nil?
  query_params[:'ContactID'] = opts[:'contact_id'] if !opts[:'contact_id'].nil?
  query_params[:'Status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'TargetTransactionID'] = opts[:'target_transaction_id'] if !opts[:'target_transaction_id'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'LinkedTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_linked_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_manual_journal(xero_tenant_id, manual_journal_id, opts = {}) ⇒ ManualJournals

Allows you to retrieve a specified manual journals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ManualJournals) 


9615
9616
9617
9618
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9615

def get_manual_journal(xero_tenant_id, manual_journal_id, opts = {})
  data, _status_code, _headers = get_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, opts)
  data
end

#get_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve specified Attachment on ManualJournal by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • file_name (String) —

    The name of the file being attached to a ManualJournal

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


9690
9691
9692
9693
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9690

def get_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, content_type, opts)
  data
end

#get_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve specified Attachment on ManualJournal by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • file_name (String) —

    The name of the file being attached to a ManualJournal

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9702

def get_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_manual_journal_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'manual_journal_id' is set
  if @api_client.config.client_side_validation && manual_journal_id.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journal_id' when calling AccountingApi.get_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_manual_journal_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/ManualJournals/{ManualJournalID}/Attachments/{FileName}'.sub('{' + 'ManualJournalID' + '}', manual_journal_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_manual_journal_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_manual_journal_attachment_by_id(xero_tenant_id, manual_journal_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve specified Attachment on ManualJournals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


9776
9777
9778
9779
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9776

def get_manual_journal_attachment_by_id(xero_tenant_id, manual_journal_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_manual_journal_attachment_by_id_with_http_info(xero_tenant_id, manual_journal_id, attachment_id, content_type, opts)
  data
end

#get_manual_journal_attachment_by_id_with_http_info(xero_tenant_id, manual_journal_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve specified Attachment on ManualJournals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9788

def get_manual_journal_attachment_by_id_with_http_info(xero_tenant_id, manual_journal_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_manual_journal_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_manual_journal_attachment_by_id"
  end
  # verify the required parameter 'manual_journal_id' is set
  if @api_client.config.client_side_validation && manual_journal_id.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journal_id' when calling AccountingApi.get_manual_journal_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_manual_journal_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_manual_journal_attachment_by_id"
  end
  # resource path
  local_var_path = '/ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}'.sub('{' + 'ManualJournalID' + '}', manual_journal_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_manual_journal_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_manual_journal_attachments(xero_tenant_id, manual_journal_id, opts = {}) ⇒ Attachments

Allows you to retrieve Attachment for manual journals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


9860
9861
9862
9863
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9860

def get_manual_journal_attachments(xero_tenant_id, manual_journal_id, opts = {})
  data, _status_code, _headers = get_manual_journal_attachments_with_http_info(xero_tenant_id, manual_journal_id, opts)
  data
end

#get_manual_journal_attachments_with_http_info(xero_tenant_id, manual_journal_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve Attachment for manual journals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9870

def get_manual_journal_attachments_with_http_info(xero_tenant_id, manual_journal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_manual_journal_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_manual_journal_attachments"
  end
  # verify the required parameter 'manual_journal_id' is set
  if @api_client.config.client_side_validation && manual_journal_id.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journal_id' when calling AccountingApi.get_manual_journal_attachments"
  end
  # resource path
  local_var_path = '/ManualJournals/{ManualJournalID}/Attachments'.sub('{' + 'ManualJournalID' + '}', manual_journal_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_manual_journal_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, opts = {}) ⇒ Array<(ManualJournals, Integer, Hash)>

Allows you to retrieve a specified manual journals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ManualJournals, Integer, Hash)>) —

    ManualJournals data, response status code and response headers



9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9625

def get_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_manual_journal ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_manual_journal"
  end
  # verify the required parameter 'manual_journal_id' is set
  if @api_client.config.client_side_validation && manual_journal_id.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journal_id' when calling AccountingApi.get_manual_journal"
  end
  # resource path
  local_var_path = '/ManualJournals/{ManualJournalID}'.sub('{' + 'ManualJournalID' + '}', manual_journal_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ManualJournals' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_manual_journal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_manual_journals(xero_tenant_id, opts = {}) ⇒ ManualJournals

Allows you to retrieve any manual journals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment

Returns:

  • (ManualJournals) 


9936
9937
9938
9939
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9936

def get_manual_journals(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_manual_journals_with_http_info(xero_tenant_id, opts)
  data
end

#get_manual_journals_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ManualJournals, Integer, Hash)>

Allows you to retrieve any manual journals

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment

Returns:

  • (Array<(ManualJournals, Integer, Hash)>) —

    ManualJournals data, response status code and response headers



9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 9949

def get_manual_journals_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_manual_journals ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_manual_journals"
  end
  # resource path
  local_var_path = '/ManualJournals'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ManualJournals' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_manual_journals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_online_invoice(xero_tenant_id, invoice_id, opts = {}) ⇒ OnlineInvoices

Allows you to retrieve a URL to an online invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (OnlineInvoices) 


10012
10013
10014
10015
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10012

def get_online_invoice(xero_tenant_id, invoice_id, opts = {})
  data, _status_code, _headers = get_online_invoice_with_http_info(xero_tenant_id, invoice_id, opts)
  data
end

#get_online_invoice_with_http_info(xero_tenant_id, invoice_id, opts = {}) ⇒ Array<(OnlineInvoices, Integer, Hash)>

Allows you to retrieve a URL to an online invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OnlineInvoices, Integer, Hash)>) —

    OnlineInvoices data, response status code and response headers



10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10022

def get_online_invoice_with_http_info(xero_tenant_id, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_online_invoice ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_online_invoice"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.get_online_invoice"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/OnlineInvoice'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'OnlineInvoices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_online_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organisation_cis_settings(xero_tenant_id, organisation_id, opts = {}) ⇒ CISOrgSetting

Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • organisation_id (String) —

    The unique Xero identifier for an organisation

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (CISOrgSetting) 


10085
10086
10087
10088
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10085

def get_organisation_cis_settings(xero_tenant_id, organisation_id, opts = {})
  data, _status_code, _headers = get_organisation_cis_settings_with_http_info(xero_tenant_id, organisation_id, opts)
  data
end

#get_organisation_cis_settings_with_http_info(xero_tenant_id, organisation_id, opts = {}) ⇒ Array<(CISOrgSetting, Integer, Hash)>

Allows you To verify if an organisation is using contruction industry scheme, you can retrieve the CIS settings for the organistaion.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • organisation_id (String) —

    The unique Xero identifier for an organisation

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CISOrgSetting, Integer, Hash)>) —

    CISOrgSetting data, response status code and response headers



10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10095

def get_organisation_cis_settings_with_http_info(xero_tenant_id, organisation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_organisation_cis_settings ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_organisation_cis_settings"
  end
  # verify the required parameter 'organisation_id' is set
  if @api_client.config.client_side_validation && organisation_id.nil?
    fail ArgumentError, "Missing the required parameter 'organisation_id' when calling AccountingApi.get_organisation_cis_settings"
  end
  # resource path
  local_var_path = '/Organisation/{OrganisationID}/CISSettings'.sub('{' + 'OrganisationID' + '}', organisation_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CISOrgSetting' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_organisation_cis_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organisations(xero_tenant_id, opts = {}) ⇒ Organisations

Allows you to retrieve Organisation details

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Organisations) 


10157
10158
10159
10160
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10157

def get_organisations(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_organisations_with_http_info(xero_tenant_id, opts)
  data
end

#get_organisations_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Organisations, Integer, Hash)>

Allows you to retrieve Organisation details

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Organisations, Integer, Hash)>) —

    Organisations data, response status code and response headers



10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10166

def get_organisations_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_organisations ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_organisations"
  end
  # resource path
  local_var_path = '/Organisation'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Organisations' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_organisations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_overpayment(xero_tenant_id, overpayment_id, opts = {}) ⇒ Overpayments

Allows you to retrieve a specified overpayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • overpayment_id (String) —

    Unique identifier for a Overpayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Overpayments) 


10225
10226
10227
10228
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10225

def get_overpayment(xero_tenant_id, overpayment_id, opts = {})
  data, _status_code, _headers = get_overpayment_with_http_info(xero_tenant_id, overpayment_id, opts)
  data
end

#get_overpayment_history(xero_tenant_id, overpayment_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an Overpayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • overpayment_id (String) —

    Unique identifier for a Overpayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


10298
10299
10300
10301
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10298

def get_overpayment_history(xero_tenant_id, overpayment_id, opts = {})
  data, _status_code, _headers = get_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, opts)
  data
end

#get_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an Overpayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • overpayment_id (String) —

    Unique identifier for a Overpayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10308

def get_overpayment_history_with_http_info(xero_tenant_id, overpayment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_overpayment_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_overpayment_history"
  end
  # verify the required parameter 'overpayment_id' is set
  if @api_client.config.client_side_validation && overpayment_id.nil?
    fail ArgumentError, "Missing the required parameter 'overpayment_id' when calling AccountingApi.get_overpayment_history"
  end
  # resource path
  local_var_path = '/Overpayments/{OverpaymentID}/History'.sub('{' + 'OverpaymentID' + '}', overpayment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_overpayment_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_overpayment_with_http_info(xero_tenant_id, overpayment_id, opts = {}) ⇒ Array<(Overpayments, Integer, Hash)>

Allows you to retrieve a specified overpayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • overpayment_id (String) —

    Unique identifier for a Overpayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Overpayments, Integer, Hash)>) —

    Overpayments data, response status code and response headers



10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10235

def get_overpayment_with_http_info(xero_tenant_id, overpayment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_overpayment ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_overpayment"
  end
  # verify the required parameter 'overpayment_id' is set
  if @api_client.config.client_side_validation && overpayment_id.nil?
    fail ArgumentError, "Missing the required parameter 'overpayment_id' when calling AccountingApi.get_overpayment"
  end
  # resource path
  local_var_path = '/Overpayments/{OverpaymentID}'.sub('{' + 'OverpaymentID' + '}', overpayment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Overpayments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_overpayment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_overpayments(xero_tenant_id, opts = {}) ⇒ Overpayments

Allows you to retrieve overpayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Overpayments) 


10375
10376
10377
10378
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10375

def get_overpayments(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_overpayments_with_http_info(xero_tenant_id, opts)
  data
end

#get_overpayments_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Overpayments, Integer, Hash)>

Allows you to retrieve overpayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Overpayments, Integer, Hash)>) —

    Overpayments data, response status code and response headers



10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10389

def get_overpayments_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_overpayments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_overpayments"
  end
  # resource path
  local_var_path = '/Overpayments'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Overpayments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_overpayments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment(xero_tenant_id, payment_id, opts = {}) ⇒ Payments

Allows you to retrieve a specified payment for invoices and credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_id (String) —

    Unique identifier for a Payment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Payments) 


10453
10454
10455
10456
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10453

def get_payment(xero_tenant_id, payment_id, opts = {})
  data, _status_code, _headers = get_payment_with_http_info(xero_tenant_id, payment_id, opts)
  data
end

#get_payment_history(xero_tenant_id, payment_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve history records of a payment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_id (String) —

    Unique identifier for a Payment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


10526
10527
10528
10529
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10526

def get_payment_history(xero_tenant_id, payment_id, opts = {})
  data, _status_code, _headers = get_payment_history_with_http_info(xero_tenant_id, payment_id, opts)
  data
end

#get_payment_history_with_http_info(xero_tenant_id, payment_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve history records of a payment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_id (String) —

    Unique identifier for a Payment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10536

def get_payment_history_with_http_info(xero_tenant_id, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_payment_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_payment_history"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling AccountingApi.get_payment_history"
  end
  # resource path
  local_var_path = '/Payments/{PaymentID}/History'.sub('{' + 'PaymentID' + '}', payment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_payment_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_services(xero_tenant_id, opts = {}) ⇒ PaymentServices

Allows you to retrieve payment services

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (PaymentServices) 


10598
10599
10600
10601
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10598

def get_payment_services(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_payment_services_with_http_info(xero_tenant_id, opts)
  data
end

#get_payment_services_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(PaymentServices, Integer, Hash)>

Allows you to retrieve payment services

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PaymentServices, Integer, Hash)>) —

    PaymentServices data, response status code and response headers



10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10607

def get_payment_services_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_payment_services ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_payment_services"
  end
  # resource path
  local_var_path = '/PaymentServices'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PaymentServices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_payment_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_with_http_info(xero_tenant_id, payment_id, opts = {}) ⇒ Array<(Payments, Integer, Hash)>

Allows you to retrieve a specified payment for invoices and credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payment_id (String) —

    Unique identifier for a Payment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Payments, Integer, Hash)>) —

    Payments data, response status code and response headers



10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10463

def get_payment_with_http_info(xero_tenant_id, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_payment ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_payment"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling AccountingApi.get_payment"
  end
  # resource path
  local_var_path = '/Payments/{PaymentID}'.sub('{' + 'PaymentID' + '}', payment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Payments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payments(xero_tenant_id, opts = {}) ⇒ Payments

Allows you to retrieve payments for invoices and credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    Up to 100 payments will be returned in a single API call

Returns:

  • (Payments) 


10669
10670
10671
10672
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10669

def get_payments(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_payments_with_http_info(xero_tenant_id, opts)
  data
end

#get_payments_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Payments, Integer, Hash)>

Allows you to retrieve payments for invoices and credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    Up to 100 payments will be returned in a single API call

Returns:

  • (Array<(Payments, Integer, Hash)>) —

    Payments data, response status code and response headers



10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10682

def get_payments_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_payments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_payments"
  end
  # resource path
  local_var_path = '/Payments'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Payments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prepayment(xero_tenant_id, prepayment_id, opts = {}) ⇒ Prepayments

Allows you to retrieve a specified prepayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • prepayment_id (String) —

    Unique identifier for a PrePayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Prepayments) 


10745
10746
10747
10748
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10745

def get_prepayment(xero_tenant_id, prepayment_id, opts = {})
  data, _status_code, _headers = get_prepayment_with_http_info(xero_tenant_id, prepayment_id, opts)
  data
end

#get_prepayment_history(xero_tenant_id, prepayment_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an Prepayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • prepayment_id (String) —

    Unique identifier for a PrePayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


10818
10819
10820
10821
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10818

def get_prepayment_history(xero_tenant_id, prepayment_id, opts = {})
  data, _status_code, _headers = get_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, opts)
  data
end

#get_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an Prepayment

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • prepayment_id (String) —

    Unique identifier for a PrePayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10828

def get_prepayment_history_with_http_info(xero_tenant_id, prepayment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_prepayment_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_prepayment_history"
  end
  # verify the required parameter 'prepayment_id' is set
  if @api_client.config.client_side_validation && prepayment_id.nil?
    fail ArgumentError, "Missing the required parameter 'prepayment_id' when calling AccountingApi.get_prepayment_history"
  end
  # resource path
  local_var_path = '/Prepayments/{PrepaymentID}/History'.sub('{' + 'PrepaymentID' + '}', prepayment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_prepayment_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prepayment_with_http_info(xero_tenant_id, prepayment_id, opts = {}) ⇒ Array<(Prepayments, Integer, Hash)>

Allows you to retrieve a specified prepayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • prepayment_id (String) —

    Unique identifier for a PrePayment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Prepayments, Integer, Hash)>) —

    Prepayments data, response status code and response headers



10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10755

def get_prepayment_with_http_info(xero_tenant_id, prepayment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_prepayment ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_prepayment"
  end
  # verify the required parameter 'prepayment_id' is set
  if @api_client.config.client_side_validation && prepayment_id.nil?
    fail ArgumentError, "Missing the required parameter 'prepayment_id' when calling AccountingApi.get_prepayment"
  end
  # resource path
  local_var_path = '/Prepayments/{PrepaymentID}'.sub('{' + 'PrepaymentID' + '}', prepayment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Prepayments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_prepayment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prepayments(xero_tenant_id, opts = {}) ⇒ Prepayments

Allows you to retrieve prepayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Prepayments) 


10895
10896
10897
10898
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10895

def get_prepayments(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_prepayments_with_http_info(xero_tenant_id, opts)
  data
end

#get_prepayments_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Prepayments, Integer, Hash)>

Allows you to retrieve prepayments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Prepayments, Integer, Hash)>) —

    Prepayments data, response status code and response headers



10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10909

def get_prepayments_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_prepayments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_prepayments"
  end
  # resource path
  local_var_path = '/Prepayments'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Prepayments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_prepayments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_purchase_order(xero_tenant_id, purchase_order_id, opts = {}) ⇒ PurchaseOrders

Allows you to retrieve a specified purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for a PurchaseOrder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (PurchaseOrders) 


10973
10974
10975
10976
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10973

def get_purchase_order(xero_tenant_id, purchase_order_id, opts = {})
  data, _status_code, _headers = get_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, opts)
  data
end

#get_purchase_order_as_pdf(xero_tenant_id, purchase_order_id, opts = {}) ⇒ File

Allows you to retrieve purchase orders as PDF files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for an Purchase Order

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


11046
11047
11048
11049
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11046

def get_purchase_order_as_pdf(xero_tenant_id, purchase_order_id, opts = {})
  data, _status_code, _headers = get_purchase_order_as_pdf_with_http_info(xero_tenant_id, purchase_order_id, opts)
  data
end

#get_purchase_order_as_pdf_with_http_info(xero_tenant_id, purchase_order_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve purchase orders as PDF files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for an Purchase Order

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11056

def get_purchase_order_as_pdf_with_http_info(xero_tenant_id, purchase_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_purchase_order_as_pdf ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_purchase_order_as_pdf"
  end
  # verify the required parameter 'purchase_order_id' is set
  if @api_client.config.client_side_validation && purchase_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_order_id' when calling AccountingApi.get_purchase_order_as_pdf"
  end
  # resource path
  local_var_path = '/PurchaseOrders/{PurchaseOrderID}'.sub('{' + 'PurchaseOrderID' + '}', purchase_order_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_purchase_order_as_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_purchase_order_by_number(xero_tenant_id, purchase_order_number, opts = {}) ⇒ PurchaseOrders

Allows you to retrieve a specified purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_number (String) —

    Unique identifier for a PurchaseOrder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (PurchaseOrders) 


11119
11120
11121
11122
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11119

def get_purchase_order_by_number(xero_tenant_id, purchase_order_number, opts = {})
  data, _status_code, _headers = get_purchase_order_by_number_with_http_info(xero_tenant_id, purchase_order_number, opts)
  data
end

#get_purchase_order_by_number_with_http_info(xero_tenant_id, purchase_order_number, opts = {}) ⇒ Array<(PurchaseOrders, Integer, Hash)>

Allows you to retrieve a specified purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_number (String) —

    Unique identifier for a PurchaseOrder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PurchaseOrders, Integer, Hash)>) —

    PurchaseOrders data, response status code and response headers



11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11129

def get_purchase_order_by_number_with_http_info(xero_tenant_id, purchase_order_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_purchase_order_by_number ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_purchase_order_by_number"
  end
  # verify the required parameter 'purchase_order_number' is set
  if @api_client.config.client_side_validation && purchase_order_number.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_order_number' when calling AccountingApi.get_purchase_order_by_number"
  end
  # resource path
  local_var_path = '/PurchaseOrders/{PurchaseOrderNumber}'.sub('{' + 'PurchaseOrderNumber' + '}', purchase_order_number.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PurchaseOrders' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_purchase_order_by_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_purchase_order_history(xero_tenant_id, purchase_order_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve history for PurchaseOrder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for a PurchaseOrder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


11192
11193
11194
11195
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11192

def get_purchase_order_history(xero_tenant_id, purchase_order_id, opts = {})
  data, _status_code, _headers = get_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, opts)
  data
end

#get_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve history for PurchaseOrder

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for a PurchaseOrder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11202

def get_purchase_order_history_with_http_info(xero_tenant_id, purchase_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_purchase_order_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_purchase_order_history"
  end
  # verify the required parameter 'purchase_order_id' is set
  if @api_client.config.client_side_validation && purchase_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_order_id' when calling AccountingApi.get_purchase_order_history"
  end
  # resource path
  local_var_path = '/PurchaseOrders/{PurchaseOrderID}/History'.sub('{' + 'PurchaseOrderID' + '}', purchase_order_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_purchase_order_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, opts = {}) ⇒ Array<(PurchaseOrders, Integer, Hash)>

Allows you to retrieve a specified purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for a PurchaseOrder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PurchaseOrders, Integer, Hash)>) —

    PurchaseOrders data, response status code and response headers



10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 10983

def get_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_purchase_order ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_purchase_order"
  end
  # verify the required parameter 'purchase_order_id' is set
  if @api_client.config.client_side_validation && purchase_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_order_id' when calling AccountingApi.get_purchase_order"
  end
  # resource path
  local_var_path = '/PurchaseOrders/{PurchaseOrderID}'.sub('{' + 'PurchaseOrderID' + '}', purchase_order_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PurchaseOrders' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_purchase_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_purchase_orders(xero_tenant_id, opts = {}) ⇒ PurchaseOrders

Allows you to retrieve purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :status (String) —

    Filter by purchase order status

  • :date_from (String) —

    Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31

  • :date_to (String) —

    Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.

Returns:

  • (PurchaseOrders) 


11270
11271
11272
11273
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11270

def get_purchase_orders(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_purchase_orders_with_http_info(xero_tenant_id, opts)
  data
end

#get_purchase_orders_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(PurchaseOrders, Integer, Hash)>

Allows you to retrieve purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :status (String) —

    Filter by purchase order status

  • :date_from (String) —

    Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31

  • :date_to (String) —

    Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31

  • :order (String) —

    Order by an any element

  • :page (Integer) —

    To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.

Returns:

  • (Array<(PurchaseOrders, Integer, Hash)>) —

    PurchaseOrders data, response status code and response headers



11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11285

def get_purchase_orders_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_purchase_orders ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_purchase_orders"
  end
  allowable_values = ["DRAFT", "SUBMITTED", "AUTHORISED", "BILLED", "DELETED"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/PurchaseOrders'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'Status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'DateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'DateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PurchaseOrders' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_purchase_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quote(xero_tenant_id, quote_id, opts = {}) ⇒ Quotes

Allows you to retrieve a specified quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Quotes) 


11354
11355
11356
11357
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11354

def get_quote(xero_tenant_id, quote_id, opts = {})
  data, _status_code, _headers = get_quote_with_http_info(xero_tenant_id, quote_id, opts)
  data
end

#get_quote_as_pdf(xero_tenant_id, quote_id, opts = {}) ⇒ File

Allows you to retrieve quotes as PDF files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


11427
11428
11429
11430
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11427

def get_quote_as_pdf(xero_tenant_id, quote_id, opts = {})
  data, _status_code, _headers = get_quote_as_pdf_with_http_info(xero_tenant_id, quote_id, opts)
  data
end

#get_quote_as_pdf_with_http_info(xero_tenant_id, quote_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve quotes as PDF files

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11437

def get_quote_as_pdf_with_http_info(xero_tenant_id, quote_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_quote_as_pdf ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_quote_as_pdf"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.get_quote_as_pdf"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}'.sub('{' + 'QuoteID' + '}', quote_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_quote_as_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachment on Quote by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • file_name (String) —

    Name of the attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


11502
11503
11504
11505
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11502

def get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, content_type, opts)
  data
end

#get_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachment on Quote by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • file_name (String) —

    Name of the attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11514

def get_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_quote_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_quote_attachment_by_file_name"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.get_quote_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_quote_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_quote_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}/Attachments/{FileName}'.sub('{' + 'QuoteID' + '}', quote_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_quote_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quote_attachment_by_id(xero_tenant_id, quote_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve specific Attachment on Quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • attachment_id (String) —

    Unique identifier for Attachment object

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


11588
11589
11590
11591
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11588

def get_quote_attachment_by_id(xero_tenant_id, quote_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_quote_attachment_by_id_with_http_info(xero_tenant_id, quote_id, attachment_id, content_type, opts)
  data
end

#get_quote_attachment_by_id_with_http_info(xero_tenant_id, quote_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve specific Attachment on Quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • attachment_id (String) —

    Unique identifier for Attachment object

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11600

def get_quote_attachment_by_id_with_http_info(xero_tenant_id, quote_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_quote_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_quote_attachment_by_id"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.get_quote_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_quote_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_quote_attachment_by_id"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}/Attachments/{AttachmentID}'.sub('{' + 'QuoteID' + '}', quote_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_quote_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quote_attachments(xero_tenant_id, quote_id, opts = {}) ⇒ Attachments

Allows you to retrieve Attachments for Quotes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


11672
11673
11674
11675
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11672

def get_quote_attachments(xero_tenant_id, quote_id, opts = {})
  data, _status_code, _headers = get_quote_attachments_with_http_info(xero_tenant_id, quote_id, opts)
  data
end

#get_quote_attachments_with_http_info(xero_tenant_id, quote_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve Attachments for Quotes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11682

def get_quote_attachments_with_http_info(xero_tenant_id, quote_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_quote_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_quote_attachments"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.get_quote_attachments"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}/Attachments'.sub('{' + 'QuoteID' + '}', quote_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_quote_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quote_history(xero_tenant_id, quote_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


11745
11746
11747
11748
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11745

def get_quote_history(xero_tenant_id, quote_id, opts = {})
  data, _status_code, _headers = get_quote_history_with_http_info(xero_tenant_id, quote_id, opts)
  data
end

#get_quote_history_with_http_info(xero_tenant_id, quote_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11755

def get_quote_history_with_http_info(xero_tenant_id, quote_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_quote_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_quote_history"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.get_quote_history"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}/History'.sub('{' + 'QuoteID' + '}', quote_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_quote_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quote_with_http_info(xero_tenant_id, quote_id, opts = {}) ⇒ Array<(Quotes, Integer, Hash)>

Allows you to retrieve a specified quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Quotes, Integer, Hash)>) —

    Quotes data, response status code and response headers



11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11364

def get_quote_with_http_info(xero_tenant_id, quote_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_quote ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_quote"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.get_quote"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}'.sub('{' + 'QuoteID' + '}', quote_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Quotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_quote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_quotes(xero_tenant_id, opts = {}) ⇒ Quotes

Allows you to retrieve any sales quotes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :date_from (Date) —

    Filter for quotes after a particular date

  • :date_to (Date) —

    Filter for quotes before a particular date

  • :expiry_date_from (Date) —

    Filter for quotes expiring after a particular date

  • :expiry_date_to (Date) —

    Filter for quotes before a particular date

  • :contact_id (String) —

    Filter for quotes belonging to a particular contact

  • :status (String) —

    Filter for quotes of a particular Status

  • :page (Integer) —

    e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote

  • :order (String) —

    Order by an any element

Returns:

  • (Quotes) 


11826
11827
11828
11829
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11826

def get_quotes(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_quotes_with_http_info(xero_tenant_id, opts)
  data
end

#get_quotes_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Quotes, Integer, Hash)>

Allows you to retrieve any sales quotes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :date_from (Date) —

    Filter for quotes after a particular date

  • :date_to (Date) —

    Filter for quotes before a particular date

  • :expiry_date_from (Date) —

    Filter for quotes expiring after a particular date

  • :expiry_date_to (Date) —

    Filter for quotes before a particular date

  • :contact_id (String) —

    Filter for quotes belonging to a particular contact

  • :status (String) —

    Filter for quotes of a particular Status

  • :page (Integer) —

    e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(Quotes, Integer, Hash)>) —

    Quotes data, response status code and response headers



11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11844

def get_quotes_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_quotes ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_quotes"
  end
  # resource path
  local_var_path = '/Quotes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'DateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'DateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'ExpiryDateFrom'] = opts[:'expiry_date_from'] if !opts[:'expiry_date_from'].nil?
  query_params[:'ExpiryDateTo'] = opts[:'expiry_date_to'] if !opts[:'expiry_date_to'].nil?
  query_params[:'ContactID'] = opts[:'contact_id'] if !opts[:'contact_id'].nil?
  query_params[:'Status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Quotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_quotes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipt(xero_tenant_id, receipt_id, opts = {}) ⇒ Receipts

Allows you to retrieve a specified draft expense claim receipts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Receipts) 


11913
11914
11915
11916
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11913

def get_receipt(xero_tenant_id, receipt_id, opts = {})
  data, _status_code, _headers = get_receipt_with_http_info(xero_tenant_id, receipt_id, opts)
  data
end

#get_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on expense claim receipts by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • file_name (String) —

    The name of the file being attached to the Receipt

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


11990
11991
11992
11993
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11990

def get_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, content_type, opts)
  data
end

#get_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on expense claim receipts by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • file_name (String) —

    The name of the file being attached to the Receipt

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12002

def get_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_receipt_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.get_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_receipt_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}/Attachments/{FileName}'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_receipt_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipt_attachment_by_id(xero_tenant_id, receipt_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve Attachments on expense claim receipts by ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


12076
12077
12078
12079
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12076

def get_receipt_attachment_by_id(xero_tenant_id, receipt_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_receipt_attachment_by_id_with_http_info(xero_tenant_id, receipt_id, attachment_id, content_type, opts)
  data
end

#get_receipt_attachment_by_id_with_http_info(xero_tenant_id, receipt_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve Attachments on expense claim receipts by ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12088

def get_receipt_attachment_by_id_with_http_info(xero_tenant_id, receipt_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_receipt_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_receipt_attachment_by_id"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.get_receipt_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_receipt_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_receipt_attachment_by_id"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}/Attachments/{AttachmentID}'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_receipt_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipt_attachments(xero_tenant_id, receipt_id, opts = {}) ⇒ Attachments

Allows you to retrieve Attachments for expense claim receipts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


12160
12161
12162
12163
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12160

def get_receipt_attachments(xero_tenant_id, receipt_id, opts = {})
  data, _status_code, _headers = get_receipt_attachments_with_http_info(xero_tenant_id, receipt_id, opts)
  data
end

#get_receipt_attachments_with_http_info(xero_tenant_id, receipt_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve Attachments for expense claim receipts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12170

def get_receipt_attachments_with_http_info(xero_tenant_id, receipt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_receipt_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_receipt_attachments"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.get_receipt_attachments"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}/Attachments'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_receipt_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipt_history(xero_tenant_id, receipt_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve a history records of an Receipt

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


12233
12234
12235
12236
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12233

def get_receipt_history(xero_tenant_id, receipt_id, opts = {})
  data, _status_code, _headers = get_receipt_history_with_http_info(xero_tenant_id, receipt_id, opts)
  data
end

#get_receipt_history_with_http_info(xero_tenant_id, receipt_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve a history records of an Receipt

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12243

def get_receipt_history_with_http_info(xero_tenant_id, receipt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_receipt_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_receipt_history"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.get_receipt_history"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}/History'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_receipt_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipt_with_http_info(xero_tenant_id, receipt_id, opts = {}) ⇒ Array<(Receipts, Integer, Hash)>

Allows you to retrieve a specified draft expense claim receipts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Receipts, Integer, Hash)>) —

    Receipts data, response status code and response headers



11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 11924

def get_receipt_with_http_info(xero_tenant_id, receipt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_receipt ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_receipt"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.get_receipt"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Receipts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipts(xero_tenant_id, opts = {}) ⇒ Receipts

Allows you to retrieve draft expense claim receipts for any user

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Receipts) 


12309
12310
12311
12312
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12309

def get_receipts(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_receipts_with_http_info(xero_tenant_id, opts)
  data
end

#get_receipts_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Receipts, Integer, Hash)>

Allows you to retrieve draft expense claim receipts for any user

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Receipts, Integer, Hash)>) —

    Receipts data, response status code and response headers



12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12322

def get_receipts_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_receipts ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_receipts"
  end
  # resource path
  local_var_path = '/Receipts'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Receipts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_receipts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_repeating_invoice(xero_tenant_id, repeating_invoice_id, opts = {}) ⇒ RepeatingInvoices

Allows you to retrieve a specified repeating invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (RepeatingInvoices) 


12385
12386
12387
12388
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12385

def get_repeating_invoice(xero_tenant_id, repeating_invoice_id, opts = {})
  data, _status_code, _headers = get_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id, opts)
  data
end

#get_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, content_type, opts = {}) ⇒ File

Allows you to retrieve specified attachment on repeating invoices by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • file_name (String) —

    The name of the file being attached to a Repeating Invoice

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


12460
12461
12462
12463
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12460

def get_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, content_type, opts = {})
  data, _status_code, _headers = get_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, content_type, opts)
  data
end

#get_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve specified attachment on repeating invoices by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • file_name (String) —

    The name of the file being attached to a Repeating Invoice

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12472

def get_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_repeating_invoice_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'repeating_invoice_id' is set
  if @api_client.config.client_side_validation && repeating_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.get_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.get_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_repeating_invoice_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_repeating_invoice_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_repeating_invoice_attachment_by_id(xero_tenant_id, repeating_invoice_id, attachment_id, content_type, opts = {}) ⇒ File

Allows you to retrieve a specified Attachments on repeating invoices

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


12546
12547
12548
12549
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12546

def get_repeating_invoice_attachment_by_id(xero_tenant_id, repeating_invoice_id, attachment_id, content_type, opts = {})
  data, _status_code, _headers = get_repeating_invoice_attachment_by_id_with_http_info(xero_tenant_id, repeating_invoice_id, attachment_id, content_type, opts)
  data
end

#get_repeating_invoice_attachment_by_id_with_http_info(xero_tenant_id, repeating_invoice_id, attachment_id, content_type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Allows you to retrieve a specified Attachments on repeating invoices

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • attachment_id (String) —

    Unique identifier for a Attachment

  • content_type (String) —

    The mime type of the attachment file you are retrieving i.e image/jpg, application/pdf

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12558

def get_repeating_invoice_attachment_by_id_with_http_info(xero_tenant_id, repeating_invoice_id, attachment_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_repeating_invoice_attachment_by_id ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_repeating_invoice_attachment_by_id"
  end
  # verify the required parameter 'repeating_invoice_id' is set
  if @api_client.config.client_side_validation && repeating_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.get_repeating_invoice_attachment_by_id"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AccountingApi.get_repeating_invoice_attachment_by_id"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AccountingApi.get_repeating_invoice_attachment_by_id"
  end
  # resource path
  local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s).sub('{' + 'AttachmentID' + '}', attachment_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'contentType'] = content_type

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'File' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_repeating_invoice_attachment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_repeating_invoice_attachments(xero_tenant_id, repeating_invoice_id, opts = {}) ⇒ Attachments

Allows you to retrieve Attachments on repeating invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


12630
12631
12632
12633
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12630

def get_repeating_invoice_attachments(xero_tenant_id, repeating_invoice_id, opts = {})
  data, _status_code, _headers = get_repeating_invoice_attachments_with_http_info(xero_tenant_id, repeating_invoice_id, opts)
  data
end

#get_repeating_invoice_attachments_with_http_info(xero_tenant_id, repeating_invoice_id, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to retrieve Attachments on repeating invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12640

def get_repeating_invoice_attachments_with_http_info(xero_tenant_id, repeating_invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_repeating_invoice_attachments ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_repeating_invoice_attachments"
  end
  # verify the required parameter 'repeating_invoice_id' is set
  if @api_client.config.client_side_validation && repeating_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.get_repeating_invoice_attachments"
  end
  # resource path
  local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_repeating_invoice_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, opts = {}) ⇒ HistoryRecords

Allows you to retrieve history for a repeating invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (HistoryRecords) 


12703
12704
12705
12706
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12703

def get_repeating_invoice_history(xero_tenant_id, repeating_invoice_id, opts = {})
  data, _status_code, _headers = get_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_invoice_id, opts)
  data
end

#get_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_invoice_id, opts = {}) ⇒ Array<(HistoryRecords, Integer, Hash)>

Allows you to retrieve history for a repeating invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HistoryRecords, Integer, Hash)>) —

    HistoryRecords data, response status code and response headers



12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12713

def get_repeating_invoice_history_with_http_info(xero_tenant_id, repeating_invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_repeating_invoice_history ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_repeating_invoice_history"
  end
  # verify the required parameter 'repeating_invoice_id' is set
  if @api_client.config.client_side_validation && repeating_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.get_repeating_invoice_history"
  end
  # resource path
  local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}/History'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'HistoryRecords' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_repeating_invoice_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id, opts = {}) ⇒ Array<(RepeatingInvoices, Integer, Hash)>

Allows you to retrieve a specified repeating invoice

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RepeatingInvoices, Integer, Hash)>) —

    RepeatingInvoices data, response status code and response headers



12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12395

def get_repeating_invoice_with_http_info(xero_tenant_id, repeating_invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_repeating_invoice ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_repeating_invoice"
  end
  # verify the required parameter 'repeating_invoice_id' is set
  if @api_client.config.client_side_validation && repeating_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.get_repeating_invoice"
  end
  # resource path
  local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'RepeatingInvoices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_repeating_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_repeating_invoices(xero_tenant_id, opts = {}) ⇒ RepeatingInvoices

Allows you to retrieve any repeating invoices

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (RepeatingInvoices) 


12777
12778
12779
12780
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12777

def get_repeating_invoices(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_repeating_invoices_with_http_info(xero_tenant_id, opts)
  data
end

#get_repeating_invoices_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(RepeatingInvoices, Integer, Hash)>

Allows you to retrieve any repeating invoices

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(RepeatingInvoices, Integer, Hash)>) —

    RepeatingInvoices data, response status code and response headers



12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12788

def get_repeating_invoices_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_repeating_invoices ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_repeating_invoices"
  end
  # resource path
  local_var_path = '/RepeatingInvoices'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'RepeatingInvoices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_repeating_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_aged_payables_by_contact(xero_tenant_id, contact_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for AgedPayablesByContact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date of the Aged Payables By Contact report

  • :from_date (Date) —

    The from date of the Aged Payables By Contact report

  • :to_date (Date) —

    The to date of the Aged Payables By Contact report

Returns:

  • (ReportWithRows) 


12852
12853
12854
12855
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12852

def get_report_aged_payables_by_contact(xero_tenant_id, contact_id, opts = {})
  data, _status_code, _headers = get_report_aged_payables_by_contact_with_http_info(xero_tenant_id, contact_id, opts)
  data
end

#get_report_aged_payables_by_contact_with_http_info(xero_tenant_id, contact_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for AgedPayablesByContact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date of the Aged Payables By Contact report

  • :from_date (Date) —

    The from date of the Aged Payables By Contact report

  • :to_date (Date) —

    The to date of the Aged Payables By Contact report

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12865

def get_report_aged_payables_by_contact_with_http_info(xero_tenant_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_aged_payables_by_contact ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_aged_payables_by_contact"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.get_report_aged_payables_by_contact"
  end
  # resource path
  local_var_path = '/Reports/AgedPayablesByContact'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'contactId'] = contact_id
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_aged_payables_by_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_aged_receivables_by_contact(xero_tenant_id, contact_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for AgedReceivablesByContact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date of the Aged Receivables By Contact report

  • :from_date (Date) —

    The from date of the Aged Receivables By Contact report

  • :to_date (Date) —

    The to date of the Aged Receivables By Contact report

Returns:

  • (ReportWithRows) 


12935
12936
12937
12938
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12935

def get_report_aged_receivables_by_contact(xero_tenant_id, contact_id, opts = {})
  data, _status_code, _headers = get_report_aged_receivables_by_contact_with_http_info(xero_tenant_id, contact_id, opts)
  data
end

#get_report_aged_receivables_by_contact_with_http_info(xero_tenant_id, contact_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for AgedReceivablesByContact

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date of the Aged Receivables By Contact report

  • :from_date (Date) —

    The from date of the Aged Receivables By Contact report

  • :to_date (Date) —

    The to date of the Aged Receivables By Contact report

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 12948

def get_report_aged_receivables_by_contact_with_http_info(xero_tenant_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_aged_receivables_by_contact ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_aged_receivables_by_contact"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.get_report_aged_receivables_by_contact"
  end
  # resource path
  local_var_path = '/Reports/AgedReceivablesByContact'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'contactId'] = contact_id
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_aged_receivables_by_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_ba_sor_gst(xero_tenant_id, report_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for BAS only valid for AU orgs

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • report_id (String) —

    Unique identifier for a Report

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ReportWithRows) 


13015
13016
13017
13018
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13015

def get_report_ba_sor_gst(xero_tenant_id, report_id, opts = {})
  data, _status_code, _headers = get_report_ba_sor_gst_with_http_info(xero_tenant_id, report_id, opts)
  data
end

#get_report_ba_sor_gst_list(xero_tenant_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for BAS only valid for AU orgs

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ReportWithRows) 


13087
13088
13089
13090
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13087

def get_report_ba_sor_gst_list(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_report_ba_sor_gst_list_with_http_info(xero_tenant_id, opts)
  data
end

#get_report_ba_sor_gst_list_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for BAS only valid for AU orgs

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13096

def get_report_ba_sor_gst_list_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_ba_sor_gst_list ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_ba_sor_gst_list"
  end
  # resource path
  local_var_path = '/Reports'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_ba_sor_gst_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_ba_sor_gst_with_http_info(xero_tenant_id, report_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for BAS only valid for AU orgs

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • report_id (String) —

    Unique identifier for a Report

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13025

def get_report_ba_sor_gst_with_http_info(xero_tenant_id, report_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_ba_sor_gst ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_ba_sor_gst"
  end
  # verify the required parameter 'report_id' is set
  if @api_client.config.client_side_validation && report_id.nil?
    fail ArgumentError, "Missing the required parameter 'report_id' when calling AccountingApi.get_report_ba_sor_gst"
  end
  # resource path
  local_var_path = '/Reports/{ReportID}'.sub('{' + 'ReportID' + '}', report_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_ba_sor_gst\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_balance_sheet(xero_tenant_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for BalanceSheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (String) —

    The date of the Balance Sheet report

  • :periods (Integer) —

    The number of periods for the Balance Sheet report

  • :timeframe (String) —

    The period size to compare to (MONTH, QUARTER, YEAR)

  • :tracking_option_id1 (String) —

    The tracking option 1 for the Balance Sheet report

  • :tracking_option_id2 (String) —

    The tracking option 2 for the Balance Sheet report

  • :standard_layout (Boolean) —

    The standard layout boolean for the Balance Sheet report

  • :payments_only (Boolean) —

    return a cash basis for the Balance Sheet report

Returns:

  • (ReportWithRows) 


13161
13162
13163
13164
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13161

def get_report_balance_sheet(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_report_balance_sheet_with_http_info(xero_tenant_id, opts)
  data
end

#get_report_balance_sheet_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for BalanceSheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (String) —

    The date of the Balance Sheet report

  • :periods (Integer) —

    The number of periods for the Balance Sheet report

  • :timeframe (String) —

    The period size to compare to (MONTH, QUARTER, YEAR)

  • :tracking_option_id1 (String) —

    The tracking option 1 for the Balance Sheet report

  • :tracking_option_id2 (String) —

    The tracking option 2 for the Balance Sheet report

  • :standard_layout (Boolean) —

    The standard layout boolean for the Balance Sheet report

  • :payments_only (Boolean) —

    return a cash basis for the Balance Sheet report

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13177

def get_report_balance_sheet_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_balance_sheet ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_balance_sheet"
  end
  allowable_values = ["MONTH", "QUARTER", "YEAR"]
  if @api_client.config.client_side_validation && opts[:'timeframe'] && !allowable_values.include?(opts[:'timeframe'])
    fail ArgumentError, "invalid value for \"timeframe\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/Reports/BalanceSheet'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  query_params[:'periods'] = opts[:'periods'] if !opts[:'periods'].nil?
  query_params[:'timeframe'] = opts[:'timeframe'] if !opts[:'timeframe'].nil?
  query_params[:'trackingOptionID1'] = opts[:'tracking_option_id1'] if !opts[:'tracking_option_id1'].nil?
  query_params[:'trackingOptionID2'] = opts[:'tracking_option_id2'] if !opts[:'tracking_option_id2'].nil?
  query_params[:'standardLayout'] = opts[:'standard_layout'] if !opts[:'standard_layout'].nil?
  query_params[:'paymentsOnly'] = opts[:'payments_only'] if !opts[:'payments_only'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_balance_sheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_bank_summary(xero_tenant_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for BankSummary

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from_date (Date) —

    The from date for the Bank Summary report e.g. 2018-03-31

  • :to_date (Date) —

    The to date for the Bank Summary report e.g. 2018-03-31

Returns:

  • (ReportWithRows) 


13248
13249
13250
13251
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13248

def get_report_bank_summary(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_report_bank_summary_with_http_info(xero_tenant_id, opts)
  data
end

#get_report_bank_summary_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for BankSummary

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from_date (Date) —

    The from date for the Bank Summary report e.g. 2018-03-31

  • :to_date (Date) —

    The to date for the Bank Summary report e.g. 2018-03-31

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13259

def get_report_bank_summary_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_bank_summary ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_bank_summary"
  end
  # resource path
  local_var_path = '/Reports/BankSummary'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_bank_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_budget_summary(xero_tenant_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for Budget Summary

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date for the Bank Summary report e.g. 2018-03-31

  • :period (Integer) —

    The number of periods to compare (integer between 1 and 12)

  • :timeframe (Integer) —

    The period size to compare to (1=month, 3=quarter, 12=year)

Returns:

  • (ReportWithRows) 


13322
13323
13324
13325
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13322

def get_report_budget_summary(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_report_budget_summary_with_http_info(xero_tenant_id, opts)
  data
end

#get_report_budget_summary_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for Budget Summary

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date for the Bank Summary report e.g. 2018-03-31

  • :period (Integer) —

    The number of periods to compare (integer between 1 and 12)

  • :timeframe (Integer) —

    The period size to compare to (1=month, 3=quarter, 12=year)

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13334

def get_report_budget_summary_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_budget_summary ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_budget_summary"
  end
  # resource path
  local_var_path = '/Reports/BudgetSummary'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'timeframe'] = opts[:'timeframe'] if !opts[:'timeframe'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_budget_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_executive_summary(xero_tenant_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for ExecutiveSummary

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date for the Bank Summary report e.g. 2018-03-31

Returns:

  • (ReportWithRows) 


13396
13397
13398
13399
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13396

def get_report_executive_summary(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_report_executive_summary_with_http_info(xero_tenant_id, opts)
  data
end

#get_report_executive_summary_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for ExecutiveSummary

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date for the Bank Summary report e.g. 2018-03-31

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13406

def get_report_executive_summary_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_executive_summary ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_executive_summary"
  end
  # resource path
  local_var_path = '/Reports/ExecutiveSummary'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_executive_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_profit_and_loss(xero_tenant_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for ProfitAndLoss

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from_date (Date) —

    The from date for the ProfitAndLoss report e.g. 2018-03-31

  • :to_date (Date) —

    The to date for the ProfitAndLoss report e.g. 2018-03-31

  • :periods (Integer) —

    The number of periods to compare (integer between 1 and 12)

  • :timeframe (String) —

    The period size to compare to (MONTH, QUARTER, YEAR)

  • :tracking_category_id (String) —

    The trackingCategory 1 for the ProfitAndLoss report

  • :tracking_category_id2 (String) —

    The trackingCategory 2 for the ProfitAndLoss report

  • :tracking_option_id (String) —

    The tracking option 1 for the ProfitAndLoss report

  • :tracking_option_id2 (String) —

    The tracking option 2 for the ProfitAndLoss report

  • :standard_layout (Boolean) —

    Return the standard layout for the ProfitAndLoss report

  • :payments_only (Boolean) —

    Return cash only basis for the ProfitAndLoss report

Returns:

  • (ReportWithRows) 


13475
13476
13477
13478
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13475

def get_report_profit_and_loss(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_report_profit_and_loss_with_http_info(xero_tenant_id, opts)
  data
end

#get_report_profit_and_loss_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for ProfitAndLoss

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from_date (Date) —

    The from date for the ProfitAndLoss report e.g. 2018-03-31

  • :to_date (Date) —

    The to date for the ProfitAndLoss report e.g. 2018-03-31

  • :periods (Integer) —

    The number of periods to compare (integer between 1 and 12)

  • :timeframe (String) —

    The period size to compare to (MONTH, QUARTER, YEAR)

  • :tracking_category_id (String) —

    The trackingCategory 1 for the ProfitAndLoss report

  • :tracking_category_id2 (String) —

    The trackingCategory 2 for the ProfitAndLoss report

  • :tracking_option_id (String) —

    The tracking option 1 for the ProfitAndLoss report

  • :tracking_option_id2 (String) —

    The tracking option 2 for the ProfitAndLoss report

  • :standard_layout (Boolean) —

    Return the standard layout for the ProfitAndLoss report

  • :payments_only (Boolean) —

    Return cash only basis for the ProfitAndLoss report

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13494

def get_report_profit_and_loss_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_profit_and_loss ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_profit_and_loss"
  end
  allowable_values = ["MONTH", "QUARTER", "YEAR"]
  if @api_client.config.client_side_validation && opts[:'timeframe'] && !allowable_values.include?(opts[:'timeframe'])
    fail ArgumentError, "invalid value for \"timeframe\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/Reports/ProfitAndLoss'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'periods'] = opts[:'periods'] if !opts[:'periods'].nil?
  query_params[:'timeframe'] = opts[:'timeframe'] if !opts[:'timeframe'].nil?
  query_params[:'trackingCategoryID'] = opts[:'tracking_category_id'] if !opts[:'tracking_category_id'].nil?
  query_params[:'trackingCategoryID2'] = opts[:'tracking_category_id2'] if !opts[:'tracking_category_id2'].nil?
  query_params[:'trackingOptionID'] = opts[:'tracking_option_id'] if !opts[:'tracking_option_id'].nil?
  query_params[:'trackingOptionID2'] = opts[:'tracking_option_id2'] if !opts[:'tracking_option_id2'].nil?
  query_params[:'standardLayout'] = opts[:'standard_layout'] if !opts[:'standard_layout'].nil?
  query_params[:'paymentsOnly'] = opts[:'payments_only'] if !opts[:'payments_only'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_profit_and_loss\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_ten_ninety_nine(xero_tenant_id, opts = {}) ⇒ Reports

Allows you to retrieve report for TenNinetyNine

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :report_year (String) —

    The year of the 1099 report

Returns:

  • (Reports) 


13567
13568
13569
13570
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13567

def get_report_ten_ninety_nine(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_report_ten_ninety_nine_with_http_info(xero_tenant_id, opts)
  data
end

#get_report_ten_ninety_nine_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Reports, Integer, Hash)>

Allows you to retrieve report for TenNinetyNine

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :report_year (String) —

    The year of the 1099 report

Returns:

  • (Array<(Reports, Integer, Hash)>) —

    Reports data, response status code and response headers



13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13577

def get_report_ten_ninety_nine_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_ten_ninety_nine ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_ten_ninety_nine"
  end
  # resource path
  local_var_path = '/Reports/TenNinetyNine'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'reportYear'] = opts[:'report_year'] if !opts[:'report_year'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Reports' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_ten_ninety_nine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_report_trial_balance(xero_tenant_id, opts = {}) ⇒ ReportWithRows

Allows you to retrieve report for TrialBalance

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date for the Trial Balance report e.g. 2018-03-31

  • :payments_only (Boolean) —

    Return cash only basis for the Trial Balance report

Returns:

  • (ReportWithRows) 


13638
13639
13640
13641
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13638

def get_report_trial_balance(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_report_trial_balance_with_http_info(xero_tenant_id, opts)
  data
end

#get_report_trial_balance_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(ReportWithRows, Integer, Hash)>

Allows you to retrieve report for TrialBalance

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    The date for the Trial Balance report e.g. 2018-03-31

  • :payments_only (Boolean) —

    Return cash only basis for the Trial Balance report

Returns:

  • (Array<(ReportWithRows, Integer, Hash)>) —

    ReportWithRows data, response status code and response headers



13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13649

def get_report_trial_balance_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_report_trial_balance ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_report_trial_balance"
  end
  # resource path
  local_var_path = '/Reports/TrialBalance'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  query_params[:'paymentsOnly'] = opts[:'payments_only'] if !opts[:'payments_only'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ReportWithRows' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_report_trial_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_rates(xero_tenant_id, opts = {}) ⇒ TaxRates

Allows you to retrieve Tax Rates

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :tax_type (String) —

    Filter by tax type

Returns:

  • (TaxRates) 


13712
13713
13714
13715
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13712

def get_tax_rates(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_tax_rates_with_http_info(xero_tenant_id, opts)
  data
end

#get_tax_rates_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(TaxRates, Integer, Hash)>

Allows you to retrieve Tax Rates

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :tax_type (String) —

    Filter by tax type

Returns:

  • (Array<(TaxRates, Integer, Hash)>) —

    TaxRates data, response status code and response headers



13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13724

def get_tax_rates_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_tax_rates ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_tax_rates"
  end
  # resource path
  local_var_path = '/TaxRates'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'TaxType'] = opts[:'tax_type'] if !opts[:'tax_type'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'TaxRates' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_tax_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tracking_categories(xero_tenant_id, opts = {}) ⇒ TrackingCategories

Allows you to retrieve tracking categories and options

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :include_archived (Boolean) —

    e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response

Returns:

  • (TrackingCategories) 


13788
13789
13790
13791
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13788

def get_tracking_categories(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_tracking_categories_with_http_info(xero_tenant_id, opts)
  data
end

#get_tracking_categories_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(TrackingCategories, Integer, Hash)>

Allows you to retrieve tracking categories and options

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

  • :include_archived (Boolean) —

    e.g. includeArchived=true - Categories and options with a status of ARCHIVED will be included in the response

Returns:

  • (Array<(TrackingCategories, Integer, Hash)>) —

    TrackingCategories data, response status code and response headers



13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13800

def get_tracking_categories_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_tracking_categories ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_tracking_categories"
  end
  # resource path
  local_var_path = '/TrackingCategories'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'TrackingCategories' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_tracking_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tracking_category(xero_tenant_id, tracking_category_id, opts = {}) ⇒ TrackingCategories

Allows you to retrieve tracking categories and options for specified category

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TrackingCategories) 


13862
13863
13864
13865
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13862

def get_tracking_category(xero_tenant_id, tracking_category_id, opts = {})
  data, _status_code, _headers = get_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, opts)
  data
end

#get_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, opts = {}) ⇒ Array<(TrackingCategories, Integer, Hash)>

Allows you to retrieve tracking categories and options for specified category

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrackingCategories, Integer, Hash)>) —

    TrackingCategories data, response status code and response headers



13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13872

def get_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_tracking_category ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_tracking_category"
  end
  # verify the required parameter 'tracking_category_id' is set
  if @api_client.config.client_side_validation && tracking_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_category_id' when calling AccountingApi.get_tracking_category"
  end
  # resource path
  local_var_path = '/TrackingCategories/{TrackingCategoryID}'.sub('{' + 'TrackingCategoryID' + '}', tracking_category_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'TrackingCategories' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_tracking_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user(xero_tenant_id, user_id, opts = {}) ⇒ Users

Allows you to retrieve a specified user

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • user_id (String) —

    Unique identifier for a User

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Users) 


13935
13936
13937
13938
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13935

def get_user(xero_tenant_id, user_id, opts = {})
  data, _status_code, _headers = get_user_with_http_info(xero_tenant_id, user_id, opts)
  data
end

#get_user_with_http_info(xero_tenant_id, user_id, opts = {}) ⇒ Array<(Users, Integer, Hash)>

Allows you to retrieve a specified user

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • user_id (String) —

    Unique identifier for a User

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Users, Integer, Hash)>) —

    Users data, response status code and response headers



13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 13945

def get_user_with_http_info(xero_tenant_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_user ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountingApi.get_user"
  end
  # resource path
  local_var_path = '/Users/{UserID}'.sub('{' + 'UserID' + '}', user_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Users' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_users(xero_tenant_id, opts = {}) ⇒ Users

Allows you to retrieve users

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Users) 


14010
14011
14012
14013
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14010

def get_users(xero_tenant_id, opts = {})
  data, _status_code, _headers = get_users_with_http_info(xero_tenant_id, opts)
  data
end

#get_users_with_http_info(xero_tenant_id, opts = {}) ⇒ Array<(Users, Integer, Hash)>

Allows you to retrieve users

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_modified_since (DateTime) —

    Only records created or modified since this timestamp will be returned

  • :where (String) —

    Filter by an any element

  • :order (String) —

    Order by an any element

Returns:

  • (Array<(Users, Integer, Hash)>) —

    Users data, response status code and response headers



14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14022

def get_users_with_http_info(xero_tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.get_users ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_users"
  end
  # resource path
  local_var_path = '/Users'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Users' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account(xero_tenant_id, account_id, accounts, opts = {}) ⇒ Accounts

Allows you to update a chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for retrieving single object

  • accounts (Accounts) —

    Request of type Accounts array with one Account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Accounts) 


14085
14086
14087
14088
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14085

def (xero_tenant_id, , accounts, opts = {})
  data, _status_code, _headers = (xero_tenant_id, , accounts, opts)
  data
end

#update_account_attachment_by_file_name(xero_tenant_id, account_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to update Attachment on Account by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • file_name (String) —

    Name of the attachment

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


14167
14168
14169
14170
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14167

def (xero_tenant_id, , file_name, body, opts = {})
  data, _status_code, _headers = (xero_tenant_id, , file_name, body, opts)
  data
end

#update_account_attachment_by_file_name_with_http_info(xero_tenant_id, account_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to update Attachment on Account by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for Account object

  • file_name (String) —

    Name of the attachment

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14179

def (xero_tenant_id, , file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_account_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_account_attachment_by_file_name"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountingApi.update_account_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_account_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_account_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Accounts/{AccountID}/Attachments/{FileName}'.sub('{' + 'AccountID' + '}', .to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_account_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account_with_http_info(xero_tenant_id, account_id, accounts, opts = {}) ⇒ Array<(Accounts, Integer, Hash)>

Allows you to update a chart of accounts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • account_id (String) —

    Unique identifier for retrieving single object

  • accounts (Accounts) —

    Request of type Accounts array with one Account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Accounts, Integer, Hash)>) —

    Accounts data, response status code and response headers



14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14096

def (xero_tenant_id, , accounts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_account ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_account"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountingApi.update_account"
  end
  # verify the required parameter 'accounts' is set
  if @api_client.config.client_side_validation && accounts.nil?
    fail ArgumentError, "Missing the required parameter 'accounts' when calling AccountingApi.update_account"
  end
  # resource path
  local_var_path = '/Accounts/{AccountID}'.sub('{' + 'AccountID' + '}', .to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(accounts) 

  # return_type
  return_type = opts[:return_type] || 'Accounts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, opts = {}) ⇒ BankTransactions

Allows you to update a single spend or receive money transaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • bank_transactions (BankTransactions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (BankTransactions) 


14254
14255
14256
14257
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14254

def update_bank_transaction(xero_tenant_id, bank_transaction_id, bank_transactions, opts = {})
  data, _status_code, _headers = update_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, bank_transactions, opts)
  data
end

#update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to update an Attachment on BankTransaction by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • file_name (String) —

    The name of the file being attached

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


14338
14339
14340
14341
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14338

def update_bank_transaction_attachment_by_file_name(xero_tenant_id, bank_transaction_id, file_name, body, opts = {})
  data, _status_code, _headers = update_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, opts)
  data
end

#update_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to update an Attachment on BankTransaction by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • file_name (String) —

    The name of the file being attached

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14350

def update_bank_transaction_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transaction_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_bank_transaction_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.update_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_bank_transaction_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_bank_transaction_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}/Attachments/{FileName}'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_bank_transaction_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, bank_transactions, opts = {}) ⇒ Array<(BankTransactions, Integer, Hash)>

Allows you to update a single spend or receive money transaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transaction_id (String) —

    Xero generated unique identifier for a bank transaction

  • bank_transactions (BankTransactions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(BankTransactions, Integer, Hash)>) —

    BankTransactions data, response status code and response headers



14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14266

def update_bank_transaction_with_http_info(xero_tenant_id, bank_transaction_id, bank_transactions, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_bank_transaction ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_bank_transaction"
  end
  # verify the required parameter 'bank_transaction_id' is set
  if @api_client.config.client_side_validation && bank_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transaction_id' when calling AccountingApi.update_bank_transaction"
  end
  # verify the required parameter 'bank_transactions' is set
  if @api_client.config.client_side_validation && bank_transactions.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transactions' when calling AccountingApi.update_bank_transaction"
  end
  # resource path
  local_var_path = '/BankTransactions/{BankTransactionID}'.sub('{' + 'BankTransactionID' + '}', bank_transaction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(bank_transactions) 

  # return_type
  return_type = opts[:return_type] || 'BankTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_bank_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts = {}) ⇒ Attachments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • file_name (String) —

    The name of the file being attached to a Bank Transfer

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


14424
14425
14426
14427
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14424

def update_bank_transfer_attachment_by_file_name(xero_tenant_id, bank_transfer_id, file_name, body, opts = {})
  data, _status_code, _headers = update_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, opts)
  data
end

#update_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Returns Attachments data, response status code and response headers.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transfer_id (String) —

    Xero generated unique identifier for a bank transfer

  • file_name (String) —

    The name of the file being attached to a Bank Transfer

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14435

def update_bank_transfer_attachment_by_file_name_with_http_info(xero_tenant_id, bank_transfer_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_bank_transfer_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'bank_transfer_id' is set
  if @api_client.config.client_side_validation && bank_transfer_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transfer_id' when calling AccountingApi.update_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_bank_transfer_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_bank_transfer_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/BankTransfers/{BankTransferID}/Attachments/{FileName}'.sub('{' + 'BankTransferID' + '}', bank_transfer_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_bank_transfer_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_contact(xero_tenant_id, contact_id, contacts, opts = {}) ⇒ Contacts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • contacts (Contacts) —

    an array of Contacts containing single Contact object with properties to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Contacts) 


14508
14509
14510
14511
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14508

def update_contact(xero_tenant_id, contact_id, contacts, opts = {})
  data, _status_code, _headers = update_contact_with_http_info(xero_tenant_id, contact_id, contacts, opts)
  data
end

#update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts = {}) ⇒ Attachments

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • file_name (String) —

    Name for the file you are attaching

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


14588
14589
14590
14591
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14588

def update_contact_attachment_by_file_name(xero_tenant_id, contact_id, file_name, body, opts = {})
  data, _status_code, _headers = update_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, opts)
  data
end

#update_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Returns Attachments data, response status code and response headers.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • file_name (String) —

    Name for the file you are attaching

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14599

def update_contact_attachment_by_file_name_with_http_info(xero_tenant_id, contact_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_contact_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_contact_attachment_by_file_name"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.update_contact_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_contact_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_contact_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}/Attachments/{FileName}'.sub('{' + 'ContactID' + '}', contact_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_contact_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_contact_group(xero_tenant_id, contact_group_id, contact_groups, opts = {}) ⇒ ContactGroups

Allows you to update a Contact Group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • contact_groups (ContactGroups) —

    an array of Contact groups with Name of specific group to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ContactGroups) 


14673
14674
14675
14676
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14673

def update_contact_group(xero_tenant_id, contact_group_id, contact_groups, opts = {})
  data, _status_code, _headers = update_contact_group_with_http_info(xero_tenant_id, contact_group_id, contact_groups, opts)
  data
end

#update_contact_group_with_http_info(xero_tenant_id, contact_group_id, contact_groups, opts = {}) ⇒ Array<(ContactGroups, Integer, Hash)>

Allows you to update a Contact Group

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_group_id (String) —

    Unique identifier for a Contact Group

  • contact_groups (ContactGroups) —

    an array of Contact groups with Name of specific group to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactGroups, Integer, Hash)>) —

    ContactGroups data, response status code and response headers



14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14684

def update_contact_group_with_http_info(xero_tenant_id, contact_group_id, contact_groups, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_contact_group ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_contact_group"
  end
  # verify the required parameter 'contact_group_id' is set
  if @api_client.config.client_side_validation && contact_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_group_id' when calling AccountingApi.update_contact_group"
  end
  # verify the required parameter 'contact_groups' is set
  if @api_client.config.client_side_validation && contact_groups.nil?
    fail ArgumentError, "Missing the required parameter 'contact_groups' when calling AccountingApi.update_contact_group"
  end
  # resource path
  local_var_path = '/ContactGroups/{ContactGroupID}'.sub('{' + 'ContactGroupID' + '}', contact_group_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(contact_groups) 

  # return_type
  return_type = opts[:return_type] || 'ContactGroups' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_contact_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_contact_with_http_info(xero_tenant_id, contact_id, contacts, opts = {}) ⇒ Array<(Contacts, Integer, Hash)>

Returns Contacts data, response status code and response headers.

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contact_id (String) —

    Unique identifier for a Contact

  • contacts (Contacts) —

    an array of Contacts containing single Contact object with properties to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Contacts, Integer, Hash)>) —

    Contacts data, response status code and response headers



14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14518

def update_contact_with_http_info(xero_tenant_id, contact_id, contacts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_contact ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_contact"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling AccountingApi.update_contact"
  end
  # verify the required parameter 'contacts' is set
  if @api_client.config.client_side_validation && contacts.nil?
    fail ArgumentError, "Missing the required parameter 'contacts' when calling AccountingApi.update_contact"
  end
  # resource path
  local_var_path = '/Contacts/{ContactID}'.sub('{' + 'ContactID' + '}', contact_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(contacts) 

  # return_type
  return_type = opts[:return_type] || 'Contacts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_credit_note(xero_tenant_id, credit_note_id, credit_notes, opts = {}) ⇒ CreditNotes

Allows you to update a specific credit note

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • credit_notes (CreditNotes) —

    an array of Credit Notes containing credit note details to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (CreditNotes) 


14755
14756
14757
14758
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14755

def update_credit_note(xero_tenant_id, credit_note_id, credit_notes, opts = {})
  data, _status_code, _headers = update_credit_note_with_http_info(xero_tenant_id, credit_note_id, credit_notes, opts)
  data
end

#update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to update Attachments on CreditNote by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • file_name (String) —

    Name of the file you are attaching to Credit Note

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


14839
14840
14841
14842
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14839

def update_credit_note_attachment_by_file_name(xero_tenant_id, credit_note_id, file_name, body, opts = {})
  data, _status_code, _headers = update_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, opts)
  data
end

#update_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to update Attachments on CreditNote by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • file_name (String) —

    Name of the file you are attaching to Credit Note

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14851

def update_credit_note_attachment_by_file_name_with_http_info(xero_tenant_id, credit_note_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_credit_note_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.update_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_credit_note_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_credit_note_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}/Attachments/{FileName}'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_credit_note_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_credit_note_with_http_info(xero_tenant_id, credit_note_id, credit_notes, opts = {}) ⇒ Array<(CreditNotes, Integer, Hash)>

Allows you to update a specific credit note

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_note_id (String) —

    Unique identifier for a Credit Note

  • credit_notes (CreditNotes) —

    an array of Credit Notes containing credit note details to update

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(CreditNotes, Integer, Hash)>) —

    CreditNotes data, response status code and response headers



14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14767

def update_credit_note_with_http_info(xero_tenant_id, credit_note_id, credit_notes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_credit_note ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_credit_note"
  end
  # verify the required parameter 'credit_note_id' is set
  if @api_client.config.client_side_validation && credit_note_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_note_id' when calling AccountingApi.update_credit_note"
  end
  # verify the required parameter 'credit_notes' is set
  if @api_client.config.client_side_validation && credit_notes.nil?
    fail ArgumentError, "Missing the required parameter 'credit_notes' when calling AccountingApi.update_credit_note"
  end
  # resource path
  local_var_path = '/CreditNotes/{CreditNoteID}'.sub('{' + 'CreditNoteID' + '}', credit_note_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(credit_notes) 

  # return_type
  return_type = opts[:return_type] || 'CreditNotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_credit_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, opts = {}) ⇒ ExpenseClaims

Allows you to update specified expense claims

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claim_id (String) —

    Unique identifier for a ExpenseClaim

  • expense_claims (ExpenseClaims)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ExpenseClaims) 


14925
14926
14927
14928
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14925

def update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims, opts = {})
  data, _status_code, _headers = update_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, expense_claims, opts)
  data
end

#update_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, expense_claims, opts = {}) ⇒ Array<(ExpenseClaims, Integer, Hash)>

Allows you to update specified expense claims

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • expense_claim_id (String) —

    Unique identifier for a ExpenseClaim

  • expense_claims (ExpenseClaims)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ExpenseClaims, Integer, Hash)>) —

    ExpenseClaims data, response status code and response headers



14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 14936

def update_expense_claim_with_http_info(xero_tenant_id, expense_claim_id, expense_claims, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_expense_claim ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_expense_claim"
  end
  # verify the required parameter 'expense_claim_id' is set
  if @api_client.config.client_side_validation && expense_claim_id.nil?
    fail ArgumentError, "Missing the required parameter 'expense_claim_id' when calling AccountingApi.update_expense_claim"
  end
  # verify the required parameter 'expense_claims' is set
  if @api_client.config.client_side_validation && expense_claims.nil?
    fail ArgumentError, "Missing the required parameter 'expense_claims' when calling AccountingApi.update_expense_claim"
  end
  # resource path
  local_var_path = '/ExpenseClaims/{ExpenseClaimID}'.sub('{' + 'ExpenseClaimID' + '}', expense_claim_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(expense_claims) 

  # return_type
  return_type = opts[:return_type] || 'ExpenseClaims' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_expense_claim\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_invoice(xero_tenant_id, invoice_id, invoices, opts = {}) ⇒ Invoices

Allows you to update a specified sales invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • invoices (Invoices)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Invoices) 


15007
15008
15009
15010
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15007

def update_invoice(xero_tenant_id, invoice_id, invoices, opts = {})
  data, _status_code, _headers = update_invoice_with_http_info(xero_tenant_id, invoice_id, invoices, opts)
  data
end

#update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to update Attachment on invoices or purchase bills by it's filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • file_name (String) —

    Name of the file you are attaching

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


15091
15092
15093
15094
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15091

def update_invoice_attachment_by_file_name(xero_tenant_id, invoice_id, file_name, body, opts = {})
  data, _status_code, _headers = update_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, opts)
  data
end

#update_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to update Attachment on invoices or purchase bills by it's filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • file_name (String) —

    Name of the file you are attaching

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15103

def update_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, invoice_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_invoice_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.update_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_invoice_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}/Attachments/{FileName}'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_invoice_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_invoice_with_http_info(xero_tenant_id, invoice_id, invoices, opts = {}) ⇒ Array<(Invoices, Integer, Hash)>

Allows you to update a specified sales invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoice_id (String) —

    Unique identifier for an Invoice

  • invoices (Invoices)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Invoices, Integer, Hash)>) —

    Invoices data, response status code and response headers



15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15019

def update_invoice_with_http_info(xero_tenant_id, invoice_id, invoices, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_invoice ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_invoice"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountingApi.update_invoice"
  end
  # verify the required parameter 'invoices' is set
  if @api_client.config.client_side_validation && invoices.nil?
    fail ArgumentError, "Missing the required parameter 'invoices' when calling AccountingApi.update_invoice"
  end
  # resource path
  local_var_path = '/Invoices/{InvoiceID}'.sub('{' + 'InvoiceID' + '}', invoice_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(invoices) 

  # return_type
  return_type = opts[:return_type] || 'Invoices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_item(xero_tenant_id, item_id, items, opts = {}) ⇒ Items

Allows you to update a specified item

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • items (Items)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Items) 


15178
15179
15180
15181
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15178

def update_item(xero_tenant_id, item_id, items, opts = {})
  data, _status_code, _headers = update_item_with_http_info(xero_tenant_id, item_id, items, opts)
  data
end

#update_item_with_http_info(xero_tenant_id, item_id, items, opts = {}) ⇒ Array<(Items, Integer, Hash)>

Allows you to update a specified item

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • item_id (String) —

    Unique identifier for an Item

  • items (Items)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Items, Integer, Hash)>) —

    Items data, response status code and response headers



15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15190

def update_item_with_http_info(xero_tenant_id, item_id, items, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_item ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_item"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling AccountingApi.update_item"
  end
  # verify the required parameter 'items' is set
  if @api_client.config.client_side_validation && items.nil?
    fail ArgumentError, "Missing the required parameter 'items' when calling AccountingApi.update_item"
  end
  # resource path
  local_var_path = '/Items/{ItemID}'.sub('{' + 'ItemID' + '}', item_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(items) 

  # return_type
  return_type = opts[:return_type] || 'Items' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, opts = {}) ⇒ LinkedTransactions

Allows you to update a specified linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • linked_transaction_id (String) —

    Unique identifier for a LinkedTransaction

  • linked_transactions (LinkedTransactions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (LinkedTransactions) 


15261
15262
15263
15264
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15261

def update_linked_transaction(xero_tenant_id, linked_transaction_id, linked_transactions, opts = {})
  data, _status_code, _headers = update_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, linked_transactions, opts)
  data
end

#update_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, linked_transactions, opts = {}) ⇒ Array<(LinkedTransactions, Integer, Hash)>

Allows you to update a specified linked transactions (billable expenses)

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • linked_transaction_id (String) —

    Unique identifier for a LinkedTransaction

  • linked_transactions (LinkedTransactions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LinkedTransactions, Integer, Hash)>) —

    LinkedTransactions data, response status code and response headers



15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15272

def update_linked_transaction_with_http_info(xero_tenant_id, linked_transaction_id, linked_transactions, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_linked_transaction ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_linked_transaction"
  end
  # verify the required parameter 'linked_transaction_id' is set
  if @api_client.config.client_side_validation && linked_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'linked_transaction_id' when calling AccountingApi.update_linked_transaction"
  end
  # verify the required parameter 'linked_transactions' is set
  if @api_client.config.client_side_validation && linked_transactions.nil?
    fail ArgumentError, "Missing the required parameter 'linked_transactions' when calling AccountingApi.update_linked_transaction"
  end
  # resource path
  local_var_path = '/LinkedTransactions/{LinkedTransactionID}'.sub('{' + 'LinkedTransactionID' + '}', linked_transaction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(linked_transactions) 

  # return_type
  return_type = opts[:return_type] || 'LinkedTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_linked_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, opts = {}) ⇒ ManualJournals

Allows you to update a specified manual journal

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • manual_journals (ManualJournals)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (ManualJournals) 


15342
15343
15344
15345
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15342

def update_manual_journal(xero_tenant_id, manual_journal_id, manual_journals, opts = {})
  data, _status_code, _headers = update_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, manual_journals, opts)
  data
end

#update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to update a specified Attachment on ManualJournal by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • file_name (String) —

    The name of the file being attached to a ManualJournal

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


15424
15425
15426
15427
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15424

def update_manual_journal_attachment_by_file_name(xero_tenant_id, manual_journal_id, file_name, body, opts = {})
  data, _status_code, _headers = update_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, opts)
  data
end

#update_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to update a specified Attachment on ManualJournal by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • file_name (String) —

    The name of the file being attached to a ManualJournal

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15436

def update_manual_journal_attachment_by_file_name_with_http_info(xero_tenant_id, manual_journal_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_manual_journal_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'manual_journal_id' is set
  if @api_client.config.client_side_validation && manual_journal_id.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journal_id' when calling AccountingApi.update_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_manual_journal_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_manual_journal_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/ManualJournals/{ManualJournalID}/Attachments/{FileName}'.sub('{' + 'ManualJournalID' + '}', manual_journal_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_manual_journal_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, manual_journals, opts = {}) ⇒ Array<(ManualJournals, Integer, Hash)>

Allows you to update a specified manual journal

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journal_id (String) —

    Unique identifier for a ManualJournal

  • manual_journals (ManualJournals)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ManualJournals, Integer, Hash)>) —

    ManualJournals data, response status code and response headers



15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15353

def update_manual_journal_with_http_info(xero_tenant_id, manual_journal_id, manual_journals, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_manual_journal ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_manual_journal"
  end
  # verify the required parameter 'manual_journal_id' is set
  if @api_client.config.client_side_validation && manual_journal_id.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journal_id' when calling AccountingApi.update_manual_journal"
  end
  # verify the required parameter 'manual_journals' is set
  if @api_client.config.client_side_validation && manual_journals.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journals' when calling AccountingApi.update_manual_journal"
  end
  # resource path
  local_var_path = '/ManualJournals/{ManualJournalID}'.sub('{' + 'ManualJournalID' + '}', manual_journal_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(manual_journals) 

  # return_type
  return_type = opts[:return_type] || 'ManualJournals' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_manual_journal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_bank_transactions(xero_tenant_id, bank_transactions, opts = {}) ⇒ BankTransactions

Allows you to update or create one or more spend or receive money transaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transactions (BankTransactions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (BankTransactions) 


15511
15512
15513
15514
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15511

def update_or_create_bank_transactions(xero_tenant_id, bank_transactions, opts = {})
  data, _status_code, _headers = update_or_create_bank_transactions_with_http_info(xero_tenant_id, bank_transactions, opts)
  data
end

#update_or_create_bank_transactions_with_http_info(xero_tenant_id, bank_transactions, opts = {}) ⇒ Array<(BankTransactions, Integer, Hash)>

Allows you to update or create one or more spend or receive money transaction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • bank_transactions (BankTransactions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(BankTransactions, Integer, Hash)>) —

    BankTransactions data, response status code and response headers



15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15523

def update_or_create_bank_transactions_with_http_info(xero_tenant_id, bank_transactions, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_bank_transactions ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_bank_transactions"
  end
  # verify the required parameter 'bank_transactions' is set
  if @api_client.config.client_side_validation && bank_transactions.nil?
    fail ArgumentError, "Missing the required parameter 'bank_transactions' when calling AccountingApi.update_or_create_bank_transactions"
  end
  # resource path
  local_var_path = '/BankTransactions'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(bank_transactions) 

  # return_type
  return_type = opts[:return_type] || 'BankTransactions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_bank_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_contacts(xero_tenant_id, contacts, opts = {}) ⇒ Contacts

Allows you to update OR create one or more contacts in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contacts (Contacts)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Contacts) 


15591
15592
15593
15594
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15591

def update_or_create_contacts(xero_tenant_id, contacts, opts = {})
  data, _status_code, _headers = update_or_create_contacts_with_http_info(xero_tenant_id, contacts, opts)
  data
end

#update_or_create_contacts_with_http_info(xero_tenant_id, contacts, opts = {}) ⇒ Array<(Contacts, Integer, Hash)>

Allows you to update OR create one or more contacts in a Xero organisation

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • contacts (Contacts)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Contacts, Integer, Hash)>) —

    Contacts data, response status code and response headers



15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15602

def update_or_create_contacts_with_http_info(xero_tenant_id, contacts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_contacts ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_contacts"
  end
  # verify the required parameter 'contacts' is set
  if @api_client.config.client_side_validation && contacts.nil?
    fail ArgumentError, "Missing the required parameter 'contacts' when calling AccountingApi.update_or_create_contacts"
  end
  # resource path
  local_var_path = '/Contacts'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(contacts) 

  # return_type
  return_type = opts[:return_type] || 'Contacts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_credit_notes(xero_tenant_id, credit_notes, opts = {}) ⇒ CreditNotes

Allows you to update OR create one or more credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_notes (CreditNotes) —

    an array of Credit Notes with a single CreditNote object.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (CreditNotes) 


15670
15671
15672
15673
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15670

def update_or_create_credit_notes(xero_tenant_id, credit_notes, opts = {})
  data, _status_code, _headers = update_or_create_credit_notes_with_http_info(xero_tenant_id, credit_notes, opts)
  data
end

#update_or_create_credit_notes_with_http_info(xero_tenant_id, credit_notes, opts = {}) ⇒ Array<(CreditNotes, Integer, Hash)>

Allows you to update OR create one or more credit notes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • credit_notes (CreditNotes) —

    an array of Credit Notes with a single CreditNote object.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(CreditNotes, Integer, Hash)>) —

    CreditNotes data, response status code and response headers



15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15682

def update_or_create_credit_notes_with_http_info(xero_tenant_id, credit_notes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_credit_notes ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_credit_notes"
  end
  # verify the required parameter 'credit_notes' is set
  if @api_client.config.client_side_validation && credit_notes.nil?
    fail ArgumentError, "Missing the required parameter 'credit_notes' when calling AccountingApi.update_or_create_credit_notes"
  end
  # resource path
  local_var_path = '/CreditNotes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(credit_notes) 

  # return_type
  return_type = opts[:return_type] || 'CreditNotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_credit_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_employees(xero_tenant_id, employees, opts = {}) ⇒ Employees

Allows you to create a single new employees used in Xero payrun

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employees (Employees) —

    Employees with array of Employee object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Employees) 


15750
15751
15752
15753
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15750

def update_or_create_employees(xero_tenant_id, employees, opts = {})
  data, _status_code, _headers = update_or_create_employees_with_http_info(xero_tenant_id, employees, opts)
  data
end

#update_or_create_employees_with_http_info(xero_tenant_id, employees, opts = {}) ⇒ Array<(Employees, Integer, Hash)>

Allows you to create a single new employees used in Xero payrun

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employees (Employees) —

    Employees with array of Employee object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Employees, Integer, Hash)>) —

    Employees data, response status code and response headers



15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15761

def update_or_create_employees_with_http_info(xero_tenant_id, employees, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_employees ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_employees"
  end
  # verify the required parameter 'employees' is set
  if @api_client.config.client_side_validation && employees.nil?
    fail ArgumentError, "Missing the required parameter 'employees' when calling AccountingApi.update_or_create_employees"
  end
  # resource path
  local_var_path = '/Employees'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(employees) 

  # return_type
  return_type = opts[:return_type] || 'Employees' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_employees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_invoices(xero_tenant_id, invoices, opts = {}) ⇒ Invoices

Allows you to update OR create one or more sales invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoices (Invoices)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Invoices) 


15829
15830
15831
15832
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15829

def update_or_create_invoices(xero_tenant_id, invoices, opts = {})
  data, _status_code, _headers = update_or_create_invoices_with_http_info(xero_tenant_id, invoices, opts)
  data
end

#update_or_create_invoices_with_http_info(xero_tenant_id, invoices, opts = {}) ⇒ Array<(Invoices, Integer, Hash)>

Allows you to update OR create one or more sales invoices or purchase bills

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • invoices (Invoices)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Invoices, Integer, Hash)>) —

    Invoices data, response status code and response headers



15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15841

def update_or_create_invoices_with_http_info(xero_tenant_id, invoices, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_invoices ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_invoices"
  end
  # verify the required parameter 'invoices' is set
  if @api_client.config.client_side_validation && invoices.nil?
    fail ArgumentError, "Missing the required parameter 'invoices' when calling AccountingApi.update_or_create_invoices"
  end
  # resource path
  local_var_path = '/Invoices'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(invoices) 

  # return_type
  return_type = opts[:return_type] || 'Invoices' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_items(xero_tenant_id, items, opts = {}) ⇒ Items

Allows you to update or create one or more items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • items (Items)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Items) 


15910
15911
15912
15913
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15910

def update_or_create_items(xero_tenant_id, items, opts = {})
  data, _status_code, _headers = update_or_create_items_with_http_info(xero_tenant_id, items, opts)
  data
end

#update_or_create_items_with_http_info(xero_tenant_id, items, opts = {}) ⇒ Array<(Items, Integer, Hash)>

Allows you to update or create one or more items

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • items (Items)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Items, Integer, Hash)>) —

    Items data, response status code and response headers



15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15922

def update_or_create_items_with_http_info(xero_tenant_id, items, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_items ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_items"
  end
  # verify the required parameter 'items' is set
  if @api_client.config.client_side_validation && items.nil?
    fail ArgumentError, "Missing the required parameter 'items' when calling AccountingApi.update_or_create_items"
  end
  # resource path
  local_var_path = '/Items'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(items) 

  # return_type
  return_type = opts[:return_type] || 'Items' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_manual_journals(xero_tenant_id, manual_journals, opts = {}) ⇒ ManualJournals

Allows you to create a single manual journal

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journals (ManualJournals) —

    ManualJournals array with ManualJournal object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (ManualJournals) 


15990
15991
15992
15993
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 15990

def update_or_create_manual_journals(xero_tenant_id, manual_journals, opts = {})
  data, _status_code, _headers = update_or_create_manual_journals_with_http_info(xero_tenant_id, manual_journals, opts)
  data
end

#update_or_create_manual_journals_with_http_info(xero_tenant_id, manual_journals, opts = {}) ⇒ Array<(ManualJournals, Integer, Hash)>

Allows you to create a single manual journal

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • manual_journals (ManualJournals) —

    ManualJournals array with ManualJournal object in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(ManualJournals, Integer, Hash)>) —

    ManualJournals data, response status code and response headers



16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16001

def update_or_create_manual_journals_with_http_info(xero_tenant_id, manual_journals, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_manual_journals ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_manual_journals"
  end
  # verify the required parameter 'manual_journals' is set
  if @api_client.config.client_side_validation && manual_journals.nil?
    fail ArgumentError, "Missing the required parameter 'manual_journals' when calling AccountingApi.update_or_create_manual_journals"
  end
  # resource path
  local_var_path = '/ManualJournals'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(manual_journals) 

  # return_type
  return_type = opts[:return_type] || 'ManualJournals' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_manual_journals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_purchase_orders(xero_tenant_id, purchase_orders, opts = {}) ⇒ PurchaseOrders

Allows you to update or create one or more purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_orders (PurchaseOrders)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (PurchaseOrders) 


16068
16069
16070
16071
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16068

def update_or_create_purchase_orders(xero_tenant_id, purchase_orders, opts = {})
  data, _status_code, _headers = update_or_create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, opts)
  data
end

#update_or_create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, opts = {}) ⇒ Array<(PurchaseOrders, Integer, Hash)>

Allows you to update or create one or more purchase orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_orders (PurchaseOrders)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(PurchaseOrders, Integer, Hash)>) —

    PurchaseOrders data, response status code and response headers



16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16079

def update_or_create_purchase_orders_with_http_info(xero_tenant_id, purchase_orders, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_purchase_orders ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_purchase_orders"
  end
  # verify the required parameter 'purchase_orders' is set
  if @api_client.config.client_side_validation && purchase_orders.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_orders' when calling AccountingApi.update_or_create_purchase_orders"
  end
  # resource path
  local_var_path = '/PurchaseOrders'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(purchase_orders) 

  # return_type
  return_type = opts[:return_type] || 'PurchaseOrders' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_purchase_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_or_create_quotes(xero_tenant_id, quotes, opts = {}) ⇒ Quotes

Allows you to update OR create one or more quotes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quotes (Quotes)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors (default to false)

Returns:

  • (Quotes) 


16146
16147
16148
16149
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16146

def update_or_create_quotes(xero_tenant_id, quotes, opts = {})
  data, _status_code, _headers = update_or_create_quotes_with_http_info(xero_tenant_id, quotes, opts)
  data
end

#update_or_create_quotes_with_http_info(xero_tenant_id, quotes, opts = {}) ⇒ Array<(Quotes, Integer, Hash)>

Allows you to update OR create one or more quotes

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quotes (Quotes)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :summarize_errors (Boolean) —

    If false return 200 OK and mix of successfully created obejcts and any with validation errors

Returns:

  • (Array<(Quotes, Integer, Hash)>) —

    Quotes data, response status code and response headers



16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16157

def update_or_create_quotes_with_http_info(xero_tenant_id, quotes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_or_create_quotes ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_or_create_quotes"
  end
  # verify the required parameter 'quotes' is set
  if @api_client.config.client_side_validation && quotes.nil?
    fail ArgumentError, "Missing the required parameter 'quotes' when calling AccountingApi.update_or_create_quotes"
  end
  # resource path
  local_var_path = '/Quotes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'summarizeErrors'] = opts[:'summarize_errors'] if !opts[:'summarize_errors'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(quotes) 

  # return_type
  return_type = opts[:return_type] || 'Quotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_or_create_quotes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, opts = {}) ⇒ PurchaseOrders

Allows you to update a specified purchase order

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for a PurchaseOrder

  • purchase_orders (PurchaseOrders)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (PurchaseOrders) 


16224
16225
16226
16227
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16224

def update_purchase_order(xero_tenant_id, purchase_order_id, purchase_orders, opts = {})
  data, _status_code, _headers = update_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, purchase_orders, opts)
  data
end

#update_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, purchase_orders, opts = {}) ⇒ Array<(PurchaseOrders, Integer, Hash)>

Allows you to update a specified purchase order

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • purchase_order_id (String) —

    Unique identifier for a PurchaseOrder

  • purchase_orders (PurchaseOrders)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PurchaseOrders, Integer, Hash)>) —

    PurchaseOrders data, response status code and response headers



16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16235

def update_purchase_order_with_http_info(xero_tenant_id, purchase_order_id, purchase_orders, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_purchase_order ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_purchase_order"
  end
  # verify the required parameter 'purchase_order_id' is set
  if @api_client.config.client_side_validation && purchase_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_order_id' when calling AccountingApi.update_purchase_order"
  end
  # verify the required parameter 'purchase_orders' is set
  if @api_client.config.client_side_validation && purchase_orders.nil?
    fail ArgumentError, "Missing the required parameter 'purchase_orders' when calling AccountingApi.update_purchase_order"
  end
  # resource path
  local_var_path = '/PurchaseOrders/{PurchaseOrderID}'.sub('{' + 'PurchaseOrderID' + '}', purchase_order_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(purchase_orders) 

  # return_type
  return_type = opts[:return_type] || 'PurchaseOrders' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_purchase_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_quote(xero_tenant_id, quote_id, quotes, opts = {}) ⇒ Quotes

Allows you to update a specified quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • quotes (Quotes)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Quotes) 


16305
16306
16307
16308
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16305

def update_quote(xero_tenant_id, quote_id, quotes, opts = {})
  data, _status_code, _headers = update_quote_with_http_info(xero_tenant_id, quote_id, quotes, opts)
  data
end

#update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to update Attachment on Quote by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • file_name (String) —

    Name of the attachment

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


16387
16388
16389
16390
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16387

def update_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, body, opts = {})
  data, _status_code, _headers = update_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, opts)
  data
end

#update_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to update Attachment on Quote by Filename

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for Quote object

  • file_name (String) —

    Name of the attachment

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16399

def update_quote_attachment_by_file_name_with_http_info(xero_tenant_id, quote_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_quote_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_quote_attachment_by_file_name"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.update_quote_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_quote_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_quote_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}/Attachments/{FileName}'.sub('{' + 'QuoteID' + '}', quote_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_quote_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_quote_with_http_info(xero_tenant_id, quote_id, quotes, opts = {}) ⇒ Array<(Quotes, Integer, Hash)>

Allows you to update a specified quote

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • quote_id (String) —

    Unique identifier for an Quote

  • quotes (Quotes)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Quotes, Integer, Hash)>) —

    Quotes data, response status code and response headers



16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16316

def update_quote_with_http_info(xero_tenant_id, quote_id, quotes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_quote ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_quote"
  end
  # verify the required parameter 'quote_id' is set
  if @api_client.config.client_side_validation && quote_id.nil?
    fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.update_quote"
  end
  # verify the required parameter 'quotes' is set
  if @api_client.config.client_side_validation && quotes.nil?
    fail ArgumentError, "Missing the required parameter 'quotes' when calling AccountingApi.update_quote"
  end
  # resource path
  local_var_path = '/Quotes/{QuoteID}'.sub('{' + 'QuoteID' + '}', quote_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(quotes) 

  # return_type
  return_type = opts[:return_type] || 'Quotes' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_quote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_receipt(xero_tenant_id, receipt_id, receipts, opts = {}) ⇒ Receipts

Allows you to retrieve a specified draft expense claim receipts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • receipts (Receipts)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Receipts) 


16474
16475
16476
16477
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16474

def update_receipt(xero_tenant_id, receipt_id, receipts, opts = {})
  data, _status_code, _headers = update_receipt_with_http_info(xero_tenant_id, receipt_id, receipts, opts)
  data
end

#update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to update Attachment on expense claim receipts by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • file_name (String) —

    The name of the file being attached to the Receipt

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


16558
16559
16560
16561
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16558

def update_receipt_attachment_by_file_name(xero_tenant_id, receipt_id, file_name, body, opts = {})
  data, _status_code, _headers = update_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, opts)
  data
end

#update_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to update Attachment on expense claim receipts by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • file_name (String) —

    The name of the file being attached to the Receipt

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16570

def update_receipt_attachment_by_file_name_with_http_info(xero_tenant_id, receipt_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_receipt_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.update_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_receipt_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_receipt_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}/Attachments/{FileName}'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_receipt_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_receipt_with_http_info(xero_tenant_id, receipt_id, receipts, opts = {}) ⇒ Array<(Receipts, Integer, Hash)>

Allows you to retrieve a specified draft expense claim receipts

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • receipt_id (String) —

    Unique identifier for a Receipt

  • receipts (Receipts)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :unitdp (Integer) —

    e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

Returns:

  • (Array<(Receipts, Integer, Hash)>) —

    Receipts data, response status code and response headers



16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16486

def update_receipt_with_http_info(xero_tenant_id, receipt_id, receipts, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_receipt ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_receipt"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling AccountingApi.update_receipt"
  end
  # verify the required parameter 'receipts' is set
  if @api_client.config.client_side_validation && receipts.nil?
    fail ArgumentError, "Missing the required parameter 'receipts' when calling AccountingApi.update_receipt"
  end
  # resource path
  local_var_path = '/Receipts/{ReceiptID}'.sub('{' + 'ReceiptID' + '}', receipt_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(receipts) 

  # return_type
  return_type = opts[:return_type] || 'Receipts' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {}) ⇒ Attachments

Allows you to update specified attachment on repeating invoices by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • file_name (String) —

    The name of the file being attached to a Repeating Invoice

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Attachments) 


16645
16646
16647
16648
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16645

def update_repeating_invoice_attachment_by_file_name(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {})
  data, _status_code, _headers = update_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, opts)
  data
end

#update_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {}) ⇒ Array<(Attachments, Integer, Hash)>

Allows you to update specified attachment on repeating invoices by file name

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • repeating_invoice_id (String) —

    Unique identifier for a Repeating Invoice

  • file_name (String) —

    The name of the file being attached to a Repeating Invoice

  • body (String) —

    Byte array of file in body of request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Attachments, Integer, Hash)>) —

    Attachments data, response status code and response headers



16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16657

def update_repeating_invoice_attachment_by_file_name_with_http_info(xero_tenant_id, repeating_invoice_id, file_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_repeating_invoice_attachment_by_file_name ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'repeating_invoice_id' is set
  if @api_client.config.client_side_validation && repeating_invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'repeating_invoice_id' when calling AccountingApi.update_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling AccountingApi.update_repeating_invoice_attachment_by_file_name"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountingApi.update_repeating_invoice_attachment_by_file_name"
  end
  # resource path
  local_var_path = '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}'.sub('{' + 'RepeatingInvoiceID' + '}', repeating_invoice_id.to_s).sub('{' + 'FileName' + '}', file_name.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/octet-stream'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'Attachments' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_repeating_invoice_attachment_by_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_rate(xero_tenant_id, tax_rates, opts = {}) ⇒ TaxRates

Allows you to update Tax Rates

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tax_rates (TaxRates)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TaxRates) 


16730
16731
16732
16733
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16730

def update_tax_rate(xero_tenant_id, tax_rates, opts = {})
  data, _status_code, _headers = update_tax_rate_with_http_info(xero_tenant_id, tax_rates, opts)
  data
end

#update_tax_rate_with_http_info(xero_tenant_id, tax_rates, opts = {}) ⇒ Array<(TaxRates, Integer, Hash)>

Allows you to update Tax Rates

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tax_rates (TaxRates)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TaxRates, Integer, Hash)>) —

    TaxRates data, response status code and response headers



16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16740

def update_tax_rate_with_http_info(xero_tenant_id, tax_rates, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_tax_rate ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_tax_rate"
  end
  # verify the required parameter 'tax_rates' is set
  if @api_client.config.client_side_validation && tax_rates.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rates' when calling AccountingApi.update_tax_rate"
  end
  # resource path
  local_var_path = '/TaxRates'

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(tax_rates) 

  # return_type
  return_type = opts[:return_type] || 'TaxRates' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_tax_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, opts = {}) ⇒ TrackingCategories

Allows you to update tracking categories

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • tracking_category (TrackingCategory)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TrackingCategories) 


16806
16807
16808
16809
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16806

def update_tracking_category(xero_tenant_id, tracking_category_id, tracking_category, opts = {})
  data, _status_code, _headers = update_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, tracking_category, opts)
  data
end

#update_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, tracking_category, opts = {}) ⇒ Array<(TrackingCategories, Integer, Hash)>

Allows you to update tracking categories

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • tracking_category (TrackingCategory)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrackingCategories, Integer, Hash)>) —

    TrackingCategories data, response status code and response headers



16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16817

def update_tracking_category_with_http_info(xero_tenant_id, tracking_category_id, tracking_category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_tracking_category ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_tracking_category"
  end
  # verify the required parameter 'tracking_category_id' is set
  if @api_client.config.client_side_validation && tracking_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_category_id' when calling AccountingApi.update_tracking_category"
  end
  # verify the required parameter 'tracking_category' is set
  if @api_client.config.client_side_validation && tracking_category.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_category' when calling AccountingApi.update_tracking_category"
  end
  # resource path
  local_var_path = '/TrackingCategories/{TrackingCategoryID}'.sub('{' + 'TrackingCategoryID' + '}', tracking_category_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(tracking_category) 

  # return_type
  return_type = opts[:return_type] || 'TrackingCategories' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_tracking_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts = {}) ⇒ TrackingOptions

Allows you to update options for a specified tracking category

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • tracking_option_id (String) —

    Unique identifier for a Tracking Option

  • tracking_option (TrackingOption)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (TrackingOptions) 


16888
16889
16890
16891
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16888

def update_tracking_options(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts = {})
  data, _status_code, _headers = update_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts)
  data
end

#update_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts = {}) ⇒ Array<(TrackingOptions, Integer, Hash)>

Allows you to update options for a specified tracking category

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • tracking_category_id (String) —

    Unique identifier for a TrackingCategory

  • tracking_option_id (String) —

    Unique identifier for a Tracking Option

  • tracking_option (TrackingOption)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TrackingOptions, Integer, Hash)>) —

    TrackingOptions data, response status code and response headers



16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
 
# File 'lib/xero-ruby/api/accounting_api.rb', line 16900

def update_tracking_options_with_http_info(xero_tenant_id, tracking_category_id, tracking_option_id, tracking_option, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingApi.update_tracking_options ...'
  end
  # verify the required parameter 'xero_tenant_id' is set
  if @api_client.config.client_side_validation && xero_tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_tracking_options"
  end
  # verify the required parameter 'tracking_category_id' is set
  if @api_client.config.client_side_validation && tracking_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_category_id' when calling AccountingApi.update_tracking_options"
  end
  # verify the required parameter 'tracking_option_id' is set
  if @api_client.config.client_side_validation && tracking_option_id.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_option_id' when calling AccountingApi.update_tracking_options"
  end
  # verify the required parameter 'tracking_option' is set
  if @api_client.config.client_side_validation && tracking_option.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_option' when calling AccountingApi.update_tracking_options"
  end
  # resource path
  local_var_path = '/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}'.sub('{' + 'TrackingCategoryID' + '}', tracking_category_id.to_s).sub('{' + 'TrackingOptionID' + '}', tracking_option_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = opts[:'where'].map{|k,v| "#{@api_client.camelize_key(k)}#{v}"}.join(' AND ') if !opts[:'where'].nil?
  # query parameters
  query_params = opts[:query_params] || {}
  
  # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
  query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'xero-tenant-id'] = xero_tenant_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(tracking_option) 

  # return_type
  return_type = opts[:return_type] || 'TrackingOptions' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingApi#update_tracking_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end