Revert registration discounts on a contract

POST

https://ssuccessv2.com/app/api/v1/contract/:id/registration-discounts/rollback

POST

/app/api/v1/contract/:id/registration-discounts/rollback

$ curl -X POST https://ssuccessv2.com/app/api/v1/contract/642/registration-discounts/rollback \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "fee_ids": [
>     101,
>     102
>   ]
> }'

1 {
2   "status": "success",
3   "message": "Registration discounts reverted.",
4   "data": {
5     "contract_id": 642,
6     "rollback": {
7       "reverted_types": [
8         "full_payment",
9         "early_bird"
10       ],
11       "fee_ids_restored": [
12         101,
13         102
14       ],
15       "warnings": [],
16       "skipped_fee_ids": []
17     },
18     "registration_discounts": {},
19     "statement_contract_balance": 12450,
20     "fees": [
21       {
22         "id": 101,
23         "name": "Registration fee",
24         "amount": 1500,
25         "discount": 0,
26         "final_amount": 1500,
27         "end_of_year_balance": 1500
28       }
29     ]
30   }
31 }

Restores registration-discount snapshots for all affected fees, or only the fee IDs supplied in the request.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired>=1

Contract ID.

Request

This endpoint expects an object.

fee_idslist of integersOptional

Optional contract fee IDs to limit the rollback.

Response

Registration discounts reverted.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error