Consignado Público: Enumeradores

Tabelas de referência do Consignado Público. Esta é a única página onde estes enumeradores são definidos; as demais páginas linkam para as âncoras daqui.

Os enumeradores estão em dois grupos. Os gerais são do contrato da QI Tech e valem em todo ente. Os por perfil são definidos pela plataforma de consignação do ente, e por isso mudam com o perfil.

API em desenvolvimento

Esta API está em fase de desenvolvimento, sendo assim, esta página está sujeita a alterações.

Enumeradores gerais

Status da reserva

Status	Significado
pending_reservation	A reserva foi criada e aguarda o registro no ente
reserved	A averbação está ativa e a margem está comprometida. É o único status em que a operação é garantida
suspended	A averbação existe, mas está bloqueada no ente. Pode voltar a reserved no desbloqueio
canceled	A operação nunca existiu no ente: foi desistida antes do registro, ou as tentativas de registro se esgotaram
deleted	A operação existiu no ente e foi removida — pela QI Tech, pelo servidor, pelo órgão ou pelo decurso de um prazo
settled	A operação existiu no ente e chegou ao fim: todas as parcelas foram processadas

Os três status finais se distinguem pelo que aconteceu no ente: canceled nunca chegou lá, deleted chegou e saiu, settled chegou e terminou.

Entre pending_reservation e reserved pode haver status intermediários, conforme o número de etapas que o ente exige para registrar uma averbação. Ver Status adicionais do Perfil 1.

Cada transição gera um webhook.

Status da consulta de margem

Status	Significado
pending	A consulta foi criada e ainda não foi respondida pelo ente
completed	O ente respondeu. O documento com os vínculos e as margens está disponível
failed	A consulta não pôde ser respondida pelo ente

Margem zerada ou insuficiente produz completed, não failed.

Tipos de reserva

O tipo de reserva é a modalidade comercial da operação, e determina de qual produto a margem é consumida.

Enumerador	Modalidade
payroll_loan	Empréstimo consignado
payroll_card	Cartão consignado
benefit_card	Cartão benefício

Quais tipos cada ente oferece está em Entes Consignantes.

Esferas do ente

Enumerador	Esfera
state	Ente estadual
municipal	Ente municipal

É o primeiro segmento da rota, antes do enumerador do ente. Ver Entes Consignantes.

Motivos

Sempre que um status precisa ser explicado — uma consulta que falhou, uma averbação recusada ou removida — a resposta traz um objeto reason. A estrutura é geral; os valores são do ente, e vêm da plataforma em que a folha é consignada.

Campo	Descrição
enumerator	O motivo, em forma estável. É por ele que a integração deve ramificar
code	O código devolvido pelo ente consignante
description	Texto operacional, para diagnóstico
translation	Texto em português, apresentável ao usuário final

{
  "enumerator": "employee_not_authorized",
  "code": "...",
  "description": "...",
  "translation": "O servidor não autorizou a consulta de margem"
}

reason é null quando o status não precisa de explicação — uma consulta completed, uma reserva reserved.

Enumeradores por perfil de consignação

Perfil 1

Status adicionais da reserva

Neste perfil o registro da averbação tem até duas etapas, e a situação da averbação precisa ser confirmada depois do registro. Daí dois status além dos gerais:

Status	Significado
pending_finalization	O ente aceitou a reserva e aguarda a finalização da operação. Ocorre apenas nas modalidades registradas em duas etapas
pending_confirmation	A averbação foi registrada e a QI Tech aguarda o ente definir a sua situação — inclusive a aprovação do servidor, onde ela é exigida. Ver Confirmação

Produtos

O produto é o "balde" de margem consumido pela operação. O servidor tem um saldo de margem por produto, e tipos de reserva diferentes consomem produtos diferentes. Devolvido como {code, enumerator, name}.

Código	Enumerador	Nome
1	optional_consignment	Consignações Facultativas
2	credit_card	Cartão de Crédito
Demais códigos	Em construção	Em construção

Quais produtos existem em cada ente está em Entes Consignantes.

Situação da margem

Acompanha cada valor de margem na consulta de margem, e é devolvida como {code, enumerator, translation}.

Código	Situação	Efeito na consulta
1	Margem disponível	completed, com o valor informado
2	Consulta não autorizada pelo servidor	failed quando é a situação de todos os itens
3	Margem indisponível	completed, com margem zerada
4	Margem insuficiente	completed, com o valor informado

Os códigos 3 e 4 não são erro: a consulta foi respondida, e os vínculos descobertos continuam válidos para operações futuras.

Tipo de vínculo

Acompanha cada provimento quando a consulta é feita com expand=appointments, e é devolvido como {code, enumerator, translation}.

Código	Enumerador	Tradução
1	statutory	Estatutário
Demais códigos	Em construção	Em construção

Motivos

Motivos devolvidos por este perfil, na estrutura descrita em Motivos.

Enumerador	Quando ocorre
employee_not_authorized	O servidor não autorizou a consulta de margem no ente
Demais motivos	Em construção