The HoopAI Platform Invoices API gives you complete control over your billing workflow. Use it to create and send invoices to contacts, collect manual or automated payments, manage reusable templates, schedule recurring invoice series, generate and send estimates that convert to invoices, and configure late-fee and payment-method rules — all through a single unified REST API.Documentation Index
Fetch the complete documentation index at: https://help.hoopai.com/llms.txt
Use this file to discover all available pages before exploring further.
Base URL
Authentication
Every request must include a Bearer token and the API version header.OAuth scopes
Invoices API endpoints support bothLocation-Access and Company-Access schemes.
| Scope | Access |
|---|---|
invoices.readonly | Read invoices |
invoices.write | Create, update, delete, send, and void invoices |
invoices/template.readonly | Read invoice templates |
invoices/template.write | Create, update, and delete invoice templates |
invoices/schedule.readonly | Read invoice schedules |
invoices/schedule.write | Create, update, delete, and manage invoice schedules |
invoices/estimate.readonly | Read estimates and estimate templates |
invoices/estimate.write | Create, update, delete, and send estimates |
Quick start
Create a new invoice for a contact:Endpoints
| Method | Path | Description |
|---|---|---|
POST | /invoices/ | Create Invoice |
GET | /invoices/ | List invoices |
GET | /invoices/{invoiceId} | Get invoice |
PUT | /invoices/{invoiceId} | Update invoice |
DELETE | /invoices/{invoiceId} | Delete invoice |
POST | /invoices/{invoiceId}/send | Send invoice |
POST | /invoices/{invoiceId}/void | Void invoice |
POST | /invoices/{invoiceId}/record-payment | Record a manual payment for an invoice |
PATCH | /invoices/{invoiceId}/late-fees-configuration | Update invoice late fees configuration |
GET | /invoices/generate-invoice-number | Generate Invoice Number |
GET | /invoices/settings | Get Invoice Settings |
PATCH | /invoices/stats/last-visited-at | Update invoice last visited at |
POST | /invoices/text2pay | Create & Send |
POST | /invoices/template | Create template |
GET | /invoices/template | List templates |
GET | /invoices/template/{templateId} | Get an template |
PUT | /invoices/template/{templateId} | Update template |
DELETE | /invoices/template/{templateId} | Delete template |
PATCH | /invoices/template/{templateId}/late-fees-configuration | Update template late fees configuration |
PATCH | /invoices/template/{templateId}/payment-methods-configuration | Update template payment methods configuration |
POST | /invoices/schedule | Create Invoice Schedule |
GET | /invoices/schedule | List schedules |
GET | /invoices/schedule/{scheduleId} | Get an schedule |
PUT | /invoices/schedule/{scheduleId} | Update schedule |
DELETE | /invoices/schedule/{scheduleId} | Delete schedule |
POST | /invoices/schedule/{scheduleId}/schedule | Schedule an schedule invoice |
POST | /invoices/schedule/{scheduleId}/updateAndSchedule | Update scheduled recurring invoice |
POST | /invoices/schedule/{scheduleId}/auto-payment | Manage Auto payment for an schedule invoice |
POST | /invoices/schedule/{scheduleId}/cancel | Cancel an scheduled invoice |
POST | /invoices/estimate | Create New Estimate |
GET | /invoices/estimate/list | List Estimates |
PUT | /invoices/estimate/{estimateId} | Update Estimate |
DELETE | /invoices/estimate/{estimateId} | Delete Estimate |
POST | /invoices/estimate/{estimateId}/send | Send Estimate |
POST | /invoices/estimate/{estimateId}/invoice | Create Invoice from Estimate |
GET | /invoices/estimate/number/generate | Generate Estimate Number |
PATCH | /invoices/estimate/stats/last-visited-at | Update estimate last visited at |
GET | /invoices/estimate/template | List Estimate Templates |
POST | /invoices/estimate/template | Create Estimate Template |
PUT | /invoices/estimate/template/{templateId} | Update Estimate Template |
DELETE | /invoices/estimate/template/{templateId} | Delete Estimate Template |
GET | /invoices/estimate/template/preview | Preview Estimate Template |
Related
- Payments API — Record payments, manage orders, and handle subscriptions
- Products API — Add products and pricing as line items on invoices
- Store API — Configure store-level settings that affect checkout and billing