HMhm-courts-and-tribunals-service
application-list-entries

Bulk append fee status rows for multiple Application List Entries.

Changed on

Atomically appends the supplied fee status rows to each specified entry in the source list (path listId). Existing fee status rows are preserved to retain fee-status history. If any supplied fee detail has hasOffsiteFee=true, the selected entries will be ensured to have an off-site fee mapping. hasOffsiteFee=false does not remove an existing off-site fee mapping. If any entry cannot be updated, no fee status rows are changed.

put/application-lists/{listId}/entries/fees

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /application-lists/{listId}/entries/fees
  • Auth
    none declared

Path parameters

listIdstring uuid required

ID of the Application List that owns the entries whose fee details will be updated.

Request body

entryIdsstring[] required

Array of entry IDs whose fee-status history should be appended to. All must belong to the list in the path. Requests with more than 1050 entry IDs are rejected with 400 Bad Request.

hasOffsiteFeeboolean nullable

If true, ensures that all selected entries have an off-site fee mapping. If false, it will remove the offsite fee. If not provided, the offsite fee will not be changed.

Example request

{
  "entryIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ],
  "feeDetails": [
    {
      "paymentStatus": "PAID",
      "statusDate": "2025-12-01",
      "paymentReference": "PAY-001"
    }
  ]
}

Response

Fee status rows appended for all entries.

totalCountinteger required

Total number of records requested for update.

updatedCountinteger required

Number of records updated.

status'SUCCEEDED' | 'FAILED' required

Overall status of the bulk update operation.

Example response

{
  "totalCount": 2,
  "updatedCount": 2,
  "status": "SUCCEEDED"
}

Changes