Merge pull request #704 from XeroAPI/v7.0.0

OAS version update - 7.0.0

Author: Raghunath-S-S-J

xero-app-store.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: Xero AppStore API
   description: These endpoints are for Xero Partners to interact with the App Store Billing platform
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"

xero-finance.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: Xero Finance API
   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.
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
@@ -100,15 +100,12 @@ paths:
                       totalAmount: 189
                       dataSource:
                         directBankFeed: 0
-                        indirectBankFeed: 0
                         fileUpload: 300
                         manual: -188
                         directBankFeedPos: 0
-                        indirectBankFeedPos: 0
                         fileUploadPos: 2223
                         manualPos: 0
                         directBankFeedNeg: 0
-                        indirectBankFeedNeg: 0
                         fileUploadNeg: -1890
                         manualNeg: -500
                         otherPos: 0
@@ -1487,9 +1484,7 @@ components:
           format: date-time
         importSourceType:
           type: string
-          description: Looking at the most recent bank statement, this field indicates
-            the source of the data (direct bank feed, indirect bank feed, file upload,
-            or manual keying).
+          description: Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying).
       additionalProperties: false
     DataSourceResponse:
       type: object
@@ -1499,12 +1494,6 @@ components:
           description: Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.   This gives an indication on the certainty of correctness of the data.
           format: double
           x-is-money: true
-        indirectBankFeed:
-          type: number
-          deprecated: true
-          description: No longer in use.
-          format: double
-          x-is-money: true
         fileUpload:
           type: number
           description: Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.
@@ -1520,12 +1509,6 @@ components:
           description: Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.  This gives an indication on the certainty of correctness of the data.  Only positive transactions are included.
           format: double
           x-is-money: true
-        indirectBankFeedPos:
-          type: number
-          deprecated: true
-          description: No longer in use.
-          format: double
-          x-is-money: true
         fileUploadPos:
           type: number
           description: Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included.
@@ -1541,12 +1524,6 @@ components:
           description: Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
           format: double
           x-is-money: true
-        indirectBankFeedNeg:
-          type: number
-          deprecated: true
-          description: No longer in use.
-          format: double
-          x-is-money: true
         fileUploadNeg:
           type: number
           description: Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.

xero-identity.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: Xero OAuth 2 Identity Service API
   description: These endpoints are related to managing authentication tokens and identity for Xero API
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"

xero-payroll-au.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: 'Xero Payroll AU API'
   description: 'This is the Xero Payroll API for orgs in Australia region.'
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"

xero-payroll-nz.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: 'Xero Payroll NZ'
   description: 'This is the Xero Payroll API for orgs in the NZ region.'
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
@@ -7147,12 +7147,23 @@ components:
           type: number
           format: double
           x-is-money: true
+        numberOfUnitsTaken:
+          description: The number of units taken for the leave
+          type: number
+          format: double
+        typeOfUnits:
+          description: The type of units paid for the leave
+          type: string
+        typeOfUnitsTaken:
+          description: The type of units taken for the leave
+          type: string
         periodStatus:
-          description: Period Status
+          description: Status of leave
           type: string
           enum:
-          - Approved
-          - Completed
+            - Approved
+            - Completed
+            - Estimated
     EmployeeLeaveBalances:
       type: object
       properties:
@@ -7417,13 +7428,25 @@ components:
           x-is-money: true
           example: 10.0
         sickLeaveHoursToAccrueAnnually:
-          description: Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day
+          description: Deprecated use SickLeaveToAccrueAnnually
           type: number
           format: double
           x-is-money: true
           example: 100.5
         sickLeaveMaximumHoursToAccrue:
-          description: Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day
+          description: Deprecated use SickLeaveMaximumToAccrue
+          type: number
+          format: double
+          x-is-money: true
+          example: 200.5
+        SickLeaveToAccrueAnnually:
+          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
+          type: number
+          format: double
+          x-is-money: true
+          example: 100.5
+        SickLeaveMaximumToAccrue:
+          description: Maximum number of units accrued annually for sick leave. The type of units is determined by the property "TypeOfUnitsToAccrue" on the "Sick Leave" leave type
           type: number
           format: double
           x-is-money: true
@@ -7439,7 +7462,13 @@ components:
           type: string
           example: OnAnniversaryDate
         SickLeaveAnniversaryDate:
-          description: If Sick Leave Schedule of Accrual is "OnAnniversaryDate", this is the date when entitled to Sick Leave
+          description: If Sick Leave Schedule of Accrual is "OnAnniversaryDate", this is the date when entitled to Sick Leave. When null the Employee's start date is used as the anniversary date
+          type: string
+          format: date
+          example: 2020-01-19
+          x-is-date: true
+        AnnualLeaveAnniversaryDate:
+          description: The first date the employee will accrue Annual Leave. When null the Employee's start date is used as the anniversary date
           type: string
           format: date
           example: 2020-01-19
@@ -7469,20 +7498,31 @@ components:
             - PercentageOfGrossEarnings  
             - NoAccruals
         hoursAccruedAnnually:
-          description: The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is "OnHourWorked"
+          description: Deprecated use UnitsAccruedAnnually
           type: number
           format: double
           x-is-money: true
+        UnitsAccruedAnnually:
+          description: The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is "NoAccruals"
+          type: number
+          format: double
+          x-is-money: true
+        typeOfUnitsToAccrue:
+          description: The type of units accrued for the leave annually
+          type: string
         maximumToAccrue:
-          description: The maximum number of hours that can be accrued for the leave  
+          description: The maximum number of units that can be accrued for the leave
           type: number
           format: double
           x-is-money: true
         openingBalance:
-          description: The initial number of hours assigned when the leave was added to the employee  
+          description: The initial number of units assigned when the leave was added to the employee
           type: number
           format: double
           x-is-money: true
+        openingBalanceTypeOfUnits:
+          description: The type of units for the opening balance
+          type: string
         rateAccruedHourly:
           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"
           type: number
@@ -7952,6 +7992,12 @@ components:
         isActive:
           description: Shows whether the leave type is active or not
           type: boolean
+        typeOfUnits:
+          description: The type of units to be paid for the leave type
+          type: string
+        typeOfUnitsToAccrue:
+          description: The type of units to be accrued for the leave type
+          type: string
     Reimbursements:
       type: object
       properties:

xero-payroll-uk.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: 'Xero Payroll UK'
   description: 'This is the Xero Payroll API for orgs in the UK region.'
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"

xero-projects.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: Xero Projects API
   description: This is the Xero Projects API 
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"

xero_accounting.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: Xero Accounting API
-  version: "6.3.0"
+  version: "7.0.0"
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
   contact:
     name: "Xero Platform Team"

xero_assets.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: Xero Assets API
   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.
   termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"

xero_bankfeeds.yaml

@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  version: "6.3.0"
+  version: "7.0.0"
   title: Xero Bank Feeds API
   description: The Bank Feeds API is a closed API that is only available to financial institutions that have an established financial services partnership with Xero.
                If you're an existing financial services partner that wants access, contact your local Partner Manager.