Xero Finance API
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 8
Finance
- GETGet cash validation
/CashValidation?balanceDate=2021-09-15&asAtSystemDate=2021-09-15&beginDate=2021-09-15Summarizes the total cash position for each account for an org - GETGet Balance Sheet report
/FinancialStatements/BalanceSheet?balanceDate=2020-06-30The balance sheet report is a standard financial report which describes the financial position of an organisation at a point in time. - GETGet Cash flow report
/FinancialStatements/Cashflow?startDate=2020-09-15&endDate=2021-09-15The statement of cash flows - direct method, provides the year to date changes in operating, financing and investing cash flow activities for an organisation.… - GETGet Profit & Loss report
/FinancialStatements/ProfitAndLoss?startDate=2020-09-15&endDate=2021-09-15The profit and loss statement is a standard financial report providing detailed year to date income and expense detail for an organisation. - GETGet Trial Balance report
/FinancialStatements/TrialBalance?endDate=2021-09-15The trial balance provides a detailed list of all accounts of an organisation at a point in time, with revenue and expense items being year to date. - GETGet revenue by contacts report
/FinancialStatements/contacts/revenue?contactIds=00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000&includeManualJournals=true&startDate=2020-09-15&endDate=2020-09-15The revenue by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact… - GETGet expense by contacts report
/FinancialStatements/contacts/expense?contactIds=00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000&includeManualJournals=true&startDate=2020-09-15&endDate=2020-09-15The expense by contact report provides a year to date profit and loss for customers and suppliers for a given organisation, including detailed contact… - GETGet Bank Statement Accounting
/BankStatementsPlus/statements?BankAccountID=3fa85f64-5717-4562-b3fc-2c963f66afa6&FromDate=2020-07-01&ToDate=2021-06-30&SummaryOnly=trueFor lenders that prefer using bank statement data as the source of truth. We provide a data point that will allow access to customer bank statements, plus for…
API details
- Base URL
https://api.xero.com/finance.xro/1.0- Authentication
- OAuth 2.0 (authorization code flow) with 6 scopes
- Operations
- 8 operations on 8 pathsGET 8
- Main resources
- Finance 8
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
20.1.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Xero's published OpenAPI description (XeroAPI/Xero-OpenAPI) (MIT)
How to test the Xero Finance API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Xero Finance API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 6 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get cash validation” (GET /CashValidation?balanceDate=2021-09-15&asAtSystemDate=2021-09-15&beginDate=2021-09-15), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Xero Finance API?
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… It is listed under Finance & banking and has 8 endpoints.
Who publishes the Xero Finance API?
It is listed from Xero's public API description (an OpenAPI document), not published by Xero on Swastik Codes. Anyone who controls xero.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Xero Finance API?
Requests go to https://api.xero.com/finance.xro/1.0. Endpoint paths are added to this base URL.
How do I authenticate with the Xero Finance API?
With OAuth 2.0 (authorization code flow) with 6 scopes.
How many endpoints does the Xero Finance API have?
8 operations on 8 paths (8 GET). The largest groups are Finance.
Is forking the Xero Finance API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.