STstuut
collections-readiness

List Partners

List Collections Readiness Partners

Returns the partners outreach would send to, largest overdue first, for the readiness drill-down tables. Under parent outreach a parent row carries its family's invoice stats and its children are not listed. Counts match /collections-readiness/stats unless include_coming_due adds partners with open AR but nothing overdue.

get/v2/collections-readiness/partners

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.

missing_information__instring[] nullable
missing_information__ninstring[] nullable
missing_information__eqstring[] nullable
include_on_holdboolean

Also list partners on an open-ended manual or integration pause.

include_coming_dueboolean

Also list partners with open AR but nothing overdue, after the overdue ones and soonest due first. The stats count them with the same flag.

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.