DocSend API
Módulo predefinido
DocSend API
Módulo predefinido
DocSend API
Copiar Página
Raiz
Usuários
Buscar usuário por ID
Atualizar usuário
Excluir usuário
Listar usuários
Criar usuário
Listar usuários root/suporte
Listar usuários das organizações
Listar usuários internos
Usuários Clientes
Buscar usuário cliente por ID
Atualizar usuário cliente
Excluir usuário cliente
Listar usuários clientes
Criar usuário cliente
Vincular clientes ao usuário
Buscar resumo de usuários clientes
Desvincular cliente do usuário
Tipos de Documentos
Buscar tipo de documento global por ID
Atualizar tipo de documento global
Excluir tipo de documento global
Atualizar tipo de documento do cliente
Excluir tipo de documento do cliente
Listar tipos de documentos globais
Criar tipo de documento global
Listar tipos de documentos do cliente
Criar tipo de documento do cliente
Listar tipos de documentos globais ativos
Listar tipos de documentos disponíveis para documento extra
Buscar tipo de documento do cliente por ID
Temas
Obter tema customizado
Atualizar tema customizado
Criar tema customizado
Remover tema customizado
Listar temas pré-definidos
Obter tema atual
Solicitações
Obter detalhes da solicitação
Atualizar solicitação
Remover solicitação
Alternar automação
Atualizar documento
Remover documento
Criar solicitação
Adicionar documento
Justificar ausência
Listar minhas solicitações
Listar meus documentos extras
Listar solicitações do cliente
Listar solicitações pendentes
Painel admin
Planos
Buscar plano por ID
Atualizar plano
Excluir plano
Listar planos
Criar plano
Desativar plano
Ativar plano
Listar planos ativos
Pastas
Renomear pasta
Excluir pasta
Listar pastas padrão do cliente
Atualizar pasta padrão do cliente
Excluir pasta padrão do cliente
Criar pasta
Salvar pasta como padrão
Obter conteúdo da pasta
Obter caminho completo
Listar pastas do cliente
Listar pastas para seleção
Obrigações
Buscar obrigação por ID
Atualizar obrigação
Remover obrigação
Listar obrigações
Criar obrigação
Ativar/desativar obrigação
Buscar estatísticas de obrigações
Listar obrigações com filtros e paginação
Exportar obrigações em PDF
Exportar obrigações em Excel
Exportar obrigações em CSV
Regimes Tributários
Buscar regime por ID
Atualizar regime tributário
Remover regime tributário
Atualizar tempo padrão da obrigação no regime
Listar regimes tributários
Criar regime tributário
Buscar regime com obrigações
Adicionar obrigação ao regime
Gerar relatório de revisão do regime
Buscar regime por código
Remover obrigação do regime
Modelos de Obrigações
Buscar modelo por ID
Atualizar modelo de obrigações
Excluir modelo de obrigações
Listar modelos de obrigações
Criar modelo de obrigações
Estatísticas de modelos
Buscar modelo por regime (ID)
Buscar modelo por código do regime
Departamentos
Buscar departamento por ID
Atualizar departamento
Remover departamento
Listar departamentos
Criar departamento
Enviar e-mail de teste
Listar departamentos em formato hierárquico
Obrigações por Cliente
Listar obrigações do cliente
Atualizar lista de obrigações do cliente
Adicionar obrigação ao cliente
Listar empresas vinculadas a uma obrigação
Adicionar empresa a uma obrigação
Vincular várias empresas a uma obrigação em massa
Criar entregas para obrigação-cliente
Atualizar status de uma obrigação-empresa
Atualizar responsável de uma obrigação-empresa
Buscar responsáveis disponíveis para uma empresa
Remover obrigação do cliente
Notificações
Marcar notificação como lida
Marcar todas como lidas
Registrar push subscription
Remover push subscription
Listar notificações
Contar notificações não lidas
Preferências de Notificação
Listar preferências
Atualizar múltiplas preferências
Obter preferência
Atualizar preferência
Modelos de Documentos
Obter modelo
Atualizar modelo
Remover modelo
Listar modelos
Criar modelo
Listar modelos do tenant
Listar modelos globais
Mapeamentos Tipo-Pasta
Buscar mapeamento global por ID
Atualizar mapeamento global
Excluir mapeamento global
Atualizar mapeamento do cliente
Excluir mapeamento do cliente
Listar mapeamentos globais
Criar mapeamento global
Listar mapeamentos do cliente
Criar mapeamento do cliente
Buscar mapeamento do cliente por ID
LGPD
Corrigir dados pessoais
Acessar meus dados pessoais
Exportar dados pessoais
Excluir conta e dados pessoais
Plano de Contas
Buscar conta por ID
Atualizar conta do plano de contas
Deletar conta do plano de contas
Listar contas do plano de contas
Criar conta no plano de contas
Buscar grupos de classificação
Buscar classificações de um grupo
Buscar contas filhas
Buscar contas analíticas
Contabilidades
Buscar contabilidade por ID
Atualizar contabilidade
Excluir contabilidade
Listar contabilidades
Criar contabilidade
Ativar/Desativar contabilidade
Obter estatísticas da contabilidade
Buscar CNPJ
Buscar CEP
Documentos Identificados
Vincular obrigações ao documento
Listar documentos identificados
Visualizar modelo
Domains
Buscar domínio por ID
Atualizar domínio
Deletar domínio
Sincronizar domínio com Cloudflare
Listar todos os domínios
Clientes
Buscar cliente por ID
Atualizar cliente
Excluir cliente
Listar clientes
Criar cliente
Buscar detalhes completos do cliente
Resumo de clientes
Estatísticas de clientes
Buscar cliente por slug
Categorias Padrão
Buscar categoria global por ID
Atualizar categoria global
Excluir categoria global
Atualizar categoria do cliente
Excluir categoria do cliente
Listar categorias globais
Criar categoria global
Listar categorias do cliente
Criar categoria do cliente
Listar categorias globais ativas
Buscar categoria do cliente por ID
Carteira de Contadores
Atualizar modo férias do contador
Atualizar carteira do contador
Resumo da carteira
Listar contadores
Listar clientes visíveis para contador
Listar clientes na carteira
Listar clientes disponíveis
Automações
Obter template
Atualizar template
Remover template
Listar templates
Criar template
Executar automação manualmente
Listar logs de execução
Arquivos
Reprovar arquivo
Aprovar arquivo
Reprovar ausência
Aprovar ausência
Upload de arquivo
Reprovar arquivos em massa
Download zipado
Aprovar arquivos em massa
Listar arquivos com filtros
Obter arquivo por ID
Excluir arquivo
Gerar link de download
Arquivos dos últimos 14 dias
Listar últimos arquivos
Buscar documentos extras
Listar arquivos do cliente
Buscar aprovações pendentes
AI Configs
Buscar configuração de IA por ID
Atualizar configuração de IA
Excluir configuração de IA
Listar configurações de IA
Criar configuração de IA
Ativar/Desativar configuração de IA
Listar configurações de IA ativas
Storage Monitoring
Sincronizar uso de storage com GCS
Listar uso de storage de todas as contabilidades
Buscar uso de storage por contabilidade
Obter métricas do servidor
Prazos de Obrigações
Listar prazos de uma obrigação
Criar ou atualizar prazo
Remover prazo
Upload Inteligente de Obrigações
Upload inteligente de obrigação (legado)
Preview de upload inteligente (múltiplos arquivos)
Confirmar upload após preview
Enviar Documentos em Massa
Iniciar preview (upload em massa)
Confirmar envio em massa
Polling do status do job
Entregas de Obrigações
Listar entregas
Criar entrega
Reenviar obrigação
Marcar como enviada (legado)
Enviar obrigação
Disparar obrigação de forma retroativa
Vincular arquivos
Buscar entrega por ID
Gerar prévia do e-mail de uma entrega
LGPD - Solicitações de Exclusão
Criar solicitação de exclusão de conta
Rejeitar solicitação de exclusão
Aprovar solicitação de exclusão
Obter solicitação por ID
Listar solicitações pendentes
Obter minha solicitação de exclusão
Cancelar minha solicitação de exclusão
Feriados
Listar feriados
Criar feriado customizado
Verificar se data é feriado
Listar anos disponíveis
Deletar feriado customizado
Allowed CORS Origins
Listar origens CORS permitidas
Criar origem CORS permitida
Remover origem CORS permitida
Logos
Obter logos de contabilidade específica
Upload de logo para contabilidade específica
Remover logo de contabilidade específica
Obter logos
Upload de logo
Remover logo
Email Templates
Listar templates de e-mail
Criar ou atualizar template de e-mail
Testar template de e-mail
Buscar template de e-mail
Deletar template de e-mail
Email Config
Buscar configuração de e-mail
Criar ou atualizar configuração de e-mail
Testar configuração de e-mail
Consentimentos
Listar meus consentimentos
Criar consentimento
Criar múltiplos consentimentos
Verificar consentimento ativo
Verificar consentimentos pendentes
Listar meus consentimentos ativos
Revogar consentimento
Revogar consentimentos por tipo
Cloudflare Config
Buscar configuração do Cloudflare
Criar ou atualizar configuração do Cloudflare
Testar conexão com Cloudflare
Autenticação
Redefinir senha
Renovar access token
Realizar logout
Realizar login
Solicitar recuperação de senha
Alterar senha
Verificar código 2FA
Configurar 2FA
Configurar 2FA com credenciais
Ativar 2FA
Ativar 2FA com credenciais
Desativar 2FA
Regenerar códigos de backup
Resetar 2FA de usuário (Admin)
Verificar token
Listar dispositivos confiáveis
Gerar token JWT para Swagger
Listar sessões ativas
Status do 2FA
Remover dispositivo confiável
Remover todos os dispositivos confiáveis
Encerrar sessão
Encerrar outras sessões
Encerrar todas as sessões
Obrigação Entrega Log
Buscar dados completos de auditoria de uma entrega
Buscar histórico completo de uma entrega
Obrigação Email Tracking
Servir pixel de tracking (Público)
Buscar estatísticas de tracking de e-mail
Buscar aberturas de e-mail
Dashboard de Obrigações
Obter métricas do dashboard
Totais do período
Indicadores por departamento
Indicadores por contador
KPIs do dashboard
Stream de Notificações
Conectar ao stream
Dashboard
Top clientes
Tendência de volume
Tempo por etapa
Tempo médio de ciclo
Taxa de rejeição
Taxa de aprovação na primeira tentativa
Obter KPIs principais
Análise de funil
Distribuição por status
Automação vs Avulsa
Pendências gerais
Taxa de sucesso de automações
Heatmap de automações
Crescimento de automações
Esquemas
UpdateUserRequest
UserDTO
UpdateUserClientRequest
ClienteDTO
ContatoDTO
UserClientDTO
UpdateTipoDocumentoRequest
TipoDocumentoDTO
UpdateTipoDocumentoClienteRequest
UpdateTemaCustomizadoRequest
TemaCustomizadoDTO
DocumentoSolicitacaoRequest
UpdateSolicitacaoRequest
ArquivoDTO
SolicitacaoDocumentoDTO
SolicitacaoMensalDTO
AlternarReplicacaoRequest
UpdatePlanRequest
PlanDTO
RenomearPastaRequest
PastaDTO
AtualizarPastaPadraoRequest
PastaPadraoClienteDTO
ObrigacaoDTO
ObrigacaoPrazoDTO
ObrigacaoRegimeDTO
RegimeTributarioDTO
AtualizarTempoRequest
ModeloObrigacaoRequest
ModeloObrigacaoDTO
ModeloObrigacaoItemDTO
DepartamentoDTO
ObrigacaoClienteDTO
NotificacaoDTO
PreferenceValues
UpdateNotificationPreferencesRequest
NotificationPreferenceDTO
UpdateNotificationPreferenceRequest
ItemModeloRequest
UpdateModeloDocumentoRequest
ModeloDocumentoDTO
ModeloDocumentoItemDTO
UpdateMapeamentoTipoPastaRequest
MapeamentoTipoPastaDTO
UpdateMapeamentoTipoPastaClienteRequest
CorrigirDadosRequest
CreatePlanoContaRequest
PlanoContaDTO
UpdateContabilidadeRequest
ContabilidadeDTO
VinculacaoObrigacoesDocumentoRequest
UpdateDomainRequest
DomainDTO
CreateContatoRequest
UpdateClienteRequest
UpdateCategoriaPadraoRequest
CategoriaPadraoDTO
UpdateCategoriaPadraoClienteRequest
UpdateContadorVacationRequest
UpdateContadorCarteiraRequest
DocumentoAutomacaoRequest
UpdateAutomacaoRequest
AutomacaoSolicitacaoDTO
AutomacaoSolicitacaoDocumentoDTO
ReprovarArquivoRequest
ReprovarAusenciaRequest
UpdateAiConfigRequest
AiConfigDTO
CreateUserRequest
CreateUserClientRequest
CreateTipoDocumentoRequest
CreateTipoDocumentoClienteRequest
CreateTemaCustomizadoRequest
StorageUsageDTO
CreateSolicitacaoRequest
JustificarAusenciaRequest
CreatePlanRequest
CreatePastaRequest
SalvarPastaPadraoRequest
UploadResultado
CamposEditaveis
ObrigacaoUploadPreviewDTO
CorrecaoManual
ObrigacaoUploadConfirmDTO
UploadConfirmacao
AdicionarObrigacaoRequest
ArquivoEnfileiradoDTO
EnviarDocumentosJobStatusDTO
ErroItemDTO
EnviarDocumentosConfirmarRequestDTO
ItemConfirmacao
ArquivoInfo
ObrigacaoEntregaDTO
EnviarObrigacaoRequest
EnviarRetroativoRequest
AdicionarEmpresaObrigacaoRequest
VincularEmpresasBulkRequest
ErroItem
VincularEmpresasBulkResponse
CriarEntregasResponse
PushSubscriptionRequest
CreateModeloDocumentoRequest
CreateMapeamentoTipoPastaRequest
CreateMapeamentoTipoPastaClienteRequest
CriarSolicitacaoExclusaoContaRequest
SolicitacaoExclusaoContaDTO
RejeitarSolicitacaoExclusaoRequest
AprovarSolicitacaoExclusaoRequest
FeriadoDTO
CreateAllowedCorsOriginRequest
AllowedCorsOriginDTO
CreateContabilidadeRequest
LogoUploadResponse
CreateEmailTemplateRequest
EmailTemplateDTO
TestEmailTemplateRequest
CreateEmailConfigRequest
EmailConfigDTO
TestEmailRequest
CreateConsentimentoRequest
ConsentimentoDTO
CreateCloudflareConfigRequest
CloudflareConfigDTO
TestCloudflareConnectionRequest
CreateClienteRequest
CreateCategoriaPadraoRequest
CreateCategoriaPadraoClienteRequest
CreateAutomacaoRequest
ResetPasswordRequest
RefreshTokenRequest
RefreshTokenResponse
LoginRequest
LoginResponse
ForgotPasswordRequest
ForgotPasswordResponse
ChangePasswordRequest
TrustDeviceRequest
TwoFactorSetupResponse
TwoFactorSetupWithCredentialsRequest
EnableTwoFactorRequest
EnableTwoFactorWithCredentialsRequest
DisableTwoFactorRequest
ReprovarEmMassaRequest
DownloadZipRequest
AprovarEmMassaRequest
CreateAiConfigRequest
AtualizarStatusRequest
AtualizarResponsavelRequest
UserClientSummaryDTO
TemaPredefinidoDTO
ServerMetricsDTO
Pageable
PageSolicitacaoMensalDTO
PageableObject
SortObject
ObrigacaoStatsDTO
ObrigacaoRelatorioDTO
RegimeTributarioRelatorioDTO
PageModeloObrigacaoDTO
ModeloObrigacaoStatsDTO
ObrigacaoListItemDTO
ObrigacaoListResponseDTO
ArquivoPreviewDTO
ObrigacaoEmailPreviewDTO
EmailAberturaDTO
EmailEnvioDTO
LogEntryDTO
ObrigacaoEntregaAuditoriaDTO
ResumoAuditoriaDTO
ObrigacaoEntregaLogDTO
ObrigacaoEmailAberturaDTO
DashboardMetrics
StatusEntregaDashboardDTO
DashboardPorDepartamentoDTO
DashboardPorContadorDTO
ObrigacoesKPIsDTO
PageNotificacaoDTO
SseEmitter
NotificacaoCountDTO
DadosCliente
DadosConsentimento
DadosContato
DadosSessao
DadosUsuario
MeusDadosDTO
DashboardTopClientesDTO
DashboardTendenciaVolumeDTO
DashboardTempoEtapaDTO
DashboardTempoCicloDTO
DashboardTaxaRejeicaoDTO
DashboardTaxaAprovacaoPrimeiraDTO
TipoDocumentoTaxaDTO
DashboardKPIsDTO
DashboardFunnelDTO
EtapaFunnelDTO
DashboardDistribuicaoStatusDTO
DashboardAutomacaoAvulsaDTO
DashboardPendenciasGeraisDTO
AutomacaoTaxaSucessoDTO
DashboardTaxaSucessoAutomacaoDTO
DashboardHeatmapAutomacaoDTO
DiaExecucaoDTO
DashboardCrescimentoAutomacoesDTO
PagePlanoContaDTO
ContabilidadeStatisticsDTO
LastLoginInfo
LogosResponse
CnpjResponseFrontendDTO
Endereco
CepResponseDTO
ConsentimentoPendenteDTO
DocumentoIdentificadoDTO
AutomacaoDetalhesDTO
ClienteDetalhesDTO
ClienteSummaryDTO
ClientePorEstadoDTO
ClientePorPrioridadeDTO
ClientePorRegimeDTO
ClienteStatsDTO
CarteiraContadoresSummaryDTO
AutomacaoSolicitacaoLogDTO
TrustedDeviceDTO
SwaggerTokenResponse
ActiveSessionDTO
TwoFactorStatusResponse
ArquivoAprovacaoDTO
DocumentosExtrasDTO
DocumentosExtrasPorMes
AprovacoesPendentesDTO
AprovacoesPorMes
KPIsAprovacoes
Módulo predefinido
DocSend API
Módulo predefinido
DocSend API
CreateTipoDocumentoRequest
Copiar Página
{
"nome"
:
"string"
,
"descricao"
:
"string"
,
"isAtivo"
:
true
}