# Reach API

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


Version: 1.0.3

## Servers

```
http://localhost:{port}
```

Variables:
- `port`
Default: "3000"

API Base URL
```
https://{baseUrl}
```

Variables:
- `baseUrl`: Enter the base URL for API calls
Default: "example.com"

## Security

### OAuth2

OAuth 2.0 authorization code flow. Use the authorization endpoint to initiate the flow, then exchange the authorization code for tokens at the token endpoint.

Type: oauth2

## Download OpenAPI description

[Reach API](https://developer.reachreporting.com/_bundle/openapi.yaml)

## Authentication

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


### OAuth discovery document

 - [GET /auth/oauth-discovery](https://developer.reachreporting.com/openapi/authentication/paths/~1auth~1oauth-discovery/get.md): Retrieves OAuth 2.0 discovery document with authorization server configuration.

### OAuth Authorization Endpoint

 - [GET /oauth2/authorize](https://developer.reachreporting.com/openapi/authentication/paths/~1oauth2~1authorize/get.md): Initiates the OAuth authorization flow. This endpoint redirects the user to an authorization page 
where they can grant or deny access. After user interaction, they are redirected back to the 
client's redirect_uri with an authorization code in the URL parameters.

### OAuth Token Endpoint

 - [POST /oauth2/token](https://developer.reachreporting.com/openapi/authentication/paths/~1oauth2~1token/post.md): Exchanges authorization code for access and refresh tokens.

### Get User Information

 - [GET /oauth2/user-info](https://developer.reachreporting.com/openapi/authentication/paths/~1oauth2~1user-info/get.md): Retrieves authenticated user information and list of accessible companies.

## Company Information

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


### Get Company Info

 - [GET /companies/{CompanyId}/info](https://developer.reachreporting.com/openapi/company-information/paths/~1companies~1%7Bcompanyid%7D~1info/get.md): Retrieves basic company information including name and fiscal month end.

## 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.


### List Chart of Accounts

 - [GET /companies/{CompanyId}/chart-of-accounts](https://developer.reachreporting.com/openapi/reference-data/paths/~1companies~1%7Bcompanyid%7D~1chart-of-accounts/get.md): 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.

### List Budgets

 - [GET /companies/{CompanyId}/budgets](https://developer.reachreporting.com/openapi/reference-data/paths/~1companies~1%7Bcompanyid%7D~1budgets/get.md): Retrieves all budgets configured for the company.

### List Classes

 - [GET /companies/{CompanyId}/classes](https://developer.reachreporting.com/openapi/reference-data/paths/~1companies~1%7Bcompanyid%7D~1classes/get.md): Retrieves all classes (cost centers or segments) for financial segmentation.

### List Departments

 - [GET /companies/{CompanyId}/departments](https://developer.reachreporting.com/openapi/reference-data/paths/~1companies~1%7Bcompanyid%7D~1departments/get.md): Retrieves all departments for organizational segmentation and reporting.

### List Non-Financial Items

 - [GET /companies/{CompanyId}/non-financial-list](https://developer.reachreporting.com/openapi/reference-data/paths/~1companies~1%7Bcompanyid%7D~1non-financial-list/get.md): Retrieves all available non-financial metrics and KPIs.

## Metrics

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


### Get non-financial data

 - [POST /companies/{CompanyId}/non-financial](https://developer.reachreporting.com/openapi/metrics/paths/~1companies~1%7Bcompanyid%7D~1non-financial/post.md): Retrieves historical values for specified non-financial metrics over a date range.

## 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.


### Profit and Loss

 - [GET /companies/{CompanyId}/profit-loss](https://developer.reachreporting.com/openapi/financial-statements/paths/~1companies~1%7Bcompanyid%7D~1profit-loss/get.md): Retrieves the Profit and Loss statement showing revenues, expenses, and net income.

### Cash Flow Statement

 - [GET /companies/{CompanyId}/cash-flow-statement](https://developer.reachreporting.com/openapi/financial-statements/paths/~1companies~1%7Bcompanyid%7D~1cash-flow-statement/get.md): Retrieves the Cash Flow Statement showing cash movements by activity type.

### Balance Sheet

 - [GET /companies/{CompanyId}/balance-sheet](https://developer.reachreporting.com/openapi/financial-statements/paths/~1companies~1%7Bcompanyid%7D~1balance-sheet/get.md): Retrieves the Balance Sheet showing assets, liabilities, and equity.