Download OpenAPI specification:Download
Preparing an R&D claim can be a very intensive process, involving a large number of stakeholders, and a lot of information (both financial and technical).
Once the process of preparing the financial and technical information is done, the final phase of an R&D claim is largely administrative, a job for the 'back office' of a consultancy. This final phase - the Claim Completion phase - is about bringing all the prepared information together, getting it submitted to HMRC, and tracking the claim through to a successful outcome.
Claimer's Claim Completion Suite's is a suite of products/modules that facilitate a high-level of process automation across the whole completion phase. The goal is to significantly reduce the administrative burden consultancies encounter in this phase by providing software solutions for every step of the completion workflow.
To address the inconsistent terminology used within the industry, we have chosen to adopt the preferred naming conventions of HM Revenue & Customs (HMRC).
For comprehensive understanding, it's essential to grasp two key concepts as outlined by HMRC:
The pre-notification API is a RESTful API that allows users to submit pre-notifications to HMRC. The API is designed to simplify the process of submitting pre-notifications by providing a single endpoint that accepts pre-notification data in JSON format. The API also provides a webhook notification system that allows users to receive real-time updates on the status of their pre-notification submissions.
The pre-notification API provides the following features:
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
financialYear required | string(\d{4}-\d{2}-\d{2})\.\.(\d{4}-\d{2}-\d{2}) Date range of financial year {startDate}..{endDate} - e.g. 2021-01-02..2021-12-31. Please refer to this section for more info about the Financial Years. |
externalId required | string (ExternalId) | ||||||||
object (CompanyDetailsRaw) | |||||||||
| |||||||||
object (AccountingPeriod) First accounting period within the financial year. Optional - will use first accounting period of associated claim if not specified. | |||||||||
| |||||||||
object (AgentDetailsRaw) | |||||||||
| |||||||||
object (SeniorOfficerRaw) | |||||||||
| |||||||||
hmrcConfirmationEmailAddress | string (EmailAddress) | ||||||||
plannedActivities | string | ||||||||
agent_consent_to_use_email required | boolean True to give permission for HMRC to use email communications emails, which may include attached files. False, use post to send communications | ||||||||
senior_officer_consent_to_use_email required | boolean True to give permission for HMRC to use email communications emails, which may include attached files. False, use post to send communications |
{- "externalId": "string",
- "companyDetails": {
- "utr": "string"
}, - "accountingPeriod": {
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "agentDetails": {
- "leadConsultantName": "string",
- "consultantEmail": "string"
}, - "seniorOfficerDetails": {
- "name": "string",
- "role": "string",
- "email": "string",
- "telephone": "string"
}, - "hmrcConfirmationEmailAddress": "string",
- "plannedActivities": "string",
- "agent_consent_to_use_email": true,
- "senior_officer_consent_to_use_email": true
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
financialYear required | string(\d{4}-\d{2}-\d{2})\.\.(\d{4}-\d{2}-\d{2}) Date range of financial year {startDate}..{endDate} - e.g. 2021-01-02..2021-12-31. Please refer to this section for more info about the Financial Years. |
preNotificationId required | string A valid Pre-Notification ID |
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
financialYear required | string(\d{4}-\d{2}-\d{2})\.\.(\d{4}-\d{2}-\d{2}) Date range of financial year {startDate}..{endDate} - e.g. 2021-01-02..2021-12-31. Please refer to this section for more info about the Financial Years. |
object (PreviousClaimInfo) | |||||||
|
{- "previous_claim_info": {
- "submission_date": "2019-08-24",
- "financial_year_start_date": "2019-08-24",
- "amendment_date": "2019-08-24"
}
}
{- "should_submit": true
}
X-Request-ID required | string Request ID used for tracking or logging purposes. Value is unique to the request. |
Content-Type required | string The media type of this message, e.g application/json |
Authorization | string Will be set if basic auth is set in the url (recommended) |
message_id | string unique event/message id | ||||||||||||||||
timestamp | string <date-time> | ||||||||||||||||
PreNotificationSubmissionStarted (object) or PreNotificationSubmitted (object) or PreNotificationSubmissionFailed (object) (PreNotificationEvent) | |||||||||||||||||
One of
|
{- "message_id": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "event": {
- "started_at": "2019-08-24T14:15:22Z",
- "client_id": "string",
- "claim_id": "string",
- "external_claim_id": "string",
- "pre_notification_id": "string",
- "event_id": "string",
- "event_type": "pre-notification-submission-started",
- "event_timestamp": "2019-08-24T14:15:22Z"
}
}