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 Notas Fiscais de Serviço Eletrônica (NFS-e).

POST
/v2/QDrive/Nfse/Importar
Este endpoint permite a importação de NFS-e (Notas Fiscais de Serviço Eletrônicas), que são documentos fiscais eletrônicos utilizados para registrar a prestação de serviços.
O usuário deve fornecer os arquivos de NFS-e e o tipo de documento fiscal para que a importação seja realizada.
Pré-requisitos:
1.
Os arquivos de NFS-e devem ser válidos e respeitar o formato exigido pelo sistema.
2.
O tipo de documento fiscal (especificado pelo parâmetro Type) deve ser informado. Ex: Entrada = 0, Saida = 1, Ambos = 2
Validações:
Verificação se os documentos fornecidos são válidos.
O tipo de documento fiscal deve ser informado.
Arquivos de NFS-e devem ser no formato correto.
Respostas:
Sucesso: Retorna o resultado da importação, indicando o sucesso ou falha para cada NFS-e.
Falhas: Indica falhas específicas como arquivos inválidos, dados ausentes, ou erro no processamento.
Exemplo de Resposta de Sucesso (200 - OK):
{
    "sucesso": true,
    "mensagens": "Anexo inserido com sucesso",
    "dados": {
        "Id": "12345"
    }
}
Exemplo de Resposta de Erro (StatusCodes.Status400BadRequest - Bad Request):
{
    "sucesso": false,
    "mensagens": "Necessário informar no mínimo um arquivo",
    "dados": null
}

Requisição

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

Parâmetros Bodymultipart/form-data

Respostas

🟢200OK
application/json
Importação realizada com sucesso. Retorna o resultado com sucesso ou falha para cada documento.
Body

🟢200Sucesso
🟠400Solicitação Incorreta
🟠404Registro Não Encontrado
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/QDrive/Nfse/Importar' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": {}
}
Modificado em 2025-08-27 13:40:26
Página anterior
Realiza a importação de documentos fiscais, incluindo NF-e, CT-e, CT-e OS, NFC-e, CF-e e seus respectivos eventos.
Próxima página
AtivoInativoEnum
Built with