Read what is planned for a customer or a payment request
The plan is a forecast rather than a record. It is recalculated as other activity changes what is needed, so a row is only true as at the moment it is read. While a recalculation is outstanding the plan is a single REASSESS row and nothing else.
Query parameters
The kind of record an activity belongs to.
The kind of record to read the plan for. Required, together with entityId. Only CUSTOMER and PAYMENT_REQUEST have a plan.
The record to read the plan for, as a UUID. Required, together with entityType.
The record to read the plan for, as a UUID. Required, together with entityType.
Which page to return, counting from one.
Which page to return, counting from one.
How many rows to return per page. A request for more than the maximum is refused.
How many rows to return per page. A request for more than the maximum is refused.
How to order the page. The direction is optional and defaults to soonest first.
How to order the page. The direction is optional and defaults to soonest first.
Response
A page of the plan, soonest first unless another order was asked for. An empty list means nothing is planned.