> 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.

# List contracts requiring collection

GET https://ssuccessv2.com/app/api/v1/collection/all/{year_id}

Returns contracts with an account due for the selected academic year, filtered to active or snoozed collection records and optionally by scheduled payment status.

Reference: https://docs.schoolset.io/api-reference/school-set-api/contract-collection/list-contract-collection

## 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. Use 0 to include all years.

### Query parameters

- `status` (enum, optional, default: active) — Collection records to return.
  - Allowed values: `active`, `snoozed`
- `payment_plan_status` (ApiV1CollectionAllYearIdGetParametersPaymentPlanStatus, optional) — Optional scheduled-payment status or statuses.

## Response

### 200

Collection contracts returned.

- `status` (string, optional)
- `message` (string, optional)
- `data` (list of map from string to 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)

## Types

### ApiV1CollectionAllYearIdGetParametersPaymentPlanStatus

- string
- list of string

## Examples

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": [
    {
      "academic_year_id": 2026,
      "academic_year_title": "2026-2027",
      "contract_id": 8841,
      "family": {
        "id": 331,
        "name": "Rivera Family",
        "parents": [
          {
            "id": 902,
            "name": "Elena Rivera"
          }
        ]
      },
      "students_statuses": [
        "Enrolled"
      ],
      "has_failed_payments": false,
      "is_scheduled_payments": true,
      "balance_without_plan": 1200,
      "statement_total_due": 9600,
      "end_of_year_balance": 1200,
      "account_balance": 1200,
      "account_due": 1200,
      "aging_balance_1_30": 1200,
      "aging_balance_31_60": 0,
      "aging_balance_61_90": 0,
      "aging_balance_90_plus": 0,
      "paid": 8400,
      "recurring_payment_count": 6,
      "upcoming_payment_count": 2,
      "last_payment_date": {},
      "last_payment_amount": 800,
      "contract_balance": 1200,
      "previous_balance": 0,
      "total": 9600,
      "current_due": 800,
      "next_payment_date": {},
      "snoozed_until": null,
      "last_snoozed_until": null,
      "last_unsnoozed_at": null,
      "assigned_user": null,
      "assigned_at": null,
      "payment_plan": {
        "scheduled": 800
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/collection/all/2026"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/collection/all/2026';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v1/collection/all/2026"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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/all/2026")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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.get("https://ssuccessv2.com/app/api/v1/collection/all/2026")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ssuccessv2.com/app/api/v1/collection/all/2026', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/collection/all/2026");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/collection/all/2026")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```