> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# Get tuition payment trends

POST https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/{year_id}
Content-Type: application/json

Returns collected, projected, outstanding-fee, and failed-payment values for each period between the supplied dates.

Reference: https://docs.schoolset.io/api-reference/school-set-api/contract-collection-widgets/get-tuition-payments-widget

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Request

### Path parameters

- `year_id` (integer, required) — Academic year identifier. The current implementation calculates across contracts regardless of this optional scope.

### Body (application/json)

This endpoint expects an object.

- `from` (date, required)
- `to` (date, required)
- `mode` (enum, required)
  - Allowed values: `monthly`, `yearly`, `weekly`, `quarterly`

## Response

### 200

Tuition trend returned.

- `status` (string, optional)
- `message` (string, optional)
- `data` (ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaData, optional)
- `example` (any, optional)

## Errors

### 401 Unauthorized Error

Authentication required.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

User cannot view contracts.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 422 Unprocessable Entity Error

Dates must be YYYY-MM-DD and mode must be supported.

- `message` (string, required)
- `errors` (map from string to list of string, required)

## Types

### ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaData

- `collected` (list of ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaDataCollectedItems, optional)
- `projected` (list of ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaDataProjectedItems, optional)
- `fees` (list of ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaDataFeesItems, optional)
- `failed` (list of ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaDataFailedItems, optional)

### ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaDataCollectedItems

- `value` (double, optional)
- `date` (datetime, optional)

### ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaDataProjectedItems

- `value` (double, optional)
- `date` (datetime, optional)

### ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaDataFeesItems

- `value` (double, optional)
- `date` (datetime, optional)

### ApiV1CollectionWidgetsTuitionPaymentsYearIdPostResponsesContentApplicationJsonSchemaDataFailedItems

- `value` (double, optional)
- `date` (datetime, optional)
- `count` (integer, optional)

## Examples

**Request**

```json
{
  "mode": "monthly"
}
```

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": {
    "collected": [
      {
        "value": 3200,
        "date": {}
      }
    ],
    "projected": [
      {
        "value": 4800,
        "date": {}
      }
    ],
    "fees": [
      {
        "value": 1600,
        "date": {}
      }
    ],
    "failed": [
      {
        "value": 0,
        "date": {},
        "count": 0
      }
    ]
  },
  "example": null
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026"

payload = { "mode": "monthly" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"mode":"monthly"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026"

	payload := strings.NewReader("{\n  \"mode\": \"monthly\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": \"monthly\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"monthly\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026', [
  'body' => '{
  "mode": "monthly"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"mode\": \"monthly\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["mode": "monthly"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```