Close Checklist

Updates a close checklist task

Changed on

Partial update of one task's details and assignments. Fields omitted from the body are left unchanged. Completion and reviewer sign-offs cannot be set or cleared here; use complete-a-close-checklist-task and sign-off-a-close-checklist-task. A reviewer who has already signed off keeps their place in the queue: a reviewer_ids list that drops or moves them is rejected with HTTP 409. Every preparer and reviewer must be an active member of the organization (see list-members). Returns the updated task.

patch/close-checklists/{period}/tasks/{task_id}

Request

Path parameters

periodstring yearMonth required

The checklist's accounting month in ISO-8601 format (YYYY-MM).

task_idstring uuid required

UUID of the checklist task, from list-close-checklist-tasks.

Request body

namestring
notesstring

Replaces the task's notes. Send an empty string to clear them. Read the task first to append.

due_datestring date

Sets a fixed due date, replacing any business-day due date rule on the task.

accounting_areastring
preparer_idstring uuid nullable

A UUID, or null to explicitly select nothing. Omitting the field is not the same as sending null.

reviewer_idsstring[]

Response

OK

idstring uuid required
namestring required
notesstring

Free-text notes on the task.

due_datestring date
accounting_areastring
status'NOT_STARTED' | 'IN_REVIEW' | 'COMPLETE' required

NOT_STARTED: the preparer has not completed the task. IN_REVIEW: completed, but at least one reviewer has not signed off (or, with no reviewers assigned, nobody has reviewed it yet). COMPLETE: completed and every reviewer has signed off.

preparer_idstring uuid

User id of the assigned preparer.

completed_bystring uuid

User id of the person who completed the task. Absent for an early task whose recorded preparer is not a user id.

completed_atstring

When the task was completed, as a local date-time in the organization's timezone.

reviewed_bystring uuid

User id of the final review sign-off.

reviewed_atstring

When the final review sign-off happened, as a local date-time in the organization's timezone.

link_urlsstring[] required
attachment_idsstring[] required

Ids of documents attached to the task.

Example response

{
  "name": "Collect accruals from department heads",
  "accounting_area": "Accruals",
  "completed_at": "2026-10-03T14:05:00",
  "reviewers": [
    {
      "signed_off_at": "2026-10-04T09:30:00"
    }
  ],
  "reviewed_at": "2026-10-04T09:30:00"
}

Changes