This section outlines the detailed process of scheduling a job to generate an BBSI (Bank and Building Society Interest) Extract using the Phoenix API.

1. Creating the Request

Create a new request in Postman as follows:

1. Ensure you have a valid access token retrieved via the authentication process.
2. Change the HTTP verb from GET to POST.
3. Click on the Authorization tab and set the access token as the Bearer Token that was retrieved previously.
4. Specify the URL to the /extracts/hmrc/bbsi API endpoint. For example: https://fslpresales.fslcgix-uat.co.uk/FSLPresales_PhoenixApi/extracts/hmrc/bbsi.

4. Navigate to the 'Body' tab, selecting 'raw' as the input type. Then choose 'JSON' from the dropdown on the right hand side. Here the following text is required before making the API call.

{
  "companyId": "string", //Validated against companies which exist in the database
  "taxYearEnd": "YYYY-04-05", //Must align with the UK tax year end, which occurs on the 5th of April each year.
  "isReadable": true //Set to true for a readable extract, false for an unreadable extract
}

🚧

Request Body

By default, the isReadable parameter is set to false. This means all transactions will be marked as reported, and an extract in the required HMRC submission format will be generated.

Once this process is complete, a single file will be created, and no further extracts can be generated for this reporting period.

To generate extracts for review purposes, set the isReadable parameter to true

❗Reported transactions can only be unflagged through CGiX front-end using the Scheduler, as this action is not supported by any API endpoints

2. Sending the Request

Click the Send button to send the prepared request.

3. The Response Body

Response Format

This JSON response is returned when an extract generation request is successfully scheduled.

{
    "correlationGuid": "1c92781b-1d1c-4706-8a2e-d86dc21e1896",
    "requestRoute": "/extracts/hmrc/bbsi",
    "requestStatus": "Accepted",
    "requestStatusDateTime": "2025-03-18T14:28:04.2105135+00:00",
    "requestStatusCheckRoute": "/notifications/1c92781b-1d1c-4706-8a2e-d86dc21e1896",
    "entityGuid": null,
    "entityCallbackRouteUri": null,
    "externalCorrelationId": null,
    "externalOperationId": null
}

• correlationGuid: Unique identifier for the scheduled job. Use this to check the status of the request later.
• requestRoute: The API route where the extract request was initiated.
• requestStatus: Current status of the request (e.g., Accepted, Processing, Completed).
• requestStatusDateTime: Timestamp indicating when the request status was last updated.
• requestStatusCheckRoute: API route to query the current status of the request.
• entityGuid: This field will initially be null and is populated with the GUID of the generated extract once the request has completed. Use it later to retrieve the extract.

To check the request status and access the generated extract, follow the steps outlined in the Access Generated Extracts section.

📘

Extract Expiry

By default, extracts are valid for 48 hours after generation and are automatically deleted once this period expires.