Get Contract Payment Collected | SchoolSet

curl https://app.schoolset.io/app/api/v1/system/payment/contract/details/payment/collected/contract_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Payment details retrieved successfully.",
  "data": {
    "contract_balance": 1250.75,
    "contract_remaining_balance": 450.25,
    "contract_scheduled_balance": 300,
    "contract_balance_percent": 72.5,
    "contract_remaining_balance_percent": 26.1,
    "contract_scheduled_balance_percent": 17.4,
    "statement_total_due_today": 150,
    "statement_total_due_today_all": 450,
    "contract_total": 1700,
    "family_credit_account_balance": 200,
    "family_unallocated_payments": 50
  }
}

Returns payment information for the selected context.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

contract_idstringRequired

Response

Successful GET response for /api/v1/system/payment/contract/details/payment/collected/{contract_id}.

statusstring

messagestring

dataobject