API Docs / Schemas / MonthlyReturnSubmissionDto

MonthlyReturnSubmissionDto

The latest submission of a monthly return to HMRC.

Properties

Name Type Description
status*enum

Pending, Delayed, Completed or Failed; the return's own status carries HMRC's answer

Pending Delayed Completed Failed

Pending, Delayed, Completed or Failed; the return's own status carries HMRC's answer

Pending Delayed Completed Failed

submittedDate*string

When the return was sent to HMRC

When the return was sent to HMRC

lastPolledDatestring

When HMRC was last polled for the outcome

When HMRC was last polled for the outcome

correlationIdstring

HMRC's correlation id for the submission

HMRC's correlation id for the submission

requestXmlstring

The GovTalk request sent to HMRC. Only for callers with the HmrcXmlViewer role; null otherwise.

The GovTalk request sent to HMRC. Only for callers with the HmrcXmlViewer role; null otherwise.

responseXmlstring

HMRC's latest GovTalk response. Only for callers with the HmrcXmlViewer role; null otherwise.

HMRC's latest GovTalk response. Only for callers with the HmrcXmlViewer role; null otherwise.

JSON Example

{
  "status": "Pending",
  "submittedDate": "2024-01-01T00:00:00Z",
  "lastPolledDate": "2024-01-01T00:00:00Z",
  "correlationId": "string",
  "requestXml": "string"
}

Used By Operations