POST Claimer/NotifyAIFSubmission

Request Information

URI Parameters

None.

Body Parameters

AIFNotification
NameDescriptionTypeAdditional information
message_id

string

None.

timestamp

date

None.

event

Event

None.

Request Formats

application/json, text/json

Sample:
{
  "message_id": "sample string 1",
  "timestamp": "2025-12-21T00:06:06.8131681+00:00",
  "event": {
    "accounting_period_start": "sample string 1",
    "accounting_period_end": "sample string 2",
    "started_at": "2025-12-21T00:06:06.8131681+00:00",
    "client_id": "sample string 4",
    "financial_year_id": "sample string 5",
    "submission_id": "sample string 6",
    "report_instance_id": "sample string 7",
    "event_id": "sample string 8",
    "event_type": "sample string 9",
    "event_timestamp": "2025-12-21T00:06:06.8131681+00:00",
    "tenant-id": "sample string 11",
    "financial_year_start": "sample string 12",
    "financial_year_end": "sample string 13",
    "company_registration_number": "sample string 14",
    "hmrc_confirmation_id": "sample string 15",
    "submitted_at": "sample string 16"
  }
}

application/xml, text/xml

Sample:
<AIFNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANDDUK_TCMS_API.Models">
  <event>
    <accounting_period_end>sample string 2</accounting_period_end>
    <accounting_period_start>sample string 1</accounting_period_start>
    <client_id>sample string 4</client_id>
    <company_registration_number>sample string 14</company_registration_number>
    <event_id>sample string 8</event_id>
    <event_timestamp>2025-12-21T00:06:06.8131681+00:00</event_timestamp>
    <event_type>sample string 9</event_type>
    <financial_year_end>sample string 13</financial_year_end>
    <financial_year_id>sample string 5</financial_year_id>
    <financial_year_start>sample string 12</financial_year_start>
    <hmrc_confirmation_id>sample string 15</hmrc_confirmation_id>
    <report_instance_id>sample string 7</report_instance_id>
    <started_at>2025-12-21T00:06:06.8131681+00:00</started_at>
    <submission_id>sample string 6</submission_id>
    <submitted_at>sample string 16</submitted_at>
    <tenantid>sample string 11</tenantid>
  </event>
  <message_id>sample string 1</message_id>
  <timestamp>2025-12-21T00:06:06.8131681+00:00</timestamp>
</AIFNotification>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>