GET/api/ordering/recurring

Every standing order

A bare array, ordered by customer name then standing-order name. customerId is optional — the list screen calls this with no filter at all and renders a Customer column.

2 parameters
customerIdstringoptional
Filter to one customer.
isActivestringoptional
Filter to active or paused.
Allowed:truefalse

4 status codes
200The standing orders.
idstringoptional
customerIdstringoptional
customerNamestringoptional
namestringoptional
daysOfWeekarray<integer>optional
0 = Sunday … 6 = Saturday, ascending. Always at least one.
isActivebooleanoptional
pausedUntilstringoptional
Suppressed until this day, and it fires again ON it. Null while active, and null while paused indefinitely — an indefinite pause is what "stop" means for v1.
createdByIdstringoptional
Null once the person who created it is retired.
createdAtstringoptional
lastGeneratedAtstringoptional
A true instant, not a day. Null until the first fire.
linesarray<object>optional
warningstringoptional
Present only on a create/update response, and NEVER a block. Says that this customer already has an active standing order sharing a weekday, and/or that today's generation run has already passed so this occurrence will not fire automatically.
400Invalid input — the `error` string says what was wrong.
errorstringrequired
401Not authenticated. Sign in first (see the Auth tag).
errorstringrequired
500Unexpected server error.
errorstringrequired

Error handling

A 400 is returned: Invalid input — the error string says what was wrong. A 401 is returned: Not authenticated. Sign in first (see the Auth tag). A 500 is returned: Unexpected server error.