RTI FPS Job Instructions



RtiFpsJobInstruction [Schema]

Name Type Required Description
HoldingDate xsd:dateTime no [Optional] date, used to defer execution of the job until a future point in time.
Generate xsd:boolean yes Flag to indicate if the job should generate the message.
Transmit xsd:boolean yes Flag to indicate if the message should be transmitted to HMRC via the RTI gateway.
TaxYear TaxYear yes The tax year the message relates to.
Employer Link yes A link to the associated Employer resource.
Timestamp xsd:dateTime no The timestamp that is transmitted on the RTI message.
PaySchedule Link yes A link to the associated PaySchedule resource.
PaymentDate xsd:date yes The relevant payment date.
SchemeCeased xsd:date no [Optional] Date to indicate if the PAYE scheme has ceased.
FinalSubmissionForYear xsd:boolean no Flag to indicate if this is the final submission of the tax year.
LateReason xsd:string (enumeration)
  • A
  • B
  • C
  • D
  • F
  • G
  • H
 no If applicable, the reason given for a late submission.

Example

<?xml version="1.0"?>
<RtiFpsJobInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <HoldingDate>2020-10-15T00:00:00+00:00</HoldingDate>
  <Generate>true</Generate>
  <Transmit>true</Transmit>
  <TaxYear>123</TaxYear>
  <Employer title="string" href="string" rel="string" />
  <Timestamp>2020-10-15T00:00:00+00:00</Timestamp>
  <PaySchedule title="string" href="string" rel="string" />
  <PaymentDate>2020-10-15</PaymentDate>
  <SchemeCeased>2020-10-15</SchemeCeased>
  <FinalSubmissionForYear>true</FinalSubmissionForYear>
  <LateReason>A</LateReason>
</RtiFpsJobInstruction>

{
  "RtiFpsJobInstruction": {
    "HoldingDate": "2020-10-15T00:00:00+00:00",
    "Generate": "true",
    "Transmit": "true",
    "TaxYear": "123",
    "Employer": {
      "@title": "string",
      "@href": "string",
      "@rel": "string"
    },
    "Timestamp": "2020-10-15T00:00:00+00:00",
    "PaySchedule": {
      "@title": "string",
      "@href": "string",
      "@rel": "string"
    },
    "PaymentDate": "2020-10-15",
    "SchemeCeased": "2020-10-15",
    "FinalSubmissionForYear": "true",
    "LateReason": "A"
  }
}