logo
API docs by Redocly

HMRC claim tracking API (2.0.0)

Download OpenAPI specification:Download

Support: customer.support@claimer.com

Claimer Claim Completion Suite

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.

Introduction to API Terminology

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:

Financial Year

  • Definition: The period covered by a company's annual accounts filed with Companies House, lasting up to a maximum of 18 months.

Accounting Period for Corporation Tax

  • Definition: A period, limited to a maximum of 12 months, for which R&D tax relief can be claimed via a tax return submission.

Relationship Between Financial Year and Accounting Period for Corporation Tax:

  • For a financial year lasting 12 months or less there is typically a single aligned accounting period for corporation tax.
  • If the financial year exceeds 12 months, it necessitates filing multiple corporation tax returns
    • This often occurs following a company's first year of incorporation. In such cases:
      • The financial year begins on the day of incorporation and ends on the last day of the same month one year later.
      • Two accounting periods are typically formed: one covering the initial 12 months and the other encompassing the remaining days beyond the initial 12 months.

Crucial Points:

  • An accounting period for corporation tax cannot span multiple financial years.
  • Historical financial year dates from Companies House filings are set in stone, serving as a reliable reference point.

Claim:

  • A "Claim" in our system aligns with the financial year, supporting multiple accounting periods for corporation tax.
  • Our system automatically determines accounting periods based on HMRC defaults, with the option for manual adjustment if required.

Projects

Fetches all the projects for a financial year

Authorizations:
bearerAuth
path Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new project for a financial year

Authorizations:
bearerAuth
path Parameters
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.

Request Body schema: application/json
required
created_by
required
string

The email of the consultant user creating the project.

title
string

The title of the project.

Responses

Request samples

Content type
application/json
{
  • "created_by": "string",
  • "title": "string"
}

Response samples

Content type
application/json
"string"

Gets a project by its ID

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Responses

Response samples

Content type
application/json
Example
{
  • "title": "string",
  • "competent_professionals": [
    ],
  • "sources": [
    ],
  • "analysis_generation_id": "string",
  • "summary": "string",
  • "analysis": {
    },
  • "field": "string",
  • "questions": [
    ],
  • "drafts": [
    ],
  • "last_analysis_time": "2019-08-24T14:15:22Z"
}

Deletes a project by its ID

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Responses

Updates a project's title

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Request Body schema: application/json
required
title
string

The new title of the project.

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Uploads

Signed url for uploading files

Returns a signed URL for the uploading of files. Upload a file to the URL returned in the response then add the file name to the appropriate resource (ie, transcription or competent-professional).

Authorizations:
bearerAuth
path Parameters
registeredCompanyNumber
required
string

A valid Companies House company number for an R&D eligible company.

Request Body schema: application/json
required
file_name
required
string

The name of the file to be uploaded.

content_type
required
string

The content type of the file to be uploaded.

Responses

Request samples

Content type
application/json
{
  • "file_name": "string",
  • "content_type": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "file_id": "string"
}

Competent Professionals

Fetches all the competent professionals for a client

Authorizations:
bearerAuth
path Parameters
registeredCompanyNumber
required
string

A valid Companies House company number for an R&D eligible company.

Responses

Response samples

Content type
application/json
{
  • "professionals": [
    ]
}

Creates a new competent professional for a client, you must provide at least a LinkedIn profile, a CV, or notes.

Authorizations:
bearerAuth
path Parameters
registeredCompanyNumber
required
string

A valid Companies House company number for an R&D eligible company.

Request Body schema: application/json
required
Any of
linked_in
required
string or null <uri> (LinkedIn)

Input for LinkedIn profile.

cv
string or null

Input for file_id for CV, returned in the signed URL response. Format is uuid:original_file_name.

notes
string or null

Input for professional notes.

requested_by
required
string

The email of the consultant user creating the competent professional.

Responses

Request samples

Content type
application/json
Example
{
  • "linked_in": "http://example.com",
  • "cv": "string",
  • "notes": "string",
  • "requested_by": "string"
}

Response samples

Content type
application/json
"string"

Fetches a competent professional

Authorizations:
bearerAuth
path Parameters
registeredCompanyNumber
required
string

A valid Companies House company number for an R&D eligible company.

competentProfessionalId
required
string

The ID of the competent professional to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": {
    },
  • "summary": "string",
  • "qualifications": "string",
  • "current_positions": "string",
  • "biography": "string"
}

Assigns a competent professional to a project

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

competentProfessionalId
required
string

The ID of the competent professional to assign to the project.

Responses

Removes a competent professional from a project

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

competentProfessionalId
required
string

The ID of the competent professional to remove from the project.

Responses

Eligibility Questionnaires

Creates an eligibility questionnaire

Only one eligibility questionnaire can be created for a project when there's no other source assigned to it.

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Request Body schema: application/json
required
name
required
string

The name of the questionnaire.

required
object

The email of the consultant user to assign the questionnaire to.

email
string

The email of the consultant user to assign the questionnaire to.

is_consultant
boolean

A flag indicating if the user is a consultant.

created_by
required
string

The email of the user creating the questionnaire.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "assignee": {
    },
  • "created_by": "string"
}

Fetches an eligibility questionnaire

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

questionnaireId
required
string

The ID of the eligibility questionnaire to retrieve.

Responses

Response samples

Content type
application/json
{
  • "steps": [
    ]
}

Cancels an eligibility questionnaire

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

questionnaireId
required
string

The ID of the eligibility questionnaire to cancel.

Responses

Standard Questionnaire

Creates a standard questionnaire

Only one standard questionnaire can be created for a project when there's no other source assigned to it.

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Request Body schema: application/json
required
name
required
string

The name of the questionnaire.

required
object

The email of the consultant user to assign the questionnaire to.

email
string

The email of the consultant user to assign the questionnaire to.

is_consultant
boolean

A flag indicating if the user is a consultant.

created_by
required
string

The email of the user creating the questionnaire.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "assignee": {
    },
  • "created_by": "string"
}

Fetches a standard questionnaire

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

questionnaireId
required
string

The ID of the standard questionnaire to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "status": "completing",
  • "field": "string",
  • "analysis": {
    },
  • "respondent": "string"
}

Cancels a standard questionnaire

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

questionnaireId
required
string

The ID of the standard questionnaire to cancel.

Responses

Transcriptions

Fetches all the transcriptions for a client

Authorizations:
bearerAuth
path Parameters
registeredCompanyNumber
required
string

A valid Companies House company number for an R&D eligible company.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new transcription for a client

Authorizations:
bearerAuth
path Parameters
registeredCompanyNumber
required
string

A valid Companies House company number for an R&D eligible company.

Request Body schema: application/json
required
One of
file_id
string

The identifier of the file, returned in the signed URL response. Format is uuid:original_file_name.

requested_by
string

Responses

Request samples

Content type
application/json
Example
{
  • "file_id": "string",
  • "requested_by": "string"
}

Response samples

Content type
application/json
"string"

Fetches a transcription

Authorizations:
bearerAuth
path Parameters
registeredCompanyNumber
required
string

A valid Companies House company number for an R&D eligible company.

transcriptionId
required
string

The ID of the transcription to retrieve.

Responses

Response samples

Content type
application/json
{
  • "projects": [
    ],
  • "title": "string",
  • "status": "generating_summary",
  • "raw_text": "string"
}

Gets all available transcriptions of a project

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Fetches a project transcription

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

transcriptionId
required
string

The ID of the transcription to retrieve.

Responses

Response samples

Content type
application/json
{
  • "projects": [
    ],
  • "title": "string",
  • "status": "generating_summary",
  • "raw_text": "string"
}

Assigns a transcription to a project

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

transcriptionId
required
string

The ID of the transcription to assign to the project.

Request Body schema: application/json
optional
projects
Array of strings

A list of the IDs of the summarised projects to assign the transcription to.

Responses

Request samples

Content type
application/json
{
  • "projects": [
    ]
}

Updates a project's transcription's summarisation projects

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

transcriptionId
required
string

The ID of the transcription to update.

Request Body schema: application/json
required
projects
required
Array of strings

A list of the IDs of all the transcription's summarisation projects that will be selected for the project.

Responses

Request samples

Content type
application/json
{
  • "projects": [
    ]
}

Removes a transcription from a project

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

transcriptionId
required
string

The ID of the transcription to remove from the project.

Responses

Notes

Gets all available notes of a project

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Creates a note

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Request Body schema: application/json
required
note
required
string

The content of the note.

requested_by
string

The email of the user requesting the note.

Responses

Request samples

Content type
application/json
{
  • "note": "string",
  • "requested_by": "string"
}

Response samples

Content type
application/json
"string"

Fetches a note

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

noteId
required
string

The ID of the note to retrieve.

Responses

Response samples

Content type
application/json
{
  • "projects": [
    ],
  • "status": "generating_summary",
  • "raw_text": "string"
}

Updates a project's note's summarisation projects

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

noteId
required
string

The ID of the note to update.

Request Body schema: application/json
required
projects
required
Array of strings

A list of the IDs of all the note's summarisation projects that will be selected for the project.

Responses

Request samples

Content type
application/json
{
  • "projects": [
    ]
}

Removes a note from a project

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

noteId
required
string

The ID of the note to remove from the project.

Responses

Drafts

Fetches all drafts of a project

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Responses

Response samples

Content type
application/json
{
  • "drafts": [
    ]
}

Generates a draft

Generates a draft when there are sources assigned to the project.

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

Request Body schema: application/json
required
requested_by
string

The email of the consultant user requesting the draft.

Responses

Request samples

Content type
application/json
{
  • "requested_by": "string"
}

Fetches a draft

Authorizations:
bearerAuth
path Parameters
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.

projectId
required
string

The ID of the project.

draftId
required
string

The ID of the draft to retrieve.

Responses

Response samples

Content type
application/json
{
  • "requested_at": "2019-08-24T14:15:22Z",
  • "requested_by": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sources": [
    ],
  • "background": {
    },
  • "baseline": {
    },
  • "advance": {
    },
  • "uncertainties": {
    },
  • "work": {
    }
}