View or download one contract PDF

POST

https://ssuccessv2.com/app/api/v1/contract/export

Generates the requested contract PDF and returns it inline or as a download. The frontend uses the same response for viewing and downloading.

AuthorizationBearer

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

This endpoint expects an object.

contract_idintegerRequired>=1

include_previous_years_balanceboolean or nullOptional

previous_years_balance_typeenum or nullOptional

Allowed values:

payerslist of stringsOptional

document_layoutenumOptionalDefaults to combined

Allowed values:

Content-DispositionstringOptional

Inline or attachment filename supplied by the server.

Content-Lengthinteger

Generated PDF file.

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/contract/export \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"contract_id": 642,
>	"include_previous_years_balance": false,
>	"previous_years_balance_type": "due_amount",
>	"payers": [],
>	"document_layout": "combined"
>	}'