From 0342c251bd893679c001dd3f389803ac289f7a8a Mon Sep 17 00:00:00 2001 From: JesseZeng2 Date: Mon, 2 Feb 2026 15:11:19 +1300 Subject: [PATCH] feat: Remove Accounting Activities Finance API --- xero-finance.yaml | 491 ---------------------------------------------- 1 file changed, 491 deletions(-) diff --git a/xero-finance.yaml b/xero-finance.yaml index 7a02eeaf2..53ac56761 100644 --- a/xero-finance.yaml +++ b/xero-finance.yaml @@ -119,255 +119,6 @@ paths: title: InvalidRequest status: 400 detail: "Invalid BalanceDate: '2020-01'" - /AccountingActivities/AccountUsage: - parameters: - - $ref: "#/components/parameters/requiredHeader" - get: - security: - - OAuth2: - - finance.accountingactivity.read - tags: - - Finance - summary: Get account usage - operationId: getAccountingActivityAccountUsage - description: A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments. - parameters: - - name: startMonth - x-snake: start_month - in: query - description: "date, yyyy-MM \r\n \r\nIf no parameter is provided, the month 12 months prior to the end month will be used.\r\n \r\nAccount usage for up to 12 months from this date will be returned." - schema: - type: string - example: 2020-09 - - name: endMonth - x-snake: end_month - in: query - description: "date, yyyy-MM \r\n \r\nIf no parameter is provided, the current month will be used.\r\n \r\nAccount usage for up to 12 months prior to this date will be returned." - schema: - type: string - example: 2021-09 - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/AccountUsageResponse" - example: - organisationId: 73151de8-3676-4887-a021-edec960dd537 - startMonth: 2010-03 - endMonth: 2010-03 - accountUsage: - - month: 2010-03 - accountId: 12345678-876b-4eff-901d-e8f4d517453e - currencyCode: CURR/NZD - totalReceived: 0 - countReceived: 0 - totalPaid: 0 - countPaid: 0 - totalManualJournal: 0 - countManualJournal: 0 - accountName: ACME Drawings - reportingCode: ABC - reportingCodeName: ABC funds - - month: 2010-03 - accountId: 12345678-9d21-43bc-b20e-d96a370cf31e - currencyCode: CURR/NZD - totalReceived: 0 - countReceived: 0 - totalPaid: 0 - countPaid: 0 - totalManualJournal: 0 - countManualJournal: 0 - accountName: Electricity & Heating - reportingCode: ELC - reportingCodeName: Expense - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/Problem" - example: - type: invalid-request - title: InvalidRequest - status: 400 - detail: Organisation 73151de8-3676-4887-a021-edec960dd537 does not exist - /AccountingActivities/LockHistory: - parameters: - - $ref: "#/components/parameters/requiredHeader" - get: - security: - - OAuth2: - - finance.accountingactivity.read - tags: - - Finance - operationId: getAccountingActivityLockHistory - description: Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods. - summary: Get lock history - parameters: - - name: endDate - x-snake: end_date - in: query - description: "date, yyyy-MM-dd \r\n \r\nIf no parameter is provided, the current date will be used.\r\n \r\nAny changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned.\r\n \r\nPlease be aware that there may be a delay of up to 3 days before a change is visible from this API." - schema: - type: string - example: "2021-09-15" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/LockHistoryResponse" - example: - organisationId: 73151de8-3676-4887-a021-edec960dd537 - endDate: "2019-06-20" - lockDates: - - hardLockDate: "2019-01-20" - softLockDate: "2019-01-20" - updatedDateUtc: "2019-01-20T10:50:03Z" - - hardLockDate: "2019-01-21" - softLockDate: "2019-01-21" - updatedDateUtc: "2019-01-21T10:59:33Z" - - hardLockDate: "2019-01-22" - softLockDate: "2019-01-22" - updatedDateUtc: "2019-01-22T10:24:12Z" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/Problem" - example: - type: invalid-request - title: InvalidRequest - status: 400 - detail: Organisation 73151de8-3676-4887-a021-edec960dd537 does not exist - /AccountingActivities/ReportHistory: - parameters: - - $ref: "#/components/parameters/requiredHeader" - get: - security: - - OAuth2: - - finance.accountingactivity.read - tags: - - Finance - operationId: getAccountingActivityReportHistory - description: For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight. - summary: Get report history - parameters: - - name: endDate - x-snake: end_date - in: query - description: "date, yyyy-MM-dd \r\n \r\nIf no parameter is provided, the current date will be used.\r\n \r\nAny reports that were published within the period up to 12 months before this date will be returned.\r\n \r\nPlease be aware that there may be a delay of up to 3 days before a published report is visible from this API." - schema: - type: string - example: "2021-09-15" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/ReportHistoryResponse" - example: - organisationId: 73151de8-3676-4887-a021-edec960dd537 - endDate: "2019-10-20" - reports: - - reportName: VATReturn - reportDateText: April 2019 to June 2019 - publishedDateUtc: "2019-09-23T00:30:17.407+00:00" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/Problem" - example: - type: invalid-request - title: InvalidRequest - status: 400 - detail: Organisation 73151de8-3676-4887-a021-edec960dd537 does not exist - /AccountingActivities/UserActivities: - parameters: - - $ref: "#/components/parameters/requiredHeader" - get: - security: - - OAuth2: - - finance.accountingactivity.read - tags: - - Finance - operationId: getAccountingActivityUserActivities - description: For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction. - summary: Get user activities - parameters: - - name: dataMonth - x-snake: data_month - in: query - description: "date, yyyy-MM \r\n \r\nThe specified month must be complete (in the past); The current month cannot be specified since it is not complete.\r\n \r\nIf no parameter is provided, the month immediately previous to the current month will be used.\r\n \r\nAny user activities occurring within the specified month will be returned.\r\n \r\nPlease be aware that there may be a delay of up to 3 days before a user activity is visible from this API." - schema: - type: string - example: 2021-09 - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/UserActivitiesResponse" - example: - organisationId: 73151de8-3676-4887-a021-edec960dd537 - dataMonth: 2020-01 - users: - - userId: bf3108f9-7449-4b2d-a1d1-41342dc1c991 - userCreatedDateUtc: "2016-04-15T04:01:42.8Z" - lastLoginDateUtc: "2020-02-12T23:59:06.42Z" - isExternalPartner: true - hasAccountantRole: true - monthPeriod: 2020-01 - numberOfLogins: 0 - numberOfDocumentsCreated: 10 - netValueDocumentsCreated: -100.99 - absoluteValueDocumentsCreated: 100.99 - attachedPractices: - - xeroPartnerSince: 2017 - tier: Silver - location: New Zealand - organisationCount: 40 - staffCertified: true - historyRecords: - - changes: Approved - dateUTCString: 2008-12-19T01:37:59 - dateUTC: "2008-12-18T14:37:59.057+00:00" - user: John Doe - details: "" - - changes: Created - dateUTCString: 2008-12-19T01:37:58 - dateUTC: "2008-12-18T14:37:58.057+00:00" - user: John Doe - details: "" - - changes: Reconciled - dateUTCString: 2008-12-20T22:50:55 - dateUTC: "2008-12-20T11:50:55.09+00:00" - user: John Doe - details: Debit payment to ACME Banking Corporation on 10 October 2008 for -10.00 - - changes: Created - dateUTCString: 2008-12-20T16:44:19 - dateUTC: "2008-12-20T05:44:19.467+00:00" - user: John Doe - details: "" - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/Problem" - example: - type: invalid-request - title: InvalidRequest - status: 400 - detail: Organisation 73151de8-3676-4887-a021-edec960dd537 does not exist /FinancialStatements/BalanceSheet: parameters: - $ref: "#/components/parameters/requiredHeader" @@ -1186,7 +937,6 @@ components: openid: Grant read-only access to your open id profile: your profile information finance.statements.read: Grant read-only access to finacial statements - finance.accountingactivity.read: Grant read-only access to Xero usage activity finance.cashvalidation.read: Grant read-only access to bank statement and reconcilation data finance.bankstatementsplus.read: Grant read-only access to bank statements accounting data parameters: @@ -1200,151 +950,6 @@ components: type: string required: true schemas: - AccountUsage: - type: object - properties: - month: - type: string - description: The month this usage item contains data for - accountId: - type: string - description: The account this usage item contains data for - format: uuid - currencyCode: - type: string - description: The currency code this usage item contains data for - totalReceived: - type: number - description: Total received - format: double - x-is-money: true - countReceived: - type: integer - description: Count of received - format: int32 - totalPaid: - type: number - description: Total paid - format: double - x-is-money: true - countPaid: - type: integer - description: Count of paid - format: int32 - totalManualJournal: - type: number - description: Total value of manual journals - format: double - x-is-money: true - countManualJournal: - type: integer - description: Count of manual journals - format: int32 - accountName: - type: string - description: The name of the account - reportingCode: - type: string - description: Shown if set - reportingCodeName: - type: string - description: Shown if set - reportCodeUpdatedDateUtc: - type: string - description: Last modified date UTC format - format: date-time - additionalProperties: false - AccountUsageResponse: - type: object - properties: - organisationId: - type: string - description: The requested Organisation to which the data pertains - format: uuid - startMonth: - type: string - description: The start month of the report - endMonth: - type: string - description: The end month of the report - accountUsage: - type: array - items: - $ref: "#/components/schemas/AccountUsage" - additionalProperties: false - HistoryRecordResponse: - type: object - properties: - changes: - type: string - description: The type of change recorded against the document - dateUTCString: - type: string - description: UTC date that the history record was created - dateUTC: - type: string - description: UTC date that the history record was created - format: date-time - user: - type: string - description: The users first and last name - details: - type: string - description: Description of the change event or transaction - additionalProperties: false - LockHistoryModel: - type: object - properties: - hardLockDate: - type: string - format: date - description: Date the account hard lock was set - softLockDate: - type: string - format: date - description: Date the account soft lock was set - updatedDateUtc: - type: string - format: date-time - description: The system date time that the lock was updated - additionalProperties: false - LockHistoryResponse: - type: object - properties: - organisationId: - type: string - description: The requested Organisation to which the data pertains - format: uuid - endDate: - type: string - format: date - description: The end date of the report - lockDates: - type: array - items: - $ref: "#/components/schemas/LockHistoryModel" - additionalProperties: false - PracticeResponse: - type: object - properties: - xeroPartnerSince: - type: integer - description: Year of becoming a partner. - format: int32 - tier: - type: string - description: Customer tier e.g. Silver - location: - type: string - description: Country of location. - organisationCount: - type: integer - description: Organisation count. - format: int32 - staffCertified: - type: boolean - description: Staff certified (true/false). - additionalProperties: false Problem: type: object properties: @@ -1372,102 +977,6 @@ components: - unauthorized - rate-limit-error type: string - ReportHistoryModel: - type: object - properties: - reportName: - type: string - description: Report code or report title - reportDateText: - type: string - description: The date or date range of the report - publishedDateUtc: - type: string - description: The system date time that the report was published - format: date-time - additionalProperties: false - ReportHistoryResponse: - type: object - properties: - organisationId: - type: string - description: The requested Organisation to which the data pertains - format: uuid - endDate: - type: string - format: date - description: The end date of the report - reports: - type: array - items: - $ref: "#/components/schemas/ReportHistoryModel" - additionalProperties: false - UserActivitiesResponse: - type: object - properties: - organisationId: - type: string - description: The requested Organisation to which the data pertains - format: uuid - dataMonth: - type: string - description: The month of the report - users: - type: array - items: - $ref: "#/components/schemas/UserResponse" - additionalProperties: false - UserResponse: - type: object - properties: - userId: - type: string - description: The Xero identifier for the user - format: uuid - userCreatedDateUtc: - type: string - description: Timestamp of user creation. - format: date-time - lastLoginDateUtc: - type: string - description: Timestamp of user last login - format: date-time - isExternalPartner: - type: boolean - description: User is external partner. - hasAccountantRole: - type: boolean - description: User has Accountant role. - monthPeriod: - type: string - description: Month period in format yyyy-MM. - numberOfLogins: - type: integer - description: Number of times the user has logged in. - format: int32 - numberOfDocumentsCreated: - type: integer - description: Number of documents created. - format: int32 - netValueDocumentsCreated: - type: number - description: Net value of documents created. - format: double - x-is-money: true - absoluteValueDocumentsCreated: - type: number - description: Absolute value of documents created. - format: double - x-is-money: true - attachedPractices: - type: array - items: - $ref: "#/components/schemas/PracticeResponse" - historyRecords: - type: array - items: - $ref: "#/components/schemas/HistoryRecordResponse" - additionalProperties: false BankStatementResponse: type: object properties: