Skip to content

Commit d06e125

Browse files
yangb-xeroyangb-xero
authored
Merge pull request #372 from XeroAPI/15.0.0
Releasing 15.0.0 (OAS: 13.0.0)
2 parents a1f04cc + be51a62 commit d06e125

20 files changed

Lines changed: 71 additions & 1290 deletions

File tree

‎Gemfile.lock‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
xero-ruby (14.0.1)
4+
xero-ruby (15.0.0)
55
faraday (>= 2.0, < 3.0)
66
json (~> 2.1, >= 2.1.0)
77
json-jwt (~> 1.16, >= 1.16.3)

‎docs/accounting/AccountingApi.md‎

Lines changed: 0 additions & 293 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ Method | HTTP request | Description
2525
[**create_credit_note_history**](AccountingApi.md#create_credit_note_history) | **PUT** /CreditNotes/{CreditNoteID}/History | Retrieves history records of a specific credit note
2626
[**create_credit_notes**](AccountingApi.md#create_credit_notes) | **PUT** /CreditNotes | Creates a new credit note
2727
[**create_currency**](AccountingApi.md#create_currency) | **PUT** /Currencies | Create a new currency for a Xero organisation
28-
[**create_employees**](AccountingApi.md#create_employees) | **PUT** /Employees | Creates new employees used in Xero payrun
2928
[**create_expense_claim_history**](AccountingApi.md#create_expense_claim_history) | **PUT** /ExpenseClaims/{ExpenseClaimID}/History | Creates a history record for a specific expense claim
3029
[**create_expense_claims**](AccountingApi.md#create_expense_claims) | **PUT** /ExpenseClaims | Creates expense claims
3130
[**create_invoice_attachment_by_file_name**](AccountingApi.md#create_invoice_attachment_by_file_name) | **PUT** /Invoices/{InvoiceID}/Attachments/{FileName} | Creates an attachment for a specific invoice or purchase bill by filename
@@ -117,8 +116,6 @@ Method | HTTP request | Description
117116
[**get_credit_note_history**](AccountingApi.md#get_credit_note_history) | **GET** /CreditNotes/{CreditNoteID}/History | Retrieves history records of a specific credit note
118117
[**get_credit_notes**](AccountingApi.md#get_credit_notes) | **GET** /CreditNotes | Retrieves any credit notes
119118
[**get_currencies**](AccountingApi.md#get_currencies) | **GET** /Currencies | Retrieves currencies for your Xero organisation
120-
[**get_employee**](AccountingApi.md#get_employee) | **GET** /Employees/{EmployeeID} | Retrieves a specific employee used in Xero payrun using a unique employee Id
121-
[**get_employees**](AccountingApi.md#get_employees) | **GET** /Employees | Retrieves employees used in Xero payrun
122119
[**get_expense_claim**](AccountingApi.md#get_expense_claim) | **GET** /ExpenseClaims/{ExpenseClaimID} | Retrieves a specific expense claim using a unique expense claim Id
123120
[**get_expense_claim_history**](AccountingApi.md#get_expense_claim_history) | **GET** /ExpenseClaims/{ExpenseClaimID}/History | Retrieves history records of a specific expense claim
124121
[**get_expense_claims**](AccountingApi.md#get_expense_claims) | **GET** /ExpenseClaims | Retrieves expense claims
@@ -223,7 +220,6 @@ Method | HTTP request | Description
223220
[**update_or_create_bank_transactions**](AccountingApi.md#update_or_create_bank_transactions) | **POST** /BankTransactions | Updates or creates one or more spent or received money transaction
224221
[**update_or_create_contacts**](AccountingApi.md#update_or_create_contacts) | **POST** /Contacts | Updates or creates one or more contacts in a Xero organisation
225222
[**update_or_create_credit_notes**](AccountingApi.md#update_or_create_credit_notes) | **POST** /CreditNotes | Updates or creates one or more credit notes
226-
[**update_or_create_employees**](AccountingApi.md#update_or_create_employees) | **POST** /Employees | Creates a single new employees used in Xero payrun
227223
[**update_or_create_invoices**](AccountingApi.md#update_or_create_invoices) | **POST** /Invoices | Updates or creates one or more sales invoices or purchase bills
228224
[**update_or_create_items**](AccountingApi.md#update_or_create_items) | **POST** /Items | Updates or creates one or more items
229225
[**update_or_create_manual_journals**](AccountingApi.md#update_or_create_manual_journals) | **POST** /ManualJournals | Updates or creates a single manual journal
@@ -1751,80 +1747,6 @@ Name | Type | Description | Notes
17511747
- **Accept**: application/json
17521748

17531749

1754-
## create_employees
1755-
1756-
> Employees create_employees(xero_tenant_id, employees, opts)
1757-
1758-
Creates new employees used in Xero payrun
1759-
1760-
This endpoint is deprecated and will be removed April 28, 2026
1761-
1762-
### Example
1763-
1764-
```ruby
1765-
# load the gem
1766-
require 'xero-ruby'
1767-
1768-
creds = {
1769-
client_id: ENV['CLIENT_ID'],
1770-
client_secret: ENV['CLIENT_SECRET'],
1771-
redirect_uri: ENV['REDIRECT_URI'],
1772-
scopes: ENV['SCOPES']
1773-
}
1774-
xero_client = XeroRuby::ApiClient.new(credentials: creds)
1775-
1776-
token_set = fetch_valid_token_set(user) # example
1777-
1778-
xero_client.refresh_token_set(token_set)
1779-
1780-
# You need to namespace your api method call to one of the following api sets
1781-
# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
1782-
1783-
api_instance = xero_client.<api_set>
1784-
1785-
1786-
1787-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
1788-
employees = {"Employees":[{"FirstName":"Nick","LastName":"Fury","ExternalLink":{"Url":"http://twitter.com/#!/search/Nick+Fury"}}]} # Employees | Employees with array of Employee object in body of request
1789-
opts = {
1790-
summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
1791-
1792-
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
1793-
}
1794-
1795-
begin
1796-
#Creates new employees used in Xero payrun
1797-
result = api_instance.create_employees(xero_tenant_id, employees, opts)
1798-
p result
1799-
rescue XeroRuby::Accounting::ApiError => e
1800-
puts "Exception when calling AccountingApi->create_employees: #{e}"
1801-
end
1802-
```
1803-
1804-
### Parameters
1805-
1806-
1807-
Name | Type | Description | Notes
1808-
------------- | ------------- | ------------- | -------------
1809-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
1810-
**employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request |
1811-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
1812-
**idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional]
1813-
1814-
### Return type
1815-
1816-
[**Employees**](Employees.md)
1817-
1818-
### Authorization
1819-
1820-
[OAuth2](../README.md#OAuth2)
1821-
1822-
### HTTP request headers
1823-
1824-
- **Content-Type**: application/json
1825-
- **Accept**: application/json
1826-
1827-
18281750
## create_expense_claim_history
18291751

18301752
> HistoryRecords create_expense_claim_history(xero_tenant_id, expense_claim_id, history_records, opts)
@@ -8108,147 +8030,6 @@ Name | Type | Description | Notes
81088030
- **Accept**: application/json
81098031

81108032

8111-
## get_employee
8112-
8113-
> Employees get_employee(xero_tenant_id, employee_id)
8114-
8115-
Retrieves a specific employee used in Xero payrun using a unique employee Id
8116-
8117-
This endpoint is deprecated and will be removed April 28, 2026
8118-
8119-
### Example
8120-
8121-
```ruby
8122-
# load the gem
8123-
require 'xero-ruby'
8124-
8125-
creds = {
8126-
client_id: ENV['CLIENT_ID'],
8127-
client_secret: ENV['CLIENT_SECRET'],
8128-
redirect_uri: ENV['REDIRECT_URI'],
8129-
scopes: ENV['SCOPES']
8130-
}
8131-
xero_client = XeroRuby::ApiClient.new(credentials: creds)
8132-
8133-
token_set = fetch_valid_token_set(user) # example
8134-
8135-
xero_client.refresh_token_set(token_set)
8136-
8137-
# You need to namespace your api method call to one of the following api sets
8138-
# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
8139-
8140-
api_instance = xero_client.<api_set>
8141-
8142-
8143-
8144-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
8145-
employee_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for a Employee
8146-
begin
8147-
#Retrieves a specific employee used in Xero payrun using a unique employee Id
8148-
result = api_instance.get_employee(xero_tenant_id, employee_id)
8149-
p result
8150-
rescue XeroRuby::Accounting::ApiError => e
8151-
puts "Exception when calling AccountingApi->get_employee: #{e}"
8152-
end
8153-
```
8154-
8155-
### Parameters
8156-
8157-
8158-
Name | Type | Description | Notes
8159-
------------- | ------------- | ------------- | -------------
8160-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
8161-
**employee_id** | [**String**](.md)| Unique identifier for a Employee |
8162-
8163-
### Return type
8164-
8165-
[**Employees**](Employees.md)
8166-
8167-
### Authorization
8168-
8169-
[OAuth2](../README.md#OAuth2)
8170-
8171-
### HTTP request headers
8172-
8173-
- **Content-Type**: Not defined
8174-
- **Accept**: application/json
8175-
8176-
8177-
## get_employees
8178-
8179-
> Employees get_employees(xero_tenant_id, opts)
8180-
8181-
Retrieves employees used in Xero payrun
8182-
8183-
This endpoint is deprecated and will be removed April 28, 2026
8184-
8185-
### Example
8186-
8187-
```ruby
8188-
# load the gem
8189-
require 'xero-ruby'
8190-
8191-
creds = {
8192-
client_id: ENV['CLIENT_ID'],
8193-
client_secret: ENV['CLIENT_SECRET'],
8194-
redirect_uri: ENV['REDIRECT_URI'],
8195-
scopes: ENV['SCOPES']
8196-
}
8197-
xero_client = XeroRuby::ApiClient.new(credentials: creds)
8198-
8199-
token_set = fetch_valid_token_set(user) # example
8200-
8201-
xero_client.refresh_token_set(token_set)
8202-
8203-
# You need to namespace your api method call to one of the following api sets
8204-
# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
8205-
8206-
api_instance = xero_client.<api_set>
8207-
8208-
8209-
8210-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
8211-
opts = {
8212-
if_modified_since: DateTime.parse('2020-02-06T12:17:43.202-08:00'), # DateTime | Only records created or modified since this timestamp will be returned
8213-
8214-
where: 'Status==\"ACTIVE\"', # String | Filter by an any element
8215-
8216-
order: 'LastName ASC' # String | Order by an any element
8217-
}
8218-
8219-
begin
8220-
#Retrieves employees used in Xero payrun
8221-
result = api_instance.get_employees(xero_tenant_id, opts)
8222-
p result
8223-
rescue XeroRuby::Accounting::ApiError => e
8224-
puts "Exception when calling AccountingApi->get_employees: #{e}"
8225-
end
8226-
```
8227-
8228-
### Parameters
8229-
8230-
8231-
Name | Type | Description | Notes
8232-
------------- | ------------- | ------------- | -------------
8233-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
8234-
**if_modified_since** | **DateTime**| Only records created or modified since this timestamp will be returned | [optional]
8235-
**where** | **String**| Filter by an any element | [optional]
8236-
**order** | **String**| Order by an any element | [optional]
8237-
8238-
### Return type
8239-
8240-
[**Employees**](Employees.md)
8241-
8242-
### Authorization
8243-
8244-
[OAuth2](../README.md#OAuth2)
8245-
8246-
### HTTP request headers
8247-
8248-
- **Content-Type**: Not defined
8249-
- **Accept**: application/json
8250-
8251-
82528033
## get_expense_claim
82538034

82548035
> ExpenseClaims get_expense_claim(xero_tenant_id, expense_claim_id)
@@ -15491,80 +15272,6 @@ Name | Type | Description | Notes
1549115272
- **Accept**: application/json
1549215273

1549315274

15494-
## update_or_create_employees
15495-
15496-
> Employees update_or_create_employees(xero_tenant_id, employees, opts)
15497-
15498-
Creates a single new employees used in Xero payrun
15499-
15500-
This endpoint is deprecated and will be removed April 28, 2026
15501-
15502-
### Example
15503-
15504-
```ruby
15505-
# load the gem
15506-
require 'xero-ruby'
15507-
15508-
creds = {
15509-
client_id: ENV['CLIENT_ID'],
15510-
client_secret: ENV['CLIENT_SECRET'],
15511-
redirect_uri: ENV['REDIRECT_URI'],
15512-
scopes: ENV['SCOPES']
15513-
}
15514-
xero_client = XeroRuby::ApiClient.new(credentials: creds)
15515-
15516-
token_set = fetch_valid_token_set(user) # example
15517-
15518-
xero_client.refresh_token_set(token_set)
15519-
15520-
# You need to namespace your api method call to one of the following api sets
15521-
# [:accounting_api, :assets_api, :projects_api, :files_api, :payroll_au_api, :payroll_nz_api, :payroll_uk_api, :app_store_api]
15522-
15523-
api_instance = xero_client.<api_set>
15524-
15525-
15526-
15527-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
15528-
employees = {"Employees":[{"FirstName":"Nick","LastName":"Fury","ExternalLink":{"Url":"http://twitter.com/#!/search/Nick+Fury"}}]} # Employees | Employees with array of Employee object in body of request
15529-
opts = {
15530-
summarize_errors: false, # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
15531-
15532-
idempotency_key: 'KEY_VALUE' # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
15533-
}
15534-
15535-
begin
15536-
#Creates a single new employees used in Xero payrun
15537-
result = api_instance.update_or_create_employees(xero_tenant_id, employees, opts)
15538-
p result
15539-
rescue XeroRuby::Accounting::ApiError => e
15540-
puts "Exception when calling AccountingApi->update_or_create_employees: #{e}"
15541-
end
15542-
```
15543-
15544-
### Parameters
15545-
15546-
15547-
Name | Type | Description | Notes
15548-
------------- | ------------- | ------------- | -------------
15549-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
15550-
**employees** | [**Employees**](Employees.md)| Employees with array of Employee object in body of request |
15551-
**summarize_errors** | **Boolean**| If false return 200 OK and mix of successfully created objects and any with validation errors | [optional] [default to false]
15552-
**idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional]
15553-
15554-
### Return type
15555-
15556-
[**Employees**](Employees.md)
15557-
15558-
### Authorization
15559-
15560-
[OAuth2](../README.md#OAuth2)
15561-
15562-
### HTTP request headers
15563-
15564-
- **Content-Type**: application/json
15565-
- **Accept**: application/json
15566-
15567-
1556815275
## update_or_create_invoices
1556915276

1557015277
> Invoices update_or_create_invoices(xero_tenant_id, invoices, opts)

‎docs/accounting/Prepayment.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
1818
**updated_date_utc** | **DateTime** | UTC timestamp of last update to the prepayment | [optional]
1919
**currency_code** | [**CurrencyCode**](CurrencyCode.md) | | [optional]
2020
**prepayment_id** | **String** | Xero generated unique identifier | [optional]
21+
**branding_theme_id** | **String** | The unique identifier of the branding template applied to a receive prepayment | [optional]
2122
**currency_rate** | **BigDecimal** | The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used | [optional]
2223
**remaining_credit** | **BigDecimal** | The remaining credit balance on the prepayment | [optional]
2324
**allocations** | [**Array&lt;Allocation&gt;**](Allocation.md) | See Allocations | [optional]
@@ -45,6 +46,7 @@ instance = XeroRuby::Accounting::Prepayment.new(type: null,
4546
updated_date_utc: /Date(1573755038314)/,
4647
currency_code: null,
4748
prepayment_id: null,
49+
branding_theme_id: null,
4850
currency_rate: null,
4951
remaining_credit: null,
5052
allocations: null,

0 commit comments

Comments
 (0)