Sign in

v1

latestOpenAPI 3.0.32026-07-13105113.9 KB

Create and Amend Quarterly Period Type for a Business

This endpoint enables you to create and amend the type of quarterly reporting period used for a business for a specific tax year. You can choose standard quarterly periods (where the first period is 6 April to 5 July) or calendar quarterly periods (first period 1 April to 30 June) for each tax year. Note that the quarterly period type cannot be changed after a submission is made for that year.

Warning: If an invalid tax year or invalid business ID is submitted, the service will return a RULE_REQUEST_CANNOT_BE_FULFILLED error response. Only the current tax year is allowed and business IDs must relate to a self-employment or property income source.

Test data

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

Header Value (Gov-Test-Scenario)Scenario
N/A - DEFAULTSimulate a successful response.
BUSINESS_ID_NOT_FOUNDSimulates the scenario in which the business ID is not found.
BUSINESS_ID_STATE_CONFLICTSimulates the scenario in which the request conflicts with the current state of the business ID.
QUARTERLY_PERIOD_UPDATINGSimulates the scenario in which the quarterly period type cannot be changed when a business commencement date falls between 1st and 5th of April, and the current date is also within that date range but later than the business commencement date.
STATEFULPerforms a stateful create and update.
put/individuals/business/details/{nino}/{businessId}/{taxYear}

Path parameters

ninostring required
Example:TC663795B

National Insurance number, in the format AA999999A

businessIdstring required
Example:XAIS12345678910

A unique identifier for the business income source. It must conform to the following regex: ^X[A-Z0-9]{1}IS[0-9]{11}$

taxYearstring required
Example:2023-24

The tax year for which a quarterly period type is being set.

Headers

Accept'application/vnd.hmrc.2.0+json' required

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

Authorizationstring required
Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

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

Gov-Test-Scenariostring
Example:-

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

Request body

quarterlyPeriodType'standard' | 'calendar' required

The quarterly period type that is being set for the business id.

Example request

{
  "quarterlyPeriodType": "standard"
}

Response

Success(No Content)