Ir para o conteúdo principal

Folha Pagamento | 2025 ~

Tipo Envio: Balancete - Folha
Chave Unicidade

 [ Exercício - Código Unidade Gestora - CPF Servidor - Código Cargo - Número Matrícula - Mês Ano - Código Operação - Código Vantagem Desconto - Tipo - Código Agrupamento - Código Unidade Orçamentária ]

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 ✅ –
numeroMatricula ✅ –
mesAnoanoMes ✅ –
tipoLancamento ✅ Tabela Tipo Lançamento Folha Pagamento
codigoVantagemDesconto ✅ –
tipoFolha ✅ Tabela Tipo Folha
codigoAgrupamento ✅ –
codigoUnidadeOrcamentaria ✅ –
valor – –
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 Folha Pagamento",
  "description": "Lista de objetos representando a entidade Folha 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": "Folha de Pagamento",
        "description": "Representação do schema para envio da entidade Folha Pagamento",
        "type": "object",
        "properties": {
          "cpfServidor": {
            "type": "string",
            "minLength": 11,
            "maxLength": 11,
            "pattern": "^[0-9]+$"
          },
          "codigoCargo": {
            "type": "string",
            "minLength": 8,
            "maxLength": 8,
            "pattern": "^[0-9]+$"
          },
          "numeroMatricula": {
            "type": "string",
            "minLength": 15,
            "maxLength": 15
          },
          "mesAno"anoMes": {
            "type": "string",
            "minLength": 6,7,
            "maxLength": 6,7,
            "pattern": "^\\d{6}4}-(0[1-9]|1[0-2])$"
          },
          "tipoLancamento": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "codigoVantagemDesconto": {
            "type": "string",
            "minLength": 10,
            "maxLength": 10,
            "pattern": "^[0-9]+$"
          },
          "tipoFolha": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "valor": {
            "type": "number",
            "minimum": 0
          },
          "codigoAgrupamento": {
            "type": "string",
            "minLength": 10,
            "maxLength": 10,
            "pattern": "^[A-Z0-9]+$"
          },
          "codigoUnidadeOrcamentaria": {
            "type": "string",
            "minLength": 5,
            "maxLength": 5,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "cpfServidor",
          "codigoCargo",
          "numeroMatricula",
          "mesAno",
          "codigoOperacao",
          "codigoVantagemDesconto",
          "tipoFolha",
          "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",
      "numeroMatricula": "000000001234567",
      "mesAno"anoMes": "092025"2025-01",
      "tipoLancamento": "1",
      "codigoVantagemDesconto": "000001",
      "tipoFolha": "0",
      "valor": 1500.50,
      "codigoAgrupamento": "0900000001",
      "codigoUnidadeOrcamentaria": "12345",
      "action": "CREATE"
    },
    {
      "cpfServidor": "98765432109",
      "codigoCargo": "00000002",
      "numeroMatricula": "000000009876543",
      "mesAno"anoMes": "092025"2026-12",
      "tipoLancamento": "0",
      "codigoVantagemDesconto": "000002",
      "tipoFolha": "1",
      "valor": 250.75,
      "codigoAgrupamento": "0900000002",
      "codigoUnidadeOrcamentaria": "54321",
      "action": "UPDATE"
    }
  ]
}

Regras

Se a situação da ultima matricula for 2 não pode estar na folha 

ID Regra
FOLHA_PAGAMENTO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
FOLHA_PAGAMENTO_UNIDADE_ORCAMENTARIA_CADASTRADAFOLHA_PAGAMENTO_MATRICULA_CADASTRADA
A matrícula deve ter sido cadastrada para a unidade gestora
FOLHA_PAGAMENTO_COD_AGRUPAMENTO_CADASTRADOFOLHA_PAGAMENTO_UNIDADE_ORCAMENTARIA_CADASTRADA
A unidade orçamentária deve ter sido cadastrado para a Unidade Gestora no exercício
CODIGO_VANTAGEM_DESCONTO_CADASTRADOFOLHA_PAGAMENTO_CODIGO_AGRUPAMENTO_CADASTRADO
O código agrupamento deve ter sido cadastrado para a Unidade Gestora no exercício
FOLHA_PAGAMENTO_CODIGO_VANTAGEM_DESCONTO_CADASTRADOO código vantagem desconto deve ter sido cadastrado para a Unidade Gestora no exercício
FOLHA_PAGAMENTO_TIPO_LANCAMENTO_INVALIDOO Tipo lançamento deve ser válido conforme a Tabela Tipo Lançamento Folha Pagamento
FOLHA_PAGAMENTO_TIPO_FOLHA_INVALIDOO Tipo folha deve ser válido conforme a Tabela Tipo Folha
FOLHA_PAGAMENTO_MATRICULA_SITUACAO_INVALIDASe a última situação da matrícula for 2 (Óbito), não é permitida sua inclusão na folha.
Voltar ao topo