API atual/Referência completa/Fiscal (NF-e e NFC-e)

Provisionamento no provedor

Registra o estabelecimento no provedor de emissão e consulta se ele já pode emitir NF-e e NFC-e.

Cadastrar um estabelecimento só guarda os dados na plataforma. Para emitir, o CNPJ também precisa existir no provedor de emissão (Focus NFe), que faz a ligação com a SEFAZ. Provisionar cria essa empresa no provedor e guarda aqui a referência e os tokens de acesso. O certificado digital A1 e o CSC (código de segurança da NFC-e) são enviados diretamente ao provedor e nunca passam pela plataforma.

Exigem o módulo focusnfe e o privilégio manage_nfe ou manage_settings. O módulo precisa ter a conta do provedor configurada; sem ela o provisionamento falha.

Provisionar um estabelecimento

Cria a empresa no provedor a partir dos dados do estabelecimento e grava a referência (focusnfe_empresa_ref) e os tokens de produção e homologação. A chamada é idempotente: repetir carrega a empresa que já existe em vez de criar outra. Publica o evento fiscal.establishment.provisioned.

POST/api/v1/admin/fiscal/establishments/{id}/provisionAdmin

Provisiona o estabelecimento no provedor

Parâmetros de caminho

iduuidobrigatório

Id do estabelecimento.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/fiscal/establishments/c04d4d27-b16d-4dcb-836a-7c9eb0a40c3b/provision" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Estabelecimento provisionado

json

{
  "provisioned": true,
  "certificate_valid_until": "2027-08-14",
  "nfe_enabled": true,
  "nfce_enabled": false
}

Campos da resposta

provisionedboolean

true quando a empresa existe no provedor.

certificate_valid_untilstring

Validade do certificado digital, como informada pelo provedor. Ausente quando o provedor não tem certificado ou não informa.

nfe_enabledboolean

NF-e habilitada para a empresa.

nfce_enabledboolean

NFC-e habilitada para a empresa (exige o CSC cadastrado no provedor).

Erros

Status	Quando	Corpo
502	Falha no provedor, conta do provedor não configurada, estabelecimento inexistente ou provisionador indisponível	`{"error":"provisioning failed","detail":"fiscal: establishment not found"}`

Consultar a situação no provedor

Pergunta ao provedor se a empresa existe e quais documentos ela já pode emitir. Serve para saber, por exemplo, se o certificado foi enviado e quando vence.

GET/api/v1/admin/fiscal/establishments/{id}/provider-statusAdmin

Consulta a situação do estabelecimento no provedor

Parâmetros de caminho

iduuidobrigatório

Id do estabelecimento.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/fiscal/establishments/c04d4d27-b16d-4dcb-836a-7c9eb0a40c3b/provider-status" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Situação devolvida

json

{
  "provisioned": true,
  "certificate_valid_until": "2027-08-14",
  "nfe_enabled": true,
  "nfce_enabled": false
}

Os campos são os mesmos do provisionamento. Para um estabelecimento ainda não provisionado a resposta é {"provisioned":false,"nfe_enabled":false,"nfce_enabled":false}.

Erros

Esta rota quase nunca falha: ela devolve 200 com o que conseguiu apurar.

Status	Quando	Corpo
200	O provedor não respondeu	`{"provisioned":true,"nfe_enabled":false,"nfce_enabled":false}`
200	Id que não existe	`{"provisioned":false,"nfe_enabled":false,"nfce_enabled":false}`
401 / 403	Sem token, sem privilégio, módulo desligado	`{"error":"insufficient privileges","privilege_required_any":["manage_nfe","manage_settings"]}`

Veja também

API atual/Referência completa/Fiscal (NF-e e NFC-e)

Provisionamento no provedor

Registra o estabelecimento no provedor de emissão e consulta se ele já pode emitir NF-e e NFC-e.

Exigem o módulo focusnfe e o privilégio manage_nfe ou manage_settings. O módulo precisa ter a conta do provedor configurada; sem ela o provisionamento falha.

Provisionar um estabelecimento

POST/api/v1/admin/fiscal/establishments/{id}/provisionAdmin

Provisiona o estabelecimento no provedor

Parâmetros de caminho

iduuidobrigatório

Id do estabelecimento.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/fiscal/establishments/c04d4d27-b16d-4dcb-836a-7c9eb0a40c3b/provision" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Estabelecimento provisionado

json

{
  "provisioned": true,
  "certificate_valid_until": "2027-08-14",
  "nfe_enabled": true,
  "nfce_enabled": false
}

Campos da resposta

provisionedboolean

true quando a empresa existe no provedor.

certificate_valid_untilstring

Validade do certificado digital, como informada pelo provedor. Ausente quando o provedor não tem certificado ou não informa.

nfe_enabledboolean

NF-e habilitada para a empresa.

nfce_enabledboolean

NFC-e habilitada para a empresa (exige o CSC cadastrado no provedor).

Erros

Status	Quando	Corpo
502	Falha no provedor, conta do provedor não configurada, estabelecimento inexistente ou provisionador indisponível	`{"error":"provisioning failed","detail":"fiscal: establishment not found"}`

Consultar a situação no provedor

Pergunta ao provedor se a empresa existe e quais documentos ela já pode emitir. Serve para saber, por exemplo, se o certificado foi enviado e quando vence.

GET/api/v1/admin/fiscal/establishments/{id}/provider-statusAdmin

Consulta a situação do estabelecimento no provedor

Parâmetros de caminho

iduuidobrigatório

Id do estabelecimento.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/fiscal/establishments/c04d4d27-b16d-4dcb-836a-7c9eb0a40c3b/provider-status" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Situação devolvida

json

{
  "provisioned": true,
  "certificate_valid_until": "2027-08-14",
  "nfe_enabled": true,
  "nfce_enabled": false
}

Os campos são os mesmos do provisionamento. Para um estabelecimento ainda não provisionado a resposta é {"provisioned":false,"nfe_enabled":false,"nfce_enabled":false}.

Erros

Esta rota quase nunca falha: ela devolve 200 com o que conseguiu apurar.

Status	Quando	Corpo
200	O provedor não respondeu	`{"provisioned":true,"nfe_enabled":false,"nfce_enabled":false}`
200	Id que não existe	`{"provisioned":false,"nfe_enabled":false,"nfce_enabled":false}`
401 / 403	Sem token, sem privilégio, módulo desligado	`{"error":"insufficient privileges","privilege_required_any":["manage_nfe","manage_settings"]}`