List PlannedInvoice (find where)
Find a list of PlannedInvoice records that match the specified criteria.
Tip: All query parameters accept multiple values for array filtering — e.g. ?id=1&id=2 or ?id[]=1&id[]=2. This also works within the where parameter: ?where={"id":[1,2,3]}.
Note: The per-attribute filter parameters and the where parameter are mutually exclusive. If where is supplied, the per-attribute filters are ignored — put all filter criteria inside where instead. limit, skip, sort, and populate are unaffected.
query Parameters
projectFilter by project ID
idFilter by record ID
createdAtFilter by creation date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead
updatedAtFilter by last update date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.sssZ). This is an exact match filter; for range queries (greater than, less than), use the where parameter instead
statusFilter by status (1 = active, 0 = inactive)
whereA JSON-encoded Waterline criteria for advanced filtering. Only whitelisted criteria are supported: project, id, createdAt, updatedAt, status. Sub-attribute modifiers such as startsWith, >=, <=, >, <, and != are supported on any whitelisted criterion. The contains modifier is not supported on this model.
Note: If where is supplied, the per-attribute filter query parameters above are ignored — where is the entire criteria. (limit, skip, sort, and populate are unaffected.) To combine filters, put them all inside where.
e.g. ?where={"startDate":{">=":"2026-06-01","<":"2026-07-01"}}
limitThe maximum number of records to return. Defaults to 10000, capped at 50000.
skipThe number of records to skip (useful for pagination).
sortThe sort order. By default, returned records are sorted by primary key value in ascending order.
e.g. ?sort=lastName%20ASC
List PlannedInvoice (find where) › Responses
Responds with a paged list of PlannedInvoice records that match the specified criteria
Create PlannedInvoice
Create a new PlannedInvoice record.
Create PlannedInvoice › Request Body
Aerion model PlannedInvoice
Create PlannedInvoice › Responses
Responds with a JSON dictionary representing the newly created PlannedInvoice instance
Aerion model PlannedInvoice
Get PlannedInvoice (find one)
Update PlannedInvoice
Partially update an existing PlannedInvoice record. Despite using PUT, this endpoint applies PATCH semantics — only the fields included in the request body are modified; omitted fields are left unchanged.
path Parameters
idThe desired PlannedInvoice record's primary key value
Update PlannedInvoice › Request Body
Aerion model PlannedInvoice
Update PlannedInvoice › Responses
Responds with the newly updated PlannedInvoice record as a JSON dictionary
Aerion model PlannedInvoice
Get PlannedInvoice history log
Returns the history log for a PlannedInvoice record. Each entry contains oldState and newState objects with only the fields that changed between revisions. Fields may be further omitted based on the requesting user's permissions.
query Parameters
idThe ID of the PlannedInvoice record to retrieve history for
Get PlannedInvoice history log › Responses
Successful operation
Shift the scheduled date of one or more planned invoices
Adds duration periodUnits to the date field of each planned invoice in plannedInvoicesIds, scoped to the caller's account. Use case: bulk-shifting a project's scheduled invoices forward when the project timeline slips, or backward to bring them in. duration may be negative to shift earlier. Each update flows through the standard update path, so per-record lifecycle hooks and permissions apply.
Shift the scheduled date of one or more planned invoices › Request Body
plannedInvoicesIdsIDs of the planned invoices to reschedule.
durationNumber of periodUnits to shift the scheduled date by. May be negative to shift earlier.
periodUnitUnit of time the duration is expressed in.
Optional metadata stored alongside each record.
Shift the scheduled date of one or more planned invoices › Responses
Updated planned invoice records with their new date values.