HMhm-courts-and-tribunals-service
reports

Generate a Fees report for applications that include a fee.

Changed on

Creates an asynchronous job to produce a CSV report of applications that incur a fee, filtered by date range and location. Returns an acknowledgement containing the job ID for tracking progress. The CSV output is capped by server configuration, defaulting to 100,000 rows.

post/reports/fees/jobs

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /reports/fees/jobs
  • Auth
    none declared

Request body

dateFromstring date required

Inclusive start date (YYYY-MM-DD).

dateTostring date required

Inclusive end date (YYYY-MM-DD).

standardApplicantCodestring

Standard applicant code (case-insensitive contains match).

applicantNamestring

Applicant name, surname, or organisation name (case-insensitive contains match).

Example request

{
  "dateFrom": "2025-10-01",
  "dateTo": "2025-10-31",
  "standardApplicantCode": "STD-00123",
  "applicantName": "john smith",
  "location": {
    "courtLocationCode": "LOC123",
    "otherLocationDescription": "town hall",
    "cjaCode": "52"
  }
}

Response

Report job accepted for asynchronous processing.

idstring uuid required

Unique identifier for the job, in UUID v4 format.

type'ACTIVITY_AUDIT_REPORT' | 'FEES_REPORT' | 'LIST_MAINTENANCE_REPORT' | 'SEARCH_WARRANTS_REPORT' | 'WORKLOAD_REPORT' | 'DURATION_REPORT' | 'PRIVATE_PROSECUTORS_INDEX_REPORT' | 'BULK_UPLOAD_ENTRIES' required

The type of the job being polled by the user.

status'RECEIVED' | 'VALIDATING' | 'PROCESSING' | 'FAILED' | 'COMPLETED' required

The status of the job being polled by the user.

createdCountinteger

Number of applications imported by this job, excluding the CSV header and including subsequently soft-deleted applications. Available only when polling a completed BULK_UPLOAD_ENTRIES job; omitted from all other responses. Counted from retained job-to-application mappings, not the current list size.

mainFeeTotalnumber

Current main fees in GBP for non-deleted applications created by this upload, regardless of payment or remission status. Available only when polling a completed BULK_UPLOAD_ENTRIES job; zero when no applicable fees remain. Calculated on read, so later changes to applications or associated fees can change this value. Omitted from all other responses.

offsiteFeeTotalnumber

Current applicable offsite fees in GBP for non-deleted applications created by this upload, regardless of payment or remission status. Available only when polling a completed BULK_UPLOAD_ENTRIES job; zero when no applicable fees remain. Calculated on read, not an upload-time snapshot. Omitted from all other responses.

totalFeeValuenumber

Sum of mainFeeTotal and offsiteFeeTotal in GBP. Available only when polling a completed BULK_UPLOAD_ENTRIES job. Zero when no applicable fees remain; calculated on read. Omitted from all other responses.

error_descriptionstring

Details of a failed job. Bulk-upload validation failures may include actionable input errors; unexpected bulk-upload processing failures use a generic message and identify the job reference to quote to support.

Example response

{
  "id": "9f7b2a35-57ac-4a1c-9c41-83b6c8157af4",
  "type": "FEES_REPORT",
  "status": "RECEIVED",
  "createdCount": 12,
  "mainFeeTotal": 120.5,
  "offsiteFeeTotal": 30.25,
  "totalFeeValue": 150.75
}

Changes

  • d4587b3d88ecRevision changes
    • info

      added the optional property to the response with the status

  • 22203fd337b7Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status