API Documentation

Use the Crater API to seamlessly embed invoicing and bill pay to your platform.

Getting started

To get started with our API, follow these steps:

Contact us to obtain sandbox API keys. These keys will give you access to a testing environment where you can experiment and develop your integration without affecting live data.
Familiarize yourself with the documentation on how to make requests for the specific resources you need to access. We provide comprehensive information on the available endpoints, request/response formats, authentication methods, and any required parameters.
Develop and test your integration using the sandbox environment. Ensure that your application interacts correctly with the API and meets your requirements.
When you're ready to deploy your integration in a production environment, reach out to us to obtain live API keys. These keys will enable access to the live data and resources of our API.

By following these steps, you can seamlessly transition from the development and testing phase to the live deployment of your application.

Feel free to include any additional instructions or guidelines specific to your API and its usage.

Learn how to authenticate your API requests.

Understand how to work with paginated responses.

Read about the different types of errors returned by the API.

Learn how to programmatically configure webhooks for your app.

Learn about the User model and how to create, retrieve, update, delete, and list users.

Learn about the Role model and how to create, retrieve, update, delete, and list roles.

Learn about the Business model and how to create, retrieve, update, delete, and list businesses.

Learn about the Counterparty model and how to add, retrieve, archive, unarchive, and list counterparties.

Learn about the Estimate model and how to create, retrieve, update, delete estimates.

Learn about the Invoice model and how to create, retrieve, update, delete, and list invoices.

Learn about the Recurring Invoice model and how to create, retrieve, update, delete, and list recurring invoices.

Learn about the Payment model and how to list payments.

Learn about the TaxType model and how to create, retrieve, update, delete, and list tax-types.

Learn about the Item model and how to create, retrieve, update, delete items.

Learn about the Note model and how to create, retrieve, update, delete, and list notes.

Learn about the Payment Reminder model and how to create, retrieve, update, delete, and list payment reminders.