Skip to content

Reach API (1.0.3)

API for accessing financial data and reporting for financing companies. Provides access to financial statements, chart of accounts, budgets, and operational metrics.

Download OpenAPI description
Languages
Servers
Mock server
https://developer.reachreporting.com/_mock/openapi/
http://localhost:{port}/
API Base URL
https://{baseUrl}/

Authentication

Endpoints for OAuth 2.0 authentication and authorization. These endpoints handle the OAuth discovery document, authorization flow, token exchange, and user information retrieval.

Operations

Company Information

Endpoints for retrieving basic company information such as company name and fiscal month end.

Operations

Reference Data

Endpoints for accessing reference data including chart of accounts, budgets, classes, departments, and non-financial metrics. These endpoints provide the foundational data structures used throughout the API.

Operations

Metrics

Endpoints for retrieving non-financial metrics and KPIs over specified date ranges.

Operations

Financial Statements

Endpoints for retrieving financial statements including Profit and Loss, Balance Sheet, and Cash Flow Statement. These endpoints support filtering by date range, accounting basis, budget, class, and department.

Operations

Request

Retrieves the Profit and Loss statement showing revenues, expenses, and net income.

Security
OAuth2
Path
CompanyIdstringrequired
Query
StartDatestring(date)required

Start date in YYYY-MM-DD format (e.g., 2025-01-01)

Example: StartDate=2025-01-01
EndDatestring(date)required

End date in YYYY-MM-DD format (e.g., 2025-01-31)

Example: EndDate=2025-01-31
AccountingBasisstring(AccountingBasis)required

Accounting method: CASH or ACCRUAL

Enum"CASH""ACCRUAL"
BudgetIdstring

Optional budget identifier. When omitted, returns actuals.

ClassIdstring

Optional class identifier to filter by class.

DepartmentIdstring

Optional department identifier to filter by department.

curl -i -X GET \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/profit-loss?StartDate=2025-01-01&EndDate=2025-01-31&AccountingBasis=CASH&BudgetId=string&ClassId=string&DepartmentId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
DataArray of objects
Response
application/json
{ "Data": [ {} ] }

Request

Retrieves the Cash Flow Statement showing cash movements by activity type.

Security
OAuth2
Path
CompanyIdstringrequired
Query
StartDatestring(date)required

Start date in YYYY-MM-DD format (e.g., 2025-01-01)

Example: StartDate=2025-01-01
EndDatestring(date)required

End date in YYYY-MM-DD format (e.g., 2025-01-31)

Example: EndDate=2025-01-31
BudgetIdstring

Optional budget identifier. When omitted, returns actuals.

ClassIdstring

Optional class identifier to filter by class.

DepartmentIdstring

Optional department identifier to filter by department.

curl -i -X GET \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/cash-flow-statement?StartDate=2025-01-01&EndDate=2025-01-31&BudgetId=string&ClassId=string&DepartmentId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
DataArray of objects
Response
application/json
{ "Data": [ {} ] }

Request

Retrieves the Balance Sheet showing assets, liabilities, and equity.

Security
OAuth2
Path
CompanyIdstringrequired
Query
StartDatestring(date)required

Start date in YYYY-MM-DD format (e.g., 2025-01-01)

Example: StartDate=2025-01-01
EndDatestring(date)required

End date in YYYY-MM-DD format (e.g., 2025-01-31)

Example: EndDate=2025-01-31
AccountingBasisstring(AccountingBasis)required

Accounting method: CASH or ACCRUAL

Enum"CASH""ACCRUAL"
BudgetIdstring

Optional budget identifier. When omitted, returns actuals.

ClassIdstring

Optional class identifier to filter by class.

DepartmentIdstring

Optional department identifier to filter by department.

curl -i -X GET \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/balance-sheet?StartDate=2025-01-01&EndDate=2025-01-31&AccountingBasis=CASH&BudgetId=string&ClassId=string&DepartmentId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
DataArray of objects
Response
application/json
{ "Data": [ {} ] }