Sudrel API
Dashboard Create API key

Documentation › Concepts

Guides

Readiness

What the company needs to issue, item by item, and what blocks issuance.

Before issuing: check readiness

GET /v1/companies/{id}/prontidao runs the same check that POST /v1/nfse runs before creating the invoice. Checking first avoids finding the problem at issuance time, and tells you what to fix.

Each item comes with situacao, and the whole response carries the worst one:

situacao Means Next step
ok Requirement met. Issue.
aviso Issuance works, but it is worth a look (certificate expiring, municipality parameter still unknown). Issue, and fix it without hurry.
bloqueio Issuance is refused with 412 empresa_nao_pronta, and nothing is created. Fix it first. Trying to issue does not help.

The items

item What it checks Can it block?
certificado A1 certificate present and valid. Warning in the last 30 days. Yes: missing or expired
regime_tributario Tax regime configured. Yes
plano_emissao Active issuance plan. Production only; in test it is always ok. Yes
sandbox_municipio_proprio Test key only: the company issues through the city hall's own system, which has no test environment. Yes
regime_apuracao_simples Assessment regime, under Simples Nacional. No
municipio_emissao The company's municipality is known. No
convenio_municipio Whether the municipality uses the Sistema Nacional, and how. No
serie_dps DPS series. No
padroes_emissao Company defaults (service code etc.). No
parametros_municipais Official municipality parameters (tax rates). No
nbs NBS for IBS/CBS, when it applies to the company. No
reducao_ibs_cbs IBS/CBS reduction provided for the service. No

Each item carries mensagem and correcao, in Portuguese, with what to do. New items may appear: handle any unknown item by its situacao.

The EMPRESA_PRONTIDAO_ALTERADA webhook tells you when an item changes status (checked every 6 hours, production only). POST /v1/nfse/validacoes also returns the readiness, together with the invoice validation.