Dependência, distinção e obrigatoriedade entre débitos veiculares

Os débitos retornados pela nossa API de pesquisa de débitos veiculares retornam 3 campos especialmente confeccionados para determinar a forma como aqueles débitos deverão ser liquidados.

É extremamente importante que as regras de depends_on e distinct sejam respeitadas no front das aplicações. Trata-se de uma responsabilidade do parceiro e deve ser vista com prioridade para que não exista nenhum prejuízo posterior.

required: Campo booleano que indica a obrigatoriedade da presença daquele débito no pagamento.
É comum em cenários onde o cliente deseja licenciar o veículo.

O que é a regra de depends_on?
Quando um débito possuir depends_on de outro(s) débito(s), esses outros débitos obrigatoriamente deverão seguir o fluxo de seleção e pagamento junto com esse.

depends_on: É uma lista de IDs de outros débitos, indica que se aquele débito for enviado para pagamento, todos os débitos informados nesse campo deverão ser pagos também.
Exemplo: ao pagar um Licenciamento, todas as multas do mesmo ano devem ser pagas em conjunto.

O que é a regra de distinct?
Quando um débito possui um distinct, de outro(s) débito(s), esses outros débitos obrigatoriamente NÃO deverão seguir o fluxo de seleção e pagamento junto com esse.

distinct: É uma lista de IDs de outros débitos, indica débitos que não devem ser pagos em conjunto.
É comum em casos em que a cota única e as cotas parceladas de um mesmo IPVA são apresentadas no retorno da pesquisa, caso o cliente selecione a cota única para ser paga, a cota parcelada não deverá ser selecionada.

❗️

Atenção as regras por estado

Por lei, para licenciar o veículo é necessário o pagamento de todos os débitos vencidos até a data de pagamento, alguns estados permitem que geremos o boleto de débitos avulsos sem dependência, outras pedem que paguemos as cotas anteriores, etc.

Com isso a Zapay tem uma regra padrão, onde: IPVA único é distinto de IPVA parcelado, cota parcelada depende da sua anterior. e também temos as regras específicas para cada estado, sendo:

Estado	Regras
Bahia	Todos os débitos são dependentes entre si
Ceará	Licenciamento depende de todos os débitos vencidos + taxa de emissão
Distrito Federal	Regra padrão Zapay
Goiás	Não existem regras de dependência
Minas Gerais	Regra padrão Zapay
Piauí	Regra Padrão Zapay
Rio Grande do Norte	Regra padrão Zapay
Rio de Janeiro	Regra padrão Zapay
São Paulo	- Licenciamento do ano anterior depende de todos os débitos vencidos - Licenciamento do ano atual depende de todos os débitos vencidos + IPVA único do ano atual depends_on: - Licenciamento: Precisa estar selecionado com: multas e IPVA cota única (independente do ano de vencimento) - Multa: Pode ser pago avulso/sozinho - IPVA cota única: Precisa estar selecionado com: multas e licenciamento (independente do ano de vencimento) - IPVA cota parcelada: Pode ser pago avulso/sozinho distinct: - Licenciamento: Não pode estar selecionado com: IPVA cota parcelada (independente do ano de vencimento) - Multa: Pode ser pago avulso/sozinho - IPVA cota única: Não pode estar selecionado com: IPVA cota parcelada (independente do ano de vencimento) - IPVA cota parcelada: Não pode estar selecionado com licenciamento e IPVA cota única (independente do ano de vencimento)

📘

Pagamento dos débitos

Se o usuário consultar débitos por meio de nossa API e desejar efetuar o pagamento, nosso módulo oferece várias opções para simular, realizar o pagamento e liquidar um débito veicular.

No tópico Pagamentos, você todos os detalhes de como seguir com a liquidação.