PensionProvider

Name / Description Type / Format Example
name string "string"
accountNo string "string"
portal string uri "string"
website string uri "string"
address Address {Address}
telephone string "string"
papdisVersion string "PAP10" "PAP11"
papdisProviderId string "string"
papdisEmployerId string "string"
csvFormat string "Papdis" "Nest" "NowPensions" "TeachersPension"
excludeNilPaidFromContributions
If we're sending contributions to an external provider then we'll include all employees that were on the payrun. If you want to exclude employees that don't have any contributions to report then set this to true.
boolean true
payPeriodDateAdjustment
If you need to adjust the reported dates of the contributions then you can do so by setting a non-zero value here. A negative value of will move the date back in time.
integer int32 0
miscBoolean1
This field has different uses dependent on the ExternalDataProvider, if any.
For Nest, it indicates whether or not contributions are reported as "Tax Weekly/Monthly" rather than just "Weekly/Monthly"
boolean true
miscBoolean2
This field has different uses dependent on the ExternalDataProvider, if any.
For Nest, it indicates whether or not to approve payments after submitting contributions
boolean true
miscString1
This field has different uses dependent on the ExternalDataProvider, if any or the CsvFormat.
For Nest, it dictates the PaymentSource. For CsvFormat.TeachersPensions it sets the Local Authority Number
string "string"
miscString2
This field has different uses dependent on the ExternalDataProvider, if any or the CsvFormat.
For CsvFormat.TeachersPensions it sets the 'School / Type of employer number'
string "string"
id
The unique id of the object
string uuid "string"
{
  "name": "string",
  "accountNo": "string",
  "portal": "string",
  "website": "string",
  "address": {
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "line4": "string",
    "line5": "string",
    "postCode": "string",
    "country": "England"
  },
  "telephone": "string",
  "papdisVersion": "PAP10",
  "papdisProviderId": "string",
  "papdisEmployerId": "string",
  "csvFormat": "Papdis",
  "excludeNilPaidFromContributions": true,
  "payPeriodDateAdjustment": 0,
  "miscBoolean1": true,
  "miscBoolean2": true,
  "miscString1": "string",
  "miscString2": "string",
  "id": "string"
}
Contained in Models
PensionScheme
Consumed by Operations

- none -

Returned by Operations

- none -