RtiSubmissionSettings

Name / Description Type / Format Example
senderType string "ActingInCapacity" "Agent" "Bureau" "Company" "Employer" "Government" "Individual" "Other" "Partnership" "Trust"
senderId
The SenderId used to submit RTI documents to HMRC
string "string"
password
The Password used to submit RTI documents to HMRC
string "string"
excludeNilPaid
Whether or not to include Employees paid a zero amount on your FPS
boolean true
includeHashCrossRef
Whether or not the Bacs Cross Ref field is included on your FPS submissions
This is automatically set to true if you use a bank payments CSV format that supports it or set to false if not
boolean true
autoSubmitFps
If set to true, we'll automatically send your FPS to HMRC whenever you finalise a PayRun
boolean true
testInLive
Used for testing the RTI gateway. If set to true then the Document Type name will have "-TIL" appended to it
boolean true
useTestGateway
If set to true then your RTI documents will be sent to HMRCs test services instead of the live service
boolean true
overrideTimestampValue
If a value is provided then it will be used as the timestamp on the RTI submission. This would normally only be used for testing purposes.
string "string"
contact RtiContact {RtiContact}
agent RtiAgent {RtiAgent}
id
The unique id of the object
string uuid "string"
{
  "senderType": "ActingInCapacity",
  "senderId": "string",
  "password": "string",
  "excludeNilPaid": true,
  "includeHashCrossRef": true,
  "autoSubmitFps": true,
  "testInLive": true,
  "useTestGateway": true,
  "overrideTimestampValue": "string",
  "contact": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "telephone": "string"
  },
  "agent": {
    "agentId": "string",
    "company": "string",
    "address": {
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "line4": "string",
      "line5": "string",
      "postCode": "string",
      "country": "England"
    },
    "contact": {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "telephone": "string"
    }
  },
  "id": "string"
}
Contained in Models
Employer
Consumed by Operations

- none -

Returned by Operations

- none -

Completing a Payrun Review and Submit the FPS