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

3.2.0

Implements OA2's client_credentials grant supported by Xero's Custom Connection feature 🥳

https://developer.xero.com/documentation/guides/oauth2/custom-connections/

This enables developers to create machine to machine interactions for a single Xero org.

3.1.4

• Bumps bindata dependency from 2.4.9 to 2.4.10.
• Add budget lines properly serialized
• handle the parsing of date objects that don't include the day

3.1.2

Added TerminationPay to UK payroll earnings type enum

3.1.1

• Adds a new option param summaryOnly to getInvoices

---

🚨 🚨 🚨 MINOR BREAKING CHANGE 🚨 🚨 🚨
getReportBASorGSTList -> getReportsList
getReportBasOrGst -> getReportFromId

Release Notes

Added missing endpoints:

• GET /Budgets
• GET /Budgets/{BudgetID}

• changes using previous GST BAS reports specific endpoints to support stable future state of adding reports that are unique to an org and require a uuid to be passed. New function names:

getReportsList
getReportFromId

🚨 🚨 🚨 END🚨 🚨 🚨

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.1.0

🚨 🚨 🚨 MINOR BREAKING CHANGE 🚨 🚨 🚨
getReportBASorGSTList -> getReportsList
getReportBasOrGst -> getReportFromId

Release Notes

Added missing endpoints:

• GET /Budgets
• GET /Budgets/{BudgetID}

• changes using previous GST BAS reports specific endpoints to support stable future state of adding reports that are unique to an org and require a uuid to be passed. New function names:

getReportsList
getReportFromId

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.0.0

A small but technically breaking change for anyone depending on the to_attributes method. This fixes any nested objects to be properly deserialize, that were previously being left as PascalCase`

Fixes edge cases around MS dates that are stored as a negative epoch

• Fixes #150

Fixes nested serialization issues for objects returned using the to_attributes method. This will lookup any nested models such as Invoices -> LineItems and ensure all the values are returned as the snake case.

to_attributes calls to_hash(downcase: true) but the default to_hash still Pascal cases everything properly so that the POST's to the XeroAPI function as expected.

• Fixes #154