Name / Description | Type / Format | Example | |
---|---|---|---|
employees
|
Item[]
|
{Item}
|
|
employeeCount
|
integer
int32
|
0
|
|
nvrRequest
|
NvrRequest
|
{NvrRequest}
|
|
iRmark
|
string
|
"string"
|
|
xml
This property will soon be removed and should not be used.
There is now a dedicated API endpoint for retrieving the XML for a submission. |
string
|
"string"
|
|
taxYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
|
|
employerReferences
|
EmpRefs
|
{EmpRefs}
|
|
govTalkSubmission
|
GovTalkSubmission
|
{GovTalkSubmission}
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"employees": [
{
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
}
],
"employeeCount": 0,
"nvrRequest": {
"employee": [
{
"employeeUniqueId": "string",
"item": {
"id": "string",
"name": "string",
"metadata": {},
"url": "string"
},
"employeeDetails": {
"nino": "string",
"name": "error too many levels",
"address": "error too many levels",
"birthDate": "string",
"gender": "string"
},
"employment": {
"payId": "string"
}
}
],
"relatedTaxYear": "string"
},
"iRmark": "string",
"xml": "string",
"taxYear": "Year2017",
"employerReferences": {
"officeNo": "string",
"payeRef": "string",
"aoRef": "string",
"econ": "string",
"cotaxRef": "string",
"sautr": "string"
},
"govTalkSubmission": {
"rawResponse": "string",
"messageClass": "string",
"pollInterval": 0,
"lastPoll": "2024-12-29T08:17:46",
"correlationId": "string",
"url": "string",
"status": "NotSubmitted",
"message": "string",
"iRmark": "string",
"errorsJson": "string",
"errors": [
{
"raisedBy": "string",
"number": "string",
"type": "string",
"text": "string",
"location": "string"
}
],
"submittedAt": "2024-12-29T08:17:46",
"id": "string"
},
"id": "string"
}
- none -