Skip to main content

Consignado Público: Entes Consignantes

Esta é a página de referência dos entes consignantes atendidos pelo Consignado Público: quais existem, como nomeá-los nas rotas, qual perfil de consignação cada um usa e o que cada um exige de diferente. As demais páginas desta seção — e o Manual Cartão Consignado, na fonte public_payroll — apontam para as âncoras daqui.

API em desenvolvimento

Os enumeradores de ente e de esfera ainda estão em definição e podem mudar até o lançamento.

Entes atendidos

Enteconsignment_entityentity_levelQuem atendePerfil
Governo do Estado de São PaulospstateServidores estaduais de São Paulo, ativos e inativosPerfil 1
Município de São Paulosao_paulo_spmunicipalServidores municipais de São PauloPerfil 1Em desenvolvimento

O par (entity_level, consignment_entity) identifica o ente em toda a API:

POST /public_payroll/state/sp/balance_inquiry

Perfis de consignação

Cada ente mantém a sua folha em uma plataforma de consignação, e as plataformas diferem em três coisas: como identificam o servidor, como informam a margem e quais enumeradores usam. O conjunto dessas três é o que chamamos de perfil.

Entes na mesma plataforma compartilham o perfil e, portanto, os mesmos payloads — o perfil é documentado uma vez, aqui, e a tabela de entes diz qual perfil cada ente usa.

O servidor é identificado pelo órgão em que trabalha e pela matrícula que tem nesse órgão. A margem é apurada por cargo e consolidada no nível da matrícula.

Identificação do servidor

CampoTipoDescriçãoObrigatório
agencystringEnumerador do órgão do servidor — a unidade pagadora dentro do ente: secretaria, autarquia, instituto de previdênciaSim
registration_numberstringMatrícula do servidor no órgão. Um mesmo CPF pode ter mais de umaSim
{
"employment_relationship": {
"agency": "spprev",
"registration_number": "1234567890123"
}
}

Os dois valores vêm da Consulta de Margem.

A averbação é registrada no nível da matrícula, e o órgão é o que determina o calendário de folha e os limites comerciais da operação.

Estrutura da margem

Abaixo da matrícula existe o provimento: cada cargo concorrente que o servidor ocupa sob a mesma matrícula. A margem é apurada por provimento e por produto — o "balde" de margem que cada tipo de operação consome.

A consulta entrega a margem já consolidada no nível da matrícula, aplicando a regra do ente: somar os provimentos, ou considerar apenas o maior. A regra usada vem no campo rule. Os valores por provimento ficam disponíveis sob demanda, com expand=appointments.

Enumeradores deste perfil

Particularidades por ente

ItemValor
consignment_entitysp
entity_levelstate
PerfilPerfil 1
Regra de margem entre provimentosMaior provimento — os provimentos não somam
Aprovação do servidorObrigatória em toda averbação nova

Aprovação do servidor

Desde 01.05.2026, o Governo do Estado de São Paulo exige que o próprio servidor aprove cada nova averbação no aplicativo do ente, com validação biométrica. A aprovação acontece depois que a averbação é registrada e vale até o fim do mesmo dia: o que não for aprovado nesse prazo é cancelado pelo ente por decurso de prazo.

Duas consequências para a integração:

  • A averbação passa por um período de confirmação antes de ser considerada efetiva. Ver Confirmação.
  • Averbações enviadas perto do fim do dia são retidas pela QI Tech e submetidas na janela seguinte, para não nascerem sem tempo hábil de aprovação.

Margem entre provimentos

Quando um servidor tem mais de um provimento na mesma matrícula, a margem considerada é a do maior provimento, não a soma. A Consulta de Margem já entrega o valor consolidado com essa regra aplicada, e informa no campo rule qual regra usou.

Órgãos

O enumerador do órgão é o valor enviado em agency.

ÓrgãoagencyCalendário de folha
São Paulo PrevidênciaspprevEm construção
Demais órgãosEm construçãoEm construção

Os exemplos desta seção usam spprev.

Tipos de reserva e produtos

Cada tipo de reserva oferecido pelo ente consome a margem de um produto.

Tipo de reservaProduto
payroll_cardcredit_card (2)
benefit_cardEm construção
payroll_loanEm construção

Canais de autorização

Valores aceitos em authorization.channel na consulta de margem.

channelOnde a anuência é colhida
Em construçãoEm construção

Limites comerciais

Prazo máximo e carência máxima da operação são definidos por órgão e por tipo de reserva. Para o cartão consignado, o Manual Cartão Consignado descreve como esses limites são aplicados na contratação.