3.10.0

Generates Xero-Ruby 3.10.0 from Xero-OpenAPI 2.23.0

Accounting API

New ReportTaxtType / TaxType TXRCTSINPUT added

Projects API

New methods createTask, updateTask, deleteTask added

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

3.9.0

Generates Xero-Ruby 3.9.0 from Xero-OpenAPI 2.22.4

Accounting API

Organisation model Class enum updated to include ULTIMATE
New method getJournalByNumber added
BADDEBTRELIEF , IGDSINPUT3, SROVR, TOURISTREFUND, TXRCN33INPUT, TXRCREINPUT, TXRCESSINPUT have been added as both a TaxType and ReportTaxType

Finance API

StatementResponse model updated to include startBalance and endBalance properties

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

3.8.0

Generates Xero-Ruby 3.8.0 from Xero-OpenAPI 2.21.0

App Store API

Adds metered capabilities for app store subscriptions end point

UK Payroll API

support new NI Category values (F, I, S, L, V)

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

3.7.1

Generates Xero-Ruby 3.7.1 from Xero-OpenAPI 2.19.3

Accounting API

Organisation model OrganisationType enum updated to include INDIVIDUAL

Finance API

Some fields were set to 'date-time' when they are actually 'date'.

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

3.7.0

Generates Xero-Ruby 3.7.0 from Xero-OpenAPI 2.19.1

Accounting API

LineItem model updated to include item object that is returned in BankTransactions, Invoices, Credit Notes - new model is LineItemItem

Finance API

Adds Bank Statements Plus endpoint via get_bank_statement_accounting method and associated models

UK Payroll API

Employee model update to include is_off_payroll_worker boolean property

Adds is_off_payroll_worker as an available query param for GET /Employees

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

3.6.0

Generates Xero-Ruby 3.6.0 from Xero-OpenAPI 2.17.4

App Store API

Plan.status enum updated to include CANCELED, available options are:
ACTIVE, CANCELED, PENDINGACTIVATION

Subscription.status type corrected from string to Subscription.StatusEnum, available options are:
ACTIVE, CANCELED, PASTDUE

SubscriptionItem updated to include status enum, available options are:
ACTIVE, CANCELED, PENDINGACTIVATION

Files API

Quote added to ObjectGroup enum
SalesQuote added to ObjectType enum

AU Payroll API

AllowanceCategory enum added to EarningsRate, available options are:
NONDEDUCTIBLE, UNIFORM, PRIVATEVEHICLE, HOMEOFFICE, TRANSPORT, GENERAL, OTHER

AllowanceType enum updated to include TOOLS, TASKS, QUALIFICATIONS, available options are:
CAR, TRANSPORT, LAUNDRY, MEALS, TRAVEL, JOBKEEPER, TOOLS, TASKS, QUALIFICATIONS, OTHER

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

3.5.0

Generates xero-ruby from OAS 2.17.2

Release is available on RubyGems: https://rubygems.org/gems/xero-ruby

Release Notes

FinanceAPI Release

Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.

The Finance API is a closed API that is only available to those that have an established (usually, but not limited to, financial services) partnership with Xero.
If you're an existing partner that wants access, contact your local Partner Manager.
If you're a financial institution or other partner who wants to leverage the Finance API for your business customers, contact us to become a financial services partner.

FinanceAPI Endpoints Added

• get_accounting_activity_account_usage
• get_accounting_activity_lock_history
• get_accounting_activity_report_history
• get_accounting_activity_user_activities
• get_cash_validation
• get_financial_statement_balance_sheet
• get_financial_statement_cashflow
• get_financial_statement_contacts_expense
• get_financial_statement_contacts_revenue
• get_financial_statement_profit_and_loss
• get_financial_statement_trial_balance

All new endpoints also have a corresponding _with_http_info method which returns the http status code & headers from the response

Models associated with these endpoints have been added under the finance/models folder.

Other changes

AccountingAPI Contact added
company_number
merged_to_contact_id
sales_default_line_amount_type
purchases_default_line_amount_type

3.4.0

Generates xero-ruby from OAS 2.17.1 minus Finance API.

Release is available on RubyGems: https://rubygems.org/gems/xero-ruby

Release Notes

AccountingAPI.get_budget() added query params:
date_to
date_from

AccountingAPI.get_contacts() added query param:
search_term

PayrollAUAPI if_modified_sInce query param type corrected:
was string --> now Date

PayrollNZAPI.get_employess() replaced query params:
was 'first_name and 'last_name --> now filter

PayrollNZAPI.get_timesheets() replaced query params:
was 'employee_idandpayroll_calendar_id--> nowfilter`

PayrollNZAPI.get_timesheets() added query params:
status
start_date
end_date
sort

PayrollUKAPI.get_timesheets() added query params:
status
start_date
end_date
sort

AccountingAPI BankTransfer model added fields:
from_is_reconciled
to_is_reconciled
reference

AppStoreAPI Product model added field:
seat_unit

PayrollAUAPI EarningsType added enum:
LUMPSUMW

PayrollAUAPI ManualTaxType added enum:
SCHEDULE4MANUAL

PayrollUKAPI EarningsRate model corrected enums:
was Tips(Direct) and Tips(Non-Direct) --> now TipsDirect and TipsNonDirect

3.3.0

Implements the endpoints available in Xero's API spec.

Description

• https://developer.xero.com/documentation/guides/how-to-guides/xero-app-store-subscriptions/
• https://developer.xero.com/documentation/api/xero-app-store/subscriptions

Release Notes

Subscriptions endpoints enable you to query data about the users who have paid to subscribe to your application through Xero.

AppStoreAPI adds

• get_subscription

• XeroRuby::AppStore:: adds

  • Subscription
  • SubscriptionItem
  • Plan
  • Product
  • Price
  • ProblemDetails

• XeroRuby::PayrollAu::Employee adds termination_reason
V Voluntary cessation
  I Ill health
  D Deceased
  R Redundancy
  F Dismissal
  C Contract cessation
  T Transfer

lib/xero-ruby/models/accounting/time_zone.rb

• EASTERISLANDSTANDARDTIME = "EASTERISLANDSTANDARDTIME".freeze

• XeroRuby::PayrollAu::PayrollCalendar adds reference_date

• Payment.rb adds bank_amount

Types of Changes

• New feature (non-breaking change that adds functionality)

3.2.1

Fix authorization_url to properly encode. Thanks @dimasusername