Get Widgets Monthly Payments | SchoolSet

curl https://app.schoolset.io/app/api/v1/collection/widgets/monthly/payments/year_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Monthly payment data retrieved successfully.",
  "data": [
    {
      "projected": {
        "value": 12500.75,
        "date": "2023-01",
        "count": 150
      },
      "collected": {
        "value": 11800.5,
        "date": "2023-01",
        "count": 145
      },
      "failed": {
        "value": 700.25,
        "date": "2023-01",
        "count": 5
      },
      "fees_total": {
        "value": 300,
        "date": "2023-01"
      },
      "collected_percent": {
        "value": 94.4,
        "date": "2023-01"
      },
      "projected_percent": {
        "value": 100,
        "date": "2023-01"
      },
      "fees_percent": {
        "value": 2.4,
        "date": "2023-01"
      }
    }
  ]
}

Returns monthly payments information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

year_idstringRequired

Response

Successful GET response for /api/v1/collection/widgets/monthly/payments/{year_id}.

statusstring

messagestring

datalist of objects