Generate an IIF export

POST

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

Generates a QuickBooks-compatible IIF export for selected contract fees, payment reports, or deposit-batch journal records and returns the saved file URL and export batch ID.

Authentication

AuthorizationBearer

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

Path parameters

formetenumRequired

Export format path value. The frontend calls this route with iif.

Allowed values:

Request

This endpoint expects an object.

modeenumRequired

Allowed values:

exportenumRequired

Allowed values:

idslist of integersRequired

batch_idinteger or nullOptional

export_modeenum or nullOptional

Allowed values:

Response

Export status or generated-file metadata.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/export/iif \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"mode": "all",
>	"export": "contract_fees",
>	"ids": [
>	412,
>	413,
>	414
>	],
>	"export_mode": "fees"
>	}'

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"step": 3,
6	"url": "https://schoolset.example/storage/contract_fees_A1b2C3d4E5.iif",
7	"filename": "contract_fees_A1b2C3d4E5.iif",
8	"batch_id": 73
9	}
10	}