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 email is used to identify the consultant within the system and the consultant ID is returned in the response.
emailAddress required | string Email address of consultant to lookup |
{- "user_id": "string"
}
The email is used to identify the client user within the system and the client ID is returned in the response.
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
emailAddress required | string Email address of client to lookup |
{- "user_id": "string"
}
The user is identified by a unique ID, which is returned in the response.
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
first_name | string |
last_name | string |
email_address | string |
job_title | string |
{- "first_name": "string",
- "last_name": "string",
- "email_address": "string",
- "job_title": "string"
}
{- "user_id": "string"
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
access_request_assignee_email | string The email address of the client to assign an access request task to |
requester_email | string The user email of the consultant creating the connection. If not supplied, the default consultant user will be selected |
{- "access_request_assignee_email": "string",
- "requester_email": "string"
}
{- "connection_id": "string",
- "task_url": "string"
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
connectionId required | string The connection ID associated with the client. |
{- "government_gateway_id": "string",
- "access_level": "Standard",
- "status": "Created",
- "access_request": {
- "task_url": "string"
}, - "services": {
- "corporation_tax": {
- "status": "Available",
- "company_name": "string",
- "discrepancies": {
- "company_name_mismatch": {
- "ignore": true
}
}
}, - "paye": {
- "status": "Available",
- "company_name": "string",
- "discrepancies": {
- "company_name_mismatch": {
- "ignore": true
}
}
}, - "vat": {
- "status": "Available",
- "company_name": "string",
- "discrepancies": {
- "company_name_mismatch": {
- "ignore": true
}
}
}
}
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
connectionId required | string The connection ID associated with the client. |
{- "errorCode": "invalid_connection_id",
- "errorMessage": "string"
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
{- "corporation_tax": {
- "company_name": "string",
- "connection_id": "string",
- "status": "available",
- "utr": "string"
}, - "paye": {
- "company_name": "string",
- "connection_id": "string",
- "status": "available",
- "employer_paye_reference": "string",
- "accounts_office_reference": "string"
}, - "vat": {
- "company_name": "string",
- "connection_id": "string",
- "status": "available",
- "vat_registration_number": "string"
}
}
Requiring a service does not guarantee its availability. Instead, it indicates the intention for the service to be available. The status of a required service will be marked as "Required", indicating that a capabilities check is pending or running to determine the actual availability of the service.
You can’t require a service if there are no connections - when there are no connections, tax services are all required: false
by default.
Attempting to mark an "Available" service as "Not Required" will result in a 400 Bad Request
response. This restriction ensures consistency and prevents unnecessary modifications to already available services.
A not required service will not be tracked by any financial years that have tracking enabled.
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
serviceType required | string (TaxServiceEnum) Enum: "corporation_tax" "vat" "paye" |
required | boolean |
{- "required": true
}
{- "errorCode": "invalid_company_number",
- "errorMessage": "string"
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
include_history | boolean Default: false Used to determine if we return history along with snapshot |
{- "current": {
- "corporation_tax": 0,
- "paye": 0,
- "vat": 0
}, - "history": [
- {
- "event_type": "corp_tax_balance_changed_event",
- "old_value": 0,
- "new_value": 0,
- "changed_at": "2019-08-24T14:15:22Z"
}
]
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
{- "details": {
- "account_period_breakdown": {
- "account_period_id": "string",
- "end": "2019-08-24",
- "tax": 0,
- "interest": 0,
- "penalties": 0,
- "less_paid": 0,
- "repayments": 0,
- "adjustments": 0,
- "total": 0,
- "created_at": "2019-08-24T14:15:22Z"
}, - "taxReturn": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "date": "2019-08-24",
- "description": "string",
- "amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "repayments": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "date": "2019-08-24",
- "description": "string",
- "amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "reallocations": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "date": "2019-08-24",
- "description": "string",
- "amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "transfers": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "date": "2019-08-24",
- "description": "string",
- "amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "credits": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "date": "2019-08-24",
- "description": "string",
- "amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "payments": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "date": "2019-08-24",
- "description": "string",
- "amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "penalties": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "date": "2019-08-24",
- "description": "string",
- "amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "late_payment_nterest": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "amount_paid": 0,
- "from_date": "2019-08-24",
- "to_date": "2019-08-24",
- "number_of_days": 0,
- "rate": 0.1,
- "interest_amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "repayment_interest": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "amount_paid": 0,
- "from_date": "2019-08-24",
- "to_date": "2019-08-24",
- "number_of_days": 0,
- "rate": 0.1,
- "interest_amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "credit_interest": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "amount_paid": 0,
- "from_date": "2019-08-24",
- "to_date": "2019-08-24",
- "number_of_days": 0,
- "rate": 0.1,
- "interest_amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "debit_interest": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "amount_paid": 0,
- "from_date": "2019-08-24",
- "to_date": "2019-08-24",
- "number_of_days": 0,
- "rate": 0.1,
- "interest_amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "adjustments": {
- "total_balance_down": 0,
- "total_balance_up": 0,
- "breakdown": [
- {
- "description": "string",
- "amount": 0
}
], - "net_balance": 0,
- "absolute_balance": 0
}, - "is_amended": true,
- "date_filed": "string"
}, - "accounting_period_end": "2019-08-24"
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
{- "event_type": "tax_return_repayment_cancelled_event",
- "amount": 0,
- "cancelled_date": "2019-08-24",
- "financial_year_id": "string",
- "year_end": "2019-08-24",
- "client_id": "string",
- "event_id": "string",
- "event_timestamp": "2019-08-24T14:15:22Z",
- "batch_id": "string",
- "offset": 0
}
registeredCompanyNumber required | string A valid Companies House company number for an R&D eligible company. |
{- "event_type": "tax_return_repayment_cancelled_event",
- "amount": 0,
- "cancelled_date": "2019-08-24",
- "financial_year_id": "string",
- "year_end": "2019-08-24",
- "client_id": "string",
- "event_id": "string",
- "event_timestamp": "2019-08-24T14:15:22Z",
- "batch_id": "string",
- "offset": 0
}
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 bearer auth is set in the url (recommended) |
event_type | string Value: "connection_enabled_event" |
enabled_by | string |
changed_at | string <date-time> (Instant) An instant in time. |
client_id | string (ClientId) The client ID associated with the event. |
event_id | string |
event_timestamp | string <date-time> |
batch_id | string |
offset | integer |
message_id | string |
request_timestamp | string <date-time> (Instant) An instant in time. |
request_type | string Value: "hmrc-tax-account-change-events" |
{- "event_type": "connection_corp_tax_service_status_changed_event",
- "old_value": "available",
- "new_value": "available",
- "changed_at": "2019-08-24T14:15:22Z",
- "client_id": "string",
- "event_id": "string",
- "event_timestamp": "2019-08-24T14:15:22Z",
- "batch_id": "string",
- "offset": 0,
- "message_id": "string",
- "request_timestamp": "2019-08-24T14:15:22Z",
- "request_type": "hmrc-tax-account-change-events"
}