Overview
API for Academy Trusts to submit Financial Returns
Documents
- FMS API Guide
- FMS API Guide 6.0
- fms.openapi.json
- Uploaded schema
Environments
| Environment | Base URL |
|---|---|
| Live | https://pp-api.education.gov.uk/fms-pp/1 |
You need to sign in to subscribe to an API environment or view your existing subscriptions.
Current release
| Release name | Available from |
|---|---|
| 1.0 | 11 April 2025 |
Operations
PUT Create or Update Submission
- Description
-
Submit new Financial Return via API. An Academy Trust needs to provide only one submission per collection period. Every subsequent submission will overwrite the previous one
- URL template
- /api/Submissions
GET Data Transfer Consent Details
- Description
-
Data Transfer Consent Details
- URL template
- /api/datatransferconsentdetails
DELETE Delete Submission By Id
- Description
-
Delete an existing Financial Return submission against a Submission Id. The submission once deleted cannot be retrieved back
- URL template
- /api/submissions/{submissionGuid}
GET Get All Submissions
- Description
-
Gets a list of Financial Return submissions per Academy Trust
- URL template
- /api/Submissions
GET Get Roles By Upin And Email
- Description
-
Get Roles By Upin And Email
- URL template
- /api/getrolesbyupinandemail
GET Trust Details
- Description
-
Gets Academy Trust Details
- URL template
- /api/trustdetails
Back to top