API Zen 2 - V2
  1. Gerenciador de Empresas
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.
        GET
      • Cadastro de uma nova empresa no sistema.
        POST
      • Edição de uma empresa existente no sistema.
        PUT
      • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
        GET
    • 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.
      • 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. Gerenciador de Empresas

Edição de uma empresa existente no sistema.

PUT
/v2/Empresas/InscricaoFederal/{inscricaoFederalEmpresa}
Este endpoint permite editar os dados de uma empresa já cadastrada, utilizando a inscrição federal da empresa para identificá-la.
O modelo fornecido deve conter os dados atualizados da empresa.
Exemplo de Requisição (Body JSON):
{
  "Nome": "Empresa Exemplo Atualizada LTDA",
  "TipoInscricao": 1,
  "InscricaoFederal": "12345678000199",
  "Ativo": true,
  "Endereco": {
    "Endereco": "Avenida Paulista",
    "Bairro": "Bela Vista",
    "Numero": 1000,
    "Complemento": "Andar 5",
    "Cep": "01310-100",
    "TipoLogradouro": "Avenida",
    "CodCidadeIbge": 3550308
  },
  "InformacoesAdicionais": {
    "NomeFantasia": "Empresa Exemplo",
    "RazaoSocial": "Empresa Exemplo Atualizada LTDA",
    "InscricaoMunicipal": "123456",
    "InscricaoEstadual": "654321",
    "InscricaoImobiliaria": "789123",
    "PeriodoVigencia": "2024-01-01",
    "Cnae": "6201-5/00",
    "DescricaoCnae": "Desenvolvimento de software",
    "RegimeTributario": 1,
    "DataInicioRegime": "2024-01-01",
    "CPFSocioPrincipal": "123.456.789-00",
    "RGSocioPrincipal": "MG-12.345.678",
    "NomeSocioPrincipal": "João da Silva",
    "TipoTelefone": 4,
    "Telefone": "(11) 91234-5678",
    "Observacoes": "Empresa de tecnologia e inovação.",
    "Email": "contato@empresaexemplo.com.br",
    "PaginaWeb": "https://www.empresaexemplo.com.br",
    "CodigoEmpresa": "001",
    "CodigoFilial": "002",
    "Caracteristicas": "Tecnologia e inovação"
  }
}
Valores e Descrições do Enum TipoInscricao:
ValorDescrição
0CPF
1CNPJ
2CNO
3Internacional
Exemplo de resposta (sucesso):
{
  "status": true,
  "message": "Empresa editada com sucesso",
  "data": ""
}
Exemplo de resposta (erro):
{
  "status": false,
  "message": "Empresa não encontrada com a inscrição fornecida",
  "data": null
}

Requisição

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

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK
application/json
Empresa editada com sucesso.
Body

🟠400Solicitação Incorreta
🟠404Registro Não Encontrado
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/v2/Empresas/InscricaoFederal/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nome": "string",
    "tipoInscricao": {},
    "inscricaoFederal": "string",
    "ativo": true,
    "endereco": {},
    "informacoesAdicionais": {}
}'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": "string"
}
Modificado em 2025-08-27 13:38:15
Página anterior
Cadastro de uma nova empresa no sistema.
Próxima página
Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
Built with