4.2.0

Generates Xero-Ruby 4.2.0 from Xero-OpenAPI 2.37.0

Description

Accounting API

• Adds tax_rates for Singapore
• Adds missing currency codes - fixes issue 250

Connections Endpoint

• last_connection now returns last instead of first - fixes issue 246

Release Notes

Adds in required tax rates for Singapore
Adds in missing currency codes

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)

4.1.0

Generates Xero-Ruby 4.1.0 from Xero-OpenAPI 2.36.0

Description

Files API

• Adds getAssociationsCount method to the Files API

Payroll AU API

• Adds new property PaidLeaveEarnings to the OpeningBalance schema definition
• Adds new property PayOutType to the LeaveApplication and LeaveEarningsLine schema definitions

Release Notes

• getAssociationsCount enables developers to fetch a count of associations for a list of objects. Previously, developers had to call separately for each object.
• https://developer.xero.com/documentation/api/payrollau/stp-changes#opening-balance-paid-leave-earnings
• https://developer.xero.com/documentation/api/payrollau/stp-changes/#cashed-out-leave

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)

4.0.0

Generates Xero-Ruby 4.0.0 from Xero-OpenAPI 2.35.0

Finance API

• Adds Indicative Balances and Payee to BankStatementsPlus

Payroll AU API

• Adds AllowanceContributesToAnnualLeaveRate and AllowanceContributesToOvertimeRate booleans to EarningsRate model

Payroll UK API

• Update the case in BackPay property of earningsType

Release Notes

• As part of STP2, two new checkboxes were added for allowance pay items.
• Resolves Xero-Ruby #241
• ⚠️ 🚨 Xero-Ruby 4.0.0 does not support Faraday 1.x, only Faraday 2.x 🚨 ⚠️

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

Release Notes

• Resolves #218. Faraday version constraint relaxed. Now supports Faraday 2.x

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

Generates Xero-Ruby 3.16.0 from Xero-OpenAPI 2.33.1

Accounting API

• Adds BatchPayment property in Payment model
• Adds Singapore tax rates for 2023
• Updates CreateBrandingThemePaymentServices method to accept an array of PaymentService objects instead of just one PaymentService object to match API functionality
• Updates data type of IsReconciled property of BatchPayment to boolean.
• Updates data type of TotalAmount property of BatchPayment to decimal

Release Notes

• Resolves Xero-NetStandard #449
• Resolves Xero-NetStandard #453
• Resolves Xero-Node #605

This will result in a small breaking change where any projects currently using the CreateBrandingThemePaymentServices method will need to wrap their PaymentService object in a PaymentServices object like so:

{ "PaymentServices": [ { "PaymentServiceID": "54b3b4f6-0443-4fba-bcd1-61ec0c35ca55", "PaymentServiceName": "PayUpNow", "PaymentServiceUrl": "https://www.payupnow.com/", "PaymentServiceType": "Custom", "PayNowText": "Time To Pay" } ] }

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

Generates Xero-Ruby 3.15.0 from Xero-OpenAPI 2.31.0

App Store API

• Adds usage/metered api end points and usage record models for app store. Further details here

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

Generates Xero-Ruby 3.14.0 from OAS 2.30.2

Description

Accounting API

Adds the following missing timezones:

• SAOTOMESTANDARDTIME
• WESTBANKSTANDARDTIME
• SOUTHSUDANSTANDARDTIME
• SUDANSTANDARDTIME
• VOLGOGRADSTANDARDTIME
• ASTRAKHANSTANDARDTIME
• SARATOVSTANDARDTIME
• QYZYLORDASTANDARDTIME
• OMSKSTANDARDTIME
• ALTAISTANDARDTIME
• WMONGOLIASTANDARDTIME
• TOMSKSTANDARDTIME
• AUSCENTRALWSTANDARDTIME
• ALEUTIANSTANDARDTIME
• BOUGAINVILLESTANDARDTIME
• CHATHAMISLANDSSTANDARDTIME
• CUBASTANDARDTIME
• EASTERNSTANDARDTIME(MEXICO)
• HAITISTANDARDTIME
• LORDHOWESTANDARDTIME
• MAGALLANESSTANDARDTIME
• MARQUESASSTANDARDTIME
• NORFOLKSTANDARDTIME
• NORTHKOREASTANDARDTIME
• SAINTPIERRESTANDARDTIME
• SAKHALINSTANDARDTIME
• TOCANTINSSTANDARDTIME
• TRANSBAIKALSTANDARDTIME
• TURKSANDCAICOSSTANDARDTIME
• UTC08
• UTC09
• YUKONSTANDARDTIME

AU Payroll API

• Captures all the schema updates made to the AU Payroll Employees API as part of the STP 2 Initiative.
• A detailed description of changes can be found here in the Xero API Developer Docs.

Release Notes

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

Generates Xero-Ruby 3.13.0 from OAS 2.29.3

Description

Accounting API

• Adds new method for Batch Payments: getBatchPayment which takes batchPaymentID as a parameter
• Adds missing report tax types to the enum (CAPEXINPUT, UNDEFINED, CAPEXOUTPUT, ZEROEXPOUTPUT, GOODSIMPORT, NONEINPUT, NOTREPORTED)

AU Payroll API

• Updates the LeaveCategoryCode enum value "PERSONALCARERSLEAVE" to "PERSONALSICKCARERSLEAVE" to match the updated value in the API.

Projects API

• Fixes Projects API createTask method to return object of type Task

Release Notes

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

Generates Xero-Ruby 3.12.0 from OAS 2.27.0

Description

Accounting API

• Added support for Xero Go organisations that have invited in their accountant.
• Add new org type LITE to Class model

AU Payroll

• Add new properties to the LeaveType object: LeaveCategoryCode and SGCExempt (See docs)
• Add new schema definitions:
  LeaveCategoryCode enum

Release Notes

API consumers will need to categorize all leave pay items as part of STP phase 2. The leave category code will be used to determine which category a new leave pay item will be filed as.
There are different rules for pay items created with these leave categories, some cannot be SGC exempt

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

Description

Generates Xero-Ruby 3.11.0 from Xero-OpenAPI 2.25.0

Accounting API

• Adds new methods for Repeating Invoices: createRepeatingInvoices, updateOrCreateRepeatingInvoices, and updateRepeatingInvoice
• Adds new method for Batch Payments: deleteBatchPayment

AU Payroll API

• Adds EarningsType enum values PAIDPARENTALLEAVE and WORKERSCOMPENSATION
• Adds missing tax declaration HasLoanOrStudentDebt

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)