Get deposit batch breakdown

GET

https://ssuccessv2.com/app/api/v2/payment/deposit-batches/:id/breakdown

Returns allocation totals and grouped fee, fundraising, and unallocated rows for the selected deposit batch.

AuthorizationBearer

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

idintegerRequired>=1

Deposit batch identifier.

The deposit allocation breakdown was returned.

statusstringOptional

messagestringOptional

dataobjectOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"totals": {
6	"amount": 1250.5,
7	"count": 8
8	},
9	"rows": [
10	{
11	"type": "contract_fee",
12	"label": "Tuition",
13	"contract_fees_type_id": 2,
14	"fundraising_fund_id": null,
15	"allocation_description": null,
16	"amount": 1000,
17	"allocations_count": 6
18	}
19	],
20	"unallocated": 25.5,
21	"unallocated_account_name": "Undeposited funds"
22	}
23	}

$	curl https://ssuccessv2.com/app/api/v2/payment/deposit-batches/42/breakdown \
>	-H "Authorization: Bearer <token>"