API Zen 2 - V2
  1. Q-Drive Documentos Fiscais
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.
        • Cadastro de Documento.
        • Cancelar Documento.
      • 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.
          POST
      • 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. 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.

POST
/v2/QDrive/DocumentosFiscais/Importar
Este endpoint permite a importação de documentos fiscais, como NF-e, CT-e, CT-e OS, NFC-e, CF-e e seus eventos. O usuário deve fornecer os documentos fiscais como arquivos,
que serão processados e importados pelo sistema.
Pré-requisitos para a importação:
1.
O usuário deve ter permissões para importar os documentos.
2.
Os arquivos devem estar no formato correto e conter as informações fiscais necessárias.
Validações executadas:
O formato do arquivo é validado para garantir que seja um documento fiscal reconhecido.
O sistema valida os dados de cada documento para verificar se eles estão completos e corretos.
Respostas:
Sucesso: Retorna uma lista indicando o status de sucesso ou falha para cada documento.
Falhas: Detalha os erros de processamento, como documentos inválidos, falha na validação de dados fiscais ou outros erros inesperados.
Exemplo de Resposta de Sucesso (200 - OK):
{
    "sucesso": true,
    "mensagens": "Importação de documentos fiscais realizada com sucesso.",
    "dados": {
        "resultadoImportacao": [
            { "sucesso": true, "documento": "nfe1.xml" },
            { "sucesso": false, "documento": "nfe2.xml", "erro": "Documento inválido" }
        ]
    }
}
Exemplo de Resposta de Erro (StatusCodes.Status400BadRequest - Bad Request):
{
    "sucesso": false,
    "mensagens": "Erro ao importar os documentos fiscais. Arquivo inválido ou dados inconsistentes.",
    "dados": null
}
Exemplo de Resposta de Erro (StatusCodes.Status500InternalServerError - Internal Server Error):
{
    "sucesso": false,
    "mensagens": "Erro interno ao processar a importação dos documentos fiscais.",
    "dados": null
}

Requisição

Authorization
API Key
Adicionar parâmetro em header
Authorization
Exemplo:
Authorization: ********************
or
Parâmetros Bodymultipart/form-data

Respostas

🟢200OK
application/json
Importação realizada com sucesso, com a lista dos documentos importados.
Body

🟢200Sucesso
🟢200Sucesso
🟠400Solicitação incorreta
🔴500Erro interno do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/QDrive/DocumentosFiscais/Importar' \
--header 'Authorization: <api-key>' \
--form 'documentos=""'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": {
        "chave": "string",
        "sucesso": true,
        "mensagem": "string",
        "tipoErro": "string",
        "lstResumoArquivoImportacao": [
            {
                "id": 0,
                "arquivo": "string",
                "empresa": "string",
                "modelo": "string",
                "movimento": "string",
                "numero": "string",
                "emissao": "string"
            }
        ]
    }
}
Modificado em 2025-09-24 14:39:45
Página anterior
Cadastro de Documento.
Próxima página
Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
Built with