PayRunJournal

Name / Description Type / Format Example
lines PayRunSummaryLine[] {PayRunSummaryLine}
date
The PaymentDate from the PayRun
string date "2024-06-24"
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" "Year2021" "Year2022" "Year2023" "Year2024"
payPeriod string "Custom" "Monthly" "FourWeekly" "Fortnightly" "Weekly" "Daily"
ordinal integer int32 0
period integer int32 0
mergeMatchingNominals boolean true
csvFormat string "Default" "SapS4Hana"
{
  "lines": [
    {
      "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,
        "payee": "string"
      },
      "costCentreCode": "string",
      "analysisCategories": [
        {
          "name": "string"
        }
      ],
      "analysisCategoryCodes": [
        {
          "code": "string",
          "title": "string",
          "color": "string",
          "accountingCode": "string"
        }
      ],
      "employeeUniqueId": "string"
    }
  ],
  "date": "2024-06-24",
  "title": "string",
  "status": "Queued",
  "statusMessage": "string",
  "link": "string",
  "taxYear": "Year2017",
  "payPeriod": "Custom",
  "ordinal": 0,
  "period": 0,
  "mergeMatchingNominals": true,
  "csvFormat": "Default"
}
Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Post Journal
Get Journal for PayRun