v1

latestOpenAPI 3.0.32026-07-131528298.7 KB
submission

Amend Overseas Return Notification

Amends an Overseas Return Notification for an accounting period.

Error Codes

<p>This table contains a list of 422 error codes returned when an Amend Overseas Return Notification request is not processed successfully.</p> <table> <thead> <tr> <th>Error Message</th> <th>Next Steps</th> </tr> </thead> <tbody> <tr> <td>003 - Request could not be processed</td> <td>The message could not be processed due to locking. Please make the following checks. Confirm if there is currently an open enquiry on your tax account. The <em>accountingPeriodFrom</em> and <em>accountingPeriodTo</em> date range should match the period defined in your test organisation. The <em>filedDateGIR</em> date should not be in the future. The <em>countryGIR</em> and <em>issuingCountryTIN</em> fields must conform to the ISO-3166 standard for country codes. In the organisation’s settings, the <em>accountStatus</em> should have the <em>inactive</em> flag set to “false". </td> </tr> <tr> <td>063 - Business Partner does not have an Active Subscription for this Regime</td> <td>The Pillar 2 ID in the request header is not listed as active by HMRC for this regime. Please contact the central support team.</td> </tr> <tr> <td>093 - Invalid Return</td> <td>There is an error with the return you’ve submitted in the request.</td> </tr> </tbody> </table>
put/organisations/pillar-two/overseas-return-notification

Headers

X-Pillar2-Idstring required

Pillar2 ID for the submission.

Authorizationstring required

Bearer token for authentication

Acceptstring
Example:application/vnd.hmrc.1.0+json

Specifies the expected response format as versioned JSON from the HMRC API (v1.0). If not provided, it will default to application/vnd.hmrc.1.0+json.

Request body

accountingPeriodFromstring date required

The calendar date upon which a business' accounting period begins.

accountingPeriodTostring date required

The calendar date upon which a business' accounting period ends.

filedDateGIRstring date required

The date upon which the GloBE Information Return (GIR) was filed or submitted.

countryGIRstring required

The country in which the GloBE Information Return (GIR) was submitted.

reportingEntityNamestring required

The name of the company that submitted the GloBE Information Return (GIR).

TINstring required

The Tax Identification Number of the entity submitting the Overseas Return Notification.

issuingCountryTINstring required

The country in which the Tax Identification Number was issued.

Response

Overseas Return Notification Submission Amended

processingDatestring required

The date and time that an event took place.

formBundleNumberstring required

A unique identifier for the request, to be noted and retained in case amendments need to be filed against the return.