Empresas
Listar empresas
Lista as empresas da sua conta com status de análise e resumo do certificado.
GET
/openapi/v2/empresasRequer os cabeçalhos de assinatura
token, timestamp e sign, veja Autenticação.Devolve apenas as empresas da conta de integrador dona da aplicação, da mais recente para a mais antiga. Use para recuperar o empresaId de empresas já registradas e acompanhar a análise sem abrir o console. Para os tipos de documento habilitados, o endereço e as datas de análise consulte Consultar empresa. Usa a mesma assinatura de interface de Registrar empresa e não é cobrada.
Parâmetros de consulta
cnpj | string | CNPJ |
status | string | Filtro de status |
nome | string | Nome |
pagina | int | Página |
tamanho | int | Tamanho da página |
* Campo obrigatório
200
Página de empresas. Sem correspondências,
itens é um array vazio.pagina | int | Página devolvida |
tamanho | int | Tamanho da página aplicado |
total | int | Total de empresas |
totalLimitado | bool | Total limitado |
| array | Empresas da página |
statusStatus da empresa
Mesmos valores do filtro e do campo itens[].status.
| Valores | Significado |
|---|---|
| Rascunho | Cadastro salvo e ainda não enviado para análise; camposPendentes lista o que falta |
| AguardandoAprovacao | Em análise pela plataforma; ainda não pode emitir |
| Ativa | Aprovada; pode emitir quando houver certificado válido |
| Rejeitada | Recusada na análise; motivoStatus traz o motivo. Corrija pelo console e reenvie; se ela tinha campos em camposPendentes, completá-los com Registrar empresa (corpo com id) a devolve para análise manual |
| Inativa | Desativada; não emite até ser reativada no console |
itens[].ambienteEmissaoAmbiente
| Valores | Significado |
|---|---|
| Homologacao | Homologação (testes); padrão de toda empresa recém-registrada |
| Producao | Produção; a troca é feita pela operação da plataforma |
itens[].certificado.statusStatus do certificado
| Valores | Significado |
|---|---|
| Nenhum | Nenhum certificado vinculado |
| Valido | Certificado em vigor |
| ProximoVencimento | Em vigor, mas vence em breve; ainda emite |
| Vencido | Vencido; vincule um novo certificado para voltar a emitir |
| Código | HTTP | |
|---|---|---|
| 10001001 | 400 | status fora da enumeração, cnpj inválido, ou pagina / tamanho fora do intervalo. |
