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.2.0)
xero-ruby (12.3.0)
faraday (>= 2.0, < 3.0)
json (~> 2.1, >= 2.1.0)
json-jwt (~> 1.16, >= 1.16.3)
Expand Down
2 changes: 1 addition & 1 deletion docs/accounting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6344,7 +6344,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.2.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>12.3.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
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.2.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>12.3.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.2.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>12.3.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.2.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>12.3.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.2.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>12.3.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.2.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>12.3.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
2 changes: 1 addition & 1 deletion docs/payroll_nz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4087,7 +4087,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.2.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>12.3.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
16 changes: 16 additions & 0 deletions docs/payroll_uk/ContractType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# XeroRuby::PayrollUk::ContractType

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

## Code Sample

```ruby
require 'XeroRuby::PayrollUk'

instance = XeroRuby::PayrollUk::ContractType.new()
```


29 changes: 29 additions & 0 deletions docs/payroll_uk/Contracts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# XeroRuby::PayrollUk::Contracts

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_date** | **Date** | The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD) |
**employment_status** | [**EmploymentStatus**](EmploymentStatus.md) | |
**contract_type** | [**ContractType**](ContractType.md) | |
**public_key** | **String** | 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 | [optional]
**is_fixed_term** | **Boolean** | describes whether the contract is fixed term (required if trying to create Fixed term contract) | [optional]
**fixed_term_end_date** | **Date** | 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) | [optional]
**developmental_role_details** | [**DevelopmentalRoleDetails**](DevelopmentalRoleDetails.md) | | [optional]

## Code Sample

```ruby
require 'XeroRuby::PayrollUk'

instance = XeroRuby::PayrollUk::Contracts.new(start_date: Mon Dec 02 00:00:00 UTC 2024,
employment_status: null,
contract_type: null,
public_key: null,
is_fixed_term: null,
fixed_term_end_date: Sat Nov 01 00:00:00 UTC 2025,
developmental_role_details: null)
```


23 changes: 23 additions & 0 deletions docs/payroll_uk/DevelopmentalRoleDetails.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# XeroRuby::PayrollUk::DevelopmentalRoleDetails

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_date** | **Date** | The start date of the developmental role |
**end_date** | **Date** | The end date of the developmental role |
**developmental_role** | **String** | The developmental role type - \&quot;Apprentice\&quot; is the only supported role currently |
**public_key** | **String** | 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 | [optional]

## Code Sample

```ruby
require 'XeroRuby::PayrollUk'

instance = XeroRuby::PayrollUk::DevelopmentalRoleDetails.new(start_date: Mon Dec 02 00:00:00 UTC 2024,
end_date: Mon Dec 02 00:00:00 UTC 2024,
developmental_role: Apprentice,
public_key: null)
```


4 changes: 3 additions & 1 deletion docs/payroll_uk/Employee.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Name | Type | Description | Notes
**ni_categories** | [**Array&lt;NICategory&gt;**](NICategory.md) | The employee&#39;s NI categories | [optional]
**national_insurance_number** | **String** | National insurance number of the employee | [optional]
**is_off_payroll_worker** | **Boolean** | Whether the employee is an off payroll worker | [optional]
**contracts** | [**Array&lt;Contracts&gt;**](Contracts.md) | The employee&#39;s contracts | [optional]

## Code Sample

Expand All @@ -45,7 +46,8 @@ instance = XeroRuby::PayrollUk::Employee.new(employee_id: d90457c4-f1be-4f2e-b4e
ni_category: null,
ni_categories: null,
national_insurance_number: AB123456C,
is_off_payroll_worker: null)
is_off_payroll_worker: null,
contracts: null)
```


4 changes: 3 additions & 1 deletion docs/payroll_uk/Employment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**employee_number** | **String** | The employment number of the employee |
**ni_category** | [**NICategoryLetter**](NICategoryLetter.md) | | [optional]
**ni_categories** | [**Array&lt;NICategory&gt;**](NICategory.md) | The employee&#39;s NI categories |
**contracts** | [**Array&lt;Contracts&gt;**](Contracts.md) | The employee&#39;s contracts | [optional]

## Code Sample

Expand All @@ -19,7 +20,8 @@ instance = XeroRuby::PayrollUk::Employment.new(payroll_calendar_id: null,
start_date: null,
employee_number: 7,
ni_category: null,
ni_categories: null)
ni_categories: null,
contracts: null)
```


16 changes: 16 additions & 0 deletions docs/payroll_uk/EmploymentStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# XeroRuby::PayrollUk::EmploymentStatus

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

## Code Sample

```ruby
require 'XeroRuby::PayrollUk'

instance = XeroRuby::PayrollUk::EmploymentStatus.new()
```


102 changes: 101 additions & 1 deletion docs/payroll_uk/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1091,6 +1091,53 @@
}
},
"description" : ""
};
defs["ContractType"] = {
"title" : "",
"type" : "string",
"description" : "The contract type of the employee.",
"example" : "FullTime",
"enum" : [ "FullTime", "PartTime", "ZeroHour", "Unspecified" ]
};
defs["Contracts"] = {
"title" : "",
"required" : [ "contractType", "employmentStatus", "startDate" ],
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD)",
"format" : "date",
"example" : "2024-12-02",
"x-is-date" : true
},
"employmentStatus" : {
"$ref" : "#/components/schemas/EmploymentStatus"
},
"contractType" : {
"$ref" : "#/components/schemas/ContractType"
},
"publicKey" : {
"type" : "string",
"description" : "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",
"format" : "uuid"
},
"isFixedTerm" : {
"type" : "boolean",
"description" : "describes whether the contract is fixed term (required if trying to create Fixed term contract)"
},
"fixedTermEndDate" : {
"type" : "string",
"description" : "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)",
"format" : "date",
"example" : "2025-11-01",
"x-is-date" : true
},
"developmentalRoleDetails" : {
"$ref" : "#/components/schemas/DevelopmentalRoleDetails"
}
},
"description" : ""
};
defs["CourtOrderLine"] = {
"title" : "",
Expand Down Expand Up @@ -1249,6 +1296,38 @@
}
},
"description" : ""
};
defs["DevelopmentalRoleDetails"] = {
"title" : "",
"required" : [ "developmentalRole", "endDate", "startDate" ],
"type" : "object",
"properties" : {
"startDate" : {
"type" : "string",
"description" : "The start date of the developmental role",
"format" : "date",
"example" : "2024-12-02",
"x-is-date" : true
},
"endDate" : {
"type" : "string",
"description" : "The end date of the developmental role",
"format" : "date",
"example" : "2024-12-02",
"x-is-date" : true
},
"developmentalRole" : {
"type" : "string",
"description" : "The developmental role type - \"Apprentice\" is the only supported role currently",
"example" : "Apprentice"
},
"publicKey" : {
"type" : "string",
"description" : "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",
"format" : "uuid"
}
},
"description" : ""
};
defs["EarningsLine"] = {
"title" : "",
Expand Down Expand Up @@ -1613,6 +1692,13 @@
"isOffPayrollWorker" : {
"type" : "boolean",
"description" : "Whether the employee is an off payroll worker"
},
"contracts" : {
"type" : "array",
"description" : "The employee's contracts",
"items" : {
"$ref" : "#/components/schemas/Contracts"
}
}
},
"description" : ""
Expand Down Expand Up @@ -2300,6 +2386,13 @@
"items" : {
"$ref" : "#/components/schemas/NICategory"
}
},
"contracts" : {
"type" : "array",
"description" : "The employee's contracts",
"items" : {
"$ref" : "#/components/schemas/Contracts"
}
}
},
"description" : ""
Expand All @@ -2319,6 +2412,13 @@
}
},
"description" : ""
};
defs["EmploymentStatus"] = {
"title" : "",
"type" : "string",
"description" : "The employment status of the employee.",
"example" : "Employee",
"enum" : [ "Employee", "Worker", "Unspecified" ]
};
defs["InvalidField"] = {
"title" : "",
Expand Down Expand Up @@ -3600,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.2.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>12.3.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.2.0</li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>12.3.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
4 changes: 4 additions & 0 deletions lib/xero-ruby.rb
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,14 @@
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'
Expand Down Expand Up @@ -131,6 +134,7 @@
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'
Expand Down
Loading
Loading