Como configurar contingência automática?
No mundo da emissão fiscal, contingência é um evento que ocorre quando não é possível realizar comunicação com a Sefaz para a emissão de um Documento Fiscal Eletrônico (DFe).
Já a contingência automática é um serviço disponibilizado pela Oobj para seus clientes. Esse serviço monitora a saúde dos servidores da Sefaz, ativando os modos de contingência automaticamente quando o sistema detecta alguma indisponibilidade, intermitência, ou falta de conexão do contribuinte com a internet.
Na API REST Oobj, quando {contigenciaAutomaticaHabilitada} = true
, a aplicação fará o monitoramento e, ao detectar qualquer problema, executará as seguintes ações:
- Habilitar o modo de contingência adequado, de acordo com o tipo de indisponibilidade apresentado;
- Alterar automaticamente campos do XML necessários para a emissão em contingência.
Você pode habilitar ou desabilitar a contingência automática via API por três endpoints, conforme sua necessidade. São eles:
- Alterar contingência automática da Conta;
- Alterar contingência automática por CNPJ;
- Alterar contingência automática por Unidade Federativa (UF).
A contingência automática vem desabilitada por padrão.
Alterar contingência automática da Conta
Para alterar a contingência automática de todas as unidades vinculadas à Conta cadastrada no Monitor Oobj, siga estes passos:
- Faça uma requisição tipo POST ao endpoint alterar contingência automática da Conta;
[URL_BASE]/api/contingencia
No corpo da requisição (
request body
) preencha os seguintes parâmetros:{contigenciaAutomaticaHabilitada}
*: true (para habilitar) ou false (para desabilitar);{modelos}
*: modelos para os quais a contingência será habilitada ou desabilitada. Valores aceitos: 55 (NFe), 57 (CTe), 58 (MDFe), 65 (NFCe), 66 (NF3e);{justificativaPadrao}
opcional: Caso não seja preenchido e a contingência esteja habilitada, o campo será preenchido com "Sefaz fora do ar.";
Caso você envie mais de um modelo de DFe, separe-os com ponto, vírgula, ponto e vírgula, quebra de linha ou caractere de espaço | . | , | ; | \n |
.
- Informe o x-auth-token no cabeçalho (
header parameters
) da requisição.
Exemplo de requisição
O exemplo abaixo traz um modelo de requisição preenchido para habilitar a contingência automática para NFe, CTe, MDFe, NFCe, NF3e.
curl -L -X POST 'https://rest-teste.oobj.com.br/api/contingencia' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '[
{
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"modelos": "55,57,58,65,66"
}
]'
Exemplo de retorno
[
{
"modelos": "65",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar."
},
{
"modelos": "66",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar."
},
{
"modelos": "55",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar."
},
{
"modelos": "57",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar."
},
{
"modelos": "58",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar."
}
]
Alterar contingência automática por CNPJ
Para alterar a contingência automática de todas as unidades vinculadas ao CNPJ (base ou completo), siga estes passos:
- Faça uma requisição tipo POST ao endpoint alterar contingência por CNPJ;
[URL_BASE]/api/contingencia/cnpj
No corpo da requisição (
request body
) preencha os seguintes parâmetros:{cnpjs}
*: lista de CNPJs (base ou completo) em que a contingência automática será alterada;{contigenciaAutomaticaHabilitada}
*: true (para habilitar) ou false (para desabilitar);{modelos}
*: modelos para os quais a contingência será habilitada ou desabilitada. Valores aceitos: 55 (NFe), 57 (CTe), 58 (MDFe), 65 (NFCe), 66 (NF3e);{justificativaPadrao}
opcional: Caso não seja preenchido e a contingência esteja habilitada, o campo será preenchido com "Sefaz fora do ar.";
Caso você envie mais de um modelo de DFe ou mais de um CNPJ, separe-os com ponto, vírgula, ponto e vírgula, quebra de linha ou caractere de espaço | . | , | ; | \n |
.
- Informe o x-auth-token no cabeçalho (
header parameters
) da requisição.
Exemplo de requisição
O exemplo abaixo traz um modelo de requisição preenchido para habilitar a contingência automática para NFe, CTe, MDFe, NFCe, NF3e de um CPNJ completo.
curl -L -X POST 'https://rest-teste.oobj.com.br/api/contingencia/cnpj' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '[
{
"cnpjs": "07385111000102",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"modelos": "55,57,58,65,66"
}
]'
Exemplo de retorno
[
{
"modelos": "55",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"cnpjs": "07385111000102"
},
{
"modelos": "57",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"cnpjs": "07385111000102"
},
{
"modelos": "58",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"cnpjs": "07385111000102"
},
{
"modelos": "65",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"cnpjs": "07385111000102"
},
{
"modelos": "66",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"cnpjs": "07385111000102"
}
]
Alterar contingência automática por Unidade Federativa (UF)
Para alterar a contingência automática de todas as unidades de um Estado (UF) específico, siga estes passos:
- Faça uma requisição tipo POST ao endpoint alterar contingência automática por UF;
[URL_BASE]/api/contingencia/uf
No corpo da requisição (
request body
) preencha os seguintes parâmetros:{contigenciaAutomaticaHabilitada}
*: true (para habilitar) ou false (para desabilitar);{modelos}
*: modelos para os quais a contingência será habilitada ou desabilitada. Valores aceitos: 55 (NFe), 57 (CTe), 58 (MDFe), 65 (NFCe), 66 (NF3e);{ufs}
*: UF ou lista de UFs. Valores aceitos: AC,AL,AP,AM,BA,CE,DF,ES,GO,MA,MT,MS,MG,PA,PB,PR,PE,PI,RJ,RN,RS,RO,RR,SC,SP,SE,TO;{justificativaPadrao}
opcional: Caso não seja preenchido e a contingência esteja habilitada, o campo será preenchido com "Sefaz fora do ar.";
Caso você envie mais de um modelo de DFe ou mais de um UF, separe-os com ponto, vírgula, ponto e vírgula, quebra de linha ou caractere de espaço | . | , | ; | \n |
.
- Informe o x-auth-token no cabeçalho (
header parameters
) da requisição.
Exemplo de requisição
O exemplo abaixo traz um modelo de requisição preenchido para habilitar a contingência automática para NFe, CTe, MDFe, NFCe, NF3e do estado Rio Grande do Sul (RS).
curl -L -X POST 'https://rest-teste.oobj.com.br/api/contingencia/uf' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '[
{
"modelos": "55,57,58,65,66"
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"ufs": "RS"
}
]'
Exemplo de retorno
[
{
"modelos": "55",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"ufs": "RS"
},
{
"modelos": "65",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"ufs": "RS"
},
{
"modelos": "66",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"ufs": "RS"
},
{
"modelos": "57",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"ufs": "RS"
},
{
"modelos": "58",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"ufs": "RS"
},
{
"modelos": "66",
"contigenciaAutomaticaHabilitada": true,
"justificativaPadrao": "Sefaz fora do ar.",
"ufs": "RS"
}
]
Pronto! Você acaba de completar a configuração da contingência automática.