Pular para o conteúdo principal

Plataforma e dados

A identidade da conexão, os indicadores de recuperação, importações e exportações, a trilha de auditoria e os webhooks.

Famílias nesta página​

FamíliaToolsreadwritedestructive
me — Identidade da conexão1100
metrics — Indicadores1100
imports — Importações3210
exports — Exportações5410
audit_logs — Trilha de auditoria1100
webhook_endpoints — Webhooks9324

Identidade da conexão​

ToolTipoPermissãoEndpointO que faz
dunning_mereadqualquer tokenGET /v1/meReturns who owns the Bearer token sent.

Indicadores​

ToolTipoPermissãoEndpointO que faz
dunning_metrics_recoveryreaddashboard.viewGET /v1/metrics/recoveryReturns the period’s recovery metrics (default: last 6 months, counted from the first day of the starting month).

Importações​

ToolTipoPermissãoEndpointO que faz
dunning_imports_listreadimports.listGET /v1/importsHistory of the organization’s 50 most recent imports (no pagination).
dunning_imports_createwriteimports.createPOST /v1/importsUploads a CSV file of customers or charges and queues asynchronous processing.
dunning_imports_getreadimports.showGET /v1/imports/{id}Returns an import’s status with progress counters and per-row rejection errors (errors: [{ line, error }]; line 1 is the header, data starts at line 2).

Exportações​

ToolTipoPermissãoEndpointO que faz
dunning_exports_peoplereadexports.createGET /v1/exports/peopleGenerates and returns the customers CSV inline (text/csv; charset=utf-8 with BOM, Content-Disposition: attachment).
dunning_exports_chargesreadexports.createGET /v1/exports/chargesGenerates and returns the charges CSV inline (text/csv; charset=utf-8 with BOM, Content-Disposition: attachment), with optional status and due-date filters.
dunning_export_jobs_listreadexports.createGET /v1/exports/jobsHistory of the organization’s 50 most recent asynchronous exports (no pagination).
dunning_export_jobs_createwriteexports.createPOST /v1/exports/jobsSchedules CSV generation on a worker, without the 10k-row cap of the synchronous mode and without blocking the request.
dunning_export_jobs_downloadreadexports.createGET /v1/exports/jobs/{id}/downloadServes the generated CSV of an asynchronous export (text/csv; charset=utf-8 with BOM).

Trilha de auditoria​

ToolTipoPermissãoEndpointO que faz
dunning_audit_logs_listreadaudit.listGET /v1/audit-logsLists the organization’s audit trail records (newest first), with filters by action, entity, actor and period.

Webhooks​

ToolTipoPermissãoEndpointO que faz
dunning_webhook_endpoints_listreadwebhooks.listGET /v1/webhook-endpointsLists the organization’s webhook endpoints with delivery counters by status.
dunning_webhook_endpoints_createwritewebhooks.createPOST /v1/webhook-endpointsCreates a webhook endpoint.
dunning_webhook_endpoints_getreadwebhooks.showGET /v1/webhook-endpoints/{id}Returns the endpoint with its latest 20 deliveries.
dunning_webhook_endpoints_updatewritewebhooks.updatePATCH /v1/webhook-endpoints/{id}Updates the endpoint (partial).
dunning_webhook_endpoints_deletedestructivewebhooks.deleteDELETE /v1/webhook-endpoints/{id}Soft-deletes the endpoint; pending deliveries stop being processed.
dunning_webhook_endpoints_rotate_secretdestructivewebhooks.updatePOST /v1/webhook-endpoints/{id}/rotate-secretGenerates a new HMAC secret; the previous one stops validating immediately.
dunning_webhook_endpoints_testdestructivewebhooks.updatePOST /v1/webhook-endpoints/{id}/testDelivers a REAL webhook.test event to the endpoint through the same pipeline as business events (queue, HMAC signature, request/response capture, retry) — validate your consumer end to end without waiting for a real event.
dunning_webhook_deliveries_listreadwebhooks.showGET /v1/webhook-endpoints/{id}/deliveriesLists the endpoint’s deliveries (paginated, newest first) with the request/response capture for inspection and debugging.
dunning_webhook_deliveries_retrydestructivewebhooks.updatePOST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retryRe-queues a delivery for an immediate retry (status resets to pending).

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.