API Zen 2 - V2
  1. E-Doc
API Zen 2 - V2
  • API Zen 2 - V2
    • Raiz
      • Arquivos
        • Insere um anexo de documento no storage.
      • Autenticação
        • Realiza o login de um usuário na API utilizando e-mail e senha.
      • E-Doc
        • Consultar Pastas.
          GET
        • Cadastro de Documento.
          POST
        • Cancelar Documento.
          DELETE
      • Gerenciador de Empresas
        • Consulta informações sobre as empresas com base nos filtros fornecidos.
        • Cadastro de uma nova empresa no sistema.
        • Consulta informações sobre os departamentos com base nos filtros fornecidos.
        • Edição de uma empresa existente no sistema.
        • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
        • Consulta os perfis de acesso com base nos filtros fornecidos.
      • Gerenciador de Usuários
        • Criação de Usuário Empresa.
        • Consulta de Usuário(s) Empresa.
        • Vincular Usuário a Empresa(s).
        • Criação de Usuário Escritório.
        • Consulta de Usuário(s) Escritório.
      • Q-Colabore
        • Consultar Pastas.
        • Cancelar Documento.
        • Cadastro de Documento.
      • Q-Drive Documentos Fiscais
        • Realiza a importação de documentos fiscais, incluindo NF-e, CT-e, CT-e OS, NFC-e, CF-e e seus respectivos eventos.
      • Q-Drive NFS-e
        • Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
    • Esquemas
      • Schemas
        • AtivoInativoEnum
        • CadastroDocumentoEdocApiModel
        • CadastroDocumentoQcolaboreApiModel
        • ConsultaEmpresaModel
        • ConsultaUsuarioEmpresaModel
        • ConsultaUsuarioEscritorioModel
        • ConsultarPastasApiModel_EdocSubpastaApiModel
        • ConsultarPastasApiModel_QColaboreSubpastaApiModel
        • DFe_Classes_Flags_TipoAmbiente
        • DepartamentoRetornoApiModel
        • DownloadArquivoRetornoApiModel
        • EditarEmpresaApiModel
        • EdocSubpastaApiModel
        • EmpresaCadastroDocumentoApi
        • EmpresaRetornoApiModel
        • EnderecoApiModel
        • EnderecoEmpresa
        • GrupoEmpresaRetornoApiModel
        • InformacoesAdicionaisApiModel
        • InformacoesAdicionaisEmpresa
        • InserirEmpresaApiModel
        • InserirUsuarioEscritorioApiModel
        • LoginRetornoApi
        • LoginUsuarioApiV2Model
        • PerfilAcessoRetornoApiModel
        • PerfilTareffaApi
        • QColaboreSubpastaApiModel
        • QuestorZen_Application_Edoc_Models_CadastroDocumentoQcolaboreApiModel_EmpresaCadastroDocumentoApi
        • RegimeTributarioEnum
        • ResultadoImportacao
        • ResumoArquivoImportacao
        • RetornoApi
        • RetornoApi_ConsultaUsuarioEmpresaModel
        • RetornoApi_DepartamentoRetornoApiModel
        • RetornoApi_EmpresaRetornoApiModel
        • RetornoApi_GrupoEmpresaRetornoApiModel
        • RetornoApi_IEnumerable_ConsultaUsuarioEscritorioModel
        • RetornoApi_IEnumerable_ConsultarPastasApiModel_EdocSubpastaApiModel
        • RetornoApi_IEnumerable_ConsultarPastasApiModel_QColaboreSubpastaApiModel
        • RetornoApi_IEnumerable_DownloadArquivoRetornoApiModel
        • RetornoApi_Int64
        • RetornoApi_LoginRetornoApi
        • RetornoApi_Object
        • RetornoApi_PerfilAcessoRetornoApiModel
        • RetornoApi_ResultadoImportacao
        • RetornoApi_String
        • TipoAmbiente
        • TipoDepartamento
        • TipoDocumentoFiscal
        • TipoFone
        • TipoInscricao
        • UsuarioDestino
        • UsuarioDestinoEdoc
        • UsuarioEmpresaApiModel
        • VinculoEmpresaUsuarioApiV2Model
  1. E-Doc

Cancelar Documento.

DELETE
/v2/EDoc/Usuarios/{usuarioId}/Documentos/{documentoId}
Este endpoint realiza o cancelamento de um documento no Edoc.
Pré-requisitos para o cancelamento:
1.
O usuário deve ser um usuário de escritório com permissões para cancelar o documento, identificado pelo usuarioId.
2.
O documento deve existir, estar com status "Aberto" e o ID do documento deve ser passado pelo documentoId.
Validações:
O usuarioId é obrigatório e deve corresponder a um usuário válido com permissão para realizar o cancelamento.
O documentoId é obrigatório e deve corresponder a um documento existente no Edoc.
O documento precisa estar com status "Aberto" para ser cancelado. Documentos com outros status (como "Cancelado" ou "Fechado") não podem ser cancelados.
Exemplo de Requisição:
Exemplo de Resposta de Sucesso (200):
{
    "sucesso": true,
    "mensagem": "Documento cancelado com sucesso",
    "dados": null
}
Exemplo de Resposta de Erro (400 - Permissões Insuficientes):
{
    "sucesso": false,
    "mensagens": "Permissões insuficientes ou dados inválidos.",
    "dados": null
}
Exemplo de Resposta de Erro (404 - Documento Não Encontrado):
{
    "sucesso": false,
    "mensagens": "Documento não encontrado.",
    "dados": null
}
Exemplo de Resposta de Erro (500 - Erro Interno):
{
    "sucesso": false,
    "mensagens": "Erro interno ao processar o cancelamento do documento.",
    "dados": null
}

Requisição

Authorization
API Key
Adicionar parâmetro em header
Authorization
Exemplo:
Authorization: ********************
or
Parâmetros de Caminho

Respostas

🟢200OK
application/json
Documento cancelado com sucesso.
Body

🟠400Solicitação incorreta
🟠403Permissão insuficiente
🟠404Não encontrado
🔴500Erro interno do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE '/v2/EDoc/Usuarios//Documentos/' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": null
}
Modificado em 2025-09-24 14:39:45
Página anterior
Cadastro de Documento.
Próxima página
Consulta informações sobre as empresas com base nos filtros fornecidos.
Built with