API Zen 2 - V2
  1. Q-Colabore
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.
        GET
      • Cancelar Documento.
        DELETE
      • Cadastro de Documento.
        POST
    • 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.
      • Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
  • 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-Colabore

Cadastro de Documento.

POST
/v2/Qcolabore/Usuarios/{usuarioId}/Documentos
Este endpoint realiza o cadastro de um novo documento no QColabore.
Pré-requisitos para o cadastro:
1.
O usuário deve ser um usuário de escritório e possuir permissões para realizar o cadastro, identificado pelo usuarioId.
2.
O documento deve conter um anexo previamente enviado no endpoint de Anexos, enviando o ID deste anexo referenciado na propriedade !:CadastroDocumentoQcolaboreApiModel.AnexoId no modelo.
3.
O documento deve ser associado a uma empresa, especificada na propriedade QuestorZen.Application.Edoc.Models.CadastroDocumentoQcolaboreApiModel.Empresa do modelo.
Caso o usuário informado no documento não exista ou não possua permissão de acesso à empresa, perfis de acesso ou departamentos correspondentes,
irá cadastrar ou atualizar o usuário, garantindo que ele receba as permissões adequadas para o cadastro do documento.
Validações executadas:
O usuarioId é obrigatório e deve corresponder a um usuário válido e com permissões.
O anexo referenciado deve existir previamente cadastrado via endpoint M:QuestorZen.Api.Controllers.v2.Arquivos.ArquivosApiController.InserirAnexoDocumento(System.Collections.Generic.List{Microsoft.AspNetCore.Http.IFormFile}) e ser válido.
Exemplo de Requisição (Body JSON):
Corpo da Requisição:
{
    "subPastaId": 104,
    "assunto": "Teste questor",
    "dataCompetencia": "",
    "dataVencimento": "",
    "valor": 50.00,
    "anexoId": "66c32ed1ef1602d339ce930c",
    "empresa": {
        "empresaId": 8,
        "usuario": {
            "nome": "FUNCIONARIO DOIS",
            "email": "questor@questores.com.br",
            "cpf": "323423423432"
        }
    }
}
Respostas:
Sucesso: Retorna o documento cadastrado.
Falhas: Detalha os erros ocorridos, como permissões inválidas, anexo não encontrado, ou dados incorretos no modelo.
Exemplo de Resposta de Sucesso(201 - Created) :
{
    "sucesso": true,
    "mensagens": "Documento cadastrado com sucesso",
    "dados": {
        "Id": "12345",
        "Nome": "Documento XYZ"
    }
}
Exemplo de Resposta de Erro (400 - Bad Request):
{
    "sucesso": false,
    "mensagens": "Dados fornecidos no modelo são inválidos.",
    "dados": null
}

Requisição

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

Parâmetros Bodyapplication/json

Examples

Respostas

🟢201Criado
application/json
Documento cadastrado com sucesso.
Body

🟠400Solicitação Incorreta
🟠403Proibido
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/Qcolabore/Usuarios/0/Documentos' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subPastaId": 0,
    "assunto": "string",
    "dataVencimento": "string",
    "dataCompetencia": "string",
    "observacao": "string",
    "valor": 0,
    "anexoId": "string",
    "empresa": {}
}'
Response Response Example
201 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": null
}
Modificado em 2025-08-27 13:38:15
Página anterior
Cancelar Documento.
Próxima página
Realiza a importação de documentos fiscais, incluindo NF-e, CT-e, CT-e OS, NFC-e, CF-e e seus respectivos eventos.
Built with