xero-ruby 3.16.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd27a05f0bb738c8238e1972b8f72085f6589bec2e56259b25900b472a7ebae6
-  data.tar.gz: ca2c2f2ad209d4c5c3dfd40e9c4961d13490d8776d74a0b64b42edb2559bd475
+  metadata.gz: ed0a9e18f21afd2a6efcb613ed308ac42c45894cd63589e250292975f967c648
+  data.tar.gz: 5e1b5fe861cd84754016b968b37164e437dd3e182ac95d8aec096629023ab81c
 SHA512:
-  metadata.gz: c4b281f34599bbea6407a0d4bd1af0a49f4dc67087489a1d75e36531dc53532cedca1587380004fb7747461c3c1fb549f8e16cf6c7b25da0662f57447ea785c6
-  data.tar.gz: 1512846c0cef01d14b24f68df2f5061ab3eed4263d570c6604436b67f16b0c1e291732a03b0b106545e03156079688873662bb623ca07fdd55d5f2da5d6f4d4e
+  metadata.gz: 9210328dbff87fd961f36d96ceb39bbfd6fca07545d49d8e0bb1a54b92cde075cd602d8a5fc64dba0f6fa369278a6dff76e9e65feabc7119cf183f063129bf35
+  data.tar.gz: 8e81d3694e0608819c54a31129bcf786b611e04171f1908172e3053572e16857b9c06c2f759a4e085adf049183d6b70d611e4c5a673c8a8c3973c649976a040e

data/lib/xero-ruby/api/files_api.rb

@@ -404,7 +404,7 @@ module XeroRuby
     end
 
     # Retrieves an association object using a unique object ID
-    # By passing in the appropriate options,
+    # By passing in the appropriate options, you can retrieve an association
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param object_id [String] Object id for single object
     # @param [Hash] opts the optional parameters
@@ -415,7 +415,7 @@ module XeroRuby
     end
 
     # Retrieves an association object using a unique object ID
-    # By passing in the appropriate options,
+    # By passing in the appropriate options, you can retrieve an association
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param object_id [String] Object id for single object
     # @param [Hash] opts the optional parameters
@@ -480,6 +480,84 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Retrieves a count of associations for a list of objects.
+    # By passing in the appropriate options, you can retrieve the association count for objects
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param object_ids [Array<String>] A comma-separated list of object ids
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_associations_count(xero_tenant_id, object_ids, opts = {})
+      data, _status_code, _headers = get_associations_count_with_http_info(xero_tenant_id, object_ids, opts)
+      data
+    end
+
+    # Retrieves a count of associations for a list of objects.
+    # By passing in the appropriate options, you can retrieve the association count for objects
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param object_ids [Array<String>] A comma-separated list of object ids
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_associations_count_with_http_info(xero_tenant_id, object_ids, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.get_associations_count ...'
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FilesApi.get_associations_count"
+      end
+      # verify the required parameter 'object_ids' is set
+      if @api_client.config.client_side_validation && object_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'object_ids' when calling FilesApi.get_associations_count"
+      end
+      # resource path
+      local_var_path = '/Associations/Count'
+
+      # 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[:'ObjectIds'] = @api_client.build_collection_param(object_ids, :multi)
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_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] || 'Object' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_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, "FilesApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#get_associations_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieves a file by a unique file ID
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param file_id [String] File id for single object

data/lib/xero-ruby/api_client.rb

@@ -304,7 +304,7 @@ module XeroRuby
       end
 
       connection = Faraday.new(:url => method_base_url, :ssl => ssl_options) do |conn|
-        conn.request(:basic_auth, config.username, config.password)
+        conn.request(:authorization, :basic, config.username, config.password)
         if opts[:header_params]["Content-Type"] == "multipart/form-data"
           conn.request :multipart
           conn.request :url_encoded

data/lib/xero-ruby/models/finance/statement_line_response.rb

@@ -22,6 +22,9 @@ module XeroRuby::Finance
     # Date of when statement line was posted
     attr_accessor :posted_date
     
+    # Payee description of statement line
+    attr_accessor :payee
+    
     # Reference description of statement line
     attr_accessor :reference
     
@@ -60,6 +63,7 @@ module XeroRuby::Finance
       {
         :'statement_line_id' => :'statementLineId',
         :'posted_date' => :'postedDate',
+        :'payee' => :'payee',
         :'reference' => :'reference',
         :'notes' => :'notes',
         :'cheque_no' => :'chequeNo',
@@ -79,6 +83,7 @@ module XeroRuby::Finance
       {
         :'statement_line_id' => :'String',
         :'posted_date' => :'Date',
+        :'payee' => :'String',
         :'reference' => :'String',
         :'notes' => :'String',
         :'cheque_no' => :'String',
@@ -116,6 +121,10 @@ module XeroRuby::Finance
         self.posted_date = attributes[:'posted_date']
       end
 
+      if attributes.key?(:'payee')
+        self.payee = attributes[:'payee']
+      end
+
       if attributes.key?(:'reference')
         self.reference = attributes[:'reference']
       end
@@ -185,6 +194,7 @@ module XeroRuby::Finance
       self.class == o.class &&
           statement_line_id == o.statement_line_id &&
           posted_date == o.posted_date &&
+          payee == o.payee &&
           reference == o.reference &&
           notes == o.notes &&
           cheque_no == o.cheque_no &&
@@ -207,7 +217,7 @@ module XeroRuby::Finance
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [statement_line_id, posted_date, reference, notes, cheque_no, amount, transaction_date, type, is_reconciled, is_duplicate, is_deleted, payments, bank_transactions].hash
+      [statement_line_id, posted_date, payee, reference, notes, cheque_no, amount, transaction_date, type, is_reconciled, is_duplicate, is_deleted, payments, bank_transactions].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/finance/statement_response.rb

@@ -31,12 +31,18 @@ module XeroRuby::Finance
     # Indicates the source of the statement data. Either imported from 1) direct bank feed OR 2) manual customer entry or upload. Manual import sources are STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/OFX, Ofx or STMTIMPORTSRC/QIF. All other import sources are direct and, depending on the direct solution, may contain the name of the financial institution.
     attr_accessor :import_source
     
-    # Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.
+    # Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0.
     attr_accessor :start_balance
     
-    # Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.
+    # Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0.
     attr_accessor :end_balance
     
+    # Opening statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true 
+    attr_accessor :indicative_start_balance
+    
+    # Closing statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true  
+    attr_accessor :indicative_end_balance
+    
     # List of statement lines
     attr_accessor :statement_lines
     
@@ -50,6 +56,8 @@ module XeroRuby::Finance
         :'import_source' => :'importSource',
         :'start_balance' => :'startBalance',
         :'end_balance' => :'endBalance',
+        :'indicative_start_balance' => :'indicativeStartBalance',
+        :'indicative_end_balance' => :'indicativeEndBalance',
         :'statement_lines' => :'statementLines'
       }
     end
@@ -64,6 +72,8 @@ module XeroRuby::Finance
         :'import_source' => :'String',
         :'start_balance' => :'BigDecimal',
         :'end_balance' => :'BigDecimal',
+        :'indicative_start_balance' => :'BigDecimal',
+        :'indicative_end_balance' => :'BigDecimal',
         :'statement_lines' => :'Array<StatementLineResponse>'
       }
     end
@@ -111,6 +121,14 @@ module XeroRuby::Finance
         self.end_balance = attributes[:'end_balance']
       end
 
+      if attributes.key?(:'indicative_start_balance')
+        self.indicative_start_balance = attributes[:'indicative_start_balance']
+      end
+
+      if attributes.key?(:'indicative_end_balance')
+        self.indicative_end_balance = attributes[:'indicative_end_balance']
+      end
+
       if attributes.key?(:'statement_lines')
         if (value = attributes[:'statement_lines']).is_a?(Array)
           self.statement_lines = value
@@ -143,6 +161,8 @@ module XeroRuby::Finance
           import_source == o.import_source &&
           start_balance == o.start_balance &&
           end_balance == o.end_balance &&
+          indicative_start_balance == o.indicative_start_balance &&
+          indicative_end_balance == o.indicative_end_balance &&
           statement_lines == o.statement_lines
     end
 
@@ -155,7 +175,7 @@ module XeroRuby::Finance
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [statement_id, start_date, end_date, imported_date_time_utc, import_source, start_balance, end_balance, statement_lines].hash
+      [statement_id, start_date, end_date, imported_date_time_utc, import_source, start_balance, end_balance, indicative_start_balance, indicative_end_balance, statement_lines].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/earnings_rate.rb

@@ -34,6 +34,12 @@ module XeroRuby::PayrollAu
     # Boolean to determine if the earnings rate is reportable or exempt from W1
     attr_accessor :is_reportable_as_w1
     
+    # Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
+    attr_accessor :allowance_contributes_to_annual_leave_rate
+    
+    # Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
+    attr_accessor :allowance_contributes_to_overtime_rate
+    
 
     attr_accessor :earnings_type
     
@@ -79,6 +85,8 @@ module XeroRuby::PayrollAu
         :'is_exempt_from_tax' => :'IsExemptFromTax',
         :'is_exempt_from_super' => :'IsExemptFromSuper',
         :'is_reportable_as_w1' => :'IsReportableAsW1',
+        :'allowance_contributes_to_annual_leave_rate' => :'AllowanceContributesToAnnualLeaveRate',
+        :'allowance_contributes_to_overtime_rate' => :'AllowanceContributesToOvertimeRate',
         :'earnings_type' => :'EarningsType',
         :'earnings_rate_id' => :'EarningsRateID',
         :'rate_type' => :'RateType',
@@ -103,6 +111,8 @@ module XeroRuby::PayrollAu
         :'is_exempt_from_tax' => :'Boolean',
         :'is_exempt_from_super' => :'Boolean',
         :'is_reportable_as_w1' => :'Boolean',
+        :'allowance_contributes_to_annual_leave_rate' => :'Boolean',
+        :'allowance_contributes_to_overtime_rate' => :'Boolean',
         :'earnings_type' => :'EarningsType',
         :'earnings_rate_id' => :'String',
         :'rate_type' => :'RateType',
@@ -157,6 +167,14 @@ module XeroRuby::PayrollAu
         self.is_reportable_as_w1 = attributes[:'is_reportable_as_w1']
       end
 
+      if attributes.key?(:'allowance_contributes_to_annual_leave_rate')
+        self.allowance_contributes_to_annual_leave_rate = attributes[:'allowance_contributes_to_annual_leave_rate']
+      end
+
+      if attributes.key?(:'allowance_contributes_to_overtime_rate')
+        self.allowance_contributes_to_overtime_rate = attributes[:'allowance_contributes_to_overtime_rate']
+      end
+
       if attributes.key?(:'earnings_type')
         self.earnings_type = attributes[:'earnings_type']
       end
@@ -260,6 +278,8 @@ module XeroRuby::PayrollAu
           is_exempt_from_tax == o.is_exempt_from_tax &&
           is_exempt_from_super == o.is_exempt_from_super &&
           is_reportable_as_w1 == o.is_reportable_as_w1 &&
+          allowance_contributes_to_annual_leave_rate == o.allowance_contributes_to_annual_leave_rate &&
+          allowance_contributes_to_overtime_rate == o.allowance_contributes_to_overtime_rate &&
           earnings_type == o.earnings_type &&
           earnings_rate_id == o.earnings_rate_id &&
           rate_type == o.rate_type &&
@@ -283,7 +303,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, account_code, type_of_units, is_exempt_from_tax, is_exempt_from_super, is_reportable_as_w1, earnings_type, earnings_rate_id, rate_type, rate_per_unit, multiplier, accrue_leave, amount, employment_termination_payment_type, updated_date_utc, current_record, allowance_type, allowance_category].hash
+      [name, account_code, type_of_units, is_exempt_from_tax, is_exempt_from_super, is_reportable_as_w1, allowance_contributes_to_annual_leave_rate, allowance_contributes_to_overtime_rate, earnings_type, earnings_rate_id, rate_type, rate_per_unit, multiplier, accrue_leave, amount, employment_termination_payment_type, updated_date_utc, current_record, allowance_type, allowance_category].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/leave_application.rb

@@ -38,6 +38,9 @@ module XeroRuby::PayrollAu
     attr_accessor :description
     
 
+    attr_accessor :pay_out_type
+    
+
     attr_accessor :leave_periods
     
     # Last modified timestamp
@@ -56,6 +59,7 @@ module XeroRuby::PayrollAu
         :'start_date' => :'StartDate',
         :'end_date' => :'EndDate',
         :'description' => :'Description',
+        :'pay_out_type' => :'PayOutType',
         :'leave_periods' => :'LeavePeriods',
         :'updated_date_utc' => :'UpdatedDateUTC',
         :'validation_errors' => :'ValidationErrors'
@@ -72,6 +76,7 @@ module XeroRuby::PayrollAu
         :'start_date' => :'Date',
         :'end_date' => :'Date',
         :'description' => :'String',
+        :'pay_out_type' => :'PayOutType',
         :'leave_periods' => :'Array<LeavePeriod>',
         :'updated_date_utc' => :'DateTime',
         :'validation_errors' => :'Array<ValidationError>'
@@ -121,6 +126,10 @@ module XeroRuby::PayrollAu
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'pay_out_type')
+        self.pay_out_type = attributes[:'pay_out_type']
+      end
+
       if attributes.key?(:'leave_periods')
         if (value = attributes[:'leave_periods']).is_a?(Array)
           self.leave_periods = value
@@ -163,6 +172,7 @@ module XeroRuby::PayrollAu
           start_date == o.start_date &&
           end_date == o.end_date &&
           description == o.description &&
+          pay_out_type == o.pay_out_type &&
           leave_periods == o.leave_periods &&
           updated_date_utc == o.updated_date_utc &&
           validation_errors == o.validation_errors
@@ -177,7 +187,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [leave_application_id, employee_id, leave_type_id, title, start_date, end_date, description, leave_periods, updated_date_utc, validation_errors].hash
+      [leave_application_id, employee_id, leave_type_id, title, start_date, end_date, description, pay_out_type, leave_periods, updated_date_utc, validation_errors].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/leave_earnings_line.rb

@@ -25,12 +25,16 @@ module XeroRuby::PayrollAu
     # Earnings rate number of units.
     attr_accessor :number_of_units
     
+
+    attr_accessor :pay_out_type
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'earnings_rate_id' => :'EarningsRateID',
         :'rate_per_unit' => :'RatePerUnit',
-        :'number_of_units' => :'NumberOfUnits'
+        :'number_of_units' => :'NumberOfUnits',
+        :'pay_out_type' => :'PayOutType'
       }
     end
 
@@ -39,7 +43,8 @@ module XeroRuby::PayrollAu
       {
         :'earnings_rate_id' => :'String',
         :'rate_per_unit' => :'BigDecimal',
-        :'number_of_units' => :'BigDecimal'
+        :'number_of_units' => :'BigDecimal',
+        :'pay_out_type' => :'PayOutType'
       }
     end
 
@@ -69,6 +74,10 @@ module XeroRuby::PayrollAu
       if attributes.key?(:'number_of_units')
         self.number_of_units = attributes[:'number_of_units']
       end
+
+      if attributes.key?(:'pay_out_type')
+        self.pay_out_type = attributes[:'pay_out_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,7 +100,8 @@ module XeroRuby::PayrollAu
       self.class == o.class &&
           earnings_rate_id == o.earnings_rate_id &&
           rate_per_unit == o.rate_per_unit &&
-          number_of_units == o.number_of_units
+          number_of_units == o.number_of_units &&
+          pay_out_type == o.pay_out_type
     end
 
     # @see the `==` method
@@ -103,7 +113,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [earnings_rate_id, rate_per_unit, number_of_units].hash
+      [earnings_rate_id, rate_per_unit, number_of_units, pay_out_type].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/opening_balances.rb

@@ -37,6 +37,9 @@ module XeroRuby::PayrollAu
 
     attr_accessor :leave_lines
     
+
+    attr_accessor :paid_leave_earnings_lines
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,7 +49,8 @@ module XeroRuby::PayrollAu
         :'deduction_lines' => :'DeductionLines',
         :'super_lines' => :'SuperLines',
         :'reimbursement_lines' => :'ReimbursementLines',
-        :'leave_lines' => :'LeaveLines'
+        :'leave_lines' => :'LeaveLines',
+        :'paid_leave_earnings_lines' => :'PaidLeaveEarningsLines'
       }
     end
 
@@ -59,7 +63,8 @@ module XeroRuby::PayrollAu
         :'deduction_lines' => :'Array<DeductionLine>',
         :'super_lines' => :'Array<SuperLine>',
         :'reimbursement_lines' => :'Array<ReimbursementLine>',
-        :'leave_lines' => :'Array<LeaveLine>'
+        :'leave_lines' => :'Array<LeaveLine>',
+        :'paid_leave_earnings_lines' => :'Array<PaidLeaveEarningsLine>'
       }
     end
 
@@ -115,6 +120,12 @@ module XeroRuby::PayrollAu
           self.leave_lines = value
         end
       end
+
+      if attributes.key?(:'paid_leave_earnings_lines')
+        if (value = attributes[:'paid_leave_earnings_lines']).is_a?(Array)
+          self.paid_leave_earnings_lines = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -141,7 +152,8 @@ module XeroRuby::PayrollAu
           deduction_lines == o.deduction_lines &&
           super_lines == o.super_lines &&
           reimbursement_lines == o.reimbursement_lines &&
-          leave_lines == o.leave_lines
+          leave_lines == o.leave_lines &&
+          paid_leave_earnings_lines == o.paid_leave_earnings_lines
     end
 
     # @see the `==` method
@@ -153,7 +165,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [opening_balance_date, tax, earnings_lines, deduction_lines, super_lines, reimbursement_lines, leave_lines].hash
+      [opening_balance_date, tax, earnings_lines, deduction_lines, super_lines, reimbursement_lines, leave_lines, paid_leave_earnings_lines].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/paid_leave_earnings_line.rb

@@ -0,0 +1,272 @@
+=begin
+#Xero Payroll AU API
+
+#This is the Xero Payroll API for orgs in Australia region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollAu
+  require 'bigdecimal'
+
+  class PaidLeaveEarningsLine
+    # Xero leave type identifier
+    attr_accessor :leave_type_id
+    
+    # Paid leave amount
+    attr_accessor :amount
+    
+    # The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories
+    attr_accessor :sgc_applied_leave_loading_amount
+    
+    # The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories
+    attr_accessor :sgc_exempted_leave_loading_amount
+    
+    # Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories
+    attr_accessor :reset_stp_categorisation
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'leave_type_id' => :'LeaveTypeID',
+        :'amount' => :'Amount',
+        :'sgc_applied_leave_loading_amount' => :'SGCAppliedLeaveLoadingAmount',
+        :'sgc_exempted_leave_loading_amount' => :'SGCExemptedLeaveLoadingAmount',
+        :'reset_stp_categorisation' => :'ResetSTPCategorisation'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'leave_type_id' => :'String',
+        :'amount' => :'BigDecimal',
+        :'sgc_applied_leave_loading_amount' => :'BigDecimal',
+        :'sgc_exempted_leave_loading_amount' => :'BigDecimal',
+        :'reset_stp_categorisation' => :'Boolean'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollAu::PaidLeaveEarningsLine` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::PayrollAu::PaidLeaveEarningsLine`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'leave_type_id')
+        self.leave_type_id = attributes[:'leave_type_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'sgc_applied_leave_loading_amount')
+        self.sgc_applied_leave_loading_amount = attributes[:'sgc_applied_leave_loading_amount']
+      end
+
+      if attributes.key?(:'sgc_exempted_leave_loading_amount')
+        self.sgc_exempted_leave_loading_amount = attributes[:'sgc_exempted_leave_loading_amount']
+      end
+
+      if attributes.key?(:'reset_stp_categorisation')
+        self.reset_stp_categorisation = attributes[:'reset_stp_categorisation']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @leave_type_id.nil?
+        invalid_properties.push('invalid value for "leave_type_id", leave_type_id cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @leave_type_id.nil?
+      return false if @amount.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          leave_type_id == o.leave_type_id &&
+          amount == o.amount &&
+          sgc_applied_leave_loading_amount == o.sgc_applied_leave_loading_amount &&
+          sgc_exempted_leave_loading_amount == o.sgc_exempted_leave_loading_amount &&
+          reset_stp_categorisation == o.reset_stp_categorisation
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [leave_type_id, amount, sgc_applied_leave_loading_amount, sgc_exempted_leave_loading_amount, reset_stp_categorisation].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(parse_date(value))
+      when :Date
+        Date.parse(parse_date(value))
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        XeroRuby::PayrollAu.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash(downcase: false)
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value, downcase: downcase)
+      end
+      hash
+    end
+
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value, downcase: false)
+      if value.is_a?(Array)
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash(downcase: downcase)
+      else
+        value
+      end
+    end
+
+    def parse_date(datestring)
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
+    end
+  end
+end

data/lib/xero-ruby/models/payroll_au/pay_out_type.rb

@@ -0,0 +1,36 @@
+=begin
+#Xero Payroll AU API
+
+#This is the Xero Payroll API for orgs in Australia region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollAu
+  class PayOutType
+    DEFAULT ||= "DEFAULT".freeze
+    CASHED_OUT ||= "CASHED_OUT".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = PayOutType.constants.select { |c| PayOutType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #PayOutType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/xero-ruby/models/payroll_uk/earnings_rate.rb

@@ -25,7 +25,7 @@ module XeroRuby::PayrollUk
     # Indicates how an employee will be paid when taking this type of earning
     attr_accessor :earnings_type
     ALLOWANCE ||= "Allowance".freeze
-    BACKPAY ||= "Backpay".freeze
+    BACK_PAY ||= "BackPay".freeze
     BONUS ||= "Bonus".freeze
     COMMISSION ||= "Commission".freeze
     LUMP_SUM ||= "LumpSum".freeze
@@ -214,7 +214,7 @@ module XeroRuby::PayrollUk
     def valid?
       return false if @name.nil?
       return false if @earnings_type.nil?
-      earnings_type_validator = EnumAttributeValidator.new('String', ["Allowance", "Backpay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay"])
+      earnings_type_validator = EnumAttributeValidator.new('String', ["Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay"])
       return false unless earnings_type_validator.valid?(@earnings_type)
       return false if @rate_type.nil?
       rate_type_validator = EnumAttributeValidator.new('String', ["RatePerUnit", "MultipleOfOrdinaryEarningsRate", "FixedAmount"])
@@ -227,7 +227,7 @@ module XeroRuby::PayrollUk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] earnings_type Object to be assigned
     def earnings_type=(earnings_type)
-      validator = EnumAttributeValidator.new('String', ["Allowance", "Backpay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay"])
+      validator = EnumAttributeValidator.new('String', ["Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay"])
       unless validator.valid?(earnings_type)
         fail ArgumentError, "invalid value for \"earnings_type\", must be one of #{validator.allowable_values}."
       end

data/lib/xero-ruby/version.rb

@@ -7,9 +7,9 @@ Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
-The version of the XeroOpenAPI document: 2.33.1
+The version of the XeroOpenAPI document: 2.36.0
 =end
 
 module XeroRuby
-  VERSION = '3.16.0'
+  VERSION = '4.1.0'
 end

data/lib/xero-ruby.rb

@@ -310,8 +310,10 @@ require 'xero-ruby/models/payroll_au/leave_type'
 require 'xero-ruby/models/payroll_au/leave_type_contribution_type'
 require 'xero-ruby/models/payroll_au/manual_tax_type'
 require 'xero-ruby/models/payroll_au/opening_balances'
+require 'xero-ruby/models/payroll_au/paid_leave_earnings_line'
 require 'xero-ruby/models/payroll_au/pay_item'
 require 'xero-ruby/models/payroll_au/pay_items'
+require 'xero-ruby/models/payroll_au/pay_out_type'
 require 'xero-ruby/models/payroll_au/pay_run'
 require 'xero-ruby/models/payroll_au/pay_run_status'
 require 'xero-ruby/models/payroll_au/pay_runs'

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 3.16.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Xero API Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -368,8 +368,10 @@ files:
 - lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb
 - lib/xero-ruby/models/payroll_au/manual_tax_type.rb
 - lib/xero-ruby/models/payroll_au/opening_balances.rb
+- lib/xero-ruby/models/payroll_au/paid_leave_earnings_line.rb
 - lib/xero-ruby/models/payroll_au/pay_item.rb
 - lib/xero-ruby/models/payroll_au/pay_items.rb
+- lib/xero-ruby/models/payroll_au/pay_out_type.rb
 - lib/xero-ruby/models/payroll_au/pay_run.rb
 - lib/xero-ruby/models/payroll_au/pay_run_status.rb
 - lib/xero-ruby/models/payroll_au/pay_runs.rb