Skip to main content
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

Create and update customers and their addresses.

Works

Create service or delivery jobs, reschedule or cancel them, and read proof of delivery.

Invoices and quotations

Create documents, read totals and change their status.

Invoice payments

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.
  • Requests and responses are JSON. Successful responses wrap a record in data. See Conventions.
  • Errors share one shape. See Errors.

Make your first request

Create a key and list your contacts in under five minutes.