v1

latestOpenAPI 3.0.32026-07-234697.5 KB

Amend CIS Deductions for Subcontractor

This endpoint allows a developer to amend a customer’s CIS deductions data that has been previously populated. A National Insurance number and submission ID must be provided.

Test data

Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.

Header Value (Gov-Test-Scenario)	Scenario
N/A - DEFAULT	Simulates success response.
DEDUCTIONS_DATE_RANGE_INVALID	Simulates the scenario where the deductions period does not align from the 6th of one month to the 5th of the following month.
UNALIGNED_DEDUCTIONS_PERIOD	Simulates the scenario where the deductions periods do not align with the tax year supplied.
DUPLICATE_PERIOD	Simulates the scenario where CIS deductions already exists for this period.
NOT_FOUND	Simulates the scenario where the CIS deduction was not found.
TAX_YEAR_NOT_SUPPORTED	Simulates the scenario where the tax year is not supported.
OUTSIDE_AMENDMENT_WINDOW	Simulates the scenario where request cannot be completed as it is outside the amendment window.
STATEFUL	Performs a stateful update.

put/individuals/deductions/cis/{nino}/amendments/{submissionId}

Path parameters

ninostring required

Example:TC663795B

National Insurance number in the format AA999999A.

submissionIdstring required

Example:4557ecb5-fd32-48cc-81f5-e6acd1099f3c

A unique identifier for the customer provided CIS deduction amendment.

Headers

Authorizationstring required

Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with the write:self-assessment scope.

Acceptstring required

Example:application/vnd.hmrc.3.0+json

Specifies the response format and the version of the API to be used.

Content-Typestring required

Example:application/json

Specifies the format of the request body, which must be JSON.

Gov-Test-Scenariostring

Example:-

Only in sandbox environment. See Test Data table for all header values.

Request body

Example request

{
  "periodData": [
    {
      "deductionAmount": 5000.99,
      "deductionFromDate": "2020-04-06",
      "deductionToDate": "2020-04-05",
      "costOfMaterials": 5000.99,
      "grossAmountPaid": 5000.99
    }
  ]
}

Response

Success (No Content)