Financial report endpoints
Inputs, response fields, and limits for the read-only REST report preview.
By Jacob Sheldon. Reviewed
Included routes
| Method and path | Purpose | Important input |
|---|---|---|
| GET /companies/{companyId}/reports/pl | Profit and loss for a date range. | startDate and endDate. |
| GET /companies/{companyId}/reports/balance-sheet | Balance sheet snapshot. | asOfDate. |
| GET /companies/{companyId}/reports/cash-flow | Cash flow statement for a date range. | startDate and endDate. |
| GET /companies/{companyId}/reports/general-ledger | Recent posted journal entries. | Date range, limit, and cursor. |
| GET /companies/{companyId}/reports/ar-aging | Receivables aging. | Optional asOfDate; availability depends on company access. |
| GET /companies/{companyId}/reports/ap-aging | Payables aging. | Optional asOfDate; availability depends on company access. |
Company and entity
Every route includes a companyId and requires a credential for that company. Some reports accept entityId. If your account has multiple entities, the API can require you to select one.
Dates and amounts
- Use YYYY-MM-DD dates. P&L and cash flow take a start and end date; balance sheet and aging use an as-of date.
- Financial statement responses include dollar totals and may also include integer minor-unit fields. Aging responses identify currency and the minor unit exponent for cents.
- The general ledger returns items with nextCursor and hasMore. Its default page size is 200 and the maximum is 1,000.
Common HTTP errors
| Status | Meaning | Next step |
|---|---|---|
| 401 Unauthorized | The request has no valid credential. | Check the X-API-Key header and ask Median to confirm the credential remains active. |
| 403 Forbidden | The key lacks company access or the reports:read scope. | Confirm companyId and ask Median to check the provisioned access. |
| 422 Unprocessable Entity | A requested entity or financial scope is missing, or an aging report cannot establish currency. | Provide an authorized entity where required. Ask Median about a persistent currency error. |
Download the OpenAPI reference
The file contains the six report routes above and their referenced schemas. It is a read-only preview; confirm access with Median before relying on an endpoint in production.