Skip to content

Commit 0826329

Browse files
authored
Merge branch 'master' into master
2 parents 636eabb + 018baf9 commit 0826329

12 files changed

Lines changed: 114 additions & 54 deletions

xero-app-store.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
version: 9.3.0
3+
version: 10.0.0
44
title: Xero AppStore API
55
description: These endpoints are for Xero Partners to interact with the App Store Billing platform
66
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/

xero-finance.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
version: 9.3.0
3+
version: 10.0.0
44
title: Xero Finance API
55
description: 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.
66
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/

xero-identity.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
version: 9.3.0
3+
version: 10.0.0
44
title: Xero OAuth 2 Identity Service API
55
description: These endpoints are related to managing authentication tokens and identity for Xero API
66
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/

xero-payroll-au.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
version: 9.3.0
3+
version: 10.0.0
44
title: Xero Payroll AU API
55
description: This is the Xero Payroll API for orgs in Australia region.
66
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/

xero-payroll-nz.yaml

Lines changed: 4 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
version: 9.3.0
3+
version: 10.0.0
44
title: "Xero Payroll NZ"
55
description: "This is the Xero Payroll API for orgs in the NZ region."
66
termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
@@ -1565,22 +1565,6 @@ paths:
15651565
default: 25.89
15661566
is_money: true
15671567
object: employeeLeaveSetup
1568-
- sickLeaveHoursToAccrueAnnually:
1569-
key: sickLeaveHoursToAccrueAnnually
1570-
keyPascal: SickLeaveHoursToAccrueAnnually
1571-
keySnake: sick_leave_hours_to_accrue_annually
1572-
nonString: true
1573-
default: 100.0
1574-
is_money: true
1575-
object: employeeLeaveSetup
1576-
- sickLeaveMaximumHoursToAccrue:
1577-
key: sickLeaveMaximumHoursToAccrue
1578-
keyPascal: SickLeaveMaximumHoursToAccrue
1579-
keySnake: sick_leave_maximum_hours_to_accrue
1580-
is_money: true
1581-
nonString: true
1582-
default: 200.0
1583-
object: employeeLeaveSetup
15841568
- sickLeaveOpeningBalance:
15851569
key: sickLeaveOpeningBalance
15861570
keyPascal: SickLeaveOpeningBalance
@@ -1659,9 +1643,7 @@ paths:
16591643
holidayPayOpeningBalance: 10
16601644
annualLeaveOpeningBalance: 100
16611645
negativeAnnualLeaveBalancePaidAmount: null
1662-
sickLeaveHoursToAccrueAnnually: 20
16631646
sickLeaveToAccrueAnnually: 20
1664-
sickLeaveMaximumHoursToAccrue: null
16651647
sickLeaveMaximumToAccrue: null
16661648
sickLeaveOpeningBalance: 10
16671649
sickLeaveScheduleOfAccrual: OnAnniversaryDate
@@ -1682,7 +1664,6 @@ paths:
16821664
example:
16831665
holidayPayOpeningBalance: 10
16841666
annualLeaveOpeningBalance: 100
1685-
sickLeaveHoursToAccrueAnnually: 20
16861667
sickLeaveToAccrueAnnually: 20
16871668
sickLeaveOpeningBalance: 10
16881669
sickLeaveScheduleOfAccrual: OnAnniversaryDate
@@ -1728,7 +1709,6 @@ paths:
17281709
leaveTypes:
17291710
- leaveTypeID: 0441497f-5dc7-4cd3-a90d-f2e07e21b2a6
17301711
scheduleOfAccrual: PercentageOfGrossEarnings
1731-
hoursAccruedAnnually: 0
17321712
maximumToAccrue: 0
17331713
openingBalance: 0
17341714
rateAccruedHourly: null
@@ -1825,7 +1805,6 @@ paths:
18251805
leaveType:
18261806
leaveTypeID: 35da97ae-05b9-427f-9a98-69157ba42cec
18271807
scheduleOfAccrual: AnnuallyAfter6Months
1828-
hoursAccruedAnnually: 10
18291808
maximumToAccrue: 80
18301809
openingBalance: 100
18311810
rateAccruedHourly: null
@@ -1852,13 +1831,12 @@ paths:
18521831
example:
18531832
leaveTypeID: 35da97ae-05b9-427f-9a98-69157ba42cec
18541833
scheduleOfAccrual: AnnuallyAfter6Months
1855-
hoursAccruedAnnually: 10
18561834
unitsAccruedAnnually: 10
18571835
typeOfUnitsToAccrue: Hours
18581836
openingBalanceTypeOfUnits: Hours
18591837
maximumToAccrue: 80
18601838
openingBalance: 100
1861-
rateAccruedHourly: 3.5
1839+
rateAccruedHourly: null
18621840
/Employees/{EmployeeID}/PaymentMethods:
18631841
parameters:
18641842
- $ref: "#/components/parameters/requiredHeader"
@@ -6892,18 +6870,6 @@ components:
68926870
format: double
68936871
x-is-money: true
68946872
example: 10.0
6895-
sickLeaveHoursToAccrueAnnually:
6896-
description: Deprecated use SickLeaveToAccrueAnnually
6897-
type: number
6898-
format: double
6899-
x-is-money: true
6900-
example: 100.5
6901-
sickLeaveMaximumHoursToAccrue:
6902-
description: Deprecated use SickLeaveMaximumToAccrue
6903-
type: number
6904-
format: double
6905-
x-is-money: true
6906-
example: 200.5
69076873
SickLeaveToAccrueAnnually:
69086874
description: Number of units accrued annually for sick leave. The type of units is determined by the property "TypeOfUnitsToAccrue" on the "Sick Leave" leave type
69096875
type: number
@@ -6962,12 +6928,7 @@ components:
69626928
- OnAnniversaryDate
69636929
- PercentageOfGrossEarnings
69646930
- NoAccruals
6965-
hoursAccruedAnnually:
6966-
description: Deprecated use UnitsAccruedAnnually
6967-
type: number
6968-
format: double
6969-
x-is-money: true
6970-
UnitsAccruedAnnually:
6931+
unitsAccruedAnnually:
69716932
description: The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is "NoAccruals"
69726933
type: number
69736934
format: double
@@ -6989,7 +6950,7 @@ components:
69896950
description: The type of units for the opening balance
69906951
type: string
69916952
rateAccruedHourly:
6992-
description: The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is "OnHourWorked"
6953+
description: not supported in Payroll NZ
69936954
type: number
69946955
format: double
69956956
x-is-money: true

xero-payroll-uk.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
version: 9.3.0
3+
version: 10.0.0
44
title: "Xero Payroll UK"
55
description: "This is the Xero Payroll API for orgs in the UK region."
66
termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"

xero-projects.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
version: 9.3.0
3+
version: 10.0.0
44
title: Xero Projects API
55
description: This is the Xero Projects API
66
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/

xero-webhooks.yaml

Lines changed: 100 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ openapi: 3.1.1
22
info:
33
description: The Xero Webhooks API exposes event notifications relating to entities in the Xero Public API and can be used for a variety of purposes
44
title: Xero Webhooks API
5-
version: 9.3.0
5+
version: 10.0.0
66
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/
77
contact:
88
name: Xero Platform Team
@@ -64,6 +64,43 @@ webhooks:
6464
$ref: "#/components/responses/200WebhookDataReceivedOk"
6565
"401":
6666
$ref: "#/components/responses/401InvalidWebhookData"
67+
creditNotes:
68+
post:
69+
summary: Credit Notes Webhook Endpoint
70+
description: Credit Note (Create, Update)
71+
operationId: publishCreditNoteEvent
72+
tags:
73+
- Events
74+
requestBody:
75+
content:
76+
application/json:
77+
schema:
78+
$ref: "#/components/schemas/CreditNoteWebhookEvent"
79+
examples:
80+
creditNoteCreate:
81+
summary: Credit Note Create Event
82+
value:
83+
events:
84+
- resourceUrl: https://api.xero.com/api.xro/2.0/CreditNotes/55d84274-a3da-4829-a7c0-0cab601b95cc
85+
resourceId: 55d84274-a3da-4829-a7c0-0cab601b95cc
86+
tenantId: aef86862-2015-4b6b-88bc-d89032cecc50
87+
tenantType: ORGANISATION
88+
eventCategory: CREDITNOTE
89+
eventType: CREATE
90+
eventDateUtc: 2025-12-02T00:44:09.923
91+
data:
92+
Type: ACCPAYCREDIT
93+
Status: DRAFT
94+
firstEventSequence: 76
95+
lastEventSequence: 76
96+
entropy: FXNGWLCCGVANWHKILRUB
97+
responses:
98+
"200":
99+
$ref: "#/components/responses/200WebhookDataReceivedOk"
100+
"401":
101+
$ref: "#/components/responses/401InvalidWebhookData"
102+
103+
67104
components:
68105
headers:
69106
x-xero-signature:
@@ -119,6 +156,9 @@ components:
119156
- type: string
120157
const: SUBSCRIPTION
121158
description: For application subscription-related events
159+
- type: string
160+
const: CREDITNOTE
161+
description: For organisation credit note-related events
122162
tenantId:
123163
type: string
124164
format: uuid
@@ -155,6 +195,65 @@ components:
155195
entropy:
156196
type: string
157197
description: A random string used for security or validation purposes
198+
CreditNoteWebhookEvent:
199+
allOf:
200+
- $ref: "#/components/schemas/WebhookEvent"
201+
- type: object
202+
properties:
203+
events:
204+
type: array
205+
items:
206+
allOf:
207+
- $ref: "#/components/schemas/WebhookEvent/properties/events/items"
208+
- type: object
209+
properties:
210+
eventCategory:
211+
const: CREDITNOTE
212+
data:
213+
type: object
214+
description: Additional data for credit note events
215+
required:
216+
- Type
217+
- Status
218+
properties:
219+
Type:
220+
type: string
221+
description: The type of credit note
222+
externalDocs:
223+
url: https://developer.xero.com/documentation/api/accounting/types#credit-notes
224+
oneOf:
225+
- type: string
226+
const: ACCPAYCREDIT
227+
description: An Accounts Payable(supplier) Credit Note
228+
- type: string
229+
const: ACCRECCREDIT
230+
description: An Account Receivable(customer) Credit Note
231+
Status:
232+
type: string
233+
description: The status of the credit note
234+
externalDocs:
235+
url: https://developer.xero.com/documentation/api/accounting/types#invoice-status-codes
236+
oneOf:
237+
- type: string
238+
const: DRAFT
239+
description: Draft credit note
240+
- type: string
241+
const: SUBMITTED
242+
description: Submitted credit note
243+
- type: string
244+
const: DELETED
245+
description: Deleted credit note
246+
- type: string
247+
const: AUTHORISED
248+
description: Authorised credit note
249+
- type: string
250+
const: PAID
251+
description: Paid credit note
252+
- type: string
253+
const: VOIDED
254+
description: Voided credit note
255+
required:
256+
- data
158257
responses:
159258
401InvalidWebhookData:
160259
description: Return a 401 status to indicate that the webhook subscription failed

xero_accounting.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.0
22
info:
33
title: Xero Accounting API
4-
version: 9.3.0
4+
version: 10.0.0
55
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/
66
contact:
77
name: Xero Platform Team

xero_assets.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.0
22
info:
3-
version: 9.3.0
3+
version: 10.0.0
44
title: Xero Assets API
55
description: The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.
66
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/

0 commit comments

Comments
 (0)