Consulta de Convênio Municipal

Método: GET

Endpoint: https://api.emitix.com.br/nfse/convenio

Descrição Geral

Permite consultar as parametrizações e regras de convênio ativas em um determinado município da SEFIN Nacional.

Função da Rota

• Verificar se um município possui convênio ativo com a plataforma nacional de NFS-e.
• Estudar quais regras específicas do município estão parametrizadas.

Situações de Uso

• Descobrir previamente se o modelo padrão (nacional) de emissão precisará de adaptações específicas exigidas pela cidade do prestador de serviços.
• Realizar onboarding de novos prestadores de serviço em novos municípios.

Campos da Requisição (Payload)

Campo	Tipo	Obrigatório	Descrição
cMun	string	✅	Código do Município (IBGE, 7 dígitos). Ex: '1234567'.
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: cnpj ou cpf.

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",
  "cnpj": "12345678000199"
}

Exemplo de Requisição Completa

curl -X GET https://api.emitix.com.br/nfse/convenio \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -H "api-key: <api_key>" \
  -d '{
    "cMun": "3550308",
    "cnpj": "12345678000199"
  }'

Exemplo de Resposta

{
  "success": true,
  "message": "Convênio municipal consultado com sucesso",
  "statusCode": 200,
  "data": {
    "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><retConsConvenio>...</retConsConvenio>",
    "response": {
      "cMun": "3550308",
      "convenioAtivo": true,
      "detalhes": "Município conveniado na plataforma nacional"
    }
  }
}