Planned invoices
A planned invoice is an invoice a firm intends to raise on a project at a future date. Read only.
GET /api/v1/planned_invoices
Lists planned invoices, earliest planned date first. Paginated (see Pagination).
| Parameter | Meaning |
|---|---|
start_date, end_date |
Planned on or after, or on or before, this date |
status |
pending, invoiced or paid |
project_id |
Planned invoices of one project |
curl -H "Authorization: Bearer $DRUM_API_TOKEN" \
"https://app.getdrum.com/api/v1/planned_invoices?start_date=2026-10-01&end_date=2026-12-31"
Response (200):
[
{
"id": 3301,
"project_id": 20488,
"invoice_id": null,
"status": "pending",
"amount_cents": 1250000,
"currency": "AUD",
"planned_date": "2026-10-31",
"project_number": "2026-088",
"project_name": "Riverside fit-out"
}
]
| Field | Meaning |
|---|---|
status |
pending, invoiced or paid |
invoice_id |
The invoice raised for it, or null |
amount_cents |
The planned amount in integer cents, tax exclusive |
planned_date |
The date the invoice is planned for |
GET /api/v1/planned_invoices/:id
Returns one planned invoice in the same shape.
Permissions
api_read, and read_invoices or a project role that can view planned invoices. Without read_invoices, the list holds only the projects where such a project role applies.
Errors
A planned invoice that does not exist in the account, or that the token’s user cannot read, returns 404 with an empty body.