Empresas

Cadastra uma empresa (CNPJ) para monitoramento

Cadastra o CNPJ na conta. Ele nasce em estado DRAFT (produção) — o próximo passo é enviar o certificado A1 em POST /companies/{id}/certificate. A chave de teste de emissão não cadastra empresa (403).

post/v1/companies

Request

  • Base URL: https://api.sudrel.com.br/api
  • URL: https://api.sudrel.com.br/api/v1/companies
  • Auth: HTTP bearer

Request body

cnpjstring required

Só dígitos.

nomeExibicaostring
nsuInicialinteger

Avançado — de onde retomar a consulta ao ADN, se este CNPJ já era monitorado por outro sistema. Ausência = 0 (histórico completo).

Response

Criada

idstring
cnpjstring
ambiente'SANDBOX' | 'PRODUCAO'
ambienteAdn'HOMOLOGACAO' | 'PRODUCAO'

Qual Ambiente de Dados Nacional (da Receita Federal) é consultado. HOMOLOGACAO nunca gera cobrança.

escopoMonitoramento'RECEBIDAS' | 'EMITIDAS' | 'AMBAS'

O que conta como visível/cobrável para esta empresa — todas as notas são sempre consultadas e guardadas, isso só afeta exibição e franquia.

nomeExibicaostring nullable
razaoSocialstring nullable
estado'DRAFT' | 'VALIDATING' | 'ANALISANDO_HISTORICO' | 'INITIAL_SYNC' | 'ACTIVE' | 'PAUSED_BY_USER' | 'PAUSED_CERTIFICATE' | 'PAUSED_BILLING' | 'ERROR' | 'REMOVAL_PENDING' | 'REMOVED'
nsuInicialstring
nsuUltimoConfirmadostring nullable
ultimaConsultaEmstring date-time nullable
monitorarDesdestring date-time nullable

Só notas emitidas a partir desta data aparecem e são cobradas. Ausência (null) = sem corte, todo o histórico aparece.

certificadoValidoAtestring date-time nullable
criadaEmstring date-time
atualizadaEmstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.