For Developers
Invoices Overview
An Invoice records billing statements for platform usage, active integrations, student seat licensing, or add-on modules. Invoices track line-item snapshots and payment transaction status.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier for the invoice. |
created_date | Date | Date when the invoice was generated. |
updated_date | Date | Last modification timestamp. |
number | String | Invoice number. |
state | String | Invoice state: draft, submitted, sent, overdue, paid, voided, or refunded. |
total | Number | Line-item total. |
due_date | Date | Payment due date. |
issued_date | Date | Date the invoice was issued. |
period_start_date | Date | Start of the billed period. |
period_end_date | Date | End of the billed period. |
billing_team_id | UUID | Team responsible for billing payment. |
JSON Example
{
"id": "2a90184b-4819-4712-9912-391820491820",
"number": "1042",
"state": "paid",
"total": 450,
"created_date": "2024-05-01T00:00:00.000Z",
"due_date": "2024-05-15T00:00:00.000Z",
"billing_team_id": "6a9e99a8-e165-4d0d-9b7d-6062a4be682d"
}
