xero-ruby 12.2.0 → 12.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df10e8946ae9af27bc25b1e3c042d0cd889ecd75118a510a8ed69b2b8cb06541
-  data.tar.gz: e42341de7ace75fb6ebec26be81b2cebdf774b0b2133bc43e37b401bf2c134f4
+  metadata.gz: fb934d84d2ae53b0239b45ec344af16f2c862369bae478f3fb15f9a7caf2d36a
+  data.tar.gz: f84af0bc72f79fa7396742ace8e2e2c2b41e0e66a0f60632da34876cb06ef773
 SHA512:
-  metadata.gz: 2a9dd5545b3be7ee32d3a68ff1e76b2934fe775a3ea6ebe391819bd1dc5c1ac6210bc11069ff39ac27281c31701472f352489670e3418e32fef109d45abf0ddf
-  data.tar.gz: 331ed090ebc22e0b11551579cc82c65d31f3f5a8d04674c747ebfc91d283fd5263cb6db1c96e178fb4b8ede6f38133049aa4fa2bdf712a989dfbabcc4d3c059a
+  metadata.gz: f5505cde298fd14eb3b2212701d20c1b49575e7faaa27bd4e6908c8d21a19e02a23eda70bc8e39bf0fbe69ca8faa1e97be92d1af153c18352b872c4c118bea74
+  data.tar.gz: 5a350f8f23d3f18bdb6bd7b2d07111785a6030dc390773bd0938c2fa8d353667e94f1339e7491a8c5a012946571a040170906d529c93d51fa800e6f83c1bd67f

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

@@ -11958,6 +11958,7 @@ module XeroRuby
     # @option opts [Integer] :page e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
     # @option opts [Integer] :unitdp e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
     # @option opts [Integer] :page_size Number of records to retrieve per page
+    # @option opts [Array<String>] :references Filter by a comma-separated list of References
     # @return [Overpayments]
     def get_overpayments(xero_tenant_id, opts = {})
       data, _status_code, _headers = get_overpayments_with_http_info(xero_tenant_id, opts)
@@ -11973,6 +11974,7 @@ module XeroRuby
     # @option opts [Integer] :page e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
     # @option opts [Integer] :unitdp e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
     # @option opts [Integer] :page_size Number of records to retrieve per page
+    # @option opts [Array<String>] :references Filter by a comma-separated list of References
     # @return [Array<(Overpayments, Integer, Hash)>] Overpayments data, response status code and response headers
     def get_overpayments_with_http_info(xero_tenant_id, options = {})
       opts = options.dup
@@ -11996,6 +11998,7 @@ module XeroRuby
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'unitdp'] = opts[:'unitdp'] if !opts[:'unitdp'].nil?
       query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'References'] = @api_client.build_collection_param(opts[:'references'], :csv) if !opts[:'references'].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?

data/lib/xero-ruby/models/accounting/overpayment.rb

@@ -76,6 +76,9 @@ module XeroRuby::Accounting
     # boolean to indicate if a overpayment has an attachment
     attr_accessor :has_attachments
     
+    # An optional description for Overpayment
+    attr_accessor :reference
+    
     # See Attachments
     attr_accessor :attachments
     
@@ -122,6 +125,7 @@ module XeroRuby::Accounting
         :'applied_amount' => :'AppliedAmount',
         :'payments' => :'Payments',
         :'has_attachments' => :'HasAttachments',
+        :'reference' => :'Reference',
         :'attachments' => :'Attachments'
       }
     end
@@ -147,6 +151,7 @@ module XeroRuby::Accounting
         :'applied_amount' => :'Float',
         :'payments' => :'Array<Payment>',
         :'has_attachments' => :'Boolean',
+        :'reference' => :'String',
         :'attachments' => :'Array<Attachment>'
       }
     end
@@ -246,6 +251,10 @@ module XeroRuby::Accounting
         self.has_attachments = false
       end
 
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
       if attributes.key?(:'attachments')
         if (value = attributes[:'attachments']).is_a?(Array)
           self.attachments = value
@@ -313,6 +322,7 @@ module XeroRuby::Accounting
           applied_amount == o.applied_amount &&
           payments == o.payments &&
           has_attachments == o.has_attachments &&
+          reference == o.reference &&
           attachments == o.attachments
     end
 
@@ -325,7 +335,7 @@ module XeroRuby::Accounting
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, contact, date, status, line_amount_types, line_items, sub_total, total_tax, total, updated_date_utc, currency_code, overpayment_id, currency_rate, remaining_credit, allocations, applied_amount, payments, has_attachments, attachments].hash
+      [type, contact, date, status, line_amount_types, line_items, sub_total, total_tax, total, updated_date_utc, currency_code, overpayment_id, currency_rate, remaining_credit, allocations, applied_amount, payments, has_attachments, reference, attachments].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb

@@ -28,12 +28,6 @@ module XeroRuby::PayrollNz
     # The dollar value of annual leave opening balance if negative.
     attr_accessor :negative_annual_leave_balance_paid_amount
     
-    # Deprecated use SickLeaveToAccrueAnnually
-    attr_accessor :sick_leave_hours_to_accrue_annually
-    
-    # Deprecated use SickLeaveMaximumToAccrue
-    attr_accessor :sick_leave_maximum_hours_to_accrue
-    
     # Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type
     attr_accessor :sick_leave_to_accrue_annually
     
@@ -59,8 +53,6 @@ module XeroRuby::PayrollNz
         :'holiday_pay_opening_balance' => :'holidayPayOpeningBalance',
         :'annual_leave_opening_balance' => :'annualLeaveOpeningBalance',
         :'negative_annual_leave_balance_paid_amount' => :'negativeAnnualLeaveBalancePaidAmount',
-        :'sick_leave_hours_to_accrue_annually' => :'sickLeaveHoursToAccrueAnnually',
-        :'sick_leave_maximum_hours_to_accrue' => :'sickLeaveMaximumHoursToAccrue',
         :'sick_leave_to_accrue_annually' => :'SickLeaveToAccrueAnnually',
         :'sick_leave_maximum_to_accrue' => :'SickLeaveMaximumToAccrue',
         :'sick_leave_opening_balance' => :'sickLeaveOpeningBalance',
@@ -77,8 +69,6 @@ module XeroRuby::PayrollNz
         :'holiday_pay_opening_balance' => :'BigDecimal',
         :'annual_leave_opening_balance' => :'BigDecimal',
         :'negative_annual_leave_balance_paid_amount' => :'BigDecimal',
-        :'sick_leave_hours_to_accrue_annually' => :'BigDecimal',
-        :'sick_leave_maximum_hours_to_accrue' => :'BigDecimal',
         :'sick_leave_to_accrue_annually' => :'BigDecimal',
         :'sick_leave_maximum_to_accrue' => :'BigDecimal',
         :'sick_leave_opening_balance' => :'BigDecimal',
@@ -119,14 +109,6 @@ module XeroRuby::PayrollNz
         self.negative_annual_leave_balance_paid_amount = attributes[:'negative_annual_leave_balance_paid_amount']
       end
 
-      if attributes.key?(:'sick_leave_hours_to_accrue_annually')
-        self.sick_leave_hours_to_accrue_annually = attributes[:'sick_leave_hours_to_accrue_annually']
-      end
-
-      if attributes.key?(:'sick_leave_maximum_hours_to_accrue')
-        self.sick_leave_maximum_hours_to_accrue = attributes[:'sick_leave_maximum_hours_to_accrue']
-      end
-
       if attributes.key?(:'sick_leave_to_accrue_annually')
         self.sick_leave_to_accrue_annually = attributes[:'sick_leave_to_accrue_annually']
       end
@@ -174,8 +156,6 @@ module XeroRuby::PayrollNz
           holiday_pay_opening_balance == o.holiday_pay_opening_balance &&
           annual_leave_opening_balance == o.annual_leave_opening_balance &&
           negative_annual_leave_balance_paid_amount == o.negative_annual_leave_balance_paid_amount &&
-          sick_leave_hours_to_accrue_annually == o.sick_leave_hours_to_accrue_annually &&
-          sick_leave_maximum_hours_to_accrue == o.sick_leave_maximum_hours_to_accrue &&
           sick_leave_to_accrue_annually == o.sick_leave_to_accrue_annually &&
           sick_leave_maximum_to_accrue == o.sick_leave_maximum_to_accrue &&
           sick_leave_opening_balance == o.sick_leave_opening_balance &&
@@ -193,7 +173,7 @@ module XeroRuby::PayrollNz
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [include_holiday_pay, holiday_pay_opening_balance, annual_leave_opening_balance, negative_annual_leave_balance_paid_amount, sick_leave_hours_to_accrue_annually, sick_leave_maximum_hours_to_accrue, sick_leave_to_accrue_annually, sick_leave_maximum_to_accrue, sick_leave_opening_balance, sick_leave_schedule_of_accrual, sick_leave_anniversary_date, annual_leave_anniversary_date].hash
+      [include_holiday_pay, holiday_pay_opening_balance, annual_leave_opening_balance, negative_annual_leave_balance_paid_amount, sick_leave_to_accrue_annually, sick_leave_maximum_to_accrue, sick_leave_opening_balance, sick_leave_schedule_of_accrual, sick_leave_anniversary_date, annual_leave_anniversary_date].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb

@@ -26,9 +26,6 @@ module XeroRuby::PayrollNz
     PERCENTAGE_OF_GROSS_EARNINGS ||= "PercentageOfGrossEarnings".freeze
     NO_ACCRUALS ||= "NoAccruals".freeze
     
-    # Deprecated use UnitsAccruedAnnually
-    attr_accessor :hours_accrued_annually
-    
     # The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"
     attr_accessor :units_accrued_annually
     
@@ -44,7 +41,7 @@ module XeroRuby::PayrollNz
     # The type of units for the opening balance
     attr_accessor :opening_balance_type_of_units
     
-    # The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"
+    # not supported in Payroll NZ
     attr_accessor :rate_accrued_hourly
     
     # Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period.
@@ -89,8 +86,7 @@ module XeroRuby::PayrollNz
       {
         :'leave_type_id' => :'leaveTypeID',
         :'schedule_of_accrual' => :'scheduleOfAccrual',
-        :'hours_accrued_annually' => :'hoursAccruedAnnually',
-        :'units_accrued_annually' => :'UnitsAccruedAnnually',
+        :'units_accrued_annually' => :'unitsAccruedAnnually',
         :'type_of_units_to_accrue' => :'typeOfUnitsToAccrue',
         :'maximum_to_accrue' => :'maximumToAccrue',
         :'opening_balance' => :'openingBalance',
@@ -109,7 +105,6 @@ module XeroRuby::PayrollNz
       {
         :'leave_type_id' => :'String',
         :'schedule_of_accrual' => :'String',
-        :'hours_accrued_annually' => :'BigDecimal',
         :'units_accrued_annually' => :'BigDecimal',
         :'type_of_units_to_accrue' => :'String',
         :'maximum_to_accrue' => :'BigDecimal',
@@ -147,10 +142,6 @@ module XeroRuby::PayrollNz
         self.schedule_of_accrual = attributes[:'schedule_of_accrual']
       end
 
-      if attributes.key?(:'hours_accrued_annually')
-        self.hours_accrued_annually = attributes[:'hours_accrued_annually']
-      end
-
       if attributes.key?(:'units_accrued_annually')
         self.units_accrued_annually = attributes[:'units_accrued_annually']
       end
@@ -228,7 +219,6 @@ module XeroRuby::PayrollNz
       self.class == o.class &&
           leave_type_id == o.leave_type_id &&
           schedule_of_accrual == o.schedule_of_accrual &&
-          hours_accrued_annually == o.hours_accrued_annually &&
           units_accrued_annually == o.units_accrued_annually &&
           type_of_units_to_accrue == o.type_of_units_to_accrue &&
           maximum_to_accrue == o.maximum_to_accrue &&
@@ -251,7 +241,7 @@ module XeroRuby::PayrollNz
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [leave_type_id, schedule_of_accrual, hours_accrued_annually, units_accrued_annually, type_of_units_to_accrue, maximum_to_accrue, opening_balance, opening_balance_type_of_units, rate_accrued_hourly, percentage_of_gross_earnings, include_holiday_pay_every_pay, show_annual_leave_in_advance, annual_leave_total_amount_paid, schedule_of_accrual_date].hash
+      [leave_type_id, schedule_of_accrual, units_accrued_annually, type_of_units_to_accrue, maximum_to_accrue, opening_balance, opening_balance_type_of_units, rate_accrued_hourly, percentage_of_gross_earnings, include_holiday_pay_every_pay, show_annual_leave_in_advance, annual_leave_total_amount_paid, schedule_of_accrual_date].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,38 @@
+=begin
+#Xero Payroll UK
+
+#This is the Xero Payroll API for orgs in the UK region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollUk
+  class ContractType
+    FULL_TIME ||= "FullTime".freeze
+    PART_TIME ||= "PartTime".freeze
+    ZERO_HOUR ||= "ZeroHour".freeze
+    UNSPECIFIED ||= "Unspecified".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 = ContractType.constants.select { |c| ContractType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #ContractType" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -0,0 +1,297 @@
+=begin
+#Xero Payroll UK
+
+#This is the Xero Payroll API for orgs in the UK region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollUk
+  require 'bigdecimal'
+
+  class Contracts
+    # The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD)
+    attr_accessor :start_date
+    
+
+    attr_accessor :employment_status
+    
+
+    attr_accessor :contract_type
+    
+    # The public key of the contract. Public key is required if the intention is to edit an existing contract. If no key is supplied a new contract will be created
+    attr_accessor :public_key
+    
+    # describes whether the contract is fixed term (required if trying to create Fixed term contract)
+    attr_accessor :is_fixed_term
+    
+    # The fixed term end date of the employee. Not required if isFixedTerm is false or not provided (required if trying to create Fixed term contract)
+    attr_accessor :fixed_term_end_date
+    
+
+    attr_accessor :developmental_role_details
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'start_date' => :'startDate',
+        :'employment_status' => :'employmentStatus',
+        :'contract_type' => :'contractType',
+        :'public_key' => :'publicKey',
+        :'is_fixed_term' => :'isFixedTerm',
+        :'fixed_term_end_date' => :'fixedTermEndDate',
+        :'developmental_role_details' => :'developmentalRoleDetails'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'start_date' => :'Date',
+        :'employment_status' => :'EmploymentStatus',
+        :'contract_type' => :'ContractType',
+        :'public_key' => :'String',
+        :'is_fixed_term' => :'Boolean',
+        :'fixed_term_end_date' => :'Date',
+        :'developmental_role_details' => :'DevelopmentalRoleDetails'
+      }
+    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::PayrollUk::Contracts` 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::PayrollUk::Contracts`. 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?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'employment_status')
+        self.employment_status = attributes[:'employment_status']
+      end
+
+      if attributes.key?(:'contract_type')
+        self.contract_type = attributes[:'contract_type']
+      end
+
+      if attributes.key?(:'public_key')
+        self.public_key = attributes[:'public_key']
+      end
+
+      if attributes.key?(:'is_fixed_term')
+        self.is_fixed_term = attributes[:'is_fixed_term']
+      end
+
+      if attributes.key?(:'fixed_term_end_date')
+        self.fixed_term_end_date = attributes[:'fixed_term_end_date']
+      end
+
+      if attributes.key?(:'developmental_role_details')
+        self.developmental_role_details = attributes[:'developmental_role_details']
+      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 @start_date.nil?
+        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
+      end
+
+      if @employment_status.nil?
+        invalid_properties.push('invalid value for "employment_status", employment_status cannot be nil.')
+      end
+
+      if @contract_type.nil?
+        invalid_properties.push('invalid value for "contract_type", contract_type 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 @start_date.nil?
+      return false if @employment_status.nil?
+      return false if @contract_type.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 &&
+          start_date == o.start_date &&
+          employment_status == o.employment_status &&
+          contract_type == o.contract_type &&
+          public_key == o.public_key &&
+          is_fixed_term == o.is_fixed_term &&
+          fixed_term_end_date == o.fixed_term_end_date &&
+          developmental_role_details == o.developmental_role_details
+    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
+      [start_date, employment_status, contract_type, public_key, is_fixed_term, fixed_term_end_date, developmental_role_details].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::PayrollUk.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_uk/developmental_role_details.rb

@@ -0,0 +1,267 @@
+=begin
+#Xero Payroll UK
+
+#This is the Xero Payroll API for orgs in the UK region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollUk
+  require 'bigdecimal'
+
+  class DevelopmentalRoleDetails
+    # The start date of the developmental role
+    attr_accessor :start_date
+    
+    # The end date of the developmental role
+    attr_accessor :end_date
+    
+    # The developmental role type - \"Apprentice\" is the only supported role currently
+    attr_accessor :developmental_role
+    
+    # The public key of the developmental role. Public key is required if the intention is to edit an existing developmental role. If no key is supplied a new developmental role will be created
+    attr_accessor :public_key
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'start_date' => :'startDate',
+        :'end_date' => :'endDate',
+        :'developmental_role' => :'developmentalRole',
+        :'public_key' => :'publicKey'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'start_date' => :'Date',
+        :'end_date' => :'Date',
+        :'developmental_role' => :'String',
+        :'public_key' => :'String'
+      }
+    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::PayrollUk::DevelopmentalRoleDetails` 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::PayrollUk::DevelopmentalRoleDetails`. 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?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'developmental_role')
+        self.developmental_role = attributes[:'developmental_role']
+      end
+
+      if attributes.key?(:'public_key')
+        self.public_key = attributes[:'public_key']
+      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 @start_date.nil?
+        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
+      end
+
+      if @end_date.nil?
+        invalid_properties.push('invalid value for "end_date", end_date cannot be nil.')
+      end
+
+      if @developmental_role.nil?
+        invalid_properties.push('invalid value for "developmental_role", developmental_role 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 @start_date.nil?
+      return false if @end_date.nil?
+      return false if @developmental_role.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 &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          developmental_role == o.developmental_role &&
+          public_key == o.public_key
+    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
+      [start_date, end_date, developmental_role, public_key].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::PayrollUk.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_uk/employee.rb

@@ -72,6 +72,9 @@ module XeroRuby::PayrollUk
     # Whether the employee is an off payroll worker
     attr_accessor :is_off_payroll_worker
     
+    # The employee's contracts
+    attr_accessor :contracts
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -114,7 +117,8 @@ module XeroRuby::PayrollUk
         :'ni_category' => :'niCategory',
         :'ni_categories' => :'niCategories',
         :'national_insurance_number' => :'nationalInsuranceNumber',
-        :'is_off_payroll_worker' => :'isOffPayrollWorker'
+        :'is_off_payroll_worker' => :'isOffPayrollWorker',
+        :'contracts' => :'contracts'
       }
     end
 
@@ -138,7 +142,8 @@ module XeroRuby::PayrollUk
         :'ni_category' => :'NICategoryLetter',
         :'ni_categories' => :'Array<NICategory>',
         :'national_insurance_number' => :'String',
-        :'is_off_payroll_worker' => :'Boolean'
+        :'is_off_payroll_worker' => :'Boolean',
+        :'contracts' => :'Array<Contracts>'
       }
     end
 
@@ -230,6 +235,12 @@ module XeroRuby::PayrollUk
       if attributes.key?(:'is_off_payroll_worker')
         self.is_off_payroll_worker = attributes[:'is_off_payroll_worker']
       end
+
+      if attributes.key?(:'contracts')
+        if (value = attributes[:'contracts']).is_a?(Array)
+          self.contracts = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -309,7 +320,8 @@ module XeroRuby::PayrollUk
           ni_category == o.ni_category &&
           ni_categories == o.ni_categories &&
           national_insurance_number == o.national_insurance_number &&
-          is_off_payroll_worker == o.is_off_payroll_worker
+          is_off_payroll_worker == o.is_off_payroll_worker &&
+          contracts == o.contracts
     end
 
     # @see the `==` method
@@ -321,7 +333,7 @@ module XeroRuby::PayrollUk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [employee_id, title, first_name, last_name, date_of_birth, address, email, gender, phone_number, start_date, end_date, payroll_calendar_id, updated_date_utc, created_date_utc, ni_category, ni_categories, national_insurance_number, is_off_payroll_worker].hash
+      [employee_id, title, first_name, last_name, date_of_birth, address, email, gender, phone_number, start_date, end_date, payroll_calendar_id, updated_date_utc, created_date_utc, ni_category, ni_categories, national_insurance_number, is_off_payroll_worker, contracts].hash
     end
 
     # Builds the object from hash

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

@@ -31,6 +31,9 @@ module XeroRuby::PayrollUk
     # The employee's NI categories
     attr_accessor :ni_categories
     
+    # The employee's contracts
+    attr_accessor :contracts
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +41,8 @@ module XeroRuby::PayrollUk
         :'start_date' => :'startDate',
         :'employee_number' => :'employeeNumber',
         :'ni_category' => :'niCategory',
-        :'ni_categories' => :'niCategories'
+        :'ni_categories' => :'niCategories',
+        :'contracts' => :'contracts'
       }
     end
 
@@ -49,7 +53,8 @@ module XeroRuby::PayrollUk
         :'start_date' => :'Date',
         :'employee_number' => :'String',
         :'ni_category' => :'NICategoryLetter',
-        :'ni_categories' => :'Array<NICategory>'
+        :'ni_categories' => :'Array<NICategory>',
+        :'contracts' => :'Array<Contracts>'
       }
     end
 
@@ -89,6 +94,12 @@ module XeroRuby::PayrollUk
           self.ni_categories = value
         end
       end
+
+      if attributes.key?(:'contracts')
+        if (value = attributes[:'contracts']).is_a?(Array)
+          self.contracts = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -133,7 +144,8 @@ module XeroRuby::PayrollUk
           start_date == o.start_date &&
           employee_number == o.employee_number &&
           ni_category == o.ni_category &&
-          ni_categories == o.ni_categories
+          ni_categories == o.ni_categories &&
+          contracts == o.contracts
     end
 
     # @see the `==` method
@@ -145,7 +157,7 @@ module XeroRuby::PayrollUk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [payroll_calendar_id, start_date, employee_number, ni_category, ni_categories].hash
+      [payroll_calendar_id, start_date, employee_number, ni_category, ni_categories, contracts].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,37 @@
+=begin
+#Xero Payroll UK
+
+#This is the Xero Payroll API for orgs in the UK region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollUk
+  class EmploymentStatus
+    EMPLOYEE ||= "Employee".freeze
+    WORKER ||= "Worker".freeze
+    UNSPECIFIED ||= "Unspecified".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 = EmploymentStatus.constants.select { |c| EmploymentStatus::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #EmploymentStatus" if constantValues.empty?
+      value
+    end
+  end
+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: 9.2.0
+The version of the XeroOpenAPI document: 10.1.0
 =end
 
 module XeroRuby
-  VERSION = '12.2.0'
+  VERSION = '12.4.0'
 end

data/lib/xero-ruby.rb

@@ -90,11 +90,14 @@ require 'xero-ruby/models/payroll_uk/benefit'
 require 'xero-ruby/models/payroll_uk/benefit_line'
 require 'xero-ruby/models/payroll_uk/benefit_object'
 require 'xero-ruby/models/payroll_uk/benefits'
+require 'xero-ruby/models/payroll_uk/contract_type'
+require 'xero-ruby/models/payroll_uk/contracts'
 require 'xero-ruby/models/payroll_uk/court_order_line'
 require 'xero-ruby/models/payroll_uk/deduction'
 require 'xero-ruby/models/payroll_uk/deduction_line'
 require 'xero-ruby/models/payroll_uk/deduction_object'
 require 'xero-ruby/models/payroll_uk/deductions'
+require 'xero-ruby/models/payroll_uk/developmental_role_details'
 require 'xero-ruby/models/payroll_uk/earnings_line'
 require 'xero-ruby/models/payroll_uk/earnings_order'
 require 'xero-ruby/models/payroll_uk/earnings_order_object'
@@ -131,6 +134,7 @@ require 'xero-ruby/models/payroll_uk/employee_tax_object'
 require 'xero-ruby/models/payroll_uk/employees'
 require 'xero-ruby/models/payroll_uk/employment'
 require 'xero-ruby/models/payroll_uk/employment_object'
+require 'xero-ruby/models/payroll_uk/employment_status'
 require 'xero-ruby/models/payroll_uk/invalid_field'
 require 'xero-ruby/models/payroll_uk/leave_accrual_line'
 require 'xero-ruby/models/payroll_uk/leave_earnings_line'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 12.4.0
 platform: ruby
 authors:
 - Xero API Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-04 00:00:00.000000000 Z
+date: 2026-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -533,11 +533,14 @@ files:
 - lib/xero-ruby/models/payroll_uk/benefit_line.rb
 - lib/xero-ruby/models/payroll_uk/benefit_object.rb
 - lib/xero-ruby/models/payroll_uk/benefits.rb
+- lib/xero-ruby/models/payroll_uk/contract_type.rb
+- lib/xero-ruby/models/payroll_uk/contracts.rb
 - lib/xero-ruby/models/payroll_uk/court_order_line.rb
 - lib/xero-ruby/models/payroll_uk/deduction.rb
 - lib/xero-ruby/models/payroll_uk/deduction_line.rb
 - lib/xero-ruby/models/payroll_uk/deduction_object.rb
 - lib/xero-ruby/models/payroll_uk/deductions.rb
+- lib/xero-ruby/models/payroll_uk/developmental_role_details.rb
 - lib/xero-ruby/models/payroll_uk/earnings_line.rb
 - lib/xero-ruby/models/payroll_uk/earnings_order.rb
 - lib/xero-ruby/models/payroll_uk/earnings_order_object.rb
@@ -574,6 +577,7 @@ files:
 - lib/xero-ruby/models/payroll_uk/employees.rb
 - lib/xero-ruby/models/payroll_uk/employment.rb
 - lib/xero-ruby/models/payroll_uk/employment_object.rb
+- lib/xero-ruby/models/payroll_uk/employment_status.rb
 - lib/xero-ruby/models/payroll_uk/invalid_field.rb
 - lib/xero-ruby/models/payroll_uk/leave_accrual_line.rb
 - lib/xero-ruby/models/payroll_uk/leave_earnings_line.rb