Consulta de Retenções Municipais
Método: GET
Endpoint: https://api.emitix.com.br/nfse/retencoes
Descrição Geral
A rota tem por finalidade disponibilizar acesso contábil e fiscal às informações relacionadas a fatores de retenção de ISS adotadas pelo município desejado dentro da referida data de competência.
Função da Rota
- Verificar se um imposto deve ser retido pelo tomador na época consultada.
- Garantir que não haverá emissão indevida sem as guias ou o desconto da retenção, ocasionando multas ou reemissões.
Situações de Uso
- Validação antecipada do serviço, confirmando a retenção antes do aceite comercial ou na modelagem do orçamento.
- Aplicação nativa de impostos corretos através de integração ERP.
Campos da Requisição (Payload)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cMun | string | ✅ | Código do Município (IBGE, 7 dígitos). Ex: '1234567'. |
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",
"competencia": "31-01-2024",
"cnpj": "12345678000199"
}
Exemplo de Requisição Completa
curl -X GET https://api.emitix.com.br/nfse/retencoes \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token>" \
-H "api-key: <api_key>" \
-d '{
"cMun": "3550308",
"competencia": "31-01-2024",
"cnpj": "12345678000199"
}'
Exemplo de Resposta
{
"success": true,
"message": "Retenções consultadas com sucesso",
"statusCode": 200,
"data": {
"xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><retConsRetencoes>...</retConsRetencoes>",
"response": {
"cMun": "3550308",
"retencaoObrigatoria": true,
"regrasAplicaveis": [
"1"
]
}
}
}