PayRunPayment

Name / Description Type / Format Example
type
The type of Payee
string "Employee" "Hmrc" "PensionProvider"
payee
The recipient of the payment
Item {Item}
date
The date the payment is to be made
string date-time "2019-11-13T23:32:00"
method
The method of payment
string "Cash" "Cheque" "Credit" "DirectDebit"
amount
The amount to pay
number double 0.0
reference
The period the payment is for
string "string"
bankDetails
If the employee is to be paid by Credit then this will contain the employees bank details
BankDetails {BankDetails}
bacsHash
if paying by Credit and you've enabled BacsHash then this will contain the BacsHash included on the FPS
string "string"
{
  "type": "Employee",
  "payee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "date": "2019-11-13T23:32:00",
  "method": "Cash",
  "amount": 0.0,
  "reference": "string",
  "bankDetails": {
    "bankName": "string",
    "bankBranch": "string",
    "bankReference": "string",
    "accountName": "string",
    "accountNumber": "string",
    "sortCode": "string",
    "note": "string"
  },
  "bacsHash": "string"
}
Consumed by Operations

- none -

Returned by Operations

- none -