RTI FPS Transaction



RtiFpsTransaction [Schema]

Name Type Required Description
PaySchedule Link yes A link to the related pay schedule.
PaymentDate xsd:date yes The payment date, employees from pay runs matching this payment were included in the message.
SchemeCeased xsd:date no [Optional] Indicates that the PAYE scheme ceased on the date.
LateReason xsd:string (enumeration)
  • A
  • B
  • C
  • D
  • F
  • G
  • H
no If applicable, the reason given for a late submission.

Interits from: RtiTransaction[Schema]

Name Type Required Description
RtiType xsd:string yes The RTI message type.
TransactionStatus RtiTransactionStatus yes The current status of the RTI transaction.
Timestamp xsd:dateTime yes The timestamp of the RTI transaction.
TransmissionDate xsd:dateTime no The date the RTI submission was made to Government Gateway.
TaxYear xsd:integer yes The relevant tax year for the RTI transaction.
RequestData xsd:string yes The serialised XML message sent to the Government Gateway. This property is [CDATA].
ResponseData xsd:string yes The serialised XML message from the Government Gateway. Where the message has been successfully accepted by the Government Gateway, the response will contain a cryptographic receipt as proof of the transaction. This property is [CDATA].
EmployerCore Link yes A link to the related Employer.

Example

<?xml version="1.0"?>
<RtiFpsTransaction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <RtiType>string</RtiType>
  <TransactionStatus>New</TransactionStatus>
  <Timestamp>2019-12-05T00:00:00+00:00</Timestamp>
  <TransmissionDate>2019-12-05T00:00:00+00:00</TransmissionDate>
  <TaxYear>123</TaxYear>
  <RequestData><![CDATA[string]]></RequestData>
  <ResponseData><![CDATA[string]]></ResponseData>
  <EmployerCore title="string" href="string" rel="string" />
  <PaySchedule title="string" href="string" rel="string" />
  <PaymentDate>2019-12-05</PaymentDate>
  <SchemeCeased>2019-12-05</SchemeCeased>
  <LateReason>A</LateReason>
</RtiFpsTransaction>
{
  "RtiFpsTransaction": {
    "RtiType": "string",
    "TransactionStatus": "New",
    "Timestamp": "2019-12-05T00:00:00+00:00",
    "TransmissionDate": "2019-12-05T00:00:00+00:00",
    "TaxYear": "123",
    "RequestData": {
      "#cdata-section": "string"
    },
    "ResponseData": {
      "#cdata-section": "string"
    },
    "EmployerCore": {
      "@title": "string",
      "@href": "string",
      "@rel": "string"
    },
    "PaySchedule": {
      "@title": "string",
      "@href": "string",
      "@rel": "string"
    },
    "PaymentDate": "2019-12-05",
    "SchemeCeased": "2019-12-05",
    "LateReason": "A"
  }
}