Skip to main content
GET
List withdrawal tracker entries

Authorizations

Authorization
string
header
required

Access token issued by POST /sessions and associated with a valid server-side session.

Query Parameters

company_id
string<uuid>
required

Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.

school_id
string<uuid>

School UUID. Must be assigned to the authenticated session. Omit to use the operation's documented company/session scope.

ems_student_status
enum<string>

Optional onboarding status, matched case-insensitively.

Available options:
Enrolled,
Registration Pending,
Confirmed Start Date,
Waitlist,
Missing Information,
Withdrawn,
Unknown,
Empty
withdrawal_date_filter
enum<string>

Choose which withdrawal date supplies the tracker.

Available options:
ems_entry,
procare,
estimated
has_alerts
boolean
default:false

Return only entries with alerts when true; false leaves all entries eligible. Accepts true/1 and false/0, case-insensitive.

sort_by
enum<string>
default:days_to_withdrawal_date_asc

Sort by a supported column with an _asc or _desc suffix.

Available options:
name_asc,
name_desc,
school_name_asc,
school_name_desc,
status_asc,
status_desc,
onboarding_status_asc,
onboarding_status_desc,
room_asc,
room_desc,
start_date_asc,
start_date_desc,
withdrawal_date_asc,
withdrawal_date_desc,
withdrawal_date_estimated_asc,
withdrawal_date_estimated_desc,
withdrawal_type_asc,
withdrawal_type_desc,
days_to_withdrawal_date_asc,
days_to_withdrawal_date_desc,
plan_status_asc,
plan_status_desc,
billing_cycle_asc,
billing_cycle_desc,
pro_rate_factor_wd_asc,
pro_rate_factor_wd_desc,
invoice_alert_asc,
invoice_alert_desc
page
integer
default:1

One-based page number.

Required range: x >= 1
per_page
integer
default:100

Items per page; values greater than 500 are clamped to 500.

Required range: x >= 1

Response

Successful response.

student_id
string
required

Student id.

student_name
string
required
school_id
string
required

School id.

school_name
string
required
procare_student_status
string
required
ems_student_status
string
required
room_id
string
required

Room id.

room_name
string
required
billing_plan
string
required
billing_cycle
string
required
pro_rate_factor_wd
number<double>
required
withdrawal_date
string
required
days_to_withdrawal_date
integer<int64>
required
plan_status
string
required
service_start_end_invoice_calculated
number<double>
required
service_start_end_invoice_invoiced
number<double>
required
service_end_invoiced
string
required
invoice_alert
string
required
deposit_applied
number<double>
required
deposit_collected
number<double>
required
start_date
string
required
alerts
object[] | null
required