Debtors and charges
The portfolio: debtors, their contact points and the open charges, with bulk actions and manual notification.
Families on this page
| Family | Tools | read | write | destructive |
|---|---|---|---|---|
people — Debtors and contact points | 11 | 4 | 4 | 3 |
charges — Charges | 10 | 3 | 2 | 5 |
Debtors and contact points
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
dunning_people_list | read | people.list | GET /v1/people | Lists the organization’s customers with pagination and filters. |
dunning_people_create | write | people.create | POST /v1/people | Creates a customer in the portfolio. |
dunning_people_get | read | people.show | GET /v1/people/{id} | Returns a customer by ID. |
dunning_people_update | write | people.update | PUT /v1/people/{id} | Updates a customer’s data (partial). |
dunning_people_delete | destructive | people.delete | DELETE /v1/people/{id} | Soft-deletes a customer. |
dunning_people_statement_pdf | read | people.show | GET /v1/people/{id}/statement-pdf | Generates the debtor statement as a PDF: all of the person’s charges (document, due date, status, original and current amount) with totals for open, overdue and already paid. |
dunning_people_bulk_archive | destructive | people.delete | POST /v1/people/bulk-archive | Archives (soft delete) up to 100 customers in one call. |
dunning_contact_points_list | read | people.show | GET /v1/people/{id}/contact-points | Lists a customer’s contact points, with pagination and filters by channel and status. |
dunning_contact_points_create | write | people.update | POST /v1/people/{id}/contact-points | Creates a contact point for the customer. |
dunning_contact_points_update | write | people.update | PATCH /v1/people/{id}/contact-points/{cpId} | Updates a contact point’s label/primary/verification and lets you manually set/clear opt-out and third-party flags. |
dunning_contact_points_delete | destructive | people.update | DELETE /v1/people/{id}/contact-points/{cpId} | Soft-deletes a contact point. |
Charges
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
dunning_charges_list | read | charges.list | GET /v1/charges | Lists the organization’s charges with pagination and filters. |
dunning_charges_create | write | charges.create | POST /v1/charges | Creates a charge for a customer. |
dunning_charges_get | read | charges.show | GET /v1/charges/{id} | Returns a charge by ID. |
dunning_charges_update | write | charges.update | PUT /v1/charges/{id} | Updates a charge’s data (partial). |
dunning_charges_delete | destructive | charges.delete | DELETE /v1/charges/{id} | Soft-deletes a charge along with related tasks and offers. |
dunning_charges_settlement_pdf | read | charges.show | GET /v1/charges/{id}/settlement-pdf | Generates the charge’s settlement letter as a PDF (legal document), scoped to the organization. |
dunning_charges_bulk_cancel | destructive | charges.update | POST /v1/charges/bulk-cancel | Cancels up to 100 charges in one call. |
dunning_charges_bulk_assign_rule | destructive | charges.update | POST /v1/charges/bulk-assign-rule | Applies a collection rule to up to 100 charges. |
dunning_charges_bulk_archive | destructive | charges.delete | POST /v1/charges/bulk-archive | Archives (soft delete) up to 100 charges in one call, cascading to related tasks and offers. |
dunning_charges_notify | destructive | charges.notify | POST /v1/charges/{id}/notify | Creates a manual notification for the charge and queues it for processing. |
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.