Report payments

POST

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

Returns payment report rows filtered for the active school. Without per_page, results are an array; with per_page, results are paginated items and metadata.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

payment_sourceslist of enumsOptional

Allowed values:

payment_type_idslist of integersOptional

credit_type_idslist of integersOptional

payment_status_idslist of integersOptional

deposit_batch_idslist of integersOptional

without_deposit_batchbooleanOptional

academic_year_idslist of integersOptional

payer_idslist of integersOptional

fromdatetimeOptional

todatetimeOptional

pageintegerOptional>=1

per_pageintegerOptional1-200

Response

Payment report returned. Data is an array without per_page

statusstring

messagestring

datalist of objects or object

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

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

1	{
2	"status": "success",
3	"message": "",
4	"data": [
5	{
6	"id": 9021,
7	"payer_type": "family",
8	"payer_id": 84,
9	"payer_name": "Morgan Family",
10	"payment_date": "2024-01-15T09:30:00Z",
11	"amount_payment": 2500,
12	"payment_type_id": 1,
13	"payment_status_id": 1,
14	"payment_source": "string",
15	"allocations": [
16	{}
17	]
18	}
19	]
20	}