Contract.ProcessingNoteResponse

Processing note detail including documents and chat eligibility.

Name / Description Type / Format Example
id
Unique identifier of the processing note.
String uuid "string"
payRunEntryId
Pay run entry the note relates to, when applicable.
Null, String uuid "string"
note
Note text entered by the processor.
Null, String "string"
user
Lightweight item representation used by processing note API contracts.
Contract.ProcessingNoteItem {Contract.ProcessingNoteItem}
payRun
Lightweight item representation used by processing note API contracts.
Contract.ProcessingNoteItem {Contract.ProcessingNoteItem}
date
Date the note was created.
String date "2026-11-22"
documentCount
Number of attached documents.
Integer int32 0
documents
Attached document summaries.
Null, Array {Null, Array}
status String "New" "Complete"
updatedByName
Name of the user who last updated the note.
Null, String "string"
completedDate
When the note was marked completed, if applicable.
Null, String date "2026-11-22"
isChatEnabled
Whether processor chat is offered for this note's pay run.
Boolean true
payRunState String "Opening" "Open" "ReOpening" "RollingBack" "RolledBack" "SubmittedForProcessing" "Processing" "AwaitingApproval" "Approved" "Finalising" "Finalised" "Deleting"
{
  "id": "string",
  "payRunEntryId": "string",
  "note": "string",
  "user": {
    "id": "string",
    "name": "string",
    "metadata": "string",
    "url": "string"
  },
  "payRun": {
    "id": "string",
    "name": "string",
    "metadata": "string",
    "url": "string"
  },
  "date": "2026-11-22",
  "documentCount": 0,
  "documents": {},
  "status": {},
  "updatedByName": "string",
  "completedDate": "2026-11-22",
  "isChatEnabled": true,
  "payRunState": {}
}
Contained in Models

- none -

Consumed by Operations

- none -