List payment allocations

POST

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

POST

/app/api/v1/report/payment/allocations

$ curl -X POST https://ssuccessv2.com/app/api/v1/report/payment/allocations \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 912,
7       "payer_type": "Family",
8       "payer_id": 42,
9       "payer_name": "Jordan Family",
10       "family_id": 42,
11       "payment_date": {},
12       "amount_payment": 1250,
13       "allocated_amount": 1250,
14       "payment_source": "tuition",
15       "allocation": {
16         "id": 1001,
17         "payment_id": 912,
18         "model_id": 301,
19         "model_type": "ContractFee",
20         "amount": 1250,
21         "contract_id": 77,
22         "academic_year_id": 2025,
23         "description": "August tuition"
24       }
25     }
26   ]
27 }

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

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects an object.

payment_sourceslist of enumsOptional

Allowed values:

academic_year_idslist of integersOptional

payment_status_idslist of integersOptional

payment_type_idslist of integersOptional

credit_type_idslist of integersOptional

deposit_batch_idslist of integersOptional

without_deposit_batchbooleanOptional

payer_idslist of stringsOptional

fromdatetimeOptional

todatetimeOptional

Response

Matching allocation rows were returned successfully.

statusstringOptional

messagestringOptional

datalist of objectsOptional

Errors

401

Unauthorized Error

422

Unprocessable Entity Error