API Zen 2 - V2
  1. Q-Drive Documentos Fiscais
API Zen 2 - V2
  • Raiz
    • Autenticação
      • Realiza o login de um usuário na API utilizando e-mail e senha.
    • E-Doc
      • Consultar Pastas.
      • Insere um anexo de documento no storage.
      • 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.
      • Edição de uma empresa existente no sistema.
      • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
    • 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
      • Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
        POST
  • Esquemas
    • Schemas
      • AtivoInativoEnum
      • CadastroDocumentoEdocApiModel
      • CadastroDocumentoQcolaboreApiModel
      • EditarEmpresaApiModel
      • InserirEmpresaApiModel
      • InserirUsuarioEscritorioApiModel
      • InserirUsuarioEscritorioComSenhaApiModel
      • LoginUsuarioApiV2Model
      • 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
      • 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
🟠400Solicitação Incorreta
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/QDrive/DocumentosFiscais/Importar' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": {}
}
Modificado em 2025-08-27 13:38:15
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