Skip to content

Releases: XeroAPI/xero-python

1.15.0

10 May 22:56
36c9132
Compare
Choose a tag to compare

Generates Xero-Python 1.15.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)

1.14.0

14 Apr 22:11
8b2cffd
Compare
Choose a tag to compare

Generates Xero-Python 1.14.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)

1.13.1

16 Mar 16:31
e5c30b6
Compare
Choose a tag to compare

Generates Xero-Python 1.13.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)

1.13.0

04 Mar 00:07
66856a7
Compare
Choose a tag to compare

Generates Xero-Python 1.13.0 from Xero-OpenAPI 2.19.1

Accounting API

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

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)

1.12.0

02 Feb 22:26
53a028c
Compare
Choose a tag to compare

Generates Xero-Python 1.12.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)

1.11.0

09 Nov 22:55
fd4b000
Compare
Choose a tag to compare

Implements the endpoints available in Xero's Finance API Spec.

Also updates the Contact model to match Xero's Accounting API Spec.

Description

https://developer.xero.com/documentation/api/finance/overview

Release Notes

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

FinanceAPI methods 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_profit_and_loss
  • get_financial_statement_trial_balance
  • get_financial_statement_contacts_expense
  • get_financial_statement_contacts_revenue

Finance models added

  • AccountUsage
  • AccountUsageResponse
  • BalanceSheetAccountDetail
  • BalanceSheetAccountGroup
  • BalanceSheetAccountType
  • BalanceSheetResponse
  • BankStatementResponse
  • CashAccountResponse
  • CashBalance
  • CashValidationResponse
  • CashflowAccount
  • CashflowActivity
  • CashflowResponse
  • CashflowType
  • ContactDetail
  • ContactTotalDetail
  • ContactTotalOther
  • CurrentStatementResponse
  • DataSourceResponse
  • HistoryRecordResponse
  • IncomeByContactResponse
  • LockHistoryModel
  • LockHistoryResponse
  • ManualJournalTotal
  • PnlAccount
  • PnlAccountClass
  • PnlAccountType
  • PracticeResponse
  • Problem
  • ProfitAndLossResponse
  • ReportHistoryModel
  • ReportHistoryResponse
  • StatementBalanceResponse
  • StatementLinesResponse
  • TotalDetail
  • TotalOther
  • TrialBalanceAccount
  • TrialBalanceEntry
  • TrialBalanceMovement
  • TrialBalanceResponse
  • UserActivitiesResponse
  • UserResponse

Accounting Contact model updated:

  • company_number - setting and retrieving Registration Number for a company/Business
  • merged_to_contact_id - retrieving the ID for the destination of a merged contact
  • sales_default_line_amount_type - retrieving the default sales line amount types for a contact
  • purchases_default_line_amount_type - retrieving the default purchases line amount types for a contact

Types of Changes

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

1.10.0

12 Oct 20:46
93435f0
Compare
Choose a tag to compare

Description

Generates Xero-Python from OAS 2.17.1 minus Finance API.

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

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)

1.9.0

31 Aug 22:02
6889c54
Compare
Choose a tag to compare

Implements the app store api 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

  • getSubscription

AppStore adds

  • Subscription

  • SubscriptionItem

  • Plan

  • Product

  • Price

  • ProblemDetails

  • time_zone.py adds EASTERISLANDSTANDARDTIME

  • payment.py adds bank_amount


Employee adds terminationReason
V Voluntary cessation
I Ill health
D Deceased
R Redundancy
F Dismissal
C Contract cessation
T Transfer

Types of Changes

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

1.8.1

29 Jul 17:46
ec94bbe
Compare
Choose a tag to compare

Changed python version and added the ability to deserialize the date without a day. This was discovered in the getBudget endpoint.

This is one of a few endpoints that has a date format without a date e.g. "2021-06".

#58

1.8.0

21 Jul 20:03
c155190
Compare
Choose a tag to compare

This PR introduces the ability to request, receive, and manage a token from Xero API using the client credentials auth method.

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.

Fixed Budgets endpoints - added budget balances and budget lines to serialize correctly.