[WIP] - Folha Pagamento | 2025 ~

Tipo Envio: Balancete - Folha

Chave Unicidade

[ Exercício - ~~Mês -~~ Código Unidade Gestora - CPF Servidor - Código Cargo - ~~Data Movimentação -~~ Número Matrícula - Mês Ano - Código Operação - Código Vantagem Desconto - Tipo ]

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
`cpfServidor`	✅	–
`codigoCargo`	✅	–
`dataMovimentacao`	✅	–
`numeroMatricula`	✅	–
`mesAno`	✅	–
`cpfSeguradocodigoOperacao`	✅	`VANTAGEM` / `DESCONTO`
`codigoVantagemDesconto`	✅	–
`tipoFolha`	✅	–
`valor`	–	–
`tipoAtocodigoAgrupamento`	–	~~Tabela Tipo Ato Pessoal~~
`situacao`	–	`ATIVO` / `INATIVO` / `PENSIONISTA`
`tipoRegimePrevidenciario`	–	~~Tabela Tipo Regime Previdência~~
`tipoRegimeTrabalho`	–	~~Tabela Tipo Regime Trabalho~~
`codigoUnidadeOrcamentaria`	–	–
`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 HistóricoFolha Funcional"Pagamento",
  "description": "Lista de objetos representando a entidade HistóricoFolha Funcional"Pagamento",
  "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": "HistóricoFolha Funcional"Pagamento",
        "description": "Representação do schema para envio da entidade HistóricoFolha Funcional"Pagamento",
        "type": "object",
        "properties": {
          "cpfServidor": {
            "type": "string",
            "minLength": 11,
            "maxLength": 11,
            "pattern": "^[0-9]+$"
          },
          "codigoCargo": {
            "type": "string",
            "minLength": 8,
            "maxLength": 8,
            "pattern": "^[0-9]+$"
          },
          "dataMovimentacao": {
            "type": "string",
            "format": "date"
          },
          "numeroMatricula": {
            "type": "string",
            "minLength": 15,
            "maxLength": 15
          },
          "mesAno": {
            "type": "string",
            "minLength": 6,
            "maxLength": 6,
            "pattern": "^\\d{6}$"
          },
          "cpfSegurado"codigoOperacao": {
            "type": "string",
            "enum": [
              "VANTAGEM",
              "DESCONTO"
            ]
          },
          "codigoVantagemDesconto": {
            "type": "string",
            "minLength": 11,6,
            "maxLength": 11,6,
            "pattern": "^[0-9]+$"
          },
          "tipoAto": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^[0-9]+$"
          },
          "situacao"tipoFolha": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
          "enum": [
              "ATIVO"},
          "INATIVO"valor": {
            "type": "number",
            "PENSIONISTA"minimum": ]0
          },
          "tipoRegimePrevidenciario"codigoAgrupamento": {
            "type": "string",
            "minLength": 1,10,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "tipoRegimeTrabalho": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"10
          },
          "codigoUnidadeOrcamentaria": {
            "type": "string",
            "minLength": 5,
            "maxLength": 5,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "cpfServidor",
          "codigoCargo",
          "dataMovimentacao",
          "numeroMatricula",
          "mesAno",
          "tipoAto"codigoOperacao",
          "situacao"codigoVantagemDesconto",
          "tipoRegimePrevidenciario"tipoFolha",
          "tipoRegimeTrabalho"valor",
          "codigoAgrupamento",
          "codigoUnidadeOrcamentaria",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}

Exemplo de Payload

{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "cpfServidor": "12345678901",
      "codigoCargo": "00000001",
      "dataMovimentacao": "2025-03-15",
      "numeroMatricula": "000000001234567",
      "mesAno": "092025",
      "cpfSegurado"codigoOperacao": "00000000000"VANTAGEM",
      "tipoAto"codigoVantagemDesconto": "01"000001",
      "situacao"tipoFolha": "0",
      "tipoRegimePrevidenciario"valor": 1500.50,
      "codigoAgrupamento": "1",
      "tipoRegimeTrabalho": "1"0900000001",
      "codigoUnidadeOrcamentaria": "12345",
      "action": "CREATE"
    },
    {
      "cpfServidor": "98765432109",
      "codigoCargo": "00000002",
      "dataMovimentacao": "2025-07-22",
      "numeroMatricula": "000000009876543",
      "mesAno": "092025",
      "cpfSegurado"codigoOperacao": "11111111111"DESCONTO",
      "tipoAto"codigoVantagemDesconto": "02"000002",
      "situacao"tipoFolha": "2"1",
      "tipoRegimePrevidenciario"valor": 250.75,
      "codigoAgrupamento": "2",
      "tipoRegimeTrabalho": "2"0900000002",
      "codigoUnidadeOrcamentaria": "54321",
      "action": "UPDATE"
    }
  ]
}

Regras

ID	Regra
~~HISTORICO_FUNCIONAL_DUPLICIDADE_NAO_PERMITIDA~~FOLHA_PAGAMENTO_DUPLICIDADE_NAO_PERMITIDA	Não é permitido cadastrar registros duplicados pela chave de unicidade
~~HISTORICO_FUNCIONAL_CPF_SEGURADO_ZERO~~	~~Se for <> persionista~~
~~HISTORICO_TIPO_ATO_PESSOAL_VALIDO~~FOLHA_PAGAMENTO_UNIDADE_ORCAMENTARIA_CADASTRADA
~~HISTORICO_FUNCIONAL_TIPO_REGIME_PREV_VALIDO~~
~~HISTORICO_FUNCIONAL_TIPO_REGIME_TRAB_VALIDO~~FOLHA_PAGAMENTO_COD_AGRUPAMENTO_CADASTRADO