Registrar baixa de fatura
/v1/faturas/baixasRegistra a baixa (quitação) de uma fatura de operadora. > **NÃO HOMOLOGADO:** este fluxo depende de integração Protheus do > lado da Izii e **nunca foi testado** no ambiente dev (confirmado com > a Izii em 16/07/2026). Contrato e códigos de resposta ainda não > verificados; não desenvolva contra este endpoint sem homologar antes.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino, atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.
ex: 01685053000156Request Body
application/jsonrequired
Ver schema bruto / exemplo JSON
{
"cnpjCliente": "33055146000193",
"contrato": {
"codigo": "1234",
"acesso": {
"usuario": "robo-rpa",
"senha": "***"
}
}
}Responses
Baixa registrada (não homologado; código de resposta não verificado).
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. Campos conforme respostas reais capturadas em 16/07/2026; cada operação popula um subconjunto.
Igual ao `protocolo`.
INCLUSAO, EXCLUSAO, ...
Emitida quando a movimentação é liberada pela operadora.
Matrícula na operadora. GUARDE (exigida na exclusão como `matriculaEmpresa`).
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.
Registrar baixa de fatura
/v1/faturas/baixasRegistra a baixa (quitação) de uma fatura de operadora. > **NÃO HOMOLOGADO:** este fluxo depende de integração Protheus do > lado da Izii e **nunca foi testado** no ambiente dev (confirmado com > a Izii em 16/07/2026). Contrato e códigos de resposta ainda não > verificados; não desenvolva contra este endpoint sem homologar antes.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino, atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.
ex: 01685053000156Request Body
application/jsonrequired
Ver schema bruto / exemplo JSON
{
"cnpjCliente": "33055146000193",
"contrato": {
"codigo": "1234",
"acesso": {
"usuario": "robo-rpa",
"senha": "***"
}
}
}Responses
Baixa registrada (não homologado; código de resposta não verificado).
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. Campos conforme respostas reais capturadas em 16/07/2026; cada operação popula um subconjunto.
Igual ao `protocolo`.
INCLUSAO, EXCLUSAO, ...
Emitida quando a movimentação é liberada pela operadora.
Matrícula na operadora. GUARDE (exigida na exclusão como `matriculaEmpresa`).
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.