Agree.com Reports API
Read-only analytics for revenue, cashflow, and accounts receivable recovery. ## Overview Report endpoints mirror the in-app **Reports** dashboards (`/reports/revenue`, `/reports/cashflow`, `/reports/recovery`). All metrics are scoped to the authenticated API key's organization. Amounts use the `Money` object shape: `amount` is in the smallest currency unit (cents for USD) and `currency` is an ISO 4217 code (e.g. `"USD"`). ## Revenue | Endpoint | Description | |----------|-------------| | `GET /reports/revenue/stats` | ARR, MRR, growth, NRR, top-5 concentration | | `GET /reports/revenue/chart` | Monthly MRR/ARR history and forecast | | `GET /reports/revenue/customers` | Customers ranked by paid revenue | | `GET /reports/revenue/customers_by_mrr` | Customers ranked by subscription MRR | ## Cashflow | Endpoint | Description | |----------|-------------| | `GET /reports/cashflow/stats` | Cash collected MTD, outstanding total, DSO, fail rate | | `GET /reports/cashflow/chart` | Monthly cash collected history and forecast | | `GET /reports/cashflow/outstanding_invoices` | Outstanding invoice list | | `GET /reports/cashflow/forecast` | Expected cash in next 30/60/90 days | ## Recovery | Endpoint | Description | |----------|-------------| | `GET /reports/recovery/aging/chart` | Aging buckets by month | | `GET /reports/recovery/aging/invoices` | Invoices grouped by aging bucket | | `GET /reports/recovery/aging/trend` | Overdue totals and average days overdue | | `GET /reports/recovery/leakage/stats` | Counts/amounts by invoice stage | | `GET /reports/recovery/leakage/waterfall` | Stage waterfall for leakage analysis | | `GET /reports/recovery/leakage/stalled_invoices` | Stalled invoices | | `GET /reports/recovery/leakage/stage_durations` | Average days between stages |
Add selected operations to Stack
Documentation
Specifications
Other Resources
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/agree-com:agree-com-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key .
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms .
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: '# Introduction
Welcome to the Agree API! Agree is a payments and agreements platform that helps businesses send invoices, collect payments, and manage customer relationships. This API lets you integrate Agree''s capabilities directly into your application. ## What You Can Do
With the Agree API, you can:
- **Create and send invoices** to customers with flexible payment options (ACH, credit card, wire transfer)
- **Manage contacts** in your organization''s address book
- **Set up recurring invoices** with customizable schedules
- **Receive real-time notifications** via webhooks when payments are made or invoices change status
- **Track payment status** and history programmatically
## Quick Start
Here''s how to send your first invoice in three API calls:
### 1. Get Your API Key
Generate an API key in your Agree dashboard under **Settings > API Keys**. Keep this key secure - it provides full access to your organization''s data. ### 2. Create a Contact
First, add the customer you want to invoice:
```bash
curl -X POST https://api.agree.com/api/v1/contacts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d ''{
"contact": {
"name": "Jane Smith",
"email": "jane@example.com",
"company": "Acme Corp"
}
}''
```
### 3. Create and Send an Invoice
Now create and send an invoice for that contact. You can use the convenience endpoint to do both in one request:
```bash
curl -X POST https://api.agree.com/api/v1/invoices/create_and_send \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d ''{
"invoice": {
"billing_contact": {
"email": "jane@example.com"
},
"amount": {"amount": 10000, "currency": "USD"},
"payment_methods": ["card", "ach"],
"due_at": "2025-02-01T00:00:00Z",
"memo": "Consulting services - January 2025"
}
}''
```
The invoice will be created and immediately sent to the customer via email. They''ll receive a payment link where they can pay using their preferred method. **Alternative:** You can also create the invoice first with `POST /api/v1/invoices`, then send it later with `POST /api/v1/invoices/:id/send` if you need to review or modify it before sending. ### 4. Get Notified When They Pay
Set up a webhook to know when the invoice is paid:
```bash
curl -X POST https://api.agree.com/api/v1/webhook_endpoints \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d ''{
"webhook_endpoint": {
"url": "https://your-app.com/webhooks/agree",
"events": ["invoice.paid", "invoice.failed"]
}
}''
```
Save the `secret` from the response - you''ll need it to verify webhook signatures. ## How Resources Connect
Understanding how Agree''s resources relate to each other will help you build effective integrations:
```
Contacts ──────► Invoices ──────► Webhooks
│ │ │
│ │ │
▼ ▼ ▼
People you Payment Real-time
do business requests notifications
with you send when things
to contacts happen
```
- **Contacts** are people or companies in your address book. You can create contacts explicitly, or they''re created automatically when you send an invoice to a new email address. - **Invoices** are payment requests sent to contacts. Each invoice has an amount, due date, and accepted payment methods. Invoices progress through a lifecycle from created → sent → paid (or failed/canceled). - **Webhooks** notify your application when invoice events occur. This lets you update your systems in real-time without polling. ## Base URL
All API requests should be made to:
```
https://api.agree.com/api/v1
```
## Authentication
All endpoints require Bearer token authentication. Include your API key in the Authorization header:
```
Authorization: Bearer YOUR_API_KEY
```
Keep your API key secure. If compromised, regenerate it immediately in your dashboard. ## Request Format
Send request bodies as JSON with the `Content-Type: application/json` header. ## Response Format
All successful responses return JSON with a `data` wrapper:
```json
{
"data": { ...'
title: Agree Reports API
version: 1.0.0
servers:
- url: https://secure.agree.com
variables: {}
security: []
tags:
- description: 'Read-only analytics for revenue, cashflow, and accounts receivable recovery.
## Overview
Report endpoints mirror the in-app **Reports** dashboards (`/reports/revenue`, `/reports/cashflow`, `/reports/recovery`). All metrics are scoped to the authenticated API key''s organization.
Amounts use the `Money` object shape: `amount` is in the smallest currency unit (cents for USD) and `currency` is an ISO 4217 code (e.g. `"USD"`).
## Revenue
| Endpoint | Description |
|----------|-------------|
| `GET /reports/revenue/stats` | ARR, MRR, growth, NRR, top-5 concentration |
| `GET /reports/revenue/chart` | Monthly MRR/ARR history and forecast |
| `GET /reports/revenue/customers` | Customers ranked by paid revenue |
| `GET /reports/revenue/customers_by_mrr` | Customers ranked by subscription MRR |
## Cashflow
| Endpoint | Description |
|----------|-------------|
| `GET /reports/cashflow/stats` | Cash collected MTD, outstanding total, DSO, fail rate |
| `GET /reports/cashflow/chart` | Monthly cash collected history and forecast |
| `GET /reports/cashflow/outstanding_invoices` | Outstanding invoice list |
| `GET /reports/cashflow/forecast` | Expected cash in next 30/60/90 days |
## Recovery
| Endpoint | Description |
|----------|-------------|
| `GET /reports/recovery/aging/chart` | Aging buckets by month |
| `GET /reports/recovery/aging/invoices` | Invoices grouped by aging bucket |
| `GET /reports/recovery/aging/trend` | Overdue totals and average days overdue |
| `GET /reports/recovery/leakage/stats` | Counts/amounts by invoice stage |
| `GET /reports/recovery/leakage/waterfall` | Stage waterfall for leakage analysis |
| `GET /reports/recovery/leakage/stalled_invoices` | Stalled invoices |
| `GET /reports/recovery/leakage/stage_durations` | Average days between stages |'
name: Reports
paths:
/api/v1/reports/revenue/stats:
get:
callbacks: {}
description: Returns ARR, MRR, MRR growth rate, net revenue retention (NRR), and top-5 customer concentration.
operationId: AgreeWeb.API.V1.ReportController.revenue_stats
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDataResponse'
description: Revenue statistics
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Revenue statistics
tags:
- Reports
/api/v1/reports/recovery/aging/trend:
get:
callbacks: {}
description: Returns total overdue amount and average days overdue per month.
operationId: AgreeWeb.API.V1.ReportController.recovery_aging_trend
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Aging trend
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Aging trend
tags:
- Reports
/api/v1/reports/revenue/chart:
get:
callbacks: {}
description: Returns historical and forecast MRR/ARR by month.
operationId: AgreeWeb.API.V1.ReportController.revenue_chart
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Revenue chart
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Revenue chart data
tags:
- Reports
/api/v1/reports/recovery/leakage/stage_durations:
get:
callbacks: {}
description: Returns average days between invoice stages for current vs previous six-month periods.
operationId: AgreeWeb.API.V1.ReportController.recovery_leakage_stage_durations
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDataResponse'
description: Stage durations
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Stage duration statistics
tags:
- Reports
/api/v1/reports/recovery/leakage/stats:
get:
callbacks: {}
description: Returns invoice counts and amounts by stage (drafted, outstanding, overdue, paid).
operationId: AgreeWeb.API.V1.ReportController.recovery_leakage_stats
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDataResponse'
description: Leakage statistics
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Leakage statistics
tags:
- Reports
/api/v1/reports/recovery/leakage/waterfall:
get:
callbacks: {}
description: Returns waterfall stages for invoice progression (drafted → outstanding → overdue → paid).
operationId: AgreeWeb.API.V1.ReportController.recovery_leakage_waterfall
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Leakage waterfall
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Leakage waterfall
tags:
- Reports
/api/v1/reports/cashflow/chart:
get:
callbacks: {}
description: Returns historical and forecast cash collected by month.
operationId: AgreeWeb.API.V1.ReportController.cashflow_chart
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Cashflow chart
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Cashflow chart data
tags:
- Reports
/api/v1/reports/recovery/leakage/stalled_invoices:
get:
callbacks: {}
description: Lists invoices that have been stalled in a workflow stage.
operationId: AgreeWeb.API.V1.ReportController.recovery_leakage_stalled_invoices
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Stalled invoices
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Stalled invoices
tags:
- Reports
/api/v1/reports/cashflow/forecast:
get:
callbacks: {}
description: Returns projected cash from outstanding invoices due in the next 30, 60, and 90 days.
operationId: AgreeWeb.API.V1.ReportController.cashflow_forecast
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDataResponse'
description: Cash forecast
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Cash forecast
tags:
- Reports
/api/v1/reports/revenue/customers_by_mrr:
get:
callbacks: {}
description: Lists customers ranked by current monthly recurring revenue from active subscriptions.
operationId: AgreeWeb.API.V1.ReportController.revenue_customers_by_mrr
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Customers by MRR
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Customers by MRR
tags:
- Reports
/api/v1/reports/cashflow/outstanding_invoices:
get:
callbacks: {}
description: Lists outstanding (sent or due) invoices with customer and aging details.
operationId: AgreeWeb.API.V1.ReportController.cashflow_outstanding_invoices
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Outstanding invoices
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Outstanding invoices
tags:
- Reports
/api/v1/reports/cashflow/stats:
get:
callbacks: {}
description: 'Returns cash collected month-to-date, outstanding invoice total, days sales outstanding (DSO),
and payment failure rate.'
operationId: AgreeWeb.API.V1.ReportController.cashflow_stats
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDataResponse'
description: Cashflow statistics
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Cashflow statistics
tags:
- Reports
/api/v1/reports/revenue/customers:
get:
callbacks: {}
description: Lists customers ranked by total paid invoice revenue.
operationId: AgreeWeb.API.V1.ReportController.revenue_customers
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Customers by revenue
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Customers by revenue
tags:
- Reports
/api/v1/reports/recovery/aging/chart:
get:
callbacks: {}
description: Returns overdue invoice amounts by aging bucket for the past six months.
operationId: AgreeWeb.API.V1.ReportController.recovery_aging_chart
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportListDataResponse'
description: Aging chart
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Aging chart data
tags:
- Reports
/api/v1/reports/recovery/aging/invoices:
get:
callbacks: {}
description: Lists outstanding invoices grouped by aging bucket (current, 1-30, 31-60, 61-90, 90+ days).
operationId: AgreeWeb.API.V1.ReportController.recovery_aging_invoices
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDataResponse'
description: Invoices by aging
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
description: Unauthorized
security:
- bearer: []
summary: Invoices by aging bucket
tags:
- Reports
components:
schemas:
ReportListDataResponse:
description: Report data payload containing a list
properties:
data:
description: List of report records
items:
additionalProperties: true
type: object
type: array
required:
- data
title: ReportListDataResponse
type: object
ReportDataResponse:
description: Report data payload
properties:
data:
additionalProperties: true
description: Report-specific payload
type: object
required:
- data
title: ReportDataResponse
type: object
Unauthorized:
description: Authentication required or invalid credentials
example:
error: Invalid or missing API key
properties:
error:
description: Error message
type: string
title: Unauthorized
type: object
securitySchemes:
bearer:
description: API key authentication via Bearer token
scheme: bearer
type: http
x-provenance:
method: harvested
publisher: Agree.com
source: https://secure.agree.com/documentation/openapi
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)