> For the complete documentation index, see [llms.txt](https://docs.moderncollections.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.moderncollections.io/readme.md).

# API Reference

The API for B2B debt collection. Place overdue invoices, follow the collection work, reconcile payments.

Modern Collections collects overdue commercial invoices as an independent third-party agency. You send the invoices and receive the activity, payment and remittance records; our voice, email and compliance systems do the collection work.

Creating a placement is **intake, not an outreach approval**. Creditor verification and a fresh compliance decision must clear before we contact anyone, and we review each new placement before outreach starts.

## Start here

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4>Quickstart</h4></td><td>Get a key and make your first API call.</td><td><a href="/getting-started/quickstart.md">Quickstart</a></td></tr><tr><td><h4>Upload files</h4></td><td>Attach contracts, invoices and supporting evidence.</td><td><a href="/rest-api/documents.md">Upload files</a></td></tr><tr><td><h4>CLI</h4></td><td>Install modern-collections and work from your terminal.</td><td><a href="/clients/cli.md">CLI</a></td></tr><tr><td><h4>MCP</h4></td><td>Connect your agent and give it approved files.</td><td><a href="/clients/mcp.md">MCP</a></td></tr></tbody></table>

## Which account model is yours

* Your own invoices: a creditor API key scoped to your account. Start with the [quickstart](/getting-started/quickstart.md).
* Your customers' invoices: a provisioned platform partner account, naming one linked creditor per request. Start with [Platform partners](/rest-api/partner-model.md).

## How this reference is organised

The [OpenAPI spec](https://github.com/knollmeyersam-dot/MC-Docs/tree/main/api-reference/rest-api/openapi.yaml) is the contract: every path, field and response shape, generated from the application's own routes and schemas. The explorer in the sidebar renders it. The prose pages cover what a spec cannot express.

| Page                                                | What it answers                                                                |
| --------------------------------------------------- | ------------------------------------------------------------------------------ |
| [Quickstart](/getting-started/quickstart.md)        | How do I get a key and make a call?                                            |
| [Errors and limits](/getting-started/errors.md)     | What do I do when a call fails?                                                |
| [REST API](/rest-api/conventions.md)                | What are the conventions, and where is the endpoint reference?                 |
| [Placements](/rest-api/placement-lifecycle.md)      | What is a placement, and what do its status, compliance and pause fields mean? |
| [Platform partners](/rest-api/partner-model.md)     | How do I place on behalf of many creditors?                                    |
| [Webhooks](/webhooks/receiving.md)                  | How do I receive and verify events?                                            |
| [Upload files](/rest-api/documents.md)              | How do I upload contracts, invoices and supporting evidence?                   |
| [CLI](/clients/cli.md)                              | How do I work from my terminal?                                                |
| [MCP](/clients/mcp.md)                              | How do I connect an agent?                                                     |
| [Python and client generation](/clients/clients.md) | How do I use the Python client or generate another client?                     |
| [Compliance](/compliance/compliance.md)             | What is my side responsible for?                                               |
| [Guides](/guides/ingest-invoices.md)                | How do I wire this to my AR system end to end?                                 |

## Support and changes

* [Change log](https://changelog.moderncollections.io): release notes.
* [Contact support](https://help.moderncollections.io/troubleshooting/contact-support): include placement IDs and UTC timestamps.
* Dashboard questions: the [Help Center](https://help.moderncollections.io).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.moderncollections.io/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.