List Planned Invoices
GET /api/v1/accounts/:account_id/planned_invoices
Returns a paginated list of planned invoices for the authenticated account, sorted by due date in ascending order.
Query Parameters
start_date- Filter by start dateend_date- Filter by end datestatus- Filter by statuspage- To paginate through results (10 per page)
Response
Returns an array of planned invoice objects with the following properties:
[
{
"id": integer,
"project_id": integer,
"invoice_id": integer,
"status": string,
"amount_cents": integer,
"currency": string,
"planned_date": date,
"project_number": string,
"project_name": string
}
]
Get Single Planned Invoice
GET /api/v1/accounts/:account_id/planned_invoices/:id
Returns details for a specific planned invoice.
Response
{
"id": integer,
"project_id": integer,
"invoice_id": integer,
"status": string,
"amount_cents": integer,
"currency": string,
"planned_date": date,
"project_number": string,
"project_name": string
}
Error Responses
404 Not Found- Planned invoice not found or not accessible by current account
The API requires authentication and will only return planned invoices belonging to the authenticated account's scope.
The response includes associated project details like project number and name for each planned invoice.