Skip to content
/Metrics

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
openapi.json
openapi.yaml
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

Get non-financial data

Request

Retrieves historical values for specified non-financial metrics over a date range.

Security
OAuth2
Path
CompanyIdstringrequired

The ID of the company.

Bodyapplication/jsonrequired
NonFinancialIdsArray of stringsrequired
StartDatestring(date)required

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

Example: "2025-01-01"
EndDatestring(date)required

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

Example: "2025-01-31"
BudgetIdstring

Optional budget identifier. When omitted, returns actuals.

ClassIdstring

Optional class identifier to filter by class.

curl -i -X POST \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/non-financial' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "NonFinancialIds": [
      "string"
    ],
    "StartDate": "2025-01-01",
    "EndDate": "2025-01-31",
    "BudgetId": "string",
    "ClassId": "string"
  }'

Responses

Successful operation

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

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