Saltar al contenido principal

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​

FamiliaToolsreadwritedestructive
agreements — Acuerdos10433
negotiation_campaigns — Campañas de negociación3102
disputes — Disputas4211

Acuerdos​

ToolTipoPermisoEndpointQué hace
dunning_agreements_listreadagreements.listGET /v1/agreementsLists the organization’s agreements with pagination and filters.
dunning_agreements_createwriteagreements.createPOST /v1/agreementsCreates an agreement with proposed status.
dunning_agreements_getreadagreements.showGET /v1/agreements/{id}Returns an agreement by ID (always includes summarized customer data).
dunning_agreements_updatewriteagreements.updatePUT /v1/agreements/{id}Updates an agreement (partial).
dunning_agreements_deletedestructiveagreements.cancelDELETE /v1/agreements/{id}Soft-deletes an agreement, marking it cancelled.
dunning_agreements_acceptdestructiveagreements.updatePOST /v1/agreements/{id}/acceptAccepts 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_canceldestructiveagreements.cancelPOST /v1/agreements/{id}/cancelCancels an agreement, recording cancelled_at and the reason, and cancels pending/overdue installments.
dunning_agreements_pdfreadagreements.showGET /v1/agreements/{id}/pdfGenerates the agreement term as a PDF (legal document) with creditor, debtor, totals and installments, scoped to the organization.
dunning_agreements_installments_listreadagreements.showGET /v1/agreements/{id}/installmentsLists an agreement’s installments (ordered by number) with an aggregated summary.
dunning_agreements_installments_updatewriteagreements.updatePUT /v1/agreements/{id}/installmentsUpdates an installment (payment/status).

Campañas de negociación​

ToolTipoPermisoEndpointQué hace
dunning_negotiation_campaigns_listreadagreements.listGET /v1/negotiation-campaignsLists the organization’s negotiation campaigns (active and ended), newest first.
dunning_negotiation_campaigns_createdestructiveagreements.createPOST /v1/negotiation-campaignsCreates and activates a discount campaign.
dunning_negotiation_campaigns_deletedestructiveagreements.cancelDELETE /v1/negotiation-campaigns/{id}Ends the campaign (deactivates; activated_at becomes null).

Disputas​

ToolTipoPermisoEndpointQué hace
dunning_disputes_listreaddisputes.listGET /v1/disputesLists the organization’s disputes, ordered by opening date (newest first).
dunning_disputes_createwritedisputes.createPOST /v1/disputesOpens a dispute against a charge and immediately pauses the collection rule.
dunning_disputes_getreaddisputes.showGET /v1/disputes/{id}Returns a dispute by ID, with the full charge, customer and assignee.
dunning_disputes_updatedestructivedisputes.resolvePATCH /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.