Skip to main content
GET
/
hmrc
/
{user_id}
Returns all HMRC income submissions for a user
curl --request GET \
  --url https://api.sandbox.goteal.co/hmrc/{user_id} \
  --header 'X-API-KEY: <api-key>'
{
  "pagination": {
    "offset": 75,
    "limit": 25,
    "count": 14,
    "total_count": 89
  },
  "income_submissions": [
    {
      "id": "cefbbff7-f405-467c-8f7e-1421be42c796",
      "account_id": "82b49a09-b352-4a67-abe1-09764417084a",
      "entry_id": "b98ee82a-0c24-4dc6-acb3-c8b2735505f4",
      "income_id": "13de317b69d5d0e3033455a670cb318b",
      "employment": {
        "total_income": "31150.00",
        "employers": [
          {
            "employer_name": "Company XYZ",
            "income": "22500.00",
            "tax_paid": "890.35"
          }
        ]
      },
      "frequency": "Annual",
      "income_period": {
        "start": "2024-04-06T12:00:00Z",
        "end": "2025-04-05T12:00:00Z"
      }
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

user_id
string
required

ID of the user to get HMRC income for

Query Parameters

offset
integer<int32>
default:0

The offset to start at

Required range: x >= 1
limit
integer<int32>
default:20

The number of items to return

Required range: 1 <= x <= 100
account_id
string<uuid>

The account_id to filter on

entry_id
string<uuid>

The entry_id to filter on

Response

HMRC income response

pagination
object
required
income_submissions
object[]
required