Releases: XeroAPI/Xero-NetStandard
3.2.1
Xero NetStandard SDK version 3.2.1 generated against OpenAPI Spec version 2.2.11
AU Payroll API Changes:
LeaveType.cs
- corrected LeaveLoadingRate date type from int to double
SDK version updated to 3.2.1 (minor bug fix)
3.2.0
Xero NetStandard SDK version 3.2.0 generated against OpenAPI Spec version 2.2.11
This release contains breaking changes/fixes for accounting, AU payroll and identity APIs.
Accounting API Changes:
Attachment.cs
- fixed ContentLengh being decimal instead of int
Added TenNinetyNineContact model.
AccoutingApi.cs
- fixed some typos
- added summarizeErrors to CreditNote Allocation
Report.cs
- fixed typo in report name for TenNinetyNineContact
ManualJournalLine.cs
- added AccountID
QuoteStatusCodes.cs
- added DELETED enum
AU Payroll API Changes:
LeaveType.cs
- NormalEntitlement changed from Int to Double
EarningsRate.cs
- AccureLeave is corrected from decimal to bool
AccountType.cs
- added enum "WAGESPAYABLELIABILITY"
Identity API Changes:
Connections.cs
- fixed the casing of createdDateUTC to be createdDateUtc
OpenAPI document version update from 2.2.2 to 2.2.11 across all files.
SDK version updated to 3.2.0 (many bug fixes)
3.1.0
Xero NetStandard SDK version 3.1.0 generated against OpenAPI Spec version 2.2.2
OpenAPI generator used to generate this SDK upgraded from v4.2.0 to v4.3.0.
This release contains breaking changes for assets & identity APIs.
Accounting API Changes:
AccoutingApi.cs
- added paging parameter to GetPaymentsAsync
Allocation.cs
- added Overpayment
- added CreditNote
- added ValidationError
- added StatusAttributeString
Organisation.cs
- added EmployerIdentificationNumber
Quotes.cs
- added StatusAttributeString
- added ValidationError
Schedule.cs
- added enums for DueDateTypeEnum: DAYSAFTERINVOICEDATE & DAYSAFTERINVOICEMONTH
TaxRate.cs
- added enums for TaxRate in South Africa: CAPINPUT, CAPIMPORTS, IMINPUT, INPUT2, CIUINPUT, SRINPUT, OUTPUT2, SROUTPUT, CAPOUTPUT, ZROUTPUT, ZREXPORT, ACC28PLUS, ACCUPTO28, OTHEROUTPUT, SHOUTPUT, ZRINPUT, BADDEBT & OTHERINPUT
Asset API Changes:
Asset.cs
- PurchaseDate type changed from DateTimeOffset to DateTime
BookDepreciationDetail.cs
- DepreciationStartDate type changed from DateTimeOffset to DateTime
Setting.cs
- AssetStartDate type changed from DateTimeOffset to DateTime
- LastDepreciationDate type changed from DateTimeOffset to DateTime
Identity API Changes:
Connections.cs
- CreatedDateUTC type changed from DateTimeOffset to DateTime
- UpdatedDateUtc type changed from DateTimeOffset to DateTime
OpenAPI document version update from 2.1.7 to 2.2.2 across all files
SDK version updated to 3.1.0 (minor release with breaking changes)
3.0.0
Xero NetStandard SDK version 3.0.0 generated against OpenAPI Spec version 2.1.7
Caution! This is a major release with many breaking changes. Review the release note before updating.
Accounting API Changes:
AccoutingApi.cs
- Added GetContactByContactNumberAsync method
AccountsPayable.cs & AccountsReceivable.cs
- Changed type of Outstanding & Overdue from double to decimal
Allocation.cs
- Changed type of Amount from double to decimal
BankTransaction.cs
- Changed type of CurrencyRate, SubTotal, TotalTax, Total from double to decimal
BankTransfer.cs
- Changed type of Amount & CurrencyRate from double to decimal
BatchPayment.cs
- Changed type of Amount from double to decimal
Contact.cs
- Changed type of Discount from double to decimal
CreditNote.cs
- Changed type of SubTotal, TotalTax, Total, CurrencyRate & RemainingCredit from double to decimal
ExpenseClaim.cs
- Changed type of Total, AmountDue & AmountPaid from double to decimal
- Default value set to false for PaymentDueDate & ReceiptID
Invoice.cs - Changed type of CurrencyRate, CISDeduction, SubTotal, TotalTax, Total, TotalDiscount, AmountDue, AmountPaid & AmountCredited from double to decimal
Item.cs
- Changed type of TotalCostPool & QuantityOnHand from double to decimal
JournalLine.cs
- Changed type of NetAmount, GrossAmount & TaxAmount from double to decimal
LineItem.cs
- Changed type of Quantity & UnitAmount from float to double
- Changed type of TaxAmount from double to decimal
ManualJournalLine.cs
- Changed type of LineAmount & TaxAmount from double to decimal
Overpayment.cs
- Changed type of SubTotal, TotalTax, Total, CurrencyRate & RemainingCredit from double to decimal
Payment.cs
- Changed type of CurrencyRate & Amount from double to decimal
Prepayment.cs
- Changed type of SubTotal, TotalTax, Total, CurrencyRate & RemainingCredit from double to decimal
Purchase.cs
- Changed type of UnitPrice from float to decimal
PurchaseOrder.cs
- Changed type of CurrencyRate, SubTotal, TotalTax, Total & TotalDiscount from double to decimal
Quote.cs
- Changed type of SubTotal, TotalTax, Total & TotalDiscount from double to decimal
Receipt.cs
- Changed type of SubTotal, TotalTax & Total from double to decimal
RepeatingInvoice.cs
- Changed type of SubTotal, TotalTax & Total from double to decimal
TaxComponent.cs
- Changed type of Rate from double to decimal
TaxRate.cs
- Changed type of DisplayTaxRate & EffectiveRate from double to decimal
TenNinteyNineContact.cs
- Changed type of Box1, Box2, ... Box14 from double to decimal
Asset API Changes:
AssetApi.cs
- Changed type of PurchasePrice, DisposalPrice & AccountingBookValue from float to decimal
BookDepreciationDetail.cs
- Changed type of CurrentCapitalGain, CurrentGainLoss, CostLimit, ResidualValue, PriorAccumDepreciationAmount & CurrentAccumDepreciationAmount from float to decimal
BookDepreciationSetting.cs
- Changed type of DepreciationRate from float to decimal
Payroll AU API Changes:
PayrollAuApi.cs
- Breaking change: api client class name & interface name corrected from "PayrollAUApi" to "PayrollAuApi" to have the casing consistent with rest of the API sets
BankAccount.cs
- Changed type of Amount from float to decimal
DeductionLine.cs
- Changed type of Amount, Percentage & NumberOfUnits from float to decimal
EarningsLine.cs
- Changed type of AnnualSalary, NumberOfUnitsPerWeek, RatePerUnit, NormalNumberOfUnits, Amount, NumberOfUnits & FixedAmount from float to decimal
EarningsRate.cs
- Changed type of Multiplier, AccrueLeave & Amount from float to decimal
LeaveAccrualLine.cs
- Changed type of NumberOfUnits from float to decimal
LeaveBalance.cs
- Changed type of NumberOfUnits from float to decimal
LeaveEarningsLine.cs
- Changed type of RatePerUnit & NumberOfUnits from float to decimal
LeaveLine.cs
- Changed type of NumberOfUnits from float to decimal
LeavePeriod.cs
- Changed type of NumberOfUnits from float to decimal
PayRun.cs, Payslip.cs & PayslipSummary.cs
- Changed type of Wages, Deductions, Tax, Super, Reimbursement & NetPay from float to decimal
ReimbursementLine.cs
- Changed type of Amount from float to decimal
SuperannuationLine.cs & SuperLine.cs
- Changed type of MinimumMonthlyEarnings, Percentage & Amount from float to decimal
TaxLine.cs
- Changed type of Amount from float to decimal
Timesheet.cs
- Changed type of Hours from float to decimal
TimesheetLine.cs
- Changed type of NumberOfUnits from float to decimal
OpenAPI document version update from 2.1.4 to 2.1.7 across all files
SDK version updated to 3.0.0 (major release, breaking changes!!!)
2.3.0
Xero NetStandard SDK version 2.3.0 generated against OpenAPI Spec version 2.1.4
Accounting API Changes:
AccoutingApi.cs
- Removed GetPrepaymentAsPdfAsync a bug fix, Prepayment endpoint does not support get as pdf.
BankTransfer.cs
- Bug fix & breaking change: type of Amount corrected from string to float
Payment.cs
- Add StatusAttributeString to Payment model
Identitiy API Changes:
IdentityApi.cs
- Added support for authEventId query parameter for all methods (making it possible to determine if the connections are added in one single oauth flow)
Connection.cs
- Bug fix & breaking change: CreatedDateUTC type corrected from string to DateTimeOffset
- Added AuthEventId element
Payroll AU API Changes:
PayrollAuApi.cs
- Bug fix: CreatePayItemAsync method now takes PayItem as parameter instead of List
- Bug fix: UpdatePayslipAsync now returns PaySlips object
- Added add ValidationErrors array to following objects:
Employee.cs
LeaveApplication.cs
PayrollCalendar.cs
PayRun.cs
SuperFund.cs
Timesheet.cs - Added PayslipLines object (PayslipLines.cs)
- Added Payslips object (Payslips.cs)
- Added ValidationError object (ValidationError.cs)
OpenAPI document version update from 2.1.2 to 2.1.4 across all files
SDK version updated to 2.3.0 (minor, improvements & bug fixes, including 2 breaking change due to fixes on data types)
2.2.0
Xero NetStandard SDK version 2.2.0 generated against OpenAPI Spec version 2.1.2
Added Payroll AU APIs Support:
A custom serialiser is added to ApiClient.cs to handle the difference payroll AU APIs has with Date and DateTime in the format of Microsoft Wcf Json Date string.
PayrollAuApi.cs included all methods to be used for Payroll AU APIs.
Models are added in /Model/PayrollAu directory with namespace of Xero.NetStandard.OAuth2.Model.PayrollAu.
API Naming Strategy Change (non-functional impact):
Json deserializer setting is changed from using the default naming strategy instead of using camel case strategy.
This will allow the APIs to work for Payroll AU while not impacting any calls for accounting APIs, asset APIs and identity APIs.
This means, instead of sending
{ "fullName": "Bob Belcher" }
the SDK will send
{ "FullName": "Bob Belcher" }
Accounting API changes:
- CreatePaymentsAsync added summarizeError parameter
- Corrected JournalNumber type from string to integer
- added GetPrepaymentAsPdfAsync method
- Added UK Domestic Reverse Charge VAT rates
OpenAPI document version update from 2.1.1 to 2.1.2 across all files
SDK version updated to 2.2.0 (minor, substantial improvements)
2.1.0
Xero NetStandard SDK version 2.1.0 generated against OpenAPI Spec version 2.1.1
Added Identity APIs:
- GetConnectionsAsync
- DeleteConnectionAsync
Added Identity Models:
- AccessToken
- Connection
- RefreshToken
SDK version updated to 2.1.0 (minor version-new functionality added)
Added note post release:
The Xero.NetStandard.OAuth2.Client is updated to v0.0.4 to include DeleteConnectionAsync(IXeroToken xeroToken, Tenant xeroTenant) method.
2.0.1
Xero NetStandard SDK version 2.0.1 generated against OpenAPI Spec version 2.1.1
Bug fix:
Addressed issue #149 & #121 where UpdatedDateUTC is DateTime object with DateTime.Kind = local issue. The UpdatedDateUTC now returns UTC time.
Accounting APIs:
- Added method GetPrepaymentAsPdfAsync
- Added UK domestic revert charge VAT rates:
DRCHARGESUPPLY20
DRCHARGE20
DRCHARGESUPPLY5
DRCHARGE5
Unit Tests (Xero.NetStandard.OAuth2.Test):
Accounting
- Added unit test case "GetInvoiceUpdatedDateUtcTest" for UpdateDateUTC returning local DateTime.Kind issue.
Removed .ionide/ folder and added .ionide/ to .gitignore to remove noise files
OpenAPI document version update from 2.1.0 to 2.1.1 across all files
SDK version updated to 2.0.1 (bug fix)
2.0.0
Xero NetStandard SDK version 2.0.0 generated against OpenAPI Spec version 2.1.0
IMPORTANT: this major versioning and has breaking changes.
The namespace of Accounting Models & Asset Models are now having below namespaces:
Accounting APIs - Xero.NetStandard.OAuth2.Model.Accounting
Asset APIs - Xero.NetStandard.OAuth2.Model.Asset
Examples:
using Xero.NetStandard.OAuth2.Model.Asset;
using Xero.NetStandard.OAuth2.Model.Accounting;
Accounting API changes:
- Correct the IncludeOnline value so that it is a query parameter and not included directly in path
- Add GetPurchaseOrderAsPdfAsync method
Asset API changes:
- Add missing assetTypeId from Assets object
- Added Error objects and Validation arrays
GET Assets requires a Status in ALL Caps otherwise you'll receive a 403 Forbidden.
CREATE or GET Assets deserialises JSON responses into the Assets object where the Status is Init Caps.
For this reason the same component in our OpenAPI spec will not support both use cases without throwing an error for missing enums due to case sensitivity.
OpenAPI document version update from 2.0.7 to 2.1.0 across all files
SDK version updated to 2.0.0 (major update with breaking changes)
0.4.4
Xero NetStandard SDK version 0.4.4 generated against OpenAPI Spec version 2.0.7
BrandingTheme.cs
- CreatedDateUTC is now readonly
Contact.cs
- UpdatedDateUTC is now readonly
CreditNote.cs
- UpdatedDateUTC is now readonly
- added support for StatusAttributeString parameter
Employee.cs
- UpdatedDateUTC is now readonly
HistoryRecord.cs
- DateUTC is now readonly
Item.cs
- UpdatedDateUTC is now readonly
LinkedTransaction.cs
- UpdatedDateUTC is now readonly
Organisation.cs
- CreatedDateUTC is now readonly
Prepayment.cs
- UpdatedDateUTC is now readonly
- HasAttachments is now readonly
Quote.cs
- UpdatedDateUTC is now readonly
RepeatingInvoice.cs
- HasAttachments is now readonly
Report.cs
- UpdatedDateUTC is now readonly
ReportWithRow.cs
- UpdatedDateUTC is now readonly
User.cs
- UpdatedDateUTC is now readonly
OpenAPI document version update from 2.0.6 to 2.0.7 across all files
SDK version updated to 0.4.4 (pactch)