Ir para o conteúdo principal

[WIP] - Código Vantagem Desconto | 2025 ~

Tipo Envio: Balancete - Folha
Chave Unicidade

 [ Exercício - Código Unidade Gestora - Tipo Lançamento - Código - Descrição - Tipo - Base Cálculo Previdenciário - Protocolo TCE Leg Aliq RPPS - Alíquota Patronal - Protocolo TCE Leg Vantagem ]

Objeto Raiz
Campo Informações
timestamp Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente
elementos –
Item
Campo Chave Informações
tipoLancamentoFolhaPagamento ✅ Tabela Tipo Lançamento Folha Pagamento
codigo ✅ –
descricao ✅ –
tipoContabilizacaoFolhaPagamento ✅ Tabela Tipo Contabilização Folha Pagamento
baseCalculoPrevidenciario ✅ –
protocoloTCELegAliqRPPS ✅ –
aliquotaPatronal ✅ –
protocoloTCELegVantagem ✅ –
action – Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão
Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Lista de Códigos Vantagem Desconto",
  "description": "Lista de objetos representando a entidade Código Vantagem Desconto",
  "type": "object",
  "properties": {
    "timestamp": {
      "type": "string",
      "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)\\.\\d{3,6}$",
      "examples": ["2025-09-11T15:30:00.123456"]
    },
    "elementos": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "title": "Código Vantagem Desconto",
        "description": "Representação do schema para envio da entidade Código Vantagem Desconto",
        "type": "object",
        "properties": {
          "tipoLancamento": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-1]$"
          },
          "codigo": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^[0-9]+$"
          },
          "descricao": {
            "type": "string",
            "minLength": 10,
            "maxLength": 50
          },
          "tipo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1
            ]
          },
          "baseCalculoPrevidenciario": {
            "type": "string",
            "enum": [
              "SIM",
              "NAO"
            ]
          },
          "protocoloTCELegAliqRPPS": {
            "type": "string",
            "minLength": 9,
            "maxLength": 9,
            "pattern": "^\\d{6}/\\d{2}$"
          },
          "aliquotaPatronal": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^\\d{3},\\d{2}$"
          },
          "protocoloTCELegVantagem": {
            "type": "string",
            "minLength": 9,
            "maxLength": 9,
            "pattern": "^\\d{6}/\\d{2}$"
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "tipoLancamentoFolhaPagamento",
          "codigo",
          "descricao",
          "tipoContabilizacaoFolhaPagamento",
          "baseCalculoPrevidenciario",
          "aliquotaPatronal",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}
Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "tipoLancamentoFolhaPagamento": "0",
      "codigo": "000001",
      "descricao": "Adição noturna remuneração",
      "tipoContabilizacaoFolhaPagamento": "0",
      "baseCalculoPrevidenciario": "SIM",
      "protocoloTCELegAliqRPPS": "123456/25",
      "aliquotaPatronal": "028,00",
      "protocoloTCELegVantagem": "654321/25",
      "action": "CREATE"
    },
    {
      "tipoLancamentoFolhaPagamento": "1",
      "codigo": "000002",
      "descricao": "Desconto contribuição sindical mensal",
      "tipoContabilizacaoFolhaPagamento": "0",
      "baseCalculoPrevidenciario": "NAO",
      "protocoloTCELegAliqRPPS": "000000/00",
      "aliquotaPatronal": "000,00",
      "protocoloTCELegVantagem": "111111/25",
      "action": "CREATE"
    }
  ]
}

Regras

ID Regra
CODIGO_VANTAGEM_DESCONTO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade

CODIGO_VANTAGEM_DESCONTO_DESCONTO_ALIQUOTA_ZERO

 Se o tipo lançamento for 1 (Desconto), a Alíquota Patronal deve ser preenchido com ’000,00’
CODIGO_VANTAGEM_DESCONTO_PROTOCOLO_ALIQ_RPPS_CADASTRADO
CODIGO_VANTAGEM_DESCONTO_PROTOCOLO_LEG_CADASTRADO
CODIGO_VANTAGEM_DESCONTO_BASE_CALCULO_PREVIDENCIARIO_INVALIDO Para registros do tipo lançamento = 0 (Vantagem), o campo baseCalculoPrevidenciario deve ser informado com:
S = para RPPS
N = para RGPS
CODIGO_VANTAGEM_DESCONTO_PROTOCOLO_ALIQ_RPPS_OBRIGATORIO Para registros do tipo lançamento = 0 (Vantagem) em favor do RPPS, o campo protocoloTCELegAliqRPPS deve ser informado
CODIGO_VANTAGEM_DESCONTO_PROTOCOLO_ALIQ_RPPS_NAO_DEVE_SER_ENVIADO Para registros do tipo lançamento = 0 (Vantagem) em favor do RGPS, o campo protocoloTCELegAliqRPPS não deve ser enviado
CODIGO_VANTAGEM_DESCONTO_ALIQUOTA_PATRONAL_FORMATO_INVALIDO O campo AliquotaPatronal deve ser informado no formato ‘000,00’.
Exemplo: para 28%, informar ‘028,00’.
Para RGPS, o valor deve considerar a soma de RAT e FAP
CODIGO_VANTAGEM_DESCONTO_PROTOCOLO_VANTAGEM_OBRIGATORIO Para registros com tipoLancamento = 0 (Vantagem), o campo protocoloTCELegVantagem deve ser informado 
Voltar ao topo