> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.beanrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BeanRails API

> Connect your ERP, accounting or e-commerce system to BeanRails.

The BeanRails API lets your systems read and write the same contacts, works, invoices, quotations and payments your team uses in the app. Use it to keep customers in sync, push orders in as works, pull invoices into your accounting software and report payments back.

## What you can do

> **[Contacts](https://api-docs.beanrails.com/api-reference/contacts/list-contacts.md)**
>
> Create and update customers and their addresses.

> **[Works](https://api-docs.beanrails.com/api-reference/works/list-works.md)**
>
> Create service or delivery jobs, reschedule or cancel them, and read proof of delivery.

> **[Invoices and quotations](https://api-docs.beanrails.com/api-reference/invoices/list-invoices.md)**
>
> Create documents, read totals and change their status.

> **[Invoice payments](https://api-docs.beanrails.com/api-reference/invoice-payments/list-payments-of-an-invoice.md)**
>
> Record payments received in your accounting system.

## How it works

* Every request goes to `https://{host}/api/public/v1`, where `{host}` is where your BeanRails workspace is served from.
* You authenticate with an API key sent as a bearer token. See [Authentication](https://api-docs.beanrails.com/authentication.md).
* Requests and responses are JSON. Successful responses wrap a record in `data`. See [Conventions](https://api-docs.beanrails.com/conventions.md).
* Errors share one shape. See [Errors](https://api-docs.beanrails.com/errors.md).

> **[Make your first request](https://api-docs.beanrails.com/quickstart.md)**
>
> Create a key and list your contacts in under five minutes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.