Consulta de Benefício Municipal
Método: GET
Endpoint: https://api.emitix.com.br/nfse/beneficio
Descrição Geral
Permite consultar se existe algum tipo de benefício municipal ativo e aplicável para aquele município, baseado no código do benefício, na data de competência e no prestador.
Função da Rota
- Verificar a existência e as regras de um determinado código de benefício municipal.
- Avaliar se as tratativas de impostos sofrerão abatimento ou isenção baseadas num benefício cadastrado.
Situações de Uso
- Parametrização do imposto no momento da emissão da nota fiscal, garantindo a aplicação de eventuais descontos fiscais ou isenções vigentes no município.
Campos da Requisição (Payload)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cMun | string | ✅ | Código do Município (IBGE, 7 dígitos). Ex: '1234567'. |
cBenef | string | ✅ | Código do benefício a ser verificado (exatamente 14 dígitos). |
competencia | string | ✅ | Data de competência no formato 'DD-MM-YYYY'. Ex: '31-01-2024'. |
cnpj | string | ⚙️ Opcional* | CNPJ do prestador (obrigatório se CPF não for informado). |
cpf | string | ⚙️ Opcional* | CPF do prestador (obrigatório se CNPJ não for informado). |
certificate | string | ⚙️ Opcional | Certificado digital A1 em base64. Se não enviado, utiliza-se o cadastrado no sistema. |
pass_certificate | string | ⚙️ Opcional | Senha do certificado digital A1. |
Observação: Deve ser informado obrigatoriamente apenas um dos identificadores do prestador:
cnpjoucpf.
Autenticação
A rota exige autenticação dupla através dos cabeçalhos:
- Bearer Token
Authorization: Bearer <seu_token_de_acesso>
- API Key
api-key: <sua_api_key>
Exemplo de Payload
{
"cMun": "3550308",
"cBenef": "12345678901234",
"competencia": "31-01-2024",
"cnpj": "12345678000199"
}
Exemplo de Requisição Completa
curl -X GET https://api.emitix.com.br/nfse/beneficio \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token>" \
-H "api-key: <api_key>" \
-d '{
"cMun": "3550308",
"cBenef": "12345678901234",
"competencia": "31-01-2024",
"cnpj": "12345678000199"
}'
Exemplo de Resposta
{
"success": true,
"message": "Benefício municipal consultado com sucesso",
"statusCode": 200,
"data": {
"xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><retConsBeneficio>...</retConsBeneficio>",
"response": {
"cMun": "3550308",
"cBenef": "12345678901234",
"status": "Ativo",
"descricao": "Isenção parcial de ISS"
}
}
}