Unlocked Entries

Get alerted when a connected pay group was unlocked. As a payroll provider, use this information to halt your payroll processing until you receive a new locked pay entry event.

This event only applies to pay groups that are part of Dayforce connected and unified pay programs.

Event Code: Unlocked Entries

Availability: R63+

Event data sample

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "additionalProperties": false,
  "definitions": {
    "PayRun": {
      "additionalProperties": false,
      "properties": {
        "ClientId": {
          "format": "int32",
          "type": "integer"
        },
        "ClientName": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayDate": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayGroupCountryCode": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayGroupDescription": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayGroupName": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayGroupXRefCode": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayPeriod": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayPeriodEndDate": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayPeriodStartDate": {
          "type": [
            "null",
            "string"
          ]
        },
        "PayPeriodSuffix": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    }
  },
  "properties": {
    "LastModifiedTimestampUTC": {
      "format": "date-time",
      "type": "string"
    },
    "LastModifiedUserId": {
      "format": "int32",
      "type": "integer"
    },
    "LastModifiedUserName": {
      "type": [
        "null",
        "string"
      ]
    },
    "Message": {
      "type": [
        "null",
        "string"
      ]
    },
    "PayRun": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/definitions/PayRun"
        }
      ]
    }
  },
  "title": "ConnectedPayEntriesUnlocked",
  "type": "object"
}