Build from OAS 7.0.0

XeroAPI · Jan 30, 2025 · 3f7dce9 · 3f7dce9
1 parent 30257b1
commit 3f7dce9
Show file tree

Hide file tree

Showing 23 changed files with 241 additions and 109 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xero-ruby (9.1.0)
+    xero-ruby (10.0.0)
       faraday (>= 2.0, < 3.0)
       json (~> 2.1, >= 2.1.0)
       json-jwt (~> 1.16, >= 1.16.3)

diff --git a/docs/accounting/index.html b/docs/accounting/index.html
@@ -6339,7 +6339,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>9.3.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>10.0.0</li>
               <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
               <li data-group="Accounting" data-name="createAccount" class="">
                 <a href="#api-Accounting-createAccount">createAccount</a>

diff --git a/docs/app_store/index.html b/docs/app_store/index.html
@@ -1241,7 +1241,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>9.3.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>10.0.0</li>
               <li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
               <li data-group="AppStore" data-name="getSubscription" class="">
                 <a href="#api-AppStore-getSubscription">getSubscription</a>

diff --git a/docs/assets/index.html b/docs/assets/index.html
@@ -1392,7 +1392,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>9.3.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>10.0.0</li>
               <li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
               <li data-group="Asset" data-name="createAsset" class="">
                 <a href="#api-Asset-createAsset">createAsset</a>

diff --git a/docs/files/index.html b/docs/files/index.html
@@ -1170,7 +1170,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Files"><strong>VSN: </strong>9.3.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>10.0.0</li>
               <li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
               <li data-group="Files" data-name="createFileAssociation" class="">
                 <a href="#api-Files-createFileAssociation">createFileAssociation</a>

diff --git a/docs/finance/CurrentStatementResponse.md b/docs/finance/CurrentStatementResponse.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **start_balance** | **BigDecimal** | Looking at the most recent bank statement, this field indicates the balance before the transactions on the statement are applied (note, this is not always populated by the bank in every single instance (~10%)). | [optional] 
 **end_balance** | **BigDecimal** | Looking at the most recent bank statement, this field indicates the balance after the transactions on the statement are applied (note, this is not always populated by the bank in every single instance (~10%)). | [optional] 
 **imported_date_time_utc** | **DateTime** | Looking at the most recent bank statement, this field indicates when the document was imported into Xero.  This date is represented in ISO 8601 format. | [optional] 
-**import_source_type** | **String** | Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, indirect bank feed, file upload, or manual keying). | [optional] 
+**import_source_type** | **String** | Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying). | [optional] 
 
 ## Code Sample
 

diff --git a/docs/finance/DataSourceResponse.md b/docs/finance/DataSourceResponse.md
@@ -5,15 +5,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **direct_bank_feed** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.   This gives an indication on the certainty of correctness of the data. | [optional] 
-**indirect_bank_feed** | **BigDecimal** | No longer in use. | [optional] 
 **file_upload** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data. | [optional] 
 **manual** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero.   This gives an indication on the certainty of correctness of the data. | [optional] 
 **direct_bank_feed_pos** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.  This gives an indication on the certainty of correctness of the data.  Only positive transactions are included. | [optional] 
-**indirect_bank_feed_pos** | **BigDecimal** | No longer in use. | [optional] 
 **file_upload_pos** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] 
 **manual_pos** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included. | [optional] 
 **direct_bank_feed_neg** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included. | [optional] 
-**indirect_bank_feed_neg** | **BigDecimal** | No longer in use. | [optional] 
 **file_upload_neg** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included. | [optional] 
 **manual_neg** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was manually input in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included. | [optional] 
 **other_pos** | **BigDecimal** | Sum of the amounts of all statement lines where the source of the data was unknown.   This gives an indication on the certainty of correctness of the data.  Only positive transactions are included. | [optional] 
@@ -26,15 +23,12 @@ Name | Type | Description | Notes
 require 'XeroRuby::Finance'
 
 instance = XeroRuby::Finance::DataSourceResponse.new(direct_bank_feed: null,
-                                 indirect_bank_feed: null,
                                  file_upload: null,
                                  manual: null,
                                  direct_bank_feed_pos: null,
-                                 indirect_bank_feed_pos: null,
                                  file_upload_pos: null,
                                  manual_pos: null,
                                  direct_bank_feed_neg: null,
-                                 indirect_bank_feed_neg: null,
                                  file_upload_neg: null,
                                  manual_neg: null,
                                  other_pos: null,

diff --git a/docs/finance/index.html b/docs/finance/index.html
@@ -1517,7 +1517,7 @@
     },
     "importSourceType" : {
       "type" : "string",
-      "description" : "Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, indirect bank feed, file upload, or manual keying)."
+      "description" : "Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying)."
     }
   },
   "additionalProperties" : false,
@@ -1533,13 +1533,6 @@
       "format" : "double",
       "x-is-money" : true
     },
-    "indirectBankFeed" : {
-      "type" : "number",
-      "description" : "No longer in use.",
-      "format" : "double",
-      "deprecated" : true,
-      "x-is-money" : true
-    },
     "fileUpload" : {
       "type" : "number",
       "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.",
@@ -1558,13 +1551,6 @@
       "format" : "double",
       "x-is-money" : true
     },
-    "indirectBankFeedPos" : {
-      "type" : "number",
-      "description" : "No longer in use.",
-      "format" : "double",
-      "deprecated" : true,
-      "x-is-money" : true
-    },
     "fileUploadPos" : {
       "type" : "number",
       "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included.",
@@ -1583,13 +1569,6 @@
       "format" : "double",
       "x-is-money" : true
     },
-    "indirectBankFeedNeg" : {
-      "type" : "number",
-      "description" : "No longer in use.",
-      "format" : "double",
-      "deprecated" : true,
-      "x-is-money" : true
-    },
     "fileUploadNeg" : {
       "type" : "number",
       "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.",
@@ -2737,7 +2716,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>9.3.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>10.0.0</li>
               <li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
               <li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
                 <a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

diff --git a/docs/payroll_au/index.html b/docs/payroll_au/index.html
@@ -3412,7 +3412,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>9.3.0</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>10.0.0</li>
               <li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
               <li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
                 <a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>

diff --git a/docs/payroll_nz/EmployeeLeaveSetup.md b/docs/payroll_nz/EmployeeLeaveSetup.md
@@ -8,11 +8,14 @@ Name | Type | Description | Notes
 **holiday_pay_opening_balance** | **BigDecimal** | Initial holiday pay balance. A percentage — usually 8% — of gross earnings since their last work anniversary. | [optional] 
 **annual_leave_opening_balance** | **BigDecimal** | Initial annual leave balance. The balance at their last anniversary, less any leave taken since then and excluding accrued annual leave. | [optional] 
 **negative_annual_leave_balance_paid_amount** | **BigDecimal** | The dollar value of annual leave opening balance if negative. | [optional] 
-**sick_leave_hours_to_accrue_annually** | **BigDecimal** | Number of hours accrued annually for sick leave. Multiply the number of days they&#39;re entitled to by the hours worked per day | [optional] 
-**sick_leave_maximum_hours_to_accrue** | **BigDecimal** | Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day | [optional] 
+**sick_leave_hours_to_accrue_annually** | **BigDecimal** | Deprecated use SickLeaveToAccrueAnnually | [optional] 
+**sick_leave_maximum_hours_to_accrue** | **BigDecimal** | Deprecated use SickLeaveMaximumToAccrue | [optional] 
+**sick_leave_to_accrue_annually** | **BigDecimal** | Number of units accrued annually for sick leave. The type of units is determined by the property \&quot;TypeOfUnitsToAccrue\&quot; on the \&quot;Sick Leave\&quot; leave type | [optional] 
+**sick_leave_maximum_to_accrue** | **BigDecimal** | Maximum number of units accrued annually for sick leave. The type of units is determined by the property \&quot;TypeOfUnitsToAccrue\&quot; on the \&quot;Sick Leave\&quot; leave type | [optional] 
 **sick_leave_opening_balance** | **BigDecimal** | Initial sick leave balance. This will be positive unless they&#39;ve taken sick leave in advance | [optional] 
 **sick_leave_schedule_of_accrual** | **String** | Set Schedule of Accrual Type for Sick Leave | [optional] 
-**sick_leave_anniversary_date** | **Date** | If Sick Leave Schedule of Accrual is \&quot;OnAnniversaryDate\&quot;, this is the date when entitled to Sick Leave | [optional] 
+**sick_leave_anniversary_date** | **Date** | If Sick Leave Schedule of Accrual is \&quot;OnAnniversaryDate\&quot;, this is the date when entitled to Sick Leave. When null the Employee&#39;s start date is used as the anniversary date | [optional] 
+**annual_leave_anniversary_date** | **Date** | The first date the employee will accrue Annual Leave. When null the Employee&#39;s start date is used as the anniversary date | [optional] 
 
 ## Code Sample
 
@@ -25,9 +28,12 @@ instance = XeroRuby::PayrollNz::EmployeeLeaveSetup.new(include_holiday_pay: fals
                                  negative_annual_leave_balance_paid_amount: 10.0,
                                  sick_leave_hours_to_accrue_annually: 100.5,
                                  sick_leave_maximum_hours_to_accrue: 200.5,
+                                 sick_leave_to_accrue_annually: 100.5,
+                                 sick_leave_maximum_to_accrue: 200.5,
                                  sick_leave_opening_balance: 10.5,
                                  sick_leave_schedule_of_accrual: OnAnniversaryDate,
-                                 sick_leave_anniversary_date: Sun Jan 19 00:00:00 GMT 2020)
+                                 sick_leave_anniversary_date: Sun Jan 19 00:00:00 GMT 2020,
+                                 annual_leave_anniversary_date: Sun Jan 19 00:00:00 GMT 2020)
 ```
 
 
diff --git a/docs/payroll_nz/EmployeeLeaveType.md b/docs/payroll_nz/EmployeeLeaveType.md
@@ -6,9 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **leave_type_id** | **String** | The Xero identifier for leave type | [optional] 
 **schedule_of_accrual** | **String** | The schedule of accrual | [optional] 
-**hours_accrued_annually** | **BigDecimal** | The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \&quot;OnHourWorked\&quot; | [optional] 
-**maximum_to_accrue** | **BigDecimal** | The maximum number of hours that can be accrued for the leave | [optional] 
-**opening_balance** | **BigDecimal** | The initial number of hours assigned when the leave was added to the employee | [optional] 
+**hours_accrued_annually** | **BigDecimal** | Deprecated use UnitsAccruedAnnually | [optional] 
+**units_accrued_annually** | **BigDecimal** | The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \&quot;NoAccruals\&quot; | [optional] 
+**type_of_units_to_accrue** | **String** | The type of units accrued for the leave annually | [optional] 
+**maximum_to_accrue** | **BigDecimal** | The maximum number of units that can be accrued for the leave | [optional] 
+**opening_balance** | **BigDecimal** | The initial number of units assigned when the leave was added to the employee | [optional] 
+**opening_balance_type_of_units** | **String** | The type of units for the opening balance | [optional] 
 **rate_accrued_hourly** | **BigDecimal** | 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 \&quot;OnHourWorked\&quot; | [optional] 
 **percentage_of_gross_earnings** | **BigDecimal** | Specific for scheduleOfAccrual having percentage of gross earnings. Identifies how much percentage of gross earnings is accrued per pay period. | [optional] 
 **include_holiday_pay_every_pay** | **Boolean** | Specific to Holiday pay. Flag determining if pay for leave type is added on each pay run. | [optional] 
@@ -24,8 +27,11 @@ require 'XeroRuby::PayrollNz'
 instance = XeroRuby::PayrollNz::EmployeeLeaveType.new(leave_type_id: null,
                                  schedule_of_accrual: null,
                                  hours_accrued_annually: null,
+                                 units_accrued_annually: null,
+                                 type_of_units_to_accrue: null,
                                  maximum_to_accrue: null,
                                  opening_balance: null,
+                                 opening_balance_type_of_units: null,
                                  rate_accrued_hourly: null,
                                  percentage_of_gross_earnings: null,
                                  include_holiday_pay_every_pay: null,

diff --git a/docs/payroll_nz/LeavePeriod.md b/docs/payroll_nz/LeavePeriod.md
@@ -7,7 +7,10 @@ Name | Type | Description | Notes
 **period_start_date** | **Date** | The Pay Period Start Date (YYYY-MM-DD) | [optional] 
 **period_end_date** | **Date** | The Pay Period End Date (YYYY-MM-DD) | [optional] 
 **number_of_units** | **BigDecimal** | The Number of Units for the leave | [optional] 
-**period_status** | **String** | Period Status | [optional] 
+**number_of_units_taken** | **Float** | The number of units taken for the leave | [optional] 
+**type_of_units** | **String** | The type of units paid for the leave | [optional] 
+**type_of_units_taken** | **String** | The type of units taken for the leave | [optional] 
+**period_status** | **String** | Status of leave | [optional] 
 
 ## Code Sample
 
@@ -17,6 +20,9 @@ require 'XeroRuby::PayrollNz'
 instance = XeroRuby::PayrollNz::LeavePeriod.new(period_start_date: null,
                                  period_end_date: null,
                                  number_of_units: null,
+                                 number_of_units_taken: null,
+                                 type_of_units: null,
+                                 type_of_units_taken: null,
                                  period_status: null)
 ```
 

diff --git a/docs/payroll_nz/LeaveType.md b/docs/payroll_nz/LeaveType.md
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
 **show_on_payslip** | **Boolean** | Indicate that a balance for this leave type to be shown on the employee’s payslips | 
 **updated_date_utc** | **DateTime** | UTC timestamp of last update to the leave type note | [optional] 
 **is_active** | **Boolean** | Shows whether the leave type is active or not | [optional] 
+**type_of_units** | **String** | The type of units to be paid for the leave type | [optional] 
+**type_of_units_to_accrue** | **String** | The type of units to be accrued for the leave type | [optional] 
 
 ## Code Sample
 
@@ -21,7 +23,9 @@ instance = XeroRuby::PayrollNz::LeaveType.new(leave_type_id: null,
                                  is_paid_leave: null,
                                  show_on_payslip: null,
                                  updated_date_utc: null,
-                                 is_active: null)
+                                 is_active: null,
+                                 type_of_units: null,
+                                 type_of_units_to_accrue: null)
 ```