Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
xero-ruby (12.3.0)
xero-ruby (12.4.0)
faraday (>= 2.0, < 3.0)
json (~> 2.1, >= 2.1.0)
json-jwt (~> 1.16, >= 1.16.3)
Expand Down
5 changes: 4 additions & 1 deletion docs/accounting/AccountingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10401,7 +10401,9 @@ opts = {

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

page_size: 100 # Integer | Number of records to retrieve per page
page_size: 100, # Integer | Number of records to retrieve per page

references: ['&quot;Ref1&quot;, &quot;Ref2&quot;'] # Array<String> | Filter by a comma-separated list of References
}

begin
Expand All @@ -10425,6 +10427,7 @@ Name | Type | Description | Notes
**page** | **Integer**| e.g. page&#x3D;1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment | [optional]
**unitdp** | **Integer**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional]
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
**references** | [**Array&lt;String&gt;**](String.md)| Filter by a comma-separated list of References | [optional]

### Return type

Expand Down
2 changes: 2 additions & 0 deletions docs/accounting/Overpayment.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Name | Type | Description | Notes
**applied_amount** | **Float** | The amount of applied to an invoice | [optional]
**payments** | [**Array&lt;Payment&gt;**](Payment.md) | See Payments | [optional]
**has_attachments** | **Boolean** | boolean to indicate if a overpayment has an attachment | [optional] [default to false]
**reference** | **String** | An optional description for Overpayment | [optional]
**attachments** | [**Array&lt;Attachment&gt;**](Attachment.md) | See Attachments | [optional]

## Code Sample
Expand All @@ -47,6 +48,7 @@ instance = XeroRuby::Accounting::Overpayment.new(type: null,
applied_amount: 2.0,
payments: null,
has_attachments: false,
reference: Ref for payment,
attachments: null)
```

Expand Down
30 changes: 28 additions & 2 deletions docs/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4357,6 +4357,11 @@
"example" : false,
"default" : false
},
"Reference" : {
"type" : "string",
"description" : "An optional description for Overpayment",
"example" : "Ref for payment"
},
"Attachments" : {
"type" : "array",
"description" : "See Attachments",
Expand Down Expand Up @@ -6344,7 +6349,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>12.3.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>12.4.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>
Expand Down Expand Up @@ -30613,9 +30618,10 @@ <h3>Usage and SDK Samples</h3>
page = 1
unitdp = 4
pageSize = 100
references = [&quot;Ref1&quot;, &quot;Ref2&quot;]

begin
response = xero_client.accounting_api.get_overpayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize)
response = xero_client.accounting_api.get_overpayments(xero_tenant_id, if_modified_since, where, order, page, unitdp, pageSize, references)
return response
rescue XeroRuby::ApiError => e
puts "Exception when calling get_overpayments: #{e}"
Expand Down Expand Up @@ -30795,6 +30801,26 @@ <h2>Parameters</h2>
</div>
</div>
</td>
</tr>

<tr><td style="width:150px;">References</td>
<td>


<div id="d2e199_getOverpayments_references">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
array[String]
</span>

<div class="inner description marked">
Filter by a comma-separated list of References
</div>
</div>
</div>
</div>
</td>
</tr>

</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/app_store/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>12.3.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>12.4.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1419,7 +1419,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>12.3.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>12.4.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/files/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>12.3.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>12.4.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/finance/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2716,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>12.3.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>12.4.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/payroll_au/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>12.3.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>12.4.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>
Expand Down
4 changes: 0 additions & 4 deletions docs/payroll_nz/EmployeeLeaveSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ 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** | 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]
Expand All @@ -26,8 +24,6 @@ instance = XeroRuby::PayrollNz::EmployeeLeaveSetup.new(include_holiday_pay: fals
holiday_pay_opening_balance: 10.5,
annual_leave_opening_balance: 25.89,
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,
Expand Down
4 changes: 1 addition & 3 deletions docs/payroll_nz/EmployeeLeaveType.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +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** | 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]
**rate_accrued_hourly** | **BigDecimal** | not supported in Payroll NZ | [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]
**show_annual_leave_in_advance** | **Boolean** | Specific to Annual Leave. Flag to include leave available to take in advance in the balance in the payslip | [optional]
Expand All @@ -26,7 +25,6 @@ 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,
Expand Down
4 changes: 2 additions & 2 deletions docs/payroll_nz/PayrollNzApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -529,7 +529,7 @@ api_instance = xero_client.<api_set>

xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
employee_leave_setup = {"holidayPayOpeningBalance":10,"annualLeaveOpeningBalance":100,"sickLeaveHoursToAccrueAnnually":20,"sickLeaveToAccrueAnnually":20,"sickLeaveOpeningBalance":10,"sickLeaveScheduleOfAccrual":"OnAnniversaryDate","sickLeaveAnniversaryDate":"2023-12-31","annualLeaveAnniversaryDate":"2023-12-31"} # EmployeeLeaveSetup |
employee_leave_setup = {"holidayPayOpeningBalance":10,"annualLeaveOpeningBalance":100,"sickLeaveToAccrueAnnually":20,"sickLeaveOpeningBalance":10,"sickLeaveScheduleOfAccrual":"OnAnniversaryDate","sickLeaveAnniversaryDate":"2023-12-31","annualLeaveAnniversaryDate":"2023-12-31"} # EmployeeLeaveSetup |
opts = {
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
}
Expand Down Expand Up @@ -600,7 +600,7 @@ api_instance = xero_client.<api_set>

xero_tenant_id = 'xero_tenant_id_example' # String | Xero identifier for Tenant
employee_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # String | Employee id for single object
employee_leave_type = {"leaveTypeID":"35da97ae-05b9-427f-9a98-69157ba42cec","scheduleOfAccrual":"AnnuallyAfter6Months","hoursAccruedAnnually":10,"unitsAccruedAnnually":10,"typeOfUnitsToAccrue":"Hours","openingBalanceTypeOfUnits":"Hours","maximumToAccrue":80,"openingBalance":100,"rateAccruedHourly":3.5} # EmployeeLeaveType |
employee_leave_type = {"leaveTypeID":"35da97ae-05b9-427f-9a98-69157ba42cec","scheduleOfAccrual":"AnnuallyAfter6Months","unitsAccruedAnnually":10,"typeOfUnitsToAccrue":"Hours","openingBalanceTypeOfUnits":"Hours","maximumToAccrue":80,"openingBalance":100,"rateAccruedHourly":null} # EmployeeLeaveType |
opts = {
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
}
Expand Down
32 changes: 4 additions & 28 deletions docs/payroll_nz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1682,20 +1682,6 @@
"example" : 10.0,
"x-is-money" : true
},
"sickLeaveHoursToAccrueAnnually" : {
"type" : "number",
"description" : "Deprecated use SickLeaveToAccrueAnnually",
"format" : "double",
"example" : 100.5,
"x-is-money" : true
},
"sickLeaveMaximumHoursToAccrue" : {
"type" : "number",
"description" : "Deprecated use SickLeaveMaximumToAccrue",
"format" : "double",
"example" : 200.5,
"x-is-money" : true
},
"SickLeaveToAccrueAnnually" : {
"type" : "number",
"description" : "Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type",
Expand Down Expand Up @@ -1769,13 +1755,7 @@
"description" : "The schedule of accrual",
"enum" : [ "AnnuallyAfter6Months", "OnAnniversaryDate", "PercentageOfGrossEarnings", "NoAccruals" ]
},
"hoursAccruedAnnually" : {
"type" : "number",
"description" : "Deprecated use UnitsAccruedAnnually",
"format" : "double",
"x-is-money" : true
},
"UnitsAccruedAnnually" : {
"unitsAccruedAnnually" : {
"type" : "number",
"description" : "The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"",
"format" : "double",
Expand Down Expand Up @@ -1803,7 +1783,7 @@
},
"rateAccruedHourly" : {
"type" : "number",
"description" : "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\"",
"description" : "not supported in Payroll NZ",
"format" : "double",
"x-is-money" : true
},
Expand Down Expand Up @@ -4087,7 +4067,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>12.3.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>12.4.0</li>
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
Expand Down Expand Up @@ -5316,8 +5296,6 @@ <h3>Usage and SDK Samples</h3>
include_holiday_pay: false,
holiday_pay_opening_balance: 10.5,
annual_leave_opening_balance: 25.89,
sick_leave_hours_to_accrue_annually: 100.0,
sick_leave_maximum_hours_to_accrue: 200.0,
sick_leave_opening_balance: 10.5,
sick_leave_to_accrue_annually: 100.0,
sick_leave_maximum_to_accrue: 200.0,
Expand Down Expand Up @@ -5460,7 +5438,6 @@ <h2>Parameters</h2>
"example" : {
"holidayPayOpeningBalance" : 10,
"annualLeaveOpeningBalance" : 100,
"sickLeaveHoursToAccrueAnnually" : 20,
"sickLeaveToAccrueAnnually" : 20,
"sickLeaveOpeningBalance" : 10,
"sickLeaveScheduleOfAccrual" : "OnAnniversaryDate",
Expand Down Expand Up @@ -5646,13 +5623,12 @@ <h2>Parameters</h2>
"example" : {
"leaveTypeID" : "35da97ae-05b9-427f-9a98-69157ba42cec",
"scheduleOfAccrual" : "AnnuallyAfter6Months",
"hoursAccruedAnnually" : 10,
"unitsAccruedAnnually" : 10,
"typeOfUnitsToAccrue" : "Hours",
"openingBalanceTypeOfUnits" : "Hours",
"maximumToAccrue" : 80,
"openingBalance" : 100,
"rateAccruedHourly" : 3.5
"rateAccruedHourly" : null
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion docs/payroll_uk/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3700,7 +3700,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>12.3.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>12.4.0</li>
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/projects/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1462,7 +1462,7 @@
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>12.3.0</li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>12.4.0</li>
<li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
<li data-group="Project" data-name="createProject" class="">
<a href="#api-Project-createProject">createProject</a>
Expand Down
Loading
Loading