STstuut
collections-readiness

List Not In Workflow

List Collections Readiness Not In Workflow Partners

Returns the accounts outreach won't reach, largest overdue first, each with why. These are the rows /collections-readiness/stats counts in not_in_workflow for the same include_on_hold and include_coming_due. Under parent outreach a parent row carries its family's invoice stats, and a paused child the parent's letter leaves out is its own row.

get/v2/collections-readiness/not-in-workflow

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, 0 indexed.

limitinteger

Number of records per page.

include_on_holdboolean

Count accounts on an open-ended manual or integration pause as reached, matching the stats.

include_coming_dueboolean

Also list accounts with open AR but nothing overdue, after the overdue ones and soonest due first.

reason'paused' | 'disputed' | 'excluded' | 'payment_pending' | 'promised' | 'none' nullable

Only accounts carrying this reason, or none for accounts carrying no reason.

reason__instring[] nullable

Only accounts carrying any of these reasons, none standing for accounts carrying no reason.

Response

Successful Response

current_pageinteger required

The current page.

total_recordsinteger nullable required

Total number of records.

next_pageinteger nullable required

The next page number, if one exists.

Changes

No recorded changes to this operation across all 1 revision of this API.