Skip to main content

Operations

The collection team's work: assigned tasks and the history of interactions with each debtor.

Families on this page​

FamilyToolsreadwritedestructive
tasks — Tasks8251
interactions — Interactions5221

Tasks​

ToolKindPermissionEndpointWhat it does
dunning_tasks_listreadtasks.listGET /v1/tasksLists the organization’s tasks with pagination and filters.
dunning_tasks_createwritetasks.createPOST /v1/tasksCreates a task, optionally linked to a customer, a charge and an assignee (all within the organization).
dunning_tasks_getreadtasks.showGET /v1/tasks/{id}Returns a task by ID, with customer, assignee and charge summaries.
dunning_tasks_updatewritetasks.updatePUT /v1/tasks/{id}Updates a task’s data (partial).
dunning_tasks_deletedestructivetasks.deleteDELETE /v1/tasks/{id}Soft-deletes a task: the status becomes cancelled (the record remains).
dunning_tasks_completewritetasks.completePOST /v1/tasks/{id}/completeMarks the task as completed and fills completed_at.
dunning_tasks_bulk_completewritetasks.completePOST /v1/tasks/bulk-completeCompletes up to 100 tasks in one call.
dunning_tasks_bulk_assignwritetasks.updatePOST /v1/tasks/bulk-assignAssigns (or clears, with assignedToId: null) the assignee of up to 100 tasks.

Interactions​

ToolKindPermissionEndpointWhat it does
dunning_interactions_listreadinteractions.listGET /v1/interactionsLists the organization’s interactions with pagination and filters.
dunning_interactions_createwriteinteractions.createPOST /v1/interactionsLogs an interaction with a customer, optionally linked to a charge.
dunning_interactions_getreadinteractions.showGET /v1/interactions/{id}Returns an interaction by ID, with customer, user and charge summaries.
dunning_interactions_updatewriteinteractions.updatePUT /v1/interactions/{id}Updates an interaction’s editable fields (partial).
dunning_interactions_deletedestructiveinteractions.deleteDELETE /v1/interactions/{id}Soft-deletes an interaction; the record remains for the audit trail.

Each resource's fields are in the API reference.

A tool you cannot run does not appear in tools/list. If one from this page is missing, see Authentication.