Ir para o conteúdo principal

[WIP] - Alíquota Previdenciária | 2026 ~

Tipo Envio: Balancete - Folha

Chave Unicidade

 [ Exercício - Código Unidade Gestora - Código Vantagem Desconto ]


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
codigoVantagemDesconto
aliquotaSegurado
aliquotaPatronal
protocoloLegislativoAliquotaSegurado
protocoloLegislativoAliquotaPatronal
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 Alíquotas",
  "description": "Lista de objetos representando a entidade Alíquotas",
  "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": "Alíquotas",
        "description": "Representação do schema para envio da entidade Alíquotas",
        "type": "object",
        "properties": {
          "codigoVantagemDesconto": {
            "type": "string",
            "minLength": 6,10,
            "maxLength": 6,10,
            "pattern": "^[0-9]+$"
          },
          "aliquotaSegurado": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "aliquotaPatronal": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "protocoloLegislativoAliquotaSegurado": {
            "type": "string",
            "minLength": 9,
            "maxLength": 9,
            "pattern": "^\\d{6}/\\d{2}$"
          },
          "protocoloLegislativoAliquotaPatronal": {
            "type": "string",
            "minLength": 9,
            "maxLength": 9,
            "pattern": "^\\d{6}/\\d{2}$"
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoVantagemDesconto",
          "aliquotaSegurado",
          "aliquotaPatronal",
          "protocoloLegislativoAliquotaSegurado",
          "protocoloLegislativoAliquotaPatronal",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}

Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "codigoVantagemDesconto": "001234"0000001234",
      "aliquotaSegurado": 8.5,
      "aliquotaPatronal": 12.5,
      "protocoloLegislativoAliquotaSegurado": "000001/25",
      "protocoloLegislativoAliquotaPatronal": "000002/25",
      "action": "CREATE"
    },
    {
      "codigoVantagemDesconto": "005678"0000001234",
      "aliquotaSegurado": 9.0,
      "aliquotaPatronal": 13.0,
      "protocoloLegislativoAliquotaSegurado": "000003/25",
      "protocoloLegislativoAliquotaPatronal": "000004/25",
      "action": "UPDATE"
    }
  ]
}

Regras

ID Regra
ALIQUOTA_PREVIDENCIARIA_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
ALIQUOTA_PREVIDENCIARIA_UNIDADE_GESTORA_RPPS Só deve ser cadastrada para unidades gestoras com RPPS