Resource
Invoices
Bills sent to customers for rentals, tolls, and violations. Read-only via API; create invoices in the portal.
The invoice object
idstring (uuid) | Unique identifier. |
objectstring | Always `"invoice"`. |
invoice_numberstring | Human-readable number (e.g. `INV-1042`). |
customer_idstring (uuid) | Billed customer. |
rental_idstring (uuid) | Source rental, if any. |
statusstring | `draft`, `open`, `paid`, `void`, `uncollectible`. |
subtotalnumber | Pre-tax total. |
tax_amountnumber | Computed tax. |
totalnumber | Grand total due. |
amount_paidnumber | Payments received. |
paid_atstring (iso8601) | Payment timestamp. |
currencystring | ISO 4217 (default `usd`). |
Webhook events
Subscribe to receive notifications when invoice resources change:
invoice.createdinvoice.paidinvoice.voidedEndpoints
GET
/v1/invoicesscope: readList invoices
Query parameters
statusstring | Filter by status. |
customerstring | Filter by customer. |
limitinteger | Default 20. Max 100. |
Request
curl -X GET 'https://userenvo.com/api/v1/invoices' \
-H 'Authorization: Bearer rv_live_…'Response
{
"object": "list",
"has_more": false,
"next_cursor": null,
"data": [
{
"object": "invoice",
"id": "in_…",
"invoice_number": "INV-1042",
"total": 450,
"status": "open"
}
]
}GET
/v1/invoices/{id}scope: readRetrieve an invoice
Path parameters
idrequiredstring | Invoice id. |
Request
curl -X GET 'https://userenvo.com/api/v1/invoices/a4d2e1c0-9b…' \
-H 'Authorization: Bearer rv_live_…'Response
{
"object": "invoice",
"id": "in_…",
"invoice_number": "INV-1042",
"total": 450,
"status": "paid"
}