ChangeSummary

Schema

Name / Description Type / Format Example
id string uuid "string"
auditId string uuid "string"
previousAuditId
This Id is used to delete the previous audit entry once the change summary entry is created
for the modifications between the current and the previous audit entry.
 string uuid "string"
date string date "2024-11-21"
name string "string"
actionPerformed string "Added" "Edited" "Deleted"
entityType string "None" "Employer" "Employee" "PayRunEntry" "PensionScheme" "PayCode" "Note" "Leave" "Benefits" "Pension" "AttachmentOrder" "OpeningBalances" "NicSummary" "HmrcPayment" "DpsNotice" "User" "Settings" "PayRun" "Loan" "Department" "EmployerOpeningBalances" "EmployerGroupMembership" "DepartmentMembership" "TermCalendar" "TermCalendarYear"
entityId
Id of the underlying entity
 string uuid "string"
employeeUniqueId
Unique id of the employee this operation belongs to
 string uuid "string"
employerUniqueId
Unique id of the employer this operation belongs to
 string uuid "string"
actionPerformedBy string "string"
actionPerformedOn string "string"
employeeFirstName string "string"
employeeLastName string "string"
uniqueId
Unique id of the owner this request belongs to
 string uuid "string"
parentEventType string "string"
displayName string "string"
payRunPeriod integer int32 0
changeType string "string"
modifications FieldModification[] {FieldModification}

JSON Example 

{
  "id": "string",
  "auditId": "string",
  "previousAuditId": "string",
  "date": "2024-11-21",
  "name": "string",
  "actionPerformed": "Added",
  "entityType": "None",
  "entityId": "string",
  "employeeUniqueId": "string",
  "employerUniqueId": "string",
  "actionPerformedBy": "string",
  "actionPerformedOn": "string",
  "employeeFirstName": "string",
  "employeeLastName": "string",
  "uniqueId": "string",
  "parentEventType": "string",
  "displayName": "string",
  "payRunPeriod": 0,
  "changeType": "string",
  "modifications": [
    {
      "fieldName": "string",
      "isSignificant": true,
      "oldValue": "string",
      "newValue": "string"
    }
  ]
}

References

Contained in Models
ChangeSummaryListReportResponse
Consumed by Operations

- none -

Returned by Operations

- none -