Interpretar fatura (RPA)
/v1/faturas/interpretacoesEnvia uma fatura (PDF em base64 ou `link`) para interpretação automatizada por robôs (RPA), usada quando a operadora não possui APIs públicas. Retorna os dados extraídos da fatura.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.
Request Body
application/jsonrequired
PDF/arquivo da fatura em base64.
Ver schema bruto / exemplo JSON
{
"cnpjCliente": "33055146000193",
"contrato": "1234",
"mes": "05",
"ano": "2026",
"valorFatura": 15000,
"link": "https://storage.operadora.com.br/faturas/maio-2026.pdf"
}Responses
Fatura interpretada.
Retorno padronizado de uma operação de escrita (`ResponseBaseSuccess`). Consolida o resultado, validações de negócio e dados de auditoria.
Código HTTP resultante do processamento na operadora.
Protocolo de rastreio gerado pela operadora.
Resumo do beneficiário afetado.
Validações/avisos retornados pela operadora.
items
Erros críticos de regra de negócio.
items
Crítica/erro de validação devolvido pela operadora.
URI exata da operadora chamada (auditoria).
Payload exato enviado à operadora (auditoria/troubleshooting).
Retorno cru (raw) devolvido pela API da operadora.
Requisição malformada (campos obrigatórios ausentes/ inválidos).
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica/erro de validação devolvido pela operadora.
Token ausente, expirado ou inválido.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica/erro de validação devolvido pela operadora.
Interpretar fatura (RPA)
/v1/faturas/interpretacoesEnvia uma fatura (PDF em base64 ou `link`) para interpretação automatizada por robôs (RPA), usada quando a operadora não possui APIs públicas. Retorna os dados extraídos da fatura.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.
Request Body
application/jsonrequired
PDF/arquivo da fatura em base64.
Ver schema bruto / exemplo JSON
{
"cnpjCliente": "33055146000193",
"contrato": "1234",
"mes": "05",
"ano": "2026",
"valorFatura": 15000,
"link": "https://storage.operadora.com.br/faturas/maio-2026.pdf"
}Responses
Fatura interpretada.
Retorno padronizado de uma operação de escrita (`ResponseBaseSuccess`). Consolida o resultado, validações de negócio e dados de auditoria.
Código HTTP resultante do processamento na operadora.
Protocolo de rastreio gerado pela operadora.
Resumo do beneficiário afetado.
Validações/avisos retornados pela operadora.
items
Erros críticos de regra de negócio.
items
Crítica/erro de validação devolvido pela operadora.
URI exata da operadora chamada (auditoria).
Payload exato enviado à operadora (auditoria/troubleshooting).
Retorno cru (raw) devolvido pela API da operadora.
Requisição malformada (campos obrigatórios ausentes/ inválidos).
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica/erro de validação devolvido pela operadora.
Token ausente, expirado ou inválido.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica/erro de validação devolvido pela operadora.