PayRunSummaryLine

An array of this model is used to represent a summary of a PayRun.
This would typically be used for creating accounting entries for the PayRun.

Schema

Name / Description Type / Format Example
nominalCode
If you've set up NominalCodeMapping then the relevant Nominal code for the PayCode will be shown here.
 string "string"
departmentCode
If the journal is split by department then the relevant department code is shown here.
 string "string"
nominalName
As above
 string "string"
description
A description of what this line summarises.
 string "string"
qty
If the PayCode is a Multiplier code then this will contain the number of days/hours
 number double 0.0
value
The total value for this line.
 number double 0.0
payCode
Each PayLine has a Code. The Code will match the Code property of a PayCode.
The PayCode that is used determines how the amount is treated with regards to tax, NI and pensions
 PayCode {PayCode}
costCentreCode
If the journal is split by cost centre then the relevant cost centre code is shown here.
 string "string"
analysisCategories
If the journal is split by analysis categories
 AnalysisCategory[] {AnalysisCategory}
analysisCategoryCodes
If the journal is split by analysis categories then the relevant analysis categories code is shown here.
 AnalysisCategoryCode[] {AnalysisCategoryCode}
employeeUniqueId
The EmployeeId this summary line relates to.
 string uuid "string"
journalNarrative
Gets the journal narrative for the pension, if defined.
 string "string"
pensionId
The PensionId of the pension associated with this summary line, only present for pension summary lines.
 string uuid "string"

JSON Example 

{
  "nominalCode": "string",
  "departmentCode": "string",
  "nominalName": "string",
  "description": "string",
  "qty": 0.0,
  "value": 0.0,
  "payCode": {
    "title": "string",
    "code": "string",
    "defaultValue": 0.0,
    "isDeduction": true,
    "isNiable": true,
    "isTaxable": true,
    "isPensionable": true,
    "isAttachable": true,
    "isRealTimeClass1aNiable": true,
    "isNotContributingToHolidayPay": true,
    "isQualifyingEarningsForAe": true,
    "isNotTierable": true,
    "isTcp_Tcls": true,
    "isTcp_Pp": true,
    "isTcp_Op": true,
    "flexibleDrawdown": "None",
    "isAutoAdjust": true,
    "calculationType": "FixedAmount",
    "multiplierType": "None",
    "dailyRateMultiplier": 0.0,
    "hourlyRateMultiplier": 0.0,
    "isSystemCode": true,
    "isControlCode": true,
    "isNotional": true,
    "payee": "string"
  },
  "costCentreCode": "string",
  "analysisCategories": [
    {
      "name": "string"
    }
  ],
  "analysisCategoryCodes": [
    {
      "code": "string",
      "title": "string",
      "color": "string",
      "accountingCode": "string"
    }
  ],
  "employeeUniqueId": "string",
  "journalNarrative": "string",
  "pensionId": "string"
}

References

Contained in Models
PayRunJournal
PayRunSummaryLineIEnumerableReportResponse
Consumed by Operations

- none -

Returned by Operations

- none -

Completing a Pay Run Get Accounting Entries