> 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 payment allocations

POST https://ssuccessv2.com/app/api/v1/report/payment/allocations
Content-Type: application/json

Returns payment allocation rows matching the selected school payment report filters.

Reference: https://docs.schoolset.io/api-reference/school-set-api/payment-reports/get-payment-allocations

## Authentication

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

## Request

### Body (application/json)

This endpoint expects an object.

- `payment_sources` (list of enum, optional)
  - Allowed values: `tuition`, `fundraising`
- `academic_year_ids` (list of integer, optional)
- `payment_status_ids` (list of integer, optional)
- `payment_type_ids` (list of integer, optional)
- `credit_type_ids` (list of integer, optional)
- `deposit_batch_ids` (list of integer, optional)
- `without_deposit_batch` (boolean, optional)
- `payer_ids` (list of string, optional)
- `from` (datetime, optional)
- `to` (datetime, optional)

## Response

### 200

Matching allocation rows were returned successfully.

- `status` (string, optional)
- `message` (string, optional)
- `data` (list of ApiV1ReportPaymentAllocationsPostResponsesContentApplicationJsonSchemaDataItems, optional)

## Errors

### 401 Unauthorized Error

Authentication is required.

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

### 422 Unprocessable Entity Error

Report filters failed validation.

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

## Types

### ApiV1ReportPaymentAllocationsPostResponsesContentApplicationJsonSchemaDataItems

- `id` (integer, optional)
- `payer_type` (string, optional)
- `payer_id` (integer, optional)
- `payer_name` (string, optional)
- `family_id` (integer, optional)
- `payment_date` (datetime, optional)
- `amount_payment` (double, optional)
- `allocated_amount` (double, optional)
- `payment_source` (string, optional)
- `allocation` (ApiV1ReportPaymentAllocationsPostResponsesContentApplicationJsonSchemaDataItemsAllocation, optional)

### ApiV1ReportPaymentAllocationsPostResponsesContentApplicationJsonSchemaDataItemsAllocation

- `id` (integer, optional)
- `payment_id` (integer, optional)
- `model_id` (integer, optional)
- `model_type` (string, optional)
- `amount` (double, optional)
- `contract_id` (integer, optional)
- `academic_year_id` (integer, optional)
- `description` (string, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 912,
      "payer_type": "Family",
      "payer_id": 42,
      "payer_name": "Jordan Family",
      "family_id": 42,
      "payment_date": {},
      "amount_payment": 1250,
      "allocated_amount": 1250,
      "payment_source": "tuition",
      "allocation": {
        "id": 1001,
        "payment_id": 912,
        "model_id": 301,
        "model_type": "ContractFee",
        "amount": 1250,
        "contract_id": 77,
        "academic_year_id": 2025,
        "description": "August tuition"
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/report/payment/allocations"

payload = {}
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/report/payment/allocations';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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/report/payment/allocations"

	payload := strings.NewReader("{}")

	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/report/payment/allocations")

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 = "{}"

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/report/payment/allocations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/report/payment/allocations', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/report/payment/allocations");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/report/payment/allocations")! 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()
```