Empresas

Detalhe de uma empresa

get/v1/companies/{id}

Request

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

Path parameters

idstring required

Id da empresa (o mesmo devolvido em GET /companies).

Response

OK

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.