-
POST Set Task WorkflowInitializes workflow step instances for a TaskItem based on a workflow template. Creates progress tracking records for each step in the s.../tenants/{tenant}/tasks/{taskCode}/workflow
-
DELETE Remove Task WorkflowClears all workflow step progress for a TaskItem. Removes all workflow progress tracking: - Deletes all TaskItemWorkflowStep instances - .../tenants/{tenant}/tasks/{taskCode}/workflow
-
GET Get Task Workflow GroupsRetrieves comprehensive workflow progress information for a TaskItem. Returns detailed progress data including: - Overall completion stat.../tenants/{tenant}/tasks/{taskCode}/workflow/groups
-
GET Get Workflow StepRetrieves a single workflow step with current status and execution details. Use this endpoint to: - Check execution status after calling .../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}
-
PUT Update Workflow StepUpdates workflow step properties including status, assignment, and email configuration. Supports updating: - Status changes (validates de.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}
-
PUT Set All Workflow Steps StatusSets every open step of the task's workflow to Completed or Skipped, then returns the refreshed groups so the workflow card can redraw without a secon.../tenants/{tenant}/tasks/{taskCode}/workflow/steps/status
-
POST Execute Workflow StepQueues a typed workflow step (e.g., SendEmail) for async execution. Validation: - Step must exist and belong to the tenant - StepType mus.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/execute
-
POST Send Workflow Step EmailSends a user-composed email for a SendEmail workflow step. The email content comes from the request body, not the step's stored config. On success, ma.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/send
-
POST Resend Client ConfirmationEmails a client confirmation step that is waiting on the client to the given addresses again, each with a fresh link, using the confirmation email tem.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/resend
-
GET Get Client Confirmation RecipientsReturns the email addresses a sent client confirmation step currently counts as its recipients: everyone it was sent to and has not since been withdra.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/recipients
-
GET Preview Workflow Step EmailGenerates a preview of the email that would be sent by a SendEmail workflow step. Renders subject and body with resolved Liquid tokens and tenant bran.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/preview
-
GET Get Step Client DataReturns the current client field values for the fields configured on an UpdateClientData workflow step, along with field metadata for rendering inputs.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/client-data
-
PUT Save Step Client DataSaves client data values from an UpdateClientData workflow step. Applies values to the client record. Set markComplete to true to also mark the step a.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/client-data
-
GET Get Review & Bill Time DefaultsReturns the billing line description (tokens rendered for the task and its client) and the accounting code a Review & Bill Time step pre-fills when it.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/review-time-defaults
-
GET Get Bill for Work PreviewReturns what a Bill for Work step will bill if it runs now (amount, service period, rendered line description), or why it cannot bill. Requires: View.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/bill-for-work-preview
-
POST Submit CIS Return"Submit to HMRC" on a Submit CIS return step: submits the step's tax month's return through CIS Manager now, as the signed-in user, with the declarati.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/cis/submit
-
POST Complete CIS PaymentsStaff complete a Collect CIS payments step the practice collects, once the team has entered the tax month's payments in CIS Manager: the month's payme.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/cis/payments
-
GET Get CIS Step SummaryA summary of a CIS Manager step's tax month as CIS Manager has it, read live for its task card: the month (the step's own once under way, else the tas.../tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/cis
