submission

Retrieve Overseas Return Notification

Retrieves an Overseas Return Notification for an accounting period.

Error Codes

<p>This table contains a list of 422 error codes returned when a Retrieve 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 check if there is currently an open enquiry on your tax account.</td> </tr> </tbody> </table>

get/organisations/pillar-two/overseas-return-notification

Request

Base URL
https://test-api.service.hmrc.gov.uk
Auth
OAuth 2
Authorization codehttps://api.service.hmrc.gov.uk/oauth/authorize
Token URLhttps://api.service.hmrc.gov.uk/oauth/token
Scopesread:pillar2
TypeScript
https://skmtc.dev/hmrc/apis/pillar2-submission-api/docs/organisations/pillar-two/overseas-return-notification/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

accountingPeriodFromstring date required

Period start date

accountingPeriodTostring date required

Period end date

Headers

Authorizationstring required

Bearer token for authentication

X-Pillar2-Idstring required

Pillar2 ID for the submission

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.

Response

Overseas Return Notification Retrieved Successfully

processingDatestring required

The date and time that an event took place.

accountingPeriodFromstring required

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

accountingPeriodTostring required

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

filedDateGIRstring 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 Overseas Return Notification (ORN).

TINstring required

The Tax Identification Number of the entity submitting the GloBE Information Return (GIR).

issuingCountryTINstring required

The country in which the Tax Identification Number was issued.

Changes

No recorded changes to this operation across all 1 revision of this API.