Negociação e disputas

Acordos de pagamento e suas parcelas, campanhas de desconto oferecidas no portal do devedor e as contestações abertas contra cobranças.

Famílias nesta página

Família	Tools	read	write	destructive
agreements — Acordos	10	4	3	3
negotiation_campaigns — Campanhas de negociação	3	1	0	2
disputes — Disputas	4	2	1	1

Acordos

Tool	Tipo	Permissão	Endpoint	O que faz
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).

Campanhas de negociação

Tool	Tipo	Permissão	Endpoint	O que faz
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	Permissão	Endpoint	O que faz
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.

---

Os campos de cada recurso estão na Referência da API.

Uma tool que você não pode rodar não aparece em tools/list. Se faltar alguma desta página, veja Autenticação.