Área técnica
Contratos
api-revenda
| ID | Método | Path | Auth | Resumo | Entradas | Saídas | Tabelas |
|---|---|---|---|---|---|---|---|
E-002 | GET | /api/v1/health | guest | Health da aplicação | [] | ["status"] | |
E-003 | GET | /api/v1/health/ready | guest | Readiness PG Redis disco CDR | [] | ["checks"] | rating.cdr_imports |
E-004 | GET | /metrics | guest | Métricas Prometheus (rede interna) | [] | ["metrics"] | integration.connector_calls |
E-087 | GET | /api/v1/public/customers/{uuid} | bearer-token | Leitura cliente por UUID (Bearer) | ["uuid"] | ["customer"] | customers.customers, customers.subscriptions |
cliente
| ID | Método | Path | Auth | Resumo | Entradas | Saídas | Tabelas |
|---|---|---|---|---|---|---|---|
E-053 | POST | /api/v1/portability-requests | sanctum-cliente | Abre pedido portabilidade | ["numbers", "files"] | ["request"] | customers.portability_requests, customers.portability_files, files.objects |
E-065 | GET | /api/v1/app/dashboard | sanctum-cliente | Início cliente tronco e alertas | [] | ["status", "quota", "alerts"] | customers.subscriptions, telco.sip_accounts, billing.credit_wallets, billing.credit_limits |
E-066 | GET | /api/v1/app/sip | sanctum-cliente | Credenciais SIP | [] | ["credentials"] | telco.sip_accounts |
E-067 | POST | /api/v1/app/sip/rotate-password | sanctum-cliente | Rotaciona senha SIP | [] | ["password_once"] | telco.sip_accounts, integration.outbox |
E-068 | GET | /api/v1/app/usage | sanctum-cliente | Extrato chamadas 30/6 | ["from", "to"] | ["calls"] | rating.rated_calls |
E-069 | GET | /api/v1/app/plan | sanctum-cliente | Plano franquia e excedente | [] | ["plan", "quota"] | catalog.plan_versions, catalog.plan_quotas, customers.subscriptions |
E-070 | POST | /api/v1/app/plan/change | sanctum-cliente | Solicita mudança de plano | ["plan_id"] | ["request"] | customers.subscriptions, catalog.plans |
E-071 | GET | /api/v1/app/credit | sanctum-cliente | Saldo e instruções recarga | [] | ["wallet", "limits"] | billing.credit_wallets, billing.credit_ledger, billing.credit_limits |
E-072 | POST | /api/v1/app/credit/top-up | sanctum-cliente | Recarga manual E4 ou mePay E5 | ["amount_cents"] | ["ledger_entry"] | billing.credit_wallets, billing.credit_ledger, billing.payments |
E-073 | GET | /api/v1/app/invoices | sanctum-cliente | Faturas modo vc1_invoices | [] | ["invoices"] | billing.invoices, fiscal.fiscal_documents |
E-074 | GET | /api/v1/app/blocked | sanctum-cliente | Motivo bloqueio conta | [] | ["reason", "actions"] | telco.block_events, customers.subscriptions |
E-075 | GET | /api/v1/app/trial | sanctum-cliente | Banner teste grátis | [] | ["trial"] | sales.trials, customers.subscriptions |
E-134 | POST | /api/v1/app/invoices/{id}/fiscal-note | sanctum-cliente | Cliente solicita nota fiscal NFCom via mePay | ["id"] | ["fiscal_document"] | billing.invoices, fiscal.fiscal_documents, fiscal.fiscal_attempts, integration.outbox, integration.connector_calls |
E-135 | GET | /api/v1/app/invoices/{id}/fiscal-note | sanctum-cliente | Download nota fiscal (PDF/XML refs) | ["id"] | ["pdf", "xml", "access_key"] | fiscal.fiscal_documents, files.objects |
documentos
| ID | Método | Path | Auth | Resumo | Entradas | Saídas | Tabelas |
|---|---|---|---|---|---|---|---|
E-020 | GET | /api/v1/documents/contracts/{id}/pdf | pin | PDF contrato assinado | ["id"] | ["application/pdf"] | sales.contracts, files.objects |
E-021 | GET | /api/v1/documents/invoices/{id}/pdf | sanctum-cliente | PDF fatura | ["id"] | ["application/pdf"] | billing.invoices, billing.invoice_lines, files.objects |
E-022 | GET | /api/v1/documents/statements/{id}/pdf | sanctum-revenda | PDF extrato tarifado revenda | ["id"] | ["application/pdf"] | billing.statements, files.objects |
E-023 | GET | /api/v1/documents/payouts/{id}/pdf | sanctum-revenda | PDF demonstrativo de repasse | ["id"] | ["application/pdf"] | billing.payouts, billing.payout_lines, files.objects |
E-024 | GET | /api/v1/documents/fiscal/{id}/danfe | sanctum-cliente | DANFE NFCom autorizada | ["id"] | ["application/pdf"] | fiscal.fiscal_documents, files.objects |
publico
| ID | Método | Path | Auth | Resumo | Entradas | Saídas | Tabelas |
|---|---|---|---|---|---|---|---|
E-001 | GET | /up | guest | Liveness Laravel | [] | ["status"] | |
E-005 | GET | /api/v1/tenancy/branding | guest | Marca da revenda por Host (cache 60s) | ["Host"] | ["slug", "logo_url", "primary_color"] | tenancy.resellers, tenancy.reseller_branding, tenancy.reseller_domains |
E-006 | POST | /api/v1/auth/login | guest | Login revenda ou cliente (tenant via Host) | ["email", "password"] | ["user", "token"] | identity.users, identity.user_roles, identity.roles, tenancy.resellers |
E-009 | POST | /api/v1/auth/forgot-password | guest | Solicita redefinição de senha | ["email"] | ["message"] | identity.users, notifications.messages |
E-010 | POST | /api/v1/auth/reset-password | guest | Redefine senha com token | ["token", "password"] | ["message"] | identity.users |
E-011 | POST | /api/v1/auth/invite/accept | guest | Aceita convite e define senha | ["token", "name", "password"] | ["user"] | identity.users, identity.user_roles |
E-012 | POST | /api/v1/auth/2fa/verify | guest | Verifica TOTP no login | ["code"] | ["session"] | identity.users |
E-014 | POST | /api/v1/public/proposals/{code}/pin | pin | Valida PIN 6 dígitos da proposta | ["pin"] | ["access_cookie"] | sales.proposals, sales.proposal_events |
E-015 | GET | /api/v1/public/proposals/{code} | pin | Detalhe da proposta para prospect | ["code"] | ["proposal", "plan", "pricing"] | sales.proposals, sales.proposal_items, catalog.plans, catalog.plan_versions |
E-016 | POST | /api/v1/public/proposals/{code}/contractor | pin | Cadastro do contratante na proposta | ["customer", "address", "contacts"] | ["customer_id"] | customers.customers, customers.addresses, customers.contacts, sales.proposals |
E-017 | POST | /api/v1/public/proposals/{code}/accept | pin | Aceite comercial dispara meSign | ["terms_accepted"] | ["contract_id", "envelope_id"] | sales.proposals, sales.contracts, sales.signature_envelopes, integration.outbox |
E-018 | GET | /api/v1/public/proposals/{code}/activation | pin | Status da ativação pós-assinatura | [] | ["steps"] | customers.subscriptions, telco.sip_accounts, telco.dids |
E-019 | GET | /api/v1/documents/proposals/{id}/pdf | pin | PDF proposta comercial A4 | ["id"] | ["application/pdf"] | sales.proposals, sales.proposal_items, files.objects |
revenda
| ID | Método | Path | Auth | Resumo | Entradas | Saídas | Tabelas |
|---|---|---|---|---|---|---|---|
E-007 | POST | /api/v1/auth/logout | sanctum-revenda | Encerra sessão Sanctum | [] | [] | |
E-008 | GET | /api/v1/auth/me | sanctum-revenda | Usuário autenticado e papéis | [] | ["user", "roles"] | identity.users, identity.user_roles, identity.roles |
E-013 | POST | /api/v1/auth/2fa/setup | sanctum-revenda | Configura 2FA TOTP | ["secret"] | ["recovery_codes"] | identity.users |
E-025 | GET | /api/v1/proposals | sanctum-revenda | Lista propostas com filtros | ["stage", "seller"] | ["proposals"] | sales.proposals, sales.proposal_items |
E-026 | GET | /api/v1/proposals/kanban | sanctum-revenda | Colunas kanban lead/negotiating/won/lost | [] | ["columns"] | sales.proposals |
E-027 | POST | /api/v1/proposals | sanctum-revenda | Cria proposta (wizard) | ["customer", "plan", "items"] | ["proposal"] | sales.proposals, sales.proposal_items, catalog.plans |
E-028 | GET | /api/v1/proposals/{id} | sanctum-revenda | Detalhe proposta e timeline | ["id"] | ["proposal", "events"] | sales.proposals, sales.proposal_events |
E-029 | PATCH | /api/v1/proposals/{id} | sanctum-revenda | Atualiza estágio ou prorroga | ["stage", "valid_until"] | ["proposal"] | sales.proposals, sales.proposal_events |
E-030 | POST | /api/v1/proposals/{id}/share | sanctum-revenda | Emite link público e PIN SMS | ["id"] | ["public_code", "pin_sent"] | sales.proposals, notifications.messages, integration.outbox |
E-031 | POST | /api/v1/proposals/{id}/cancel | sanctum-revenda | Cancela proposta | ["reason"] | ["proposal"] | sales.proposals, sales.proposal_events |
E-032 | GET | /api/v1/plans | sanctum-revenda | Lista planos da revenda | [] | ["plans"] | catalog.plans, catalog.plan_versions |
E-033 | POST | /api/v1/plans | sanctum-revenda | Cria pacote ou consumo mínimo | ["kind", "quotas", "pricing"] | ["plan"] | catalog.plans, catalog.plan_versions, catalog.plan_quotas, pricing.reseller_tier_rows |
E-034 | GET | /api/v1/plans/{id} | sanctum-revenda | Detalhe plano e margem cenários | ["id"] | ["plan", "margin_scenarios"] | catalog.plans, catalog.plan_versions, catalog.plan_quotas |
E-035 | PATCH | /api/v1/plans/{id} | sanctum-revenda | Atualiza plano | ["fields"] | ["plan"] | catalog.plans, catalog.plan_versions |
E-036 | GET | /api/v1/suggested-packages | sanctum-revenda | Pacotes sugeridos VC1 | [] | ["packages"] | catalog.suggested_packages |
E-037 | POST | /api/v1/suggested-packages/{id}/clone | sanctum-revenda | Clona pacote sugerido | ["id"] | ["plan"] | catalog.suggested_packages, catalog.plans |
E-038 | GET | /api/v1/reseller-tier-rows | sanctum-revenda | Tabela de faixas markup revenda | [] | ["rows"] | pricing.reseller_tier_tables, pricing.reseller_tier_rows, pricing.vc1_tiers |
E-039 | PATCH | /api/v1/reseller-tier-rows/{id} | sanctum-revenda | Edita linha de faixa revenda | ["markup", "offered"] | ["row"] | pricing.reseller_tier_rows |
E-040 | GET | /api/v1/customers | sanctum-revenda | Lista clientes da revenda | ["status", "plan"] | ["customers"] | customers.customers, customers.subscriptions |
E-041 | POST | /api/v1/customers | sanctum-revenda | Novo cliente venda direta (proposta interna) | ["customer", "plan"] | ["customer", "proposal"] | customers.customers, sales.proposals |
E-042 | GET | /api/v1/customers/{uuid} | sanctum-revenda | Resumo do cliente | ["uuid"] | ["customer", "subscription"] | customers.customers, customers.subscriptions, customers.contacts |
E-043 | PATCH | /api/v1/customers/{uuid} | sanctum-revenda | Atualiza dados do cliente | ["fields"] | ["customer"] | customers.customers, customers.addresses |
E-044 | GET | /api/v1/customers/{uuid}/usage | sanctum-revenda | Consumo e extrato tarifado | ["uuid", "cycle"] | ["calls", "quota"] | rating.rated_calls, rating.usage_records, catalog.plan_quotas |
E-045 | GET | /api/v1/customers/{uuid}/finance | sanctum-revenda | Financeiro do cliente por billing_mode | ["uuid"] | ["invoices", "statements", "wallet"] | billing.invoices, billing.statements, billing.credit_wallets |
E-046 | GET | /api/v1/customers/{uuid}/history | sanctum-revenda | Bloqueios e eventos | ["uuid"] | ["blocks", "events"] | telco.block_events, audit.audit_log |
E-047 | GET | /api/v1/customers/{uuid}/telephony | sanctum-revenda | SIP DIDs e canais | ["uuid"] | ["sip", "dids", "channels"] | telco.sip_accounts, telco.dids, telco.channel_allocations |
E-048 | POST | /api/v1/customers/{uuid}/dids | sanctum-revenda | Adiciona DID com pró-rata | ["did_id"] | ["allocation"] | telco.dids, telco.channel_allocations, billing.invoice_lines, integration.outbox |
E-049 | PATCH | /api/v1/customers/{uuid}/channels | sanctum-revenda | Altera canais com pró-rata | ["quantity"] | ["allocation"] | telco.channel_allocations, telco.channel_changes, integration.outbox |
E-050 | GET | /api/v1/dids | sanctum-revenda | Estoque DIDs por cidade | ["area_code"] | ["dids"] | telco.dids, integration.legacy_id_map |
E-051 | POST | /api/v1/dids/{id}/reserve | sanctum-revenda | Reserva DID para cliente | ["customer_id"] | ["did"] | telco.dids |
E-052 | GET | /api/v1/portability-requests | sanctum-revenda | Fila portabilidade revenda | [] | ["requests"] | customers.portability_requests |
E-054 | GET | /api/v1/portability-requests/{id} | sanctum-revenda | Detalhe portabilidade | ["id"] | ["request"] | customers.portability_requests, customers.portability_files |
E-055 | GET | /api/v1/activations | sanctum-revenda | Fila provisionamento | [] | ["queue"] | customers.subscriptions, integration.outbox, integration.connector_calls |
E-056 | POST | /api/v1/activations/{id}/retry | sanctum-revenda | Reprocessa provisionamento | ["id"] | ["status"] | integration.outbox, integration.connector_calls |
E-057 | GET | /api/v1/invoices | sanctum-revenda | Faturas VC1 para revenda ou clientes | ["party"] | ["invoices"] | billing.invoices |
E-058 | GET | /api/v1/invoices/{id} | sanctum-revenda | Detalhe fatura | ["id"] | ["invoice", "lines", "payments"] | billing.invoices, billing.invoice_lines, billing.payments |
E-059 | GET | /api/v1/statements | sanctum-revenda | Extratos modo revenda fatura | ["cycle"] | ["statements"] | billing.statements |
E-060 | GET | /api/v1/statements/{id}/export | sanctum-revenda | Export CSV/PDF extrato | ["format"] | ["file_url"] | billing.statements, files.objects |
E-061 | GET | /api/v1/payouts | sanctum-revenda | Repasses da revenda | [] | ["payouts"] | billing.payouts |
E-062 | GET | /api/v1/payouts/{id} | sanctum-revenda | Detalhe repasse | ["id"] | ["payout", "lines"] | billing.payouts, billing.payout_lines |
E-063 | POST | /api/v1/payouts/{id}/commission-invoice | sanctum-revenda | Envia nota de comissão | ["file"] | ["commission_invoice"] | billing.commission_invoices, files.objects |
E-064 | GET | /api/v1/reseller/account | sanctum-revenda | Minha conta VC1 faixa e consumo | [] | ["tier", "usage", "billing_mode"] | tenancy.resellers, tenancy.reseller_contracts, rating.cycles |
E-076 | GET | /api/v1/users | sanctum-revenda | Usuários equipe revenda | [] | ["users"] | identity.users, identity.user_roles, customers.customer_users |
E-077 | POST | /api/v1/users/invite | sanctum-revenda | Convida usuário | ["email", "role"] | ["invitation"] | identity.users, notifications.messages |
E-078 | PATCH | /api/v1/profile | sanctum-revenda | Atualiza perfil e senha | ["fields"] | ["user"] | identity.users |
E-079 | GET | /api/v1/notifications | sanctum-revenda | Notificações in-app | [] | ["notifications"] | notifications.messages, notifications.opt_outs |
E-080 | PATCH | /api/v1/notifications/preferences | sanctum-revenda | Preferências alertas | ["channels"] | ["prefs"] | notifications.opt_outs, tenancy.reseller_settings |
E-081 | GET | /api/v1/branding | sanctum-revenda | Marca atual revenda | [] | ["branding"] | tenancy.reseller_branding |
E-082 | PATCH | /api/v1/branding | sanctum-revenda | Atualiza logo cores fantasia | ["logo", "colors"] | ["branding"] | tenancy.reseller_branding, files.objects |
E-083 | GET | /api/v1/reports/summary | sanctum-revenda | Relatórios minutos margem funil | ["report", "cycle"] | ["data"] | rating.rated_calls, sales.proposals, billing.payouts |
E-084 | GET | /api/v1/api-tokens | sanctum-revenda | Lista tokens Bearer revenda | [] | ["tokens"] | identity.api_tokens |
E-085 | POST | /api/v1/api-tokens | sanctum-revenda | Cria token API | ["name", "abilities"] | ["token_prefix"] | identity.api_tokens |
E-086 | DELETE | /api/v1/api-tokens/{id} | sanctum-revenda | Revoga token | ["id"] | [] | identity.api_tokens |
vc1
| ID | Método | Path | Auth | Resumo | Entradas | Saídas | Tabelas |
|---|---|---|---|---|---|---|---|
E-090 | GET | /admin/login | filament-staff | Login equipe Filament | ["email", "password"] | ["session"] | identity.users |
E-091 | GET | / | filament-staff | Dashboard visão geral | [] | ["kpis"] | billing.invoices, rating.cycles, integration.reconciliation_runs, billing.limit_events |
E-092 | GET | /admin/resellers | filament-staff | Lista revendas | ["filters"] | ["resellers"] | tenancy.resellers, tenancy.stfc_licenses |
E-093 | POST | /admin/resellers | filament-staff | Cadastro revenda wizard | ["reseller"] | ["reseller"] | tenancy.resellers, tenancy.reseller_domains, tenancy.reseller_contracts, pricing.reseller_tier_tables, integration.outbox |
E-094 | GET | /admin/resellers/{id} | filament-staff | Dados revenda | ["id"] | ["reseller"] | tenancy.resellers, customers.contacts |
E-095 | PUT | /admin/resellers/{id} | filament-staff | Edita revenda suspende | ["id", "status"] | ["reseller"] | tenancy.resellers, audit.audit_log |
E-096 | GET | /admin/resellers/{id}/contract | filament-staff | Contrato e faixa revenda | ["id"] | ["contract"] | tenancy.reseller_contracts, pricing.vc1_tiers |
E-097 | GET | /admin/resellers/{id}/billing-mode | filament-staff | Modo cobrança STFC | ["id"] | ["billing_mode", "stfc"] | tenancy.resellers, tenancy.stfc_licenses, files.objects |
E-098 | GET | /admin/resellers/{id}/branding | filament-staff | Marca domínio revenda | ["id"] | ["branding"] | tenancy.reseller_branding, tenancy.reseller_domains |
E-099 | GET | /admin/resellers/{id}/users | filament-staff | Usuários revenda | ["id"] | ["users"] | identity.users, identity.user_roles |
E-100 | GET | /admin/resellers/{id}/customers | filament-staff | Clientes da revenda | ["id"] | ["customers"] | customers.customers, customers.subscriptions |
E-101 | GET | /admin/resellers/{id}/invoices | filament-staff | Faturas revenda | ["id"] | ["invoices"] | billing.invoices |
E-102 | GET | /admin/resellers/{id}/payouts | filament-staff | Repasses revenda | ["id"] | ["payouts"] | billing.payouts |
E-103 | GET | /admin/resellers/{id}/credit | filament-staff | Crédito limite revenda | ["id"] | ["wallet", "limits"] | billing.credit_wallets, billing.credit_limits, billing.limit_events |
E-104 | GET | /admin/resellers/{id}/audit | filament-staff | Auditoria revenda | ["id"] | ["logs"] | audit.audit_log |
E-105 | GET | /admin/price-bases | filament-staff | Bases de preços | [] | ["bases"] | pricing.price_bases, pricing.price_base_versions |
E-106 | GET | /admin/price-bases/{version}/tiers | filament-staff | Editor faixas VC1 | ["version"] | ["tiers"] | pricing.vc1_tiers, pricing.price_base_version_rows |
E-107 | POST | /admin/price-bases/{version}/publish | filament-staff | Publicar vigência base preços | ["effective_at"] | ["version"] | pricing.price_base_versions, audit.audit_log |
E-108 | GET | /admin/suggested-packages | filament-staff | Pacotes sugeridos VC1 | [] | ["packages"] | catalog.suggested_packages |
E-109 | GET | /admin/suggested-packages/{id}/edit | filament-staff | Editor pacote sugerido | ["id"] | ["package"] | catalog.suggested_packages, catalog.plan_quotas |
E-110 | GET | /admin/customers | filament-staff | Clientes finais global | ["filters"] | ["customers"] | customers.customers |
E-111 | GET | /admin/customers/{id} | filament-staff | Assinatura cliente staff | ["id"] | ["subscription"] | customers.subscriptions, telco.sip_accounts, telco.dids, integration.legacy_id_map |
E-112 | GET | /admin/dids | filament-staff | Estoque números DIDs | [] | ["dids"] | telco.dids |
E-113 | GET | /admin/portability-requests | filament-staff | Portabilidade ops | [] | ["requests"] | customers.portability_requests |
E-114 | GET | /admin/usage | filament-staff | Uso CDR tarifado | ["cycle"] | ["calls"] | rating.rated_calls, rating.usage_records |
E-115 | GET | /admin/reconciliation | filament-staff | Reconciliação CDR | [] | ["runs"] | integration.reconciliation_runs, rating.cdr_imports |
E-116 | GET | /admin/cycles/{month} | filament-staff | Prévia fechamento ciclo | ["month"] | ["preview"] | rating.cycles, billing.cycle_runs |
E-117 | POST | /admin/cycles/{month}/issue | filament-staff | Emissão fechamento faturas NFCom | ["month"] | ["progress"] | billing.cycle_runs, billing.invoices, fiscal.fiscal_documents, integration.outbox |
E-118 | GET | /admin/invoices/resellers | filament-staff | Faturas para revendas | [] | ["invoices"] | billing.invoices |
E-119 | GET | /admin/invoices/customers | filament-staff | Faturas clientes vc1_invoices | [] | ["invoices"] | billing.invoices |
E-120 | GET | /admin/invoices/{id} | filament-staff | Detalhe fatura staff | ["id"] | ["invoice"] | billing.invoices, billing.invoice_lines, billing.payments, fiscal.fiscal_documents |
E-121 | GET | /admin/fiscal-documents | filament-staff | Monitor NFCom | [] | ["documents"] | fiscal.fiscal_documents, fiscal.fiscal_attempts |
E-122 | GET | /admin/payouts | filament-staff | Repasses ciclo | [] | ["payouts"] | billing.payouts |
E-123 | GET | /admin/payouts/{id} | filament-staff | Detalhe repasse staff | ["id"] | ["payout"] | billing.payouts, billing.payout_adjustments, billing.commission_invoices |
E-124 | GET | /admin/credit | filament-staff | Crédito limites global | [] | ["wallets"] | billing.credit_wallets, billing.credit_limits |
E-125 | GET | /admin/blocks | filament-staff | Bloqueios telco | [] | ["blocks"] | telco.block_events, customers.subscriptions |
E-126 | POST | /admin/blocks/{id}/unblock | filament-staff | Desbloqueio manual com justificativa | ["reason"] | ["block"] | telco.block_events, audit.audit_log, integration.outbox |
E-127 | GET | /admin/connectors | filament-staff | Saúde conectores | [] | ["health"] | integration.connector_calls, integration.outbox |
E-128 | GET | /admin/staff | filament-staff | Equipe papéis VC1 | [] | ["users"] | identity.users, identity.roles, identity.role_permissions, identity.permissions |
E-129 | GET | /admin/audit-log | filament-staff | Auditoria global | ["filters"] | ["logs"] | audit.audit_log |
E-130 | GET | /admin/settings | filament-staff | Configurações plataforma | [] | ["settings"] | tenancy.reseller_settings, rating.cycles |
E-131 | GET | /admin/templates | filament-staff | Modelos contrato e-mail SMS | [] | ["templates"] | notifications.templates |
E-132 | POST | /admin/resellers/{id}/impersonate | filament-staff | Ver como revenda | ["reason"] | ["session"] | identity.impersonation_sessions, audit.audit_log |
E-133 | GET | /admin/stfc-licenses | filament-staff | Validações STFC | [] | ["licenses"] | tenancy.stfc_licenses, files.objects |
webhook
| ID | Método | Path | Auth | Resumo | Entradas | Saídas | Tabelas |
|---|---|---|---|---|---|---|---|
E-088 | POST | /api/v1/webhooks/paco-assign | hmac | Webhook meSign envelope completed/archived | ["body", "X-Paco-Signature"] | ["200"] | integration.inbox_webhooks, sales.signature_envelopes, sales.contracts, integration.outbox |
E-089 | POST | /api/v1/webhooks/mepay | hmac | Webhook mePay invoice.paid + fiscal.issued/failed | ["body", "webhook-id", "webhook-timestamp", "webhook-signature"] | ["200"] | integration.inbox_webhooks, billing.payments, billing.invoices, fiscal.fiscal_documents, fiscal.fiscal_attempts |
Eventos
| ID | Nome | Producer | Consumers | Payload | Tabelas |
|---|---|---|---|---|---|
V-001 | ResellerProvisionRequested | Tenancy | ["Integration"] | ["reseller_id"] | tenancy.resellers, integration.outbox, integration.legacy_id_map |
V-002 | ProposalShared | Sales | ["Notifications"] | ["proposal_id", "public_code"] | sales.proposals, notifications.messages, integration.outbox |
V-003 | ProposalAccepted | Sales | ["Sales", "Integration"] | ["proposal_id", "contract_id"] | sales.proposals, sales.contracts, integration.outbox |
V-004 | SignatureEnvelopeCompleted | Sales | ["Customers", "Integration"] | ["envelope_id"] | sales.signature_envelopes, sales.contracts, integration.inbox_webhooks |
V-005 | SubscriptionActivated | Customers | ["Telco", "Integration"] | ["subscription_id"] | customers.subscriptions, integration.outbox, telco.sip_accounts |
V-006 | CdrImported | Rating | ["Rating"] | ["import_id", "count"] | rating.cdr_imports, rating.usage_records |
V-007 | CallRated | Rating | ["Billing"] | ["rated_call_id"] | rating.rated_calls, billing.credit_ledger |
V-008 | CreditThresholdReached | Billing | ["Notifications", "Telco"] | ["subscription_id", "threshold"] | billing.limit_events, notifications.messages, integration.outbox |
V-009 | TelcoBlockRequested | Telco | ["Integration"] | ["subscription_id", "reason"] | telco.block_events, integration.outbox |
V-010 | CycleClosed | Rating | ["Billing"] | ["cycle_id"] | rating.cycles, billing.cycle_runs |
V-011 | InvoiceIssued | Billing | ["Fiscal", "Integration"] | ["invoice_id"] | billing.invoices, billing.invoice_lines, fiscal.fiscal_documents, integration.outbox |
V-012 | PaymentRecorded | Billing | ["Billing", "Telco"] | ["payment_id"] | billing.payments, billing.invoices, billing.dunning_events |
V-013 | FiscalDocumentAuthorized | Fiscal | ["Notifications"] | ["fiscal_document_id"] | fiscal.fiscal_documents, fiscal.fiscal_attempts |
V-014 | PayoutCalculated | Billing | ["Notifications"] | ["payout_id"] | billing.payouts, billing.payout_lines, billing.payout_adjustments |
V-015 | StfcExpiryAlert | Tenancy | ["Notifications"] | ["reseller_id", "days_left"] | tenancy.stfc_licenses, notifications.messages |
V-016 | WebhookReceived | Integration | ["Application"] | ["provider", "event_id"] | integration.inbox_webhooks |
V-017 | ConnectorCallLogged | Integration | ["Audit"] | ["port", "operation"] | integration.connector_calls |
V-018 | ReconciliationCompleted | Integration | ["Audit"] | ["run_id"] | integration.reconciliation_runs, rating.rated_calls |
V-019 | ImpersonationStarted | Identity | ["Audit"] | ["staff_user_id", "reseller_id"] | identity.impersonation_sessions, audit.audit_log |
V-020 | LabWriteRefused | Integration | ["Audit"] | ["legacy_id"] | integration.lab_allowlist, integration.connector_calls |
V-021 | DunningStepSent | Billing | ["Notifications"] | ["invoice_id", "step"] | billing.dunning_events, notifications.messages |
V-022 | PortabilityFileUploaded | Customers | ["Files"] | ["request_id"] | customers.portability_files, files.objects |
V-023 | PlanVersionPublished | Catalog | ["Sales"] | ["plan_id"] | catalog.plans, catalog.plan_versions |
V-024 | ResellerTierTableUpdated | Pricing | ["Catalog"] | ["reseller_id"] | pricing.reseller_tier_tables, pricing.reseller_tier_rows |
V-025 | TrialStarted | Sales | ["Customers", "Integration"] | ["trial_id"] | sales.trials, customers.subscriptions, integration.outbox |
V-026 | CommissionInvoiceReceived | Billing | ["Billing"] | ["payout_id"] | billing.commission_invoices, files.objects |
V-027 | PaymentMethodUpdated | Billing | ["Integration"] | ["customer_id"] | billing.payment_methods |
V-028 | DestinationPrefixUpdated | Rating | ["Rating"] | [] | rating.destination_prefixes, catalog.destinations |
V-029 | AuditLogWritten | Audit | ["Audit"] | ["action"] | audit.audit_log |
V-030 | OutboxMessagePublished | Integration | ["Integration"] | ["event_type"] | integration.outbox |
V-031 | ProposalItemChanged | Sales | ["Sales"] | ["proposal_id"] | sales.proposal_items |
V-032 | ChannelChangeRecorded | Telco | ["Billing"] | ["subscription_id"] | telco.channel_changes, billing.invoice_lines |
V-033 | CustomerUserLinked | Customers | ["Identity"] | ["customer_id", "user_id"] | customers.customer_users, identity.users |
V-034 | RolePermissionChanged | Identity | ["Identity"] | ["role_id"] | identity.roles, identity.permissions, identity.role_permissions |
V-035 | ResellerSettingsChanged | Tenancy | ["Tenancy"] | ["reseller_id"] | tenancy.reseller_settings |
V-036 | NegativeMarginAcknowledged | Catalog | ["Audit"] | ["plan_id"] | catalog.plans, audit.audit_log |
V-037 | InvoiceLineAdded | Billing | ["Billing"] | ["invoice_id"] | billing.invoice_lines |
V-038 | UsageRecordCreated | Rating | ["Rating"] | ["usage_record_id"] | rating.usage_records, rating.rated_calls |
V-039 | PlanTrialRuleApplied | Catalog | ["Sales"] | ["plan_version_id"] | catalog.plan_trial_rules, sales.trials |
V-040 | FiscalNoteRequested | Fiscal | ["Integration"] | ["fiscal_document_id", "invoice_id"] | fiscal.fiscal_documents, integration.outbox |
V-041 | FiscalNoteIssued | Fiscal | ["Notifications"] | ["fiscal_document_id", "access_key"] | fiscal.fiscal_documents, files.objects |
V-042 | FiscalNoteFailed | Fiscal | ["Notifications"] | ["fiscal_document_id", "error_code"] | fiscal.fiscal_documents, fiscal.fiscal_attempts |
Integrações
| ID | Nome | Direção | Entradas | Saídas | Status |
|---|---|---|---|---|---|
I-001 | ERP legado (easy_cicerone white_label) | out | [] | ["cadastro_total_tronco", "block", "DIDs"] | confirmado |
I-002 | SipPulse SOAP | out | [] | ["insertSubscriber", "blockOutgoingCalls"] | confirmado |
I-003 | SipPulse CDR (MySQL reports) | in | ["cdrs_report rows"] | [] | a confirmar |
I-004 | mePay (cobrança + fiscal NFCom) | both | ["invoice.paid webhooks", "fiscal.issued webhooks (a criar no mePay)", "fiscal.failed webhooks (a criar no mePay)"] | ["upsertCustomer", "createInvoice adhoc", "createCharge", "requestFiscalNote"] | confirmado |
I-005 | SyncNFe NFCom (supersedido ADR-013) | out | [] | [] | supersedido |
I-006 | meSign | both | ["envelope.completed webhook"] | ["POST /api/v1/envelopes"] | confirmado |
I-007 | meDNS PowerDNS | out | [] | ["ACME TXT", "zone records"] | confirmado |
I-008 | SMTP/SMS | out | [] | ["transactional messages"] | confirmado |