Negociación y disputas
Acuerdos de pago y sus cuotas, campañas de descuento ofrecidas en el portal del deudor y las impugnaciones abiertas contra cobros.
Familias en esta página
| Familia | Tools | read | write | destructive |
|---|---|---|---|---|
agreements — Acuerdos | 10 | 4 | 3 | 3 |
negotiation_campaigns — Campañas de negociación | 3 | 1 | 0 | 2 |
disputes — Disputas | 4 | 2 | 1 | 1 |
Acuerdos
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_agreements_list | read | agreements.list | GET /v1/agreements | Lists the organization’s agreements with pagination and filters. |
dunning_agreements_create | write | agreements.create | POST /v1/agreements | Creates an agreement with proposed status. |
dunning_agreements_get | read | agreements.show | GET /v1/agreements/{id} | Returns an agreement by ID (always includes summarized customer data). |
dunning_agreements_update | write | agreements.update | PUT /v1/agreements/{id} | Updates an agreement (partial). |
dunning_agreements_delete | destructive | agreements.cancel | DELETE /v1/agreements/{id} | Soft-deletes an agreement, marking it cancelled. |
dunning_agreements_accept | destructive | agreements.update | POST /v1/agreements/{id}/accept | Accepts a proposed agreement (409 for other statuses): records accepted_at/accepted_ip and creates the installments with monthly due dates starting at first_due_date. |
dunning_agreements_cancel | destructive | agreements.cancel | POST /v1/agreements/{id}/cancel | Cancels an agreement, recording cancelled_at and the reason, and cancels pending/overdue installments. |
dunning_agreements_pdf | read | agreements.show | GET /v1/agreements/{id}/pdf | Generates the agreement term as a PDF (legal document) with creditor, debtor, totals and installments, scoped to the organization. |
dunning_agreements_installments_list | read | agreements.show | GET /v1/agreements/{id}/installments | Lists an agreement’s installments (ordered by number) with an aggregated summary. |
dunning_agreements_installments_update | write | agreements.update | PUT /v1/agreements/{id}/installments | Updates an installment (payment/status). |
Campañas de negociación
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_negotiation_campaigns_list | read | agreements.list | GET /v1/negotiation-campaigns | Lists the organization’s negotiation campaigns (active and ended), newest first. |
dunning_negotiation_campaigns_create | destructive | agreements.create | POST /v1/negotiation-campaigns | Creates and activates a discount campaign. |
dunning_negotiation_campaigns_delete | destructive | agreements.cancel | DELETE /v1/negotiation-campaigns/{id} | Ends the campaign (deactivates; activated_at becomes null). |
Disputas
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
dunning_disputes_list | read | disputes.list | GET /v1/disputes | Lists the organization’s disputes, ordered by opening date (newest first). |
dunning_disputes_create | write | disputes.create | POST /v1/disputes | Opens a dispute against a charge and immediately pauses the collection rule. |
dunning_disputes_get | read | disputes.show | GET /v1/disputes/{id} | Returns a dispute by ID, with the full charge, customer and assignee. |
dunning_disputes_update | destructive | disputes.resolve | PATCH /v1/disputes/{id} | Runs a workflow action on the dispute: start_review, resolve or cancel. |
Los campos de cada recurso están en la Referencia de la API.
Una tool que no puedes ejecutar no aparece en tools/list. Si falta alguna de esta página, ve Autenticación.