PayRunJournal

Name / Description Type / Format Example
lines PayRunSummaryLine[] {PayRunSummaryLine}
date
The PaymentDate from the PayRun
string date "2020-07-11"
title
The status of the task for posting this journal to an ExternalDataProvider
string "string"
status string "Queued" "Sent" "Failed" "Processing"
statusMessage
A message to elaborate on the Status
string "string"
link
If available, a link to the journal in the ExternalDataProvider
string "string"
taxYear string "Year2017" "Year2018" "Year2019" "Year2020"
payPeriod string "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily" "Custom"
ordinal integer int32 0
period integer int32 0
{
  "lines": [
    {
      "nominalCode": 0,
      "departmentCode": "string",
      "nominalName": "string",
      "description": "string",
      "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,
        "calculationType": "FixedAmount",
        "multiplierType": "None",
        "isSystemCode": true,
        "isControlCode": true
      }
    }
  ],
  "date": "2020-07-11",
  "title": "string",
  "status": "Queued",
  "statusMessage": "string",
  "link": "string",
  "taxYear": "Year2017",
  "payPeriod": "Monthly",
  "ordinal": 0,
  "period": 0
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Post Journal
Get Journal for PayRun