Class: XeroRuby::PayrollUkApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.new) ⇒ PayrollUkApi

Returns a new instance of PayrollUkApi.



16
17
18
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#approve_timesheet(xero_tenant_id, timesheet_id, opts = {}) ⇒ TimesheetObject

Approves a specific timesheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

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

    the optional parameters

Returns:

  • (TimesheetObject) 


24
25
26
27
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 24

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

#approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) ⇒ Array<(TimesheetObject, Integer, Hash)>

Approves a specific timesheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • opts (Hash) —

    the optional parameters

Returns:

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

    TimesheetObject data, response status code and response headers



34
35
36
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 34

def approve_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.approve_timesheet ...'
  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 PayrollUkApi.approve_timesheet"
  end
  # verify the required parameter 'timesheet_id' is set
  if @api_client.config.client_side_validation && timesheet_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_id' when calling PayrollUkApi.approve_timesheet"
  end
  # resource path
  local_var_path = '/Timesheets/{TimesheetID}/Approve'.sub('{' + 'TimesheetID' + '}', timesheet_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'TimesheetObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#approve_timesheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_benefit(xero_tenant_id, benefit, opts = {}) ⇒ BenefitObject

Creates a new employee benefit

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (BenefitObject) 


99
100
101
102
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 99

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

#create_benefit_with_http_info(xero_tenant_id, benefit, options = {}) ⇒ Array<(BenefitObject, Integer, Hash)>

Creates a new employee benefit

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • benefit (Benefit)
  • opts (Hash) —

    the optional parameters

Returns:

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

    BenefitObject data, response status code and response headers



109
110
111
112
113
114
115
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 109

def create_benefit_with_http_info(xero_tenant_id, benefit, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_benefit ...'
  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 PayrollUkApi.create_benefit"
  end
  # verify the required parameter 'benefit' is set
  if @api_client.config.client_side_validation && benefit.nil?
    fail ArgumentError, "Missing the required parameter 'benefit' when calling PayrollUkApi.create_benefit"
  end
  # resource path
  local_var_path = '/Benefits'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(benefit) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_benefit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_deduction(xero_tenant_id, deduction, opts = {}) ⇒ DeductionObject

Creates a new deduction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (DeductionObject) 


176
177
178
179
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 176

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

#create_deduction_with_http_info(xero_tenant_id, deduction, options = {}) ⇒ Array<(DeductionObject, Integer, Hash)>

Creates a new deduction

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • deduction (Deduction)
  • opts (Hash) —

    the optional parameters

Returns:

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

    DeductionObject data, response status code and response headers



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 186

def create_deduction_with_http_info(xero_tenant_id, deduction, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_deduction ...'
  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 PayrollUkApi.create_deduction"
  end
  # verify the required parameter 'deduction' is set
  if @api_client.config.client_side_validation && deduction.nil?
    fail ArgumentError, "Missing the required parameter 'deduction' when calling PayrollUkApi.create_deduction"
  end
  # resource path
  local_var_path = '/Deductions'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(deduction) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_deduction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_earnings_rate(xero_tenant_id, earnings_rate, opts = {}) ⇒ EarningsRateObject

Creates a new earnings rate

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (EarningsRateObject) 


253
254
255
256
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 253

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

#create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = {}) ⇒ Array<(EarningsRateObject, Integer, Hash)>

Creates a new earnings rate

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • earnings_rate (EarningsRate)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EarningsRateObject data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 263

def create_earnings_rate_with_http_info(xero_tenant_id, earnings_rate, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_earnings_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 PayrollUkApi.create_earnings_rate"
  end
  # verify the required parameter 'earnings_rate' is set
  if @api_client.config.client_side_validation && earnings_rate.nil?
    fail ArgumentError, "Missing the required parameter 'earnings_rate' when calling PayrollUkApi.create_earnings_rate"
  end
  # resource path
  local_var_path = '/EarningsRates'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(earnings_rate) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_earnings_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employee(xero_tenant_id, employee, opts = {}) ⇒ EmployeeObject

Creates employees

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (EmployeeObject) 


330
331
332
333
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 330

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

#create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {}) ⇒ EarningsTemplateObject

Creates an earnings template records for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EarningsTemplateObject) 


408
409
410
411
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 408

def create_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {})
  data, _status_code, _headers = create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts)
  data
end

#create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {}) ⇒ Array<(EarningsTemplateObject, Integer, Hash)>

Creates an earnings template records for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • earnings_template (EarningsTemplate)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EarningsTemplateObject data, response status code and response headers



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 419

def create_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_earnings_template ...'
  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 PayrollUkApi.create_employee_earnings_template"
  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 PayrollUkApi.create_employee_earnings_template"
  end
  # verify the required parameter 'earnings_template' is set
  if @api_client.config.client_side_validation && earnings_template.nil?
    fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollUkApi.create_employee_earnings_template"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(earnings_template) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employee_earnings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts = {}) ⇒ EmployeeLeaveObject

Creates leave records for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeLeaveObject) 


491
492
493
494
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 491

def create_employee_leave(xero_tenant_id, employee_id, employee_leave, opts = {})
  data, _status_code, _headers = create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, opts)
  data
end

#create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts = {}) ⇒ EmployeeLeaveTypeObject

Creates employee leave type records

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeLeaveTypeObject) 


574
575
576
577
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 574

def create_employee_leave_type(xero_tenant_id, employee_id, employee_leave_type, opts = {})
  data, _status_code, _headers = create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, opts)
  data
end

#create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, options = {}) ⇒ Array<(EmployeeLeaveTypeObject, Integer, Hash)>

Creates employee leave type records

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • employee_leave_type (EmployeeLeaveType)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeLeaveTypeObject data, response status code and response headers



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 585

def create_employee_leave_type_with_http_info(xero_tenant_id, employee_id, employee_leave_type, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_leave_type ...'
  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 PayrollUkApi.create_employee_leave_type"
  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 PayrollUkApi.create_employee_leave_type"
  end
  # verify the required parameter 'employee_leave_type' is set
  if @api_client.config.client_side_validation && employee_leave_type.nil?
    fail ArgumentError, "Missing the required parameter 'employee_leave_type' when calling PayrollUkApi.create_employee_leave_type"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/LeaveTypes'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employee_leave_type) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employee_leave_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, options = {}) ⇒ Array<(EmployeeLeaveObject, Integer, Hash)>

Creates leave records for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • employee_leave (EmployeeLeave)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeLeaveObject data, response status code and response headers



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 502

def create_employee_leave_with_http_info(xero_tenant_id, employee_id, employee_leave, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_leave ...'
  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 PayrollUkApi.create_employee_leave"
  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 PayrollUkApi.create_employee_leave"
  end
  # verify the required parameter 'employee_leave' is set
  if @api_client.config.client_side_validation && employee_leave.nil?
    fail ArgumentError, "Missing the required parameter 'employee_leave' when calling PayrollUkApi.create_employee_leave"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/Leave'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employee_leave) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employee_leave\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts = {}) ⇒ EmployeeOpeningBalancesObject

Creates an opening balance for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeOpeningBalancesObject) 


657
658
659
660
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 657

def create_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts = {})
  data, _status_code, _headers = create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, opts)
  data
end

#create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {}) ⇒ Array<(EmployeeOpeningBalancesObject, Integer, Hash)>

Creates an opening balance for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • employee_opening_balances (EmployeeOpeningBalances)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeOpeningBalancesObject data, response status code and response headers



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 668

def create_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_opening_balances ...'
  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 PayrollUkApi.create_employee_opening_balances"
  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 PayrollUkApi.create_employee_opening_balances"
  end
  # verify the required parameter 'employee_opening_balances' is set
  if @api_client.config.client_side_validation && employee_opening_balances.nil?
    fail ArgumentError, "Missing the required parameter 'employee_opening_balances' when calling PayrollUkApi.create_employee_opening_balances"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/ukopeningbalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employee_opening_balances) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employee_opening_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts = {}) ⇒ PaymentMethodObject

Creates an employee payment method

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (PaymentMethodObject) 


740
741
742
743
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 740

def create_employee_payment_method(xero_tenant_id, employee_id, payment_method, opts = {})
  data, _status_code, _headers = create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, opts)
  data
end

#create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, options = {}) ⇒ Array<(PaymentMethodObject, Integer, Hash)>

Creates an employee payment method

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • payment_method (PaymentMethod)
  • opts (Hash) —

    the optional parameters

Returns:

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

    PaymentMethodObject data, response status code and response headers



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 751

def create_employee_payment_method_with_http_info(xero_tenant_id, employee_id, payment_method, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_payment_method ...'
  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 PayrollUkApi.create_employee_payment_method"
  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 PayrollUkApi.create_employee_payment_method"
  end
  # verify the required parameter 'payment_method' is set
  if @api_client.config.client_side_validation && payment_method.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method' when calling PayrollUkApi.create_employee_payment_method"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/PaymentMethods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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_method) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employee_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts = {}) ⇒ SalaryAndWageObject

Creates a salary and wage record for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (SalaryAndWageObject) 


823
824
825
826
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 823

def create_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wage, opts = {})
  data, _status_code, _headers = create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, opts)
  data
end

#create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, options = {}) ⇒ Array<(SalaryAndWageObject, Integer, Hash)>

Creates a salary and wage record for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • salary_and_wage (SalaryAndWage)
  • opts (Hash) —

    the optional parameters

Returns:

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

    SalaryAndWageObject data, response status code and response headers



834
835
836
837
838
839
840
841
842
843
844
845
846
847
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 834

def create_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wage, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_salary_and_wage ...'
  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 PayrollUkApi.create_employee_salary_and_wage"
  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 PayrollUkApi.create_employee_salary_and_wage"
  end
  # verify the required parameter 'salary_and_wage' is set
  if @api_client.config.client_side_validation && salary_and_wage.nil?
    fail ArgumentError, "Missing the required parameter 'salary_and_wage' when calling PayrollUkApi.create_employee_salary_and_wage"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/SalaryAndWages'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(salary_and_wage) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employee_salary_and_wage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employee_statutory_sick_leave(xero_tenant_id, employee_statutory_sick_leave, opts = {}) ⇒ EmployeeStatutorySickLeaveObject

Creates statutory sick leave records

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (EmployeeStatutorySickLeaveObject) 


905
906
907
908
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 905

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

#create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee_statutory_sick_leave, options = {}) ⇒ Array<(EmployeeStatutorySickLeaveObject, Integer, Hash)>

Creates statutory sick leave records

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_statutory_sick_leave (EmployeeStatutorySickLeave)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeStatutorySickLeaveObject data, response status code and response headers



915
916
917
918
919
920
921
922
923
924
925
926
927
928
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 915

def create_employee_statutory_sick_leave_with_http_info(xero_tenant_id, employee_statutory_sick_leave, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employee_statutory_sick_leave ...'
  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 PayrollUkApi.create_employee_statutory_sick_leave"
  end
  # verify the required parameter 'employee_statutory_sick_leave' is set
  if @api_client.config.client_side_validation && employee_statutory_sick_leave.nil?
    fail ArgumentError, "Missing the required parameter 'employee_statutory_sick_leave' when calling PayrollUkApi.create_employee_statutory_sick_leave"
  end
  # resource path
  local_var_path = '/StatutoryLeaves/Sick'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employee_statutory_sick_leave) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employee_statutory_sick_leave\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employee_with_http_info(xero_tenant_id, employee, options = {}) ⇒ Array<(EmployeeObject, Integer, Hash)>

Creates employees

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee (Employee)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeObject data, response status code and response headers



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 340

def create_employee_with_http_info(xero_tenant_id, employee, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_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 PayrollUkApi.create_employee"
  end
  # verify the required parameter 'employee' is set
  if @api_client.config.client_side_validation && employee.nil?
    fail ArgumentError, "Missing the required parameter 'employee' when calling PayrollUkApi.create_employee"
  end
  # resource path
  local_var_path = '/Employees'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employee) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_employment(xero_tenant_id, employee_id, employment, opts = {}) ⇒ EmploymentObject

Creates employment detail for a specific employee using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmploymentObject) 


983
984
985
986
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 983

def create_employment(xero_tenant_id, employee_id, employment, opts = {})
  data, _status_code, _headers = create_employment_with_http_info(xero_tenant_id, employee_id, employment, opts)
  data
end

#create_employment_with_http_info(xero_tenant_id, employee_id, employment, options = {}) ⇒ Array<(EmploymentObject, Integer, Hash)>

Creates employment detail for a specific employee using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • employment (Employment)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmploymentObject data, response status code and response headers



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 994

def create_employment_with_http_info(xero_tenant_id, employee_id, employment, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_employment ...'
  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 PayrollUkApi.create_employment"
  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 PayrollUkApi.create_employment"
  end
  # verify the required parameter 'employment' is set
  if @api_client.config.client_side_validation && employment.nil?
    fail ArgumentError, "Missing the required parameter 'employment' when calling PayrollUkApi.create_employment"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/Employment'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employment) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_employment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_leave_type(xero_tenant_id, leave_type, opts = {}) ⇒ LeaveTypeObject

Creates a new leave type

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (LeaveTypeObject) 


1065
1066
1067
1068
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1065

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

#create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {}) ⇒ Array<(LeaveTypeObject, Integer, Hash)>

Creates a new leave type

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • leave_type (LeaveType)
  • opts (Hash) —

    the optional parameters

Returns:

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

    LeaveTypeObject data, response status code and response headers



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1075

def create_leave_type_with_http_info(xero_tenant_id, leave_type, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_leave_type ...'
  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 PayrollUkApi.create_leave_type"
  end
  # verify the required parameter 'leave_type' is set
  if @api_client.config.client_side_validation && leave_type.nil?
    fail ArgumentError, "Missing the required parameter 'leave_type' when calling PayrollUkApi.create_leave_type"
  end
  # resource path
  local_var_path = '/LeaveTypes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(leave_type) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_leave_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {}) ⇒ EmployeePayTemplates

Creates multiple earnings template records for a specific employee using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • earnings_template (Array<EarningsTemplate>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (EmployeePayTemplates) 


1143
1144
1145
1146
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1143

def create_multiple_employee_earnings_template(xero_tenant_id, employee_id, earnings_template, opts = {})
  data, _status_code, _headers = create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, opts)
  data
end

#create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {}) ⇒ Array<(EmployeePayTemplates, Integer, Hash)>

Creates multiple earnings template records for a specific employee using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • earnings_template (Array<EarningsTemplate>)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeePayTemplates data, response status code and response headers



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1154

def create_multiple_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, earnings_template, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_multiple_employee_earnings_template ...'
  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 PayrollUkApi.create_multiple_employee_earnings_template"
  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 PayrollUkApi.create_multiple_employee_earnings_template"
  end
  # verify the required parameter 'earnings_template' is set
  if @api_client.config.client_side_validation && earnings_template.nil?
    fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollUkApi.create_multiple_employee_earnings_template"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/paytemplateearnings'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(earnings_template) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_multiple_employee_earnings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_pay_run_calendar(xero_tenant_id, pay_run_calendar, opts = {}) ⇒ PayRunCalendarObject

Creates a new payrun calendar

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (PayRunCalendarObject) 


1225
1226
1227
1228
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1225

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

#create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, options = {}) ⇒ Array<(PayRunCalendarObject, Integer, Hash)>

Creates a new payrun calendar

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_calendar (PayRunCalendar)
  • opts (Hash) —

    the optional parameters

Returns:

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

    PayRunCalendarObject data, response status code and response headers



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1235

def create_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_pay_run_calendar ...'
  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 PayrollUkApi.create_pay_run_calendar"
  end
  # verify the required parameter 'pay_run_calendar' is set
  if @api_client.config.client_side_validation && pay_run_calendar.nil?
    fail ArgumentError, "Missing the required parameter 'pay_run_calendar' when calling PayrollUkApi.create_pay_run_calendar"
  end
  # resource path
  local_var_path = '/PayRunCalendars'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(pay_run_calendar) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_pay_run_calendar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_reimbursement(xero_tenant_id, reimbursement, opts = {}) ⇒ ReimbursementObject

Creates a new reimbursement

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (ReimbursementObject) 


1302
1303
1304
1305
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1302

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

#create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = {}) ⇒ Array<(ReimbursementObject, Integer, Hash)>

Creates a new reimbursement

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • reimbursement (Reimbursement)
  • opts (Hash) —

    the optional parameters

Returns:

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

    ReimbursementObject data, response status code and response headers



1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1312

def create_reimbursement_with_http_info(xero_tenant_id, reimbursement, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_reimbursement ...'
  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 PayrollUkApi.create_reimbursement"
  end
  # verify the required parameter 'reimbursement' is set
  if @api_client.config.client_side_validation && reimbursement.nil?
    fail ArgumentError, "Missing the required parameter 'reimbursement' when calling PayrollUkApi.create_reimbursement"
  end
  # resource path
  local_var_path = '/Reimbursements'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(reimbursement) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_reimbursement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_timesheet(xero_tenant_id, timesheet, opts = {}) ⇒ TimesheetObject

Creates a new timesheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (TimesheetObject) 


1379
1380
1381
1382
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1379

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

#create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts = {}) ⇒ TimesheetLineObject

Creates a new timesheet line for a specific timesheet using a unique timesheet ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

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

    the optional parameters

Returns:

  • (TimesheetLineObject) 


1457
1458
1459
1460
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1457

def create_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line, opts = {})
  data, _status_code, _headers = create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, opts)
  data
end

#create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, options = {}) ⇒ Array<(TimesheetLineObject, Integer, Hash)>

Creates a new timesheet line for a specific timesheet using a unique timesheet ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • timesheet_line (TimesheetLine)
  • opts (Hash) —

    the optional parameters

Returns:

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

    TimesheetLineObject data, response status code and response headers



1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1468

def create_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_timesheet_line ...'
  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 PayrollUkApi.create_timesheet_line"
  end
  # verify the required parameter 'timesheet_id' is set
  if @api_client.config.client_side_validation && timesheet_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_id' when calling PayrollUkApi.create_timesheet_line"
  end
  # verify the required parameter 'timesheet_line' is set
  if @api_client.config.client_side_validation && timesheet_line.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_line' when calling PayrollUkApi.create_timesheet_line"
  end
  # resource path
  local_var_path = '/Timesheets/{TimesheetID}/Lines'.sub('{' + 'TimesheetID' + '}', timesheet_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(timesheet_line) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_timesheet_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {}) ⇒ Array<(TimesheetObject, Integer, Hash)>

Creates a new timesheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet (Timesheet)
  • opts (Hash) —

    the optional parameters

Returns:

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

    TimesheetObject data, response status code and response headers



1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1389

def create_timesheet_with_http_info(xero_tenant_id, timesheet, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.create_timesheet ...'
  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 PayrollUkApi.create_timesheet"
  end
  # verify the required parameter 'timesheet' is set
  if @api_client.config.client_side_validation && timesheet.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet' when calling PayrollUkApi.create_timesheet"
  end
  # resource path
  local_var_path = '/Timesheets'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(timesheet) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#create_timesheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, opts = {}) ⇒ nil

Deletes a specific employee’s earnings template record

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • pay_template_earning_id (String) —

    Id for single pay template earnings object

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

    the optional parameters

Returns:

  • (nil) 


1540
1541
1542
1543
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1540

def delete_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, opts = {})
  delete_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, opts)
  nil
end

#delete_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, options = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes a specific employee&#39;s earnings template record

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • pay_template_earning_id (String) —

    Id for single pay template earnings object

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1551

def delete_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_employee_earnings_template ...'
  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 PayrollUkApi.delete_employee_earnings_template"
  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 PayrollUkApi.delete_employee_earnings_template"
  end
  # verify the required parameter 'pay_template_earning_id' is set
  if @api_client.config.client_side_validation && pay_template_earning_id.nil?
    fail ArgumentError, "Missing the required parameter 'pay_template_earning_id' when calling PayrollUkApi.delete_employee_earnings_template"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#delete_employee_earnings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_employee_leave(xero_tenant_id, employee_id, leave_id, opts = {}) ⇒ EmployeeLeaveObject

Deletes a specific employee’s leave record

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • leave_id (String) —

    Leave id for single object

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

    the optional parameters

Returns:

  • (EmployeeLeaveObject) 


1619
1620
1621
1622
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1619

def delete_employee_leave(xero_tenant_id, employee_id, leave_id, opts = {})
  data, _status_code, _headers = delete_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, opts)
  data
end

#delete_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, options = {}) ⇒ Array<(EmployeeLeaveObject, Integer, Hash)>

Deletes a specific employee&#39;s leave record

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • leave_id (String) —

    Leave id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeLeaveObject data, response status code and response headers



1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1630

def delete_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_employee_leave ...'
  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 PayrollUkApi.delete_employee_leave"
  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 PayrollUkApi.delete_employee_leave"
  end
  # verify the required parameter 'leave_id' is set
  if @api_client.config.client_side_validation && leave_id.nil?
    fail ArgumentError, "Missing the required parameter 'leave_id' when calling PayrollUkApi.delete_employee_leave"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/Leave/{LeaveID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeLeaveObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#delete_employee_leave\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, opts = {}) ⇒ nil

Deletes a salary and wages record for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • salary_and_wages_id (String) —

    Id for single salary and wages object

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

    the optional parameters

Returns:

  • (nil) 


1700
1701
1702
1703
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1700

def delete_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, opts = {})
  delete_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, opts)
  nil
end

#delete_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, options = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes a salary and wages record for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • salary_and_wages_id (String) —

    Id for single salary and wages object

  • opts (Hash) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1711

def delete_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_employee_salary_and_wage ...'
  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 PayrollUkApi.delete_employee_salary_and_wage"
  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 PayrollUkApi.delete_employee_salary_and_wage"
  end
  # verify the required parameter 'salary_and_wages_id' is set
  if @api_client.config.client_side_validation && salary_and_wages_id.nil?
    fail ArgumentError, "Missing the required parameter 'salary_and_wages_id' when calling PayrollUkApi.delete_employee_salary_and_wage"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#delete_employee_salary_and_wage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_timesheet(xero_tenant_id, timesheet_id, opts = {}) ⇒ TimesheetLine

Deletes a specific timesheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

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

    the optional parameters

Returns:

  • (TimesheetLine) 


1778
1779
1780
1781
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1778

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

#delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, opts = {}) ⇒ TimesheetLine

Deletes a specific timesheet line

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • timesheet_line_id (String) —

    Identifier for the timesheet line

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

    the optional parameters

Returns:

  • (TimesheetLine) 


1854
1855
1856
1857
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1854

def delete_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, opts = {})
  data, _status_code, _headers = delete_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, opts)
  data
end

#delete_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, options = {}) ⇒ Array<(TimesheetLine, Integer, Hash)>

Deletes a specific timesheet line

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • timesheet_line_id (String) —

    Identifier for the timesheet line

  • opts (Hash) —

    the optional parameters

Returns:

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

    TimesheetLine data, response status code and response headers



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1865

def delete_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_timesheet_line ...'
  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 PayrollUkApi.delete_timesheet_line"
  end
  # verify the required parameter 'timesheet_id' is set
  if @api_client.config.client_side_validation && timesheet_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_id' when calling PayrollUkApi.delete_timesheet_line"
  end
  # verify the required parameter 'timesheet_line_id' is set
  if @api_client.config.client_side_validation && timesheet_line_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_line_id' when calling PayrollUkApi.delete_timesheet_line"
  end
  # resource path
  local_var_path = '/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}'.sub('{' + 'TimesheetID' + '}', timesheet_id.to_s).sub('{' + 'TimesheetLineID' + '}', timesheet_line_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'TimesheetLine' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#delete_timesheet_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) ⇒ Array<(TimesheetLine, Integer, Hash)>

Deletes a specific timesheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • opts (Hash) —

    the optional parameters

Returns:

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

    TimesheetLine data, response status code and response headers



1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1788

def delete_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.delete_timesheet ...'
  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 PayrollUkApi.delete_timesheet"
  end
  # verify the required parameter 'timesheet_id' is set
  if @api_client.config.client_side_validation && timesheet_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_id' when calling PayrollUkApi.delete_timesheet"
  end
  # resource path
  local_var_path = '/Timesheets/{TimesheetID}'.sub('{' + 'TimesheetID' + '}', timesheet_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'TimesheetLine' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#delete_timesheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_benefit(xero_tenant_id, id, opts = {}) ⇒ BenefitObject

Retrieves a specific benefit by using a unique benefit ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • id (String) —

    Identifier for the benefit

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

    the optional parameters

Returns:

  • (BenefitObject) 


1934
1935
1936
1937
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1934

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

#get_benefit_with_http_info(xero_tenant_id, id, options = {}) ⇒ Array<(BenefitObject, Integer, Hash)>

Retrieves a specific benefit by using a unique benefit ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • id (String) —

    Identifier for the benefit

  • opts (Hash) —

    the optional parameters

Returns:

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

    BenefitObject data, response status code and response headers



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 1944

def get_benefit_with_http_info(xero_tenant_id, id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_benefit ...'
  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 PayrollUkApi.get_benefit"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PayrollUkApi.get_benefit"
  end
  # resource path
  local_var_path = '/Benefits/{id}'.sub('{' + 'id' + '}', id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'BenefitObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_benefit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_benefits(xero_tenant_id, opts = {}) ⇒ Benefits

Retrieves employee benefits

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (Benefits) 


2009
2010
2011
2012
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2009

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

#get_benefits_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(Benefits, Integer, Hash)>

Retrieves employee benefits

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    Benefits data, response status code and response headers



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
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2019

def get_benefits_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_benefits ...'
  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 PayrollUkApi.get_benefits"
  end
  # resource path
  local_var_path = '/Benefits'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  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

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_benefits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_deduction(xero_tenant_id, deduction_id, opts = {}) ⇒ DeductionObject

Retrieves a specific deduction by using a unique deduction ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • deduction_id (String) —

    Identifier for the deduction

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

    the optional parameters

Returns:

  • (DeductionObject) 


2081
2082
2083
2084
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2081

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

#get_deduction_with_http_info(xero_tenant_id, deduction_id, options = {}) ⇒ Array<(DeductionObject, Integer, Hash)>

Retrieves a specific deduction by using a unique deduction ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • deduction_id (String) —

    Identifier for the deduction

  • opts (Hash) —

    the optional parameters

Returns:

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

    DeductionObject data, response status code and response headers



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
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2091

def get_deduction_with_http_info(xero_tenant_id, deduction_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_deduction ...'
  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 PayrollUkApi.get_deduction"
  end
  # verify the required parameter 'deduction_id' is set
  if @api_client.config.client_side_validation && deduction_id.nil?
    fail ArgumentError, "Missing the required parameter 'deduction_id' when calling PayrollUkApi.get_deduction"
  end
  # resource path
  local_var_path = '/Deductions/{deductionId}'.sub('{' + 'deductionId' + '}', deduction_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'DeductionObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_deduction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_deductions(xero_tenant_id, opts = {}) ⇒ Deductions

Retrieves deductions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (Deductions) 


2156
2157
2158
2159
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2156

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

#get_deductions_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(Deductions, Integer, Hash)>

Retrieves deductions

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    Deductions data, response status code and response headers



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
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2166

def get_deductions_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_deductions ...'
  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 PayrollUkApi.get_deductions"
  end
  # resource path
  local_var_path = '/Deductions'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  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

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_deductions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_earnings_order(xero_tenant_id, id, opts = {}) ⇒ EarningsOrderObject

Retrieves a specific earnings orders by using a unique earnings orders id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • id (String) —

    Identifier for the deduction

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

    the optional parameters

Returns:

  • (EarningsOrderObject) 


2228
2229
2230
2231
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2228

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

#get_earnings_order_with_http_info(xero_tenant_id, id, options = {}) ⇒ Array<(EarningsOrderObject, Integer, Hash)>

Retrieves a specific earnings orders by using a unique earnings orders id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • id (String) —

    Identifier for the deduction

  • opts (Hash) —

    the optional parameters

Returns:

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

    EarningsOrderObject data, response status code and response headers



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
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2238

def get_earnings_order_with_http_info(xero_tenant_id, id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_earnings_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 PayrollUkApi.get_earnings_order"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling PayrollUkApi.get_earnings_order"
  end
  # resource path
  local_var_path = '/EarningsOrders/{id}'.sub('{' + 'id' + '}', id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EarningsOrderObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_earnings_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_earnings_orders(xero_tenant_id, opts = {}) ⇒ EarningsOrders

Retrieves earnings orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (EarningsOrders) 


2303
2304
2305
2306
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2303

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

#get_earnings_orders_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(EarningsOrders, Integer, Hash)>

Retrieves earnings orders

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    EarningsOrders data, response status code and response headers



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
2368
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2313

def get_earnings_orders_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_earnings_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 PayrollUkApi.get_earnings_orders"
  end
  # resource path
  local_var_path = '/EarningsOrders'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  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

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_earnings_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_earnings_rate(xero_tenant_id, earnings_rate_id, opts = {}) ⇒ EarningsRateObject

Retrieves a specific earnings rates by using a unique earnings rate id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • earnings_rate_id (String) —

    Identifier for the earnings rate

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

    the optional parameters

Returns:

  • (EarningsRateObject) 


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

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

#get_earnings_rate_with_http_info(xero_tenant_id, earnings_rate_id, options = {}) ⇒ Array<(EarningsRateObject, Integer, Hash)>

Retrieves a specific earnings rates by using a unique earnings rate id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • earnings_rate_id (String) —

    Identifier for the earnings rate

  • opts (Hash) —

    the optional parameters

Returns:

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

    EarningsRateObject data, response status code and response headers



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
2443
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2385

def get_earnings_rate_with_http_info(xero_tenant_id, earnings_rate_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_earnings_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 PayrollUkApi.get_earnings_rate"
  end
  # verify the required parameter 'earnings_rate_id' is set
  if @api_client.config.client_side_validation && earnings_rate_id.nil?
    fail ArgumentError, "Missing the required parameter 'earnings_rate_id' when calling PayrollUkApi.get_earnings_rate"
  end
  # resource path
  local_var_path = '/EarningsRates/{EarningsRateID}'.sub('{' + 'EarningsRateID' + '}', earnings_rate_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EarningsRateObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_earnings_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_earnings_rates(xero_tenant_id, opts = {}) ⇒ EarningsRates

Retrieves earnings rates

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (EarningsRates) 


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

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

#get_earnings_rates_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(EarningsRates, Integer, Hash)>

Retrieves earnings rates

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    EarningsRates data, response status code and response headers



2460
2461
2462
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2460

def get_earnings_rates_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_earnings_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 PayrollUkApi.get_earnings_rates"
  end
  # resource path
  local_var_path = '/EarningsRates'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  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

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_earnings_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeeObject

Retrieves specific employees by using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeObject) 


2522
2523
2524
2525
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2522

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_leave(xero_tenant_id, employee_id, leave_id, opts = {}) ⇒ EmployeeLeaveObject

Retrieves a specific employee’s leave record using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • leave_id (String) —

    Leave id for single object

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

    the optional parameters

Returns:

  • (EmployeeLeaveObject) 


2598
2599
2600
2601
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2598

def get_employee_leave(xero_tenant_id, employee_id, leave_id, opts = {})
  data, _status_code, _headers = get_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, opts)
  data
end

#get_employee_leave_balances(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeeLeaveBalances

Retrieves a specific employee’s leave balances using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeLeaveBalances) 


2678
2679
2680
2681
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2678

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

#get_employee_leave_balances_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeeLeaveBalances, Integer, Hash)>

Retrieves a specific employee&#39;s leave balances using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeLeaveBalances data, response status code and response headers



2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2688

def get_employee_leave_balances_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leave_balances ...'
  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 PayrollUkApi.get_employee_leave_balances"
  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 PayrollUkApi.get_employee_leave_balances"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/LeaveBalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeLeaveBalances' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_leave_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_leave_periods(xero_tenant_id, employee_id, opts = {}) ⇒ LeavePeriods

Retrieves a specific employee’s leave periods using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Filter by start date

  • :end_date (Date) —

    Filter by end date

Returns:

  • (LeavePeriods) 


2755
2756
2757
2758
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2755

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

#get_employee_leave_periods_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(LeavePeriods, Integer, Hash)>

Retrieves a specific employee&#39;s leave periods using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    LeavePeriods data, response status code and response headers



2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2767

def get_employee_leave_periods_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leave_periods ...'
  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 PayrollUkApi.get_employee_leave_periods"
  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 PayrollUkApi.get_employee_leave_periods"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/LeavePeriods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_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] || 'LeavePeriods' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_leave_periods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_leave_types(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeeLeaveTypes

Retrieves a specific employee’s leave types using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeLeaveTypes) 


2834
2835
2836
2837
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2834

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

#get_employee_leave_types_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeeLeaveTypes, Integer, Hash)>

Retrieves a specific employee&#39;s leave types using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeLeaveTypes data, response status code and response headers



2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2844

def get_employee_leave_types_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leave_types ...'
  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 PayrollUkApi.get_employee_leave_types"
  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 PayrollUkApi.get_employee_leave_types"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/LeaveTypes'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeLeaveTypes' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_leave_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, options = {}) ⇒ Array<(EmployeeLeaveObject, Integer, Hash)>

Retrieves a specific employee&#39;s leave record using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • leave_id (String) —

    Leave id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeLeaveObject data, response status code and response headers



2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2609

def get_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leave ...'
  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 PayrollUkApi.get_employee_leave"
  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 PayrollUkApi.get_employee_leave"
  end
  # verify the required parameter 'leave_id' is set
  if @api_client.config.client_side_validation && leave_id.nil?
    fail ArgumentError, "Missing the required parameter 'leave_id' when calling PayrollUkApi.get_employee_leave"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/Leave/{LeaveID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeLeaveObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_leave\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_leaves(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeeLeaves

Retrieves a specific employee’s leave records using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeLeaves) 


2909
2910
2911
2912
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2909

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

#get_employee_leaves_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeeLeaves, Integer, Hash)>

Retrieves a specific employee&#39;s leave records using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeLeaves data, response status code and response headers



2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2919

def get_employee_leaves_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_leaves ...'
  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 PayrollUkApi.get_employee_leaves"
  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 PayrollUkApi.get_employee_leaves"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/Leave'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeLeaves' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_leaves\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_opening_balances(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeeOpeningBalancesObject

Retrieves a specific employee’s openingbalances using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeOpeningBalancesObject) 


2984
2985
2986
2987
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2984

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

#get_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeeOpeningBalancesObject, Integer, Hash)>

Retrieves a specific employee&#39;s openingbalances using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeOpeningBalancesObject data, response status code and response headers



2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2994

def get_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_opening_balances ...'
  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 PayrollUkApi.get_employee_opening_balances"
  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 PayrollUkApi.get_employee_opening_balances"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/ukopeningbalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeOpeningBalancesObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_opening_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_pay_template(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeePayTemplateObject

Retrieves a specific employee pay templates using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeePayTemplateObject) 


3059
3060
3061
3062
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3059

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

#get_employee_pay_template_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeePayTemplateObject, Integer, Hash)>

Retrieves a specific employee pay templates using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeePayTemplateObject data, response status code and response headers



3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3069

def get_employee_pay_template_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_pay_template ...'
  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 PayrollUkApi.get_employee_pay_template"
  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 PayrollUkApi.get_employee_pay_template"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/PayTemplates'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeePayTemplateObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_pay_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_payment_method(xero_tenant_id, employee_id, opts = {}) ⇒ PaymentMethodObject

Retrieves a specific employee’s payment method using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (PaymentMethodObject) 


3134
3135
3136
3137
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3134

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

#get_employee_payment_method_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(PaymentMethodObject, Integer, Hash)>

Retrieves a specific employee&#39;s payment method using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    PaymentMethodObject data, response status code and response headers



3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3144

def get_employee_payment_method_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_payment_method ...'
  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 PayrollUkApi.get_employee_payment_method"
  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 PayrollUkApi.get_employee_payment_method"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/PaymentMethods'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'PaymentMethodObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, opts = {}) ⇒ SalaryAndWages

Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • salary_and_wages_id (String) —

    Id for single pay template earnings object

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

    the optional parameters

Returns:

  • (SalaryAndWages) 


3210
3211
3212
3213
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3210

def get_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, opts = {})
  data, _status_code, _headers = get_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, opts)
  data
end

#get_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, options = {}) ⇒ Array<(SalaryAndWages, Integer, Hash)>

Retrieves a specific salary and wages record for a specific employee using a unique salary and wage id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • salary_and_wages_id (String) —

    Id for single pay template earnings object

  • opts (Hash) —

    the optional parameters

Returns:

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

    SalaryAndWages data, response status code and response headers



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
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3221

def get_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_salary_and_wage ...'
  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 PayrollUkApi.get_employee_salary_and_wage"
  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 PayrollUkApi.get_employee_salary_and_wage"
  end
  # verify the required parameter 'salary_and_wages_id' is set
  if @api_client.config.client_side_validation && salary_and_wages_id.nil?
    fail ArgumentError, "Missing the required parameter 'salary_and_wages_id' when calling PayrollUkApi.get_employee_salary_and_wage"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'SalaryAndWages' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_salary_and_wage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_salary_and_wages(xero_tenant_id, employee_id, opts = {}) ⇒ SalaryAndWages

Retrieves a specific employee’s salary and wages by using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (SalaryAndWages) 


3291
3292
3293
3294
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3291

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

#get_employee_salary_and_wages_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(SalaryAndWages, Integer, Hash)>

Retrieves a specific employee&#39;s salary and wages by using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    SalaryAndWages data, response status code and response headers



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
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3302

def get_employee_salary_and_wages_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_salary_and_wages ...'
  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 PayrollUkApi.get_employee_salary_and_wages"
  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 PayrollUkApi.get_employee_salary_and_wages"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/SalaryAndWages'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  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

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_salary_and_wages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_statutory_leave_balances(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeeStatutoryLeaveBalanceObject

Retrieves a specific employee’s leave balances using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Options Hash (opts):

  • :leave_type (String) —

    Filter by the type of statutory leave

  • :as_of_date (Date) —

    The date from which to calculate balance remaining. If not specified, current date UTC is used.

Returns:

  • (EmployeeStatutoryLeaveBalanceObject) 


3370
3371
3372
3373
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3370

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

#get_employee_statutory_leave_balances_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeeStatutoryLeaveBalanceObject, Integer, Hash)>

Retrieves a specific employee&#39;s leave balances using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeStatutoryLeaveBalanceObject data, response status code and response headers



3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3382

def get_employee_statutory_leave_balances_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_statutory_leave_balances ...'
  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 PayrollUkApi.get_employee_statutory_leave_balances"
  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 PayrollUkApi.get_employee_statutory_leave_balances"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/StatutoryLeaveBalance'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'LeaveType'] = opts[:'leave_type'] if !opts[:'leave_type'].nil?
  query_params[:'AsOfDate'] = opts[:'as_of_date'] if !opts[:'as_of_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] || 'EmployeeStatutoryLeaveBalanceObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_statutory_leave_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_statutory_sick_leave(xero_tenant_id, statutory_sick_leave_id, opts = {}) ⇒ EmployeeStatutorySickLeaveObject

Retrieves a statutory sick leave for an employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • statutory_sick_leave_id (String) —

    Statutory sick leave id for single object

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

    the optional parameters

Returns:

  • (EmployeeStatutorySickLeaveObject) 


3449
3450
3451
3452
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3449

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

#get_employee_statutory_sick_leave_with_http_info(xero_tenant_id, statutory_sick_leave_id, options = {}) ⇒ Array<(EmployeeStatutorySickLeaveObject, Integer, Hash)>

Retrieves a statutory sick leave for an employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • statutory_sick_leave_id (String) —

    Statutory sick leave id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeStatutorySickLeaveObject data, response status code and response headers



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
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3459

def get_employee_statutory_sick_leave_with_http_info(xero_tenant_id, statutory_sick_leave_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_statutory_sick_leave ...'
  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 PayrollUkApi.get_employee_statutory_sick_leave"
  end
  # verify the required parameter 'statutory_sick_leave_id' is set
  if @api_client.config.client_side_validation && statutory_sick_leave_id.nil?
    fail ArgumentError, "Missing the required parameter 'statutory_sick_leave_id' when calling PayrollUkApi.get_employee_statutory_sick_leave"
  end
  # resource path
  local_var_path = '/StatutoryLeaves/Sick/{StatutorySickLeaveID}'.sub('{' + 'StatutorySickLeaveID' + '}', statutory_sick_leave_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeStatutorySickLeaveObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_statutory_sick_leave\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_tax(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeeTaxObject

Retrieves tax records for a specific employee using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeTaxObject) 


3524
3525
3526
3527
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3524

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

#get_employee_tax_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeeTaxObject, Integer, Hash)>

Retrieves tax records for a specific employee using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeTaxObject data, response status code and response headers



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
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3534

def get_employee_tax_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_employee_tax ...'
  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 PayrollUkApi.get_employee_tax"
  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 PayrollUkApi.get_employee_tax"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/Tax'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeTaxObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employee_tax\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employee_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeeObject, Integer, Hash)>

Retrieves specific employees by using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeObject data, response status code and response headers



2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 2532

def get_employee_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.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 PayrollUkApi.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 PayrollUkApi.get_employee"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'EmployeeObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#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

Retrieves employees

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter by first name, lastname, and/or whether they are an off-payroll worker

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (Employees) 


3600
3601
3602
3603
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3600

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, options = {}) ⇒ Array<(Employees, Integer, Hash)>

Retrieves employees

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    Employees data, response status code and response headers



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
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3611

def get_employees_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.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 PayrollUkApi.get_employees"
  end
  # resource path
  local_var_path = '/Employees'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_employees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_leave_type(xero_tenant_id, leave_type_id, opts = {}) ⇒ LeaveTypeObject

Retrieves a specific leave type by using a unique leave type ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • leave_type_id (String) —

    Identifier for the leave type

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

    the optional parameters

Returns:

  • (LeaveTypeObject) 


3674
3675
3676
3677
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3674

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

#get_leave_type_with_http_info(xero_tenant_id, leave_type_id, options = {}) ⇒ Array<(LeaveTypeObject, Integer, Hash)>

Retrieves a specific leave type by using a unique leave type ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • leave_type_id (String) —

    Identifier for the leave type

  • opts (Hash) —

    the optional parameters

Returns:

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

    LeaveTypeObject data, response status code and response headers



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
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3684

def get_leave_type_with_http_info(xero_tenant_id, leave_type_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_leave_type ...'
  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 PayrollUkApi.get_leave_type"
  end
  # verify the required parameter 'leave_type_id' is set
  if @api_client.config.client_side_validation && leave_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'leave_type_id' when calling PayrollUkApi.get_leave_type"
  end
  # resource path
  local_var_path = '/LeaveTypes/{LeaveTypeID}'.sub('{' + 'LeaveTypeID' + '}', leave_type_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'LeaveTypeObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_leave_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_leave_types(xero_tenant_id, opts = {}) ⇒ LeaveTypes

Retrieves leave types

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

  • :active_only (Boolean) —

    Filters leave types by active status. By default the API returns all leave types.

Returns:

  • (LeaveTypes) 


3750
3751
3752
3753
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3750

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

#get_leave_types_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(LeaveTypes, Integer, Hash)>

Retrieves leave types

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    LeaveTypes data, response status code and response headers



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
3817
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3761

def get_leave_types_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_leave_types ...'
  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 PayrollUkApi.get_leave_types"
  end
  # resource path
  local_var_path = '/LeaveTypes'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'ActiveOnly'] = opts[:'active_only'] if !opts[:'active_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] || 'LeaveTypes' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_leave_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pay_run(xero_tenant_id, pay_run_id, opts = {}) ⇒ PayRunObject

Retrieves a specific pay run by using a unique pay run ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_id (String) —

    Identifier for the pay run

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

    the optional parameters

Returns:

  • (PayRunObject) 


3824
3825
3826
3827
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3824

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

#get_pay_run_calendar(xero_tenant_id, pay_run_calendar_id, opts = {}) ⇒ PayRunCalendarObject

Retrieves a specific payrun calendar by using a unique payrun calendar ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_calendar_id (String) —

    Identifier for the payrun calendars

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

    the optional parameters

Returns:

  • (PayRunCalendarObject) 


3899
3900
3901
3902
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3899

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

#get_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar_id, options = {}) ⇒ Array<(PayRunCalendarObject, Integer, Hash)>

Retrieves a specific payrun calendar by using a unique payrun calendar ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_calendar_id (String) —

    Identifier for the payrun calendars

  • opts (Hash) —

    the optional parameters

Returns:

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

    PayRunCalendarObject data, response status code and response headers



3909
3910
3911
3912
3913
3914
3915
3916
3917
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3909

def get_pay_run_calendar_with_http_info(xero_tenant_id, pay_run_calendar_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_run_calendar ...'
  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 PayrollUkApi.get_pay_run_calendar"
  end
  # verify the required parameter 'pay_run_calendar_id' is set
  if @api_client.config.client_side_validation && pay_run_calendar_id.nil?
    fail ArgumentError, "Missing the required parameter 'pay_run_calendar_id' when calling PayrollUkApi.get_pay_run_calendar"
  end
  # resource path
  local_var_path = '/PayRunCalendars/{PayRunCalendarID}'.sub('{' + 'PayRunCalendarID' + '}', pay_run_calendar_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'PayRunCalendarObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_pay_run_calendar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pay_run_calendars(xero_tenant_id, opts = {}) ⇒ PayRunCalendars

Retrieves payrun calendars

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (PayRunCalendars) 


3974
3975
3976
3977
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3974

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

#get_pay_run_calendars_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(PayRunCalendars, Integer, Hash)>

Retrieves payrun calendars

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    PayRunCalendars data, response status code and response headers



3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3984

def get_pay_run_calendars_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_run_calendars ...'
  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 PayrollUkApi.get_pay_run_calendars"
  end
  # resource path
  local_var_path = '/PayRunCalendars'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  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

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_pay_run_calendars\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pay_run_with_http_info(xero_tenant_id, pay_run_id, options = {}) ⇒ Array<(PayRunObject, Integer, Hash)>

Retrieves a specific pay run by using a unique pay run ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_id (String) —

    Identifier for the pay run

  • opts (Hash) —

    the optional parameters

Returns:

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

    PayRunObject data, response status code and response headers



3834
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 3834

def get_pay_run_with_http_info(xero_tenant_id, pay_run_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_run ...'
  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 PayrollUkApi.get_pay_run"
  end
  # verify the required parameter 'pay_run_id' is set
  if @api_client.config.client_side_validation && pay_run_id.nil?
    fail ArgumentError, "Missing the required parameter 'pay_run_id' when calling PayrollUkApi.get_pay_run"
  end
  # resource path
  local_var_path = '/PayRuns/{PayRunID}'.sub('{' + 'PayRunID' + '}', pay_run_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'PayRunObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_pay_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pay_runs(xero_tenant_id, opts = {}) ⇒ PayRuns

Retrieves pay runs

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

  • :status (String) —

    By default get payruns will return all the payruns for an organization. You can add GET api.xero.com/payroll.xro/2.0/payRuns?statu&#x3D;PayRunStatus to filter the payruns by status.

Returns:

  • (PayRuns) 


4047
4048
4049
4050
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4047

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

#get_pay_runs_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(PayRuns, Integer, Hash)>

Retrieves pay runs

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    PayRuns data, response status code and response headers



4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4058

def get_pay_runs_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_runs ...'
  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 PayrollUkApi.get_pay_runs"
  end
  allowable_values = ["Draft", "Posted"]
  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 = '/PayRuns'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'PayRuns' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_pay_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pay_slip(xero_tenant_id, payslip_id, opts = {}) ⇒ PayslipObject

Retrieves a specific payslip by using a unique payslip ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payslip_id (String) —

    Identifier for the payslip

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

    the optional parameters

Returns:

  • (PayslipObject) 


4125
4126
4127
4128
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4125

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

#get_pay_slip_with_http_info(xero_tenant_id, payslip_id, options = {}) ⇒ Array<(PayslipObject, Integer, Hash)>

Retrieves a specific payslip by using a unique payslip ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • payslip_id (String) —

    Identifier for the payslip

  • opts (Hash) —

    the optional parameters

Returns:

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

    PayslipObject data, response status code and response headers



4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4135

def get_pay_slip_with_http_info(xero_tenant_id, payslip_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_slip ...'
  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 PayrollUkApi.get_pay_slip"
  end
  # verify the required parameter 'payslip_id' is set
  if @api_client.config.client_side_validation && payslip_id.nil?
    fail ArgumentError, "Missing the required parameter 'payslip_id' when calling PayrollUkApi.get_pay_slip"
  end
  # resource path
  local_var_path = '/Payslips/{PayslipID}'.sub('{' + 'PayslipID' + '}', payslip_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'PayslipObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_pay_slip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pay_slips(xero_tenant_id, pay_run_id, opts = {}) ⇒ Payslips

Retrieves payslips

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_id (String) —

    PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (Payslips) 


4201
4202
4203
4204
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4201

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

#get_pay_slips_with_http_info(xero_tenant_id, pay_run_id, options = {}) ⇒ Array<(Payslips, Integer, Hash)>

Retrieves payslips

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_id (String) —

    PayrunID which specifies the containing payrun of payslips to retrieve. By default, the API does not group payslips by payrun.

  • opts (Hash) —

    the optional parameters

Returns:

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

    Payslips data, response status code and response headers



4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4212

def get_pay_slips_with_http_info(xero_tenant_id, pay_run_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_pay_slips ...'
  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 PayrollUkApi.get_pay_slips"
  end
  # verify the required parameter 'pay_run_id' is set
  if @api_client.config.client_side_validation && pay_run_id.nil?
    fail ArgumentError, "Missing the required parameter 'pay_run_id' when calling PayrollUkApi.get_pay_slips"
  end
  # resource path
  local_var_path = '/Payslips'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'PayRunID'] = pay_run_id
  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

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_pay_slips\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reimbursement(xero_tenant_id, reimbursement_id, opts = {}) ⇒ ReimbursementObject

Retrieves a specific reimbursement by using a unique reimbursement id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • reimbursement_id (String) —

    Identifier for the reimbursement

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

    the optional parameters

Returns:

  • (ReimbursementObject) 


4279
4280
4281
4282
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4279

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

#get_reimbursement_with_http_info(xero_tenant_id, reimbursement_id, options = {}) ⇒ Array<(ReimbursementObject, Integer, Hash)>

Retrieves a specific reimbursement by using a unique reimbursement id

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • reimbursement_id (String) —

    Identifier for the reimbursement

  • opts (Hash) —

    the optional parameters

Returns:

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

    ReimbursementObject data, response status code and response headers



4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4289

def get_reimbursement_with_http_info(xero_tenant_id, reimbursement_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_reimbursement ...'
  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 PayrollUkApi.get_reimbursement"
  end
  # verify the required parameter 'reimbursement_id' is set
  if @api_client.config.client_side_validation && reimbursement_id.nil?
    fail ArgumentError, "Missing the required parameter 'reimbursement_id' when calling PayrollUkApi.get_reimbursement"
  end
  # resource path
  local_var_path = '/Reimbursements/{ReimbursementID}'.sub('{' + 'ReimbursementID' + '}', reimbursement_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'ReimbursementObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_reimbursement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_reimbursements(xero_tenant_id, opts = {}) ⇒ Reimbursements

Retrieves reimbursements

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

Returns:

  • (Reimbursements) 


4354
4355
4356
4357
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4354

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

#get_reimbursements_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(Reimbursements, Integer, Hash)>

Retrieves reimbursements

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    Reimbursements data, response status code and response headers



4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4364

def get_reimbursements_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_reimbursements ...'
  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 PayrollUkApi.get_reimbursements"
  end
  # resource path
  local_var_path = '/Reimbursements'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  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

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_reimbursements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_settings(xero_tenant_id, opts = {}) ⇒ Settings

Retrieves payroll settings

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (Settings) 


4425
4426
4427
4428
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4425

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

#get_settings_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(Settings, Integer, Hash)>

Retrieves payroll settings

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    Settings data, response status code and response headers



4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4434

def get_settings_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_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 PayrollUkApi.get_settings"
  end
  # resource path
  local_var_path = '/Settings'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'Settings' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_statutory_leave_summary(xero_tenant_id, employee_id, opts = {}) ⇒ EmployeeStatutoryLeavesSummaries

Retrieves a specific employee’s summary of statutory leaves using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Options Hash (opts):

  • :active_only (Boolean) —

    Filter response with leaves that are currently active or yet to be taken. If not specified, all leaves (past, current, and future scheduled) are returned

Returns:

  • (EmployeeStatutoryLeavesSummaries) 


4496
4497
4498
4499
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4496

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

#get_statutory_leave_summary_with_http_info(xero_tenant_id, employee_id, options = {}) ⇒ Array<(EmployeeStatutoryLeavesSummaries, Integer, Hash)>

Retrieves a specific employee&#39;s summary of statutory leaves using a unique employee ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeStatutoryLeavesSummaries data, response status code and response headers



4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4507

def get_statutory_leave_summary_with_http_info(xero_tenant_id, employee_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_statutory_leave_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 PayrollUkApi.get_statutory_leave_summary"
  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 PayrollUkApi.get_statutory_leave_summary"
  end
  # resource path
  local_var_path = '/StatutoryLeaves/Summary/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'activeOnly'] = opts[:'active_only'] if !opts[:'active_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] || 'EmployeeStatutoryLeavesSummaries' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_statutory_leave_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_timesheet(xero_tenant_id, timesheet_id, opts = {}) ⇒ TimesheetObject

Retrieve a specific timesheet by using a unique timesheet ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

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

    the optional parameters

Returns:

  • (TimesheetObject) 


4573
4574
4575
4576
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4573

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

#get_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) ⇒ Array<(TimesheetObject, Integer, Hash)>

Retrieve a specific timesheet by using a unique timesheet ID

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • opts (Hash) —

    the optional parameters

Returns:

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

    TimesheetObject data, response status code and response headers



4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4583

def get_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_timesheet ...'
  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 PayrollUkApi.get_timesheet"
  end
  # verify the required parameter 'timesheet_id' is set
  if @api_client.config.client_side_validation && timesheet_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_id' when calling PayrollUkApi.get_timesheet"
  end
  # resource path
  local_var_path = '/Timesheets/{TimesheetID}'.sub('{' + 'TimesheetID' + '}', timesheet_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'TimesheetObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_timesheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_timesheets(xero_tenant_id, opts = {}) ⇒ Timesheets

Retrieves timesheets

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.

  • :filter (String) —

    Filter by employeeId and/or payrollCalendarId

  • :status (String) —

    filter results by any timesheets with a matching timesheet status

  • :start_date (String) —

    filter results by any timesheets with a startDate on or after the provided date

  • :end_date (String) —

    filter results by any timesheets with a endDate on or before the provided date

  • :sort (String) —

    sort the order of timesheets returned. The default is based on the timesheets createdDate, sorted oldest to newest. Currently, the only other option is to reverse the order based on the timesheets startDate, sorted newest to oldest.

Returns:

  • (Timesheets) 


4653
4654
4655
4656
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4653

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

#get_timesheets_with_http_info(xero_tenant_id, options = {}) ⇒ Array<(Timesheets, Integer, Hash)>

Retrieves timesheets

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    Timesheets data, response status code and response headers



4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4668

def get_timesheets_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.get_timesheets ...'
  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 PayrollUkApi.get_timesheets"
  end
  # resource path
  local_var_path = '/Timesheets'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'Timesheets' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_timesheets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tracking_categories(xero_tenant_id, opts = {}) ⇒ TrackingCategories

Retrieves tracking categories

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

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

    the optional parameters

Returns:

  • (TrackingCategories) 


4734
4735
4736
4737
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4734

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, options = {}) ⇒ Array<(TrackingCategories, Integer, Hash)>

Retrieves tracking categories

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • opts (Hash) —

    the optional parameters

Returns:

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

    TrackingCategories data, response status code and response headers



4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4743

def get_tracking_categories_with_http_info(xero_tenant_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.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 PayrollUkApi.get_tracking_categories"
  end
  # resource path
  local_var_path = '/Settings/trackingCategories'

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#get_tracking_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revert_timesheet(xero_tenant_id, timesheet_id, opts = {}) ⇒ TimesheetObject

Reverts a specific timesheet to draft

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

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

    the optional parameters

Returns:

  • (TimesheetObject) 


4804
4805
4806
4807
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4804

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

#revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {}) ⇒ Array<(TimesheetObject, Integer, Hash)>

Reverts a specific timesheet to draft

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • opts (Hash) —

    the optional parameters

Returns:

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

    TimesheetObject data, response status code and response headers



4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4814

def revert_timesheet_with_http_info(xero_tenant_id, timesheet_id, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.revert_timesheet ...'
  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 PayrollUkApi.revert_timesheet"
  end
  # verify the required parameter 'timesheet_id' is set
  if @api_client.config.client_side_validation && timesheet_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_id' when calling PayrollUkApi.revert_timesheet"
  end
  # resource path
  local_var_path = '/Timesheets/{TimesheetID}/RevertToDraft'.sub('{' + 'TimesheetID' + '}', timesheet_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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] || 'TimesheetObject' 

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#revert_timesheet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_employee(xero_tenant_id, employee_id, employee, opts = {}) ⇒ EmployeeObject

Updates a specific employee’s detail

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeObject) 


4880
4881
4882
4883
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4880

def update_employee(xero_tenant_id, employee_id, employee, opts = {})
  data, _status_code, _headers = update_employee_with_http_info(xero_tenant_id, employee_id, employee, opts)
  data
end

#update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts = {}) ⇒ EarningsTemplateObject

Updates a specific employee’s earnings template records

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • pay_template_earning_id (String) —

    Id for single pay template earnings object

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

    the optional parameters

Returns:

  • (EarningsTemplateObject) 


4964
4965
4966
4967
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4964

def update_employee_earnings_template(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts = {})
  data, _status_code, _headers = update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, opts)
  data
end

#update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, options = {}) ⇒ Array<(EarningsTemplateObject, Integer, Hash)>

Updates a specific employee&#39;s earnings template records

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • pay_template_earning_id (String) —

    Id for single pay template earnings object

  • earnings_template (EarningsTemplate)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EarningsTemplateObject data, response status code and response headers



4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4976

def update_employee_earnings_template_with_http_info(xero_tenant_id, employee_id, pay_template_earning_id, earnings_template, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee_earnings_template ...'
  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 PayrollUkApi.update_employee_earnings_template"
  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 PayrollUkApi.update_employee_earnings_template"
  end
  # verify the required parameter 'pay_template_earning_id' is set
  if @api_client.config.client_side_validation && pay_template_earning_id.nil?
    fail ArgumentError, "Missing the required parameter 'pay_template_earning_id' when calling PayrollUkApi.update_employee_earnings_template"
  end
  # verify the required parameter 'earnings_template' is set
  if @api_client.config.client_side_validation && earnings_template.nil?
    fail ArgumentError, "Missing the required parameter 'earnings_template' when calling PayrollUkApi.update_employee_earnings_template"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'PayTemplateEarningID' + '}', pay_template_earning_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(earnings_template) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#update_employee_earnings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts = {}) ⇒ EmployeeLeaveObject

Updates a specific employee’s leave records

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • leave_id (String) —

    Leave id for single object

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

    the optional parameters

Returns:

  • (EmployeeLeaveObject) 


5053
5054
5055
5056
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5053

def update_employee_leave(xero_tenant_id, employee_id, leave_id, employee_leave, opts = {})
  data, _status_code, _headers = update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, opts)
  data
end

#update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, options = {}) ⇒ Array<(EmployeeLeaveObject, Integer, Hash)>

Updates a specific employee&#39;s leave records

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • leave_id (String) —

    Leave id for single object

  • employee_leave (EmployeeLeave)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeLeaveObject data, response status code and response headers



5065
5066
5067
5068
5069
5070
5071
5072
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5065

def update_employee_leave_with_http_info(xero_tenant_id, employee_id, leave_id, employee_leave, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee_leave ...'
  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 PayrollUkApi.update_employee_leave"
  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 PayrollUkApi.update_employee_leave"
  end
  # verify the required parameter 'leave_id' is set
  if @api_client.config.client_side_validation && leave_id.nil?
    fail ArgumentError, "Missing the required parameter 'leave_id' when calling PayrollUkApi.update_employee_leave"
  end
  # verify the required parameter 'employee_leave' is set
  if @api_client.config.client_side_validation && employee_leave.nil?
    fail ArgumentError, "Missing the required parameter 'employee_leave' when calling PayrollUkApi.update_employee_leave"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/Leave/{LeaveID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'LeaveID' + '}', leave_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employee_leave) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#update_employee_leave\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts = {}) ⇒ EmployeeOpeningBalancesObject

Updates a specific employee’s opening balances

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

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

    the optional parameters

Returns:

  • (EmployeeOpeningBalancesObject) 


5141
5142
5143
5144
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5141

def update_employee_opening_balances(xero_tenant_id, employee_id, employee_opening_balances, opts = {})
  data, _status_code, _headers = update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, opts)
  data
end

#update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {}) ⇒ Array<(EmployeeOpeningBalancesObject, Integer, Hash)>

Updates a specific employee&#39;s opening balances

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • employee_opening_balances (EmployeeOpeningBalances)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeOpeningBalancesObject data, response status code and response headers



5152
5153
5154
5155
5156
5157
5158
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5152

def update_employee_opening_balances_with_http_info(xero_tenant_id, employee_id, employee_opening_balances, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee_opening_balances ...'
  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 PayrollUkApi.update_employee_opening_balances"
  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 PayrollUkApi.update_employee_opening_balances"
  end
  # verify the required parameter 'employee_opening_balances' is set
  if @api_client.config.client_side_validation && employee_opening_balances.nil?
    fail ArgumentError, "Missing the required parameter 'employee_opening_balances' when calling PayrollUkApi.update_employee_opening_balances"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/ukopeningbalances'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employee_opening_balances) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#update_employee_opening_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts = {}) ⇒ SalaryAndWageObject

Updates salary and wages record for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • salary_and_wages_id (String) —

    Id for single pay template earnings object

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

    the optional parameters

Returns:

  • (SalaryAndWageObject) 


5225
5226
5227
5228
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5225

def update_employee_salary_and_wage(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts = {})
  data, _status_code, _headers = update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, opts)
  data
end

#update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, options = {}) ⇒ Array<(SalaryAndWageObject, Integer, Hash)>

Updates salary and wages record for a specific employee

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • salary_and_wages_id (String) —

    Id for single pay template earnings object

  • salary_and_wage (SalaryAndWage)
  • opts (Hash) —

    the optional parameters

Returns:

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

    SalaryAndWageObject data, response status code and response headers



5237
5238
5239
5240
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
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5237

def update_employee_salary_and_wage_with_http_info(xero_tenant_id, employee_id, salary_and_wages_id, salary_and_wage, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_employee_salary_and_wage ...'
  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 PayrollUkApi.update_employee_salary_and_wage"
  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 PayrollUkApi.update_employee_salary_and_wage"
  end
  # verify the required parameter 'salary_and_wages_id' is set
  if @api_client.config.client_side_validation && salary_and_wages_id.nil?
    fail ArgumentError, "Missing the required parameter 'salary_and_wages_id' when calling PayrollUkApi.update_employee_salary_and_wage"
  end
  # verify the required parameter 'salary_and_wage' is set
  if @api_client.config.client_side_validation && salary_and_wage.nil?
    fail ArgumentError, "Missing the required parameter 'salary_and_wage' when calling PayrollUkApi.update_employee_salary_and_wage"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s).sub('{' + 'SalaryAndWagesID' + '}', salary_and_wages_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(salary_and_wage) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#update_employee_salary_and_wage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_employee_with_http_info(xero_tenant_id, employee_id, employee, options = {}) ⇒ Array<(EmployeeObject, Integer, Hash)>

Updates a specific employee&#39;s detail

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • employee_id (String) —

    Employee id for single object

  • employee (Employee)
  • opts (Hash) —

    the optional parameters

Returns:

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

    EmployeeObject data, response status code and response headers



4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
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
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 4891

def update_employee_with_http_info(xero_tenant_id, employee_id, employee, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_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 PayrollUkApi.update_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 PayrollUkApi.update_employee"
  end
  # verify the required parameter 'employee' is set
  if @api_client.config.client_side_validation && employee.nil?
    fail ArgumentError, "Missing the required parameter 'employee' when calling PayrollUkApi.update_employee"
  end
  # resource path
  local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(employee) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#update_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {}) ⇒ PayRunObject

Updates a specific pay run

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_id (String) —

    Identifier for the pay run

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

    the optional parameters

Returns:

  • (PayRunObject) 


5313
5314
5315
5316
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5313

def update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {})
  data, _status_code, _headers = update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, opts)
  data
end

#update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {}) ⇒ Array<(PayRunObject, Integer, Hash)>

Updates a specific pay run

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • pay_run_id (String) —

    Identifier for the pay run

  • pay_run (PayRun)
  • opts (Hash) —

    the optional parameters

Returns:

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

    PayRunObject data, response status code and response headers



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
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5324

def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_pay_run ...'
  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 PayrollUkApi.update_pay_run"
  end
  # verify the required parameter 'pay_run_id' is set
  if @api_client.config.client_side_validation && pay_run_id.nil?
    fail ArgumentError, "Missing the required parameter 'pay_run_id' when calling PayrollUkApi.update_pay_run"
  end
  # verify the required parameter 'pay_run' is set
  if @api_client.config.client_side_validation && pay_run.nil?
    fail ArgumentError, "Missing the required parameter 'pay_run' when calling PayrollUkApi.update_pay_run"
  end
  # resource path
  local_var_path = '/PayRuns/{PayRunID}'.sub('{' + 'PayRunID' + '}', pay_run_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(pay_run) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#update_pay_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts = {}) ⇒ TimesheetLineObject

Updates a specific timesheet line for a specific timesheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • timesheet_line_id (String) —

    Identifier for the timesheet line

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

    the optional parameters

Returns:

  • (TimesheetLineObject) 


5397
5398
5399
5400
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5397

def update_timesheet_line(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts = {})
  data, _status_code, _headers = update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, opts)
  data
end

#update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, options = {}) ⇒ Array<(TimesheetLineObject, Integer, Hash)>

Updates a specific timesheet line for a specific timesheet

Parameters:

  • xero_tenant_id (String) —

    Xero identifier for Tenant

  • timesheet_id (String) —

    Identifier for the timesheet

  • timesheet_line_id (String) —

    Identifier for the timesheet line

  • timesheet_line (TimesheetLine)
  • opts (Hash) —

    the optional parameters

Returns:

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

    TimesheetLineObject data, response status code and response headers



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
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
 
# File 'lib/xero-ruby/api/payroll_uk_api.rb', line 5409

def update_timesheet_line_with_http_info(xero_tenant_id, timesheet_id, timesheet_line_id, timesheet_line, options = {})
  opts = options.dup
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_timesheet_line ...'
  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 PayrollUkApi.update_timesheet_line"
  end
  # verify the required parameter 'timesheet_id' is set
  if @api_client.config.client_side_validation && timesheet_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_id' when calling PayrollUkApi.update_timesheet_line"
  end
  # verify the required parameter 'timesheet_line_id' is set
  if @api_client.config.client_side_validation && timesheet_line_id.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_line_id' when calling PayrollUkApi.update_timesheet_line"
  end
  # verify the required parameter 'timesheet_line' is set
  if @api_client.config.client_side_validation && timesheet_line.nil?
    fail ArgumentError, "Missing the required parameter 'timesheet_line' when calling PayrollUkApi.update_timesheet_line"
  end
  # resource path
  local_var_path = '/Timesheets/{TimesheetID}/Lines/{TimesheetLineID}'.sub('{' + 'TimesheetID' + '}', timesheet_id.to_s).sub('{' + 'TimesheetLineID' + '}', timesheet_line_id.to_s)

  # camelize keys of incoming `where` opts
  opts[:'where'] = @api_client.parameterize_where(opts[:'where']) 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(timesheet_line) 

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

  # 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, "PayrollUkApi", new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayrollUkApi#update_timesheet_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end