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	Em desenvolvimento. A averbação existe, mas está bloqueada no ente. Pode voltar a reserved no desbloqueio. Não ocorre em reservas de cartão
canceled	A operação nunca existiu no ente: o ente recusou o registro, ou a reserva foi cancelada antes de o ente registrá-la
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	Em desenvolvimento. A operação existiu no ente e chegou ao fim: todas as parcelas foram processadas. Não ocorre em reservas de cartão

Os três status finais se distinguem pelo que aconteceu no ente: canceled nunca chegou lá, deleted chegou e saiu, settled (em desenvolvimento) 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 mudança de status depois da criaçã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	Em desenvolvimento. Empréstimo consignado
payroll_card	Cartão consignado
benefit_card	Cartão de 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 do retorno
description	Descrição do código, em inglês
translation	Descrição do código, em português

{
  "enumerator": "employee_not_authorized",
  "code": "LSCC0001",
  "description": "The employee did not authorize the margin inquiry",
  "translation": "O servidor não autorizou a consulta de margem"
}

Quando o status não precisa de explicação, a reserva traz reason como null, e a consulta de margem omite o campo — uma consulta completed, por exemplo.

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	Em desenvolvimento. O ente aceitou a reserva e aguarda a finalização da operação. Ocorre apenas nas modalidades registradas em duas etapas. Não ocorre em reservas de cartão
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
3	benefit_card	Cartão de Benefício
4	additional_margin	Margem adicional 5% — LF 14.131/2021
5	compulsory_consignment	Consignação Compulsória
6	debt_settlement	Quitação de Dívidas
999	total	Somatória

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

Situação da margem

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

Código	Enumerador	Situação	Efeito na consulta
1	available	Margem disponível	completed, com o valor informado
2	not_authorized	Consulta de margem não autorizada pelo servidor	failed, motivo employee_not_authorized, quando é a situação de todos os provimentos
3	unavailable	Margem indisponível	completed, com margem zerada
4	insufficient	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 ou expand=history, e é devolvido como {code, enumerator, translation}.

Código	Enumerador	Tradução
1	retired	Aposentado
2	public_exam_hire	Concursado
3	intern	Estagiário
4	clt_employee	Celetista
5	temporary	Temporário
6	pensioner	Pensionista
7	permanent	Efetivo
8	constitutionally_tenured	Estab. Constit
9	special_pension	Pensão Especial
10	elected_office	Emp. em Cargo Elet.
11	appointed_councillor	Nomeada Conselheiro
13	commissioned_only	Exclusivamente Comissão
14	provisional	Provisório
15	scholarship_holder	Bolsista
16	statutory	Estatutário
17	permanent_in_commission	Efetivo/CLT Permanente em Comissão/Confiança
18	health_commissioned	Comissionados Saúde
19	health	Saúde
20	health_inspector	Fiscais Saúde
21	health_production	Produção Saúde
22	inspector	Fiscais
23	selective_process_hire	Seletivos
24	family_health_program	PSF
25	unified_health_system	SUS
26	commissioned_pressem	Comissionados / Pressem
27	health_statutory	Estatutário Saúde
28	no_employment_bond	Sem Vínculo Empregatício
29	retirement_supplement	Complementação de Aposentadoria
30	pension_supplement	Complementação de Pensão
99001	not_authorized_by_entity	Consulta não autorizada pelo Ente
99002	not_authorized_by_employee	Consulta não autorizada pelo Servidor
99003	not_registered	Dados não registrados na base

Motivos

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

Consulta de margem

Código	Enumerador	Quando ocorre
LSCC0001	employee_not_authorized	O servidor não autorizou a consulta de margem no ente: todos os provimentos vieram com a situação not_authorized
ESCC0187	employee_not_found	O CPF não consta no cadastro de servidores do ente
ESCC0018	employee_registration_not_found	Os dados de cadastro do servidor não foram localizados no SCC

Um motivo fora desta tabela pode indicar um problema no cadastro da instituição no ente, e o translation traz a causa entre parênteses.

Reserva

Código	Enumerador	Status	Quando ocorre
ESCC0049	margin_unavailable	canceled	A margem consignável do servidor não está disponível
ESCC0050	insufficient_margin	canceled	A margem consignável do servidor é menor que o valor da parcela
ESCC0117	consignee_reservation_limit_exceeded	canceled	O servidor atingiu o número máximo de averbações com a instituição
ESCC0118	registration_number_reservation_limit_reached	canceled	A matrícula atingiu o número máximo de averbações
ESCC0158	disbursement_date_too_late	canceled	A data de início do contrato passa do limite de dias aceito pelo ente
ESCC0187	employee_not_found	canceled	O CPF não consta no cadastro de servidores do ente
ESCC0188	registration_number_not_found	canceled	A matrícula informada não existe no órgão
ESCC0189	registration_number_mismatch	canceled	A matrícula informada não confere com a cadastrada no órgão
ESCC0202	registration_number_not_registered	canceled	A matrícula informada não existe no órgão
ESCC0291	consignment_type_not_allowed_for_registration_number	canceled	A matrícula do servidor não permite contratar este produto
ESCC0463	reservation_not_authorized_by_agency	canceled	O órgão não autorizou o registro da averbação
ESCC0583	consignment_type_not_allowed_for_relationship_type	canceled	O tipo de vínculo do servidor não permite contratar este produto
ESCC0593	benefit_card_active_at_another_consignee	canceled	O servidor já tem um cartão benefício ativo em outra instituição
ESCC0594	no_active_registration_number	canceled	O servidor não tem matrícula ativa
LSCC0002	employee_refused_reservation	deleted	O servidor recusou a averbação no aplicativo do ente
LSCC0003	employee_approval_expired	deleted	O servidor não aprovou a averbação dentro do prazo
LSCC0004	deletion_requested	canceled ou deleted	A instituição solicitou a exclusão da averbação

Uma reserva pode terminar em canceled com outro código de recusa do ente: o primeiro código da recusa vira o motivo.