Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xero Finance API

The Finance API from Xero — 8 operation(s) for finance.

Xero Finance API is one of 10 APIs that Xero publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Finance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 8 operations across 8 paths, and defines 44 schemas. It is described by OpenAPI 3.0.0, at version 11.1.0.

Requests are made against a single base URL, https://api.xero.com/api.xro/2.0.

8 operations 8 paths 44 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
11.1.0
Base URL
https://api.xero.com/api.xro/2.0
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Xero Finance API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 16 scopes.

  • OAuth2 — For more information

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Finance 8
GET
/CashValidation
Xero Get cash validation
getCashValidation 4 params → 200400
GET
/FinancialStatements/BalanceSheet
Xero Get Balance Sheet report
getFinancialStatementBalanceSheet 2 params → 200400503
GET
/FinancialStatements/Cashflow
Xero Get Cash flow report
getFinancialStatementCashflow 3 params → 200400503
GET
/FinancialStatements/ProfitAndLoss
Xero Get Profit & Loss report
getFinancialStatementProfitAndLoss 3 params → 200400
GET
/FinancialStatements/TrialBalance
Xero Get Trial Balance report
getFinancialStatementTrialBalance 2 params → 200400
GET
/FinancialStatements/contacts/revenue
Xero Get revenue by contacts report
getFinancialStatementContactsRevenue 5 params → 200400
GET
/FinancialStatements/contacts/expense
Xero Get expense by contacts report
getFinancialStatementContactsExpense 5 params → 200400
GET
/BankStatementsPlus/statements
Xero Get Bank Statement Accounting
getBankStatementAccounting 5 params → 200400

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are StatementLinesResponse (17 properties), StatementLineResponse (14 properties), DataSourceResponse (12 properties), TrialBalanceAccount (10 properties). Each schema is shown below with its type and property counts.

TotalDetail
object
3 properties
TrialBalanceResponse
object
3 properties
ProblemType
string
ContactDetail
object
6 properties
CashflowAccount
object
7 properties
PaymentResponse
object
10 properties
CashValidationResponse
object
5 properties
CashBalance
object
3 properties
BalanceSheetAccountGroup
object
2 properties
BalanceSheetAccountType
object
3 properties
StatementResponse
object
10 properties
TrialBalanceAccount
object
10 properties
StatementLinesResponse
object
17 properties
ContactTotalDetail
object
3 properties
BankTransactionResponse
object
6 properties
BankStatementAccountingResponse
object
4 properties
CashAccountResponse
object
5 properties
ProfitAndLossResponse
object
5 properties
TrialBalanceEntry
object
2 properties
OverpaymentResponse
object
4 properties
BankStatementResponse
object
2 properties
BalanceSheetResponse
object
4 properties
StatementBalanceResponse
object
2 properties
PrepaymentResponse
object
4 properties
LineItemResponse
object
4 properties
CashflowActivity
object
3 properties
CreditNoteResponse
object
4 properties
BalanceSheetAccountDetail
object
5 properties
TrialBalanceMovement
object
4 properties
ContactResponse
object
2 properties
CashflowResponse
object
4 properties
StatementLineResponse
object
14 properties
CashflowType
object
3 properties
ManualJournalTotal
object
1 property
PnlAccountType
object
3 properties
Problem
object
4 properties
PnlAccountClass
object
2 properties
TotalOther
object
3 properties
PnlAccount
object
6 properties
InvoiceResponse
object
4 properties
CurrentStatementResponse
object
6 properties
DataSourceResponse
object
12 properties
IncomeByContactResponse
object
7 properties
ContactTotalOther
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xero-finance-api-openapi.yml Raw ↑

Other APIs Xero publishes across the network.

Xero Accounting API
Xero Asset API
Xero BankFeeds API
Xero Files API
Xero Identity API
Xero PayrollAu API
Xero PayrollNz API
Xero PayrollUk API
Xero Project API