Skip to content
/Reference Data

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

List Chart of Accounts

Request

Retrieves the complete chart of accounts with account details and hierarchy. A balance sheet account that also exists on the cash flow statement must only be one entry.

Security
OAuth2
Path
CompanyIdstringrequired

The ID of the company.

Query
offsetinteger>= 0

Number of records to skip for pagination

Default 0
limitinteger[ 1 .. 1000 ]

Maximum number of records to return

Default 100
curl -i -X GET \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/chart-of-accounts?offset=0&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
DataArray of objects
Paginationobject(PaginationMetadata)
Response
application/json
{
  "Data": [
    { … }
  ],
  "Pagination": {
    "offset": 0,
    "limit": 100,
    "total": 250
  }
}

List Budgets

Request

Retrieves all budgets configured for the company.

Security
OAuth2
Path
CompanyIdstringrequired

The ID of the company.

Query
offsetinteger>= 0

Number of records to skip for pagination

Default 0
limitinteger[ 1 .. 1000 ]

Maximum number of records to return

Default 100
curl -i -X GET \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/budgets?offset=0&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
DataArray of objects
Paginationobject(PaginationMetadata)
Response
application/json
{
  "Data": [
    { … }
  ],
  "Pagination": {
    "offset": 0,
    "limit": 100,
    "total": 250
  }
}

List Classes

Request

Retrieves all classes (cost centers or segments) for financial segmentation.

Security
OAuth2
Path
CompanyIdstringrequired

The ID of the company.

Query
offsetinteger>= 0

Number of records to skip for pagination

Default 0
limitinteger[ 1 .. 1000 ]

Maximum number of records to return

Default 100
curl -i -X GET \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/classes?offset=0&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
DataArray of objects
Paginationobject(PaginationMetadata)
Response
application/json
{
  "Data": [
    { … }
  ],
  "Pagination": {
    "offset": 0,
    "limit": 100,
    "total": 250
  }
}

List Departments

Request

Retrieves all departments for organizational segmentation and reporting.

Security
OAuth2
Path
CompanyIdstringrequired

The ID of the company.

Query
offsetinteger>= 0

Number of records to skip for pagination

Default 0
limitinteger[ 1 .. 1000 ]

Maximum number of records to return

Default 100
curl -i -X GET \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/departments?offset=0&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
DataArray of objects
Paginationobject(PaginationMetadata)
Response
application/json
{
  "Data": [
    { … }
  ],
  "Pagination": {
    "offset": 0,
    "limit": 100,
    "total": 250
  }
}

List Non-Financial Items

Request

Retrieves all available non-financial metrics and KPIs.

Security
OAuth2
Path
CompanyIdstringrequired

The ID of the company.

Query
offsetinteger>= 0

Number of records to skip for pagination

Default 0
limitinteger[ 1 .. 1000 ]

Maximum number of records to return

Default 100
curl -i -X GET \
  'https://developer.reachreporting.com/_mock/openapi/companies/{CompanyId}/non-financial-list?offset=0&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
DataArray of objects
Paginationobject(PaginationMetadata)
Response
application/json
{
  "Data": [
    { … }
  ],
  "Pagination": {
    "offset": 0,
    "limit": 100,
    "total": 250
  }
}

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