PayRunJournal

Name / Description Type / Format Example
lines PayRunSummaryLine[] {PayRunSummaryLine}
date
The PaymentDate from the PayRun
string date-time "2019-11-12T03:57:41"
title
The status of the task for posting this journal to an ExternalDataProvider
string "string"
status
The status of the task for posting this journal to an ExternalDataProvider
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
The lines for the journal entry
string "Year2017" "Year2018" "Year2019" "Year2020"
payPeriod string "Monthly" "FourWeekly" "Fortnightly" "Weekly"
period integer int32 0
{
  "lines": [
    {
      "nominalCode": 0,
      "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,
        "calculationType": "FixedAmount",
        "multiplierType": "None",
        "isSystemCode": true,
        "isControlCode": true
      }
    }
  ],
  "date": "2019-11-12T03:57:41",
  "title": "string",
  "status": "Queued",
  "statusMessage": "string",
  "link": "string",
  "taxYear": "Year2017",
  "payPeriod": "Monthly",
  "period": 0
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Post Journal
Get Journal for PayRun