RtiSubmissionSettings

Name / Description Type / Format Example
senderType
The type of RTI Sender.
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 to include the Bacs Cross Ref field on your FPS submissions
This is required by law if you pay by BACS using an allocated Bacs Service User Number (SUN)
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
contact
Contact details to include in your RTI submissions to HMRC
RtiContact {RtiContact}
agent
If your SenderType is 'Agent' then you can provide details of the Agent here
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,
  "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