Entidades - Folha

Esta página apresenta todas as informações para o recebimento dos dados de folha no SAGRES Captura 2.0.


⚠️ Páginas com a tag [WIP] ainda estão em revisão pelo TCE e/ou não foram implementadas, podendo sofrer alterações.

Alíquota Previdenciária


Alíquota Previdenciária

Alíquota Previdenciária | 2026 ~

Tipo Envio: Balancete - Folha
Chave Unicidade

 [ Exercício - Código Unidade Gestora - Código Vantagem Desconto - Aliquota Segurado - Aliquota Patronal - Protocolo Leg. Aliquota Segurado - Protocolo Leg. Aliquota Patronal ]

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": 10,
            "maxLength": 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": "0000001234",
      "aliquotaSegurado": 8.5,
      "aliquotaPatronal": 12.5,
      "protocoloLegislativoAliquotaSegurado": "000001/25",
      "protocoloLegislativoAliquotaPatronal": "000002/25",
      "action": "CREATE"
    },
    {
      "codigoVantagemDesconto": "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
ALIQUOTA_PREVIDENCIARIA_OBRIGATORIO_RPPS_JANEIRO Para municípios com RPPS, é obrigatório que todas as UGs realizem envio no mês de janeiro.

Cargo

Cargo

Cargo | 2025 ~

Tipo Envio: Balancete - Folha
Chave Unicidade

 [ Exercício - Código Unidade Gestora - Código Cargo - Descrição - Tipo Cargo - Tipo Natureza Acumulação - Escolaridade Mínima - Protocolo TCE - Atribuições Lei - Requisitos Investidura - Quantidade Vagas Total - Tipo Regime Trabalho - Tipo Regime Previdência ]

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 –
Campo Chave Informações
codigoCargo ✅ –
descricao ✅ –
tipoCargo ✅ Tabela Tipo Cargo
tipoNaturezaAcumulacao ✅ Tabela Tipo Natureza Acumulação
escolaridadeMinima ✅ Tabela Tipo Escolaridade
protocoloTCE ✅ –
atribuicoesLei ✅ –
requisitosInvestidura ✅ –
quantidadeVagasTotal ✅ –
tipoRegimeTrabalho ✅ Tabela Tipo Regime Trabalho
tipoRegimePrevidencia ✅ Tabela Tipo Regime Previdência
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 Cargos",
  "description": "Lista de objetos representando a entidade Cargo",
  "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": "Cargo",
        "description": "Representação do schema para envio da entidade Cargo",
        "type": "object",
        "properties": {
          "codigoCargo": {
            "type": "string",
            "minLength": 8,
            "maxLength": 8,
            "pattern": "^[A-Z0-9]+$"
          },
          "descricao": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50
          },
          "tipoCargo": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "tipoNaturezaAcumulacao": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "escolaridadeMinima": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "protocoloTCE": {
            "type": "string",
            "minLength": 9,
            "maxLength": 9,
            "pattern": "^\\d{6}/\\d{2}$"
          },
          "atribuicoesLei": {
            "type": "string",
            "minLength": 10,
            "maxLength": 1000
          },
          "requisitosInvestidura": {
            "type": "string",
            "minLength": 10,
            "maxLength": 1000
          },
          "quantidadeVagasTotal": {
            "type": "integer",
            "exclusiveMinimum": 0
          },
          "tipoRegimeTrabalho": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "tipoRegimePrevidencia": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigoCargo",
          "descricao",
          "tipoCargo",
          "tipoNaturezaAcumulacao",
          "escolaridadeMinima",
          "protocoloTCE",
          "atribuicoesLei",
          "requisitosInvestidura",
          "quantidadeVagasTotal",
          "tipoRegimeTrabalho",
          "tipoRegimePrevidencia",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}
Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "codigoCargo": "12345678",
      "descricao": "Assistente de Administração",
      "tipoCargo": "1",
      "tipoNaturezaAcumulacao": "2",
      "escolaridadeMinima": "1",
      "protocoloTCE": "000000/00",
      "atribuicoesLei": "Prestar suporte administrativo, organizando documentos, agendamentos e correspondências da unidade gestora.",
      "requisitosInvestidura": "15",
      "quantidadeVagasTotal": 5,
      "tipoRegimeTrabalho": "01",
      "tipoRegimePrevidencia": "02",
      "action": "CREATE"
    },
    {
      "codigoCargo": "87654321",
      "descricao": "Diretor Executivo",
      "tipoCargo": "2",
      "tipoNaturezaAcumulacao": "1",
      "escolaridadeMinima": "3",
      "protocoloTCE": "000001/00",
      "atribuicoesLei": "Exercer liderança estratégica da unidade, supervisionando equipes e garantindo cumprimento de metas.",
      "requisitosInvestidura": "18",
      "quantidadeVagasTotal": 1,
      "tipoRegimeTrabalho": "01",
      "tipoRegimePrevidencia": "01",
      "action": "DELETE"
    }
  ]
}

Regras

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

O tipo deve ser válido para o exercício do envio, conforme a

Tabela Tipo Escolaridade
CARGO_TIPO_VALIDO

O tipo deve ser válido para o exercício do envio, conforme a

Tabela Tipo Cargo
CARGO_TIPO_NATUREZA_ACUMULACAO_VALIDO

O tipo deve ser válido para o exercício do envio, conforme a

Tabela Tipo Natureza Acumulação
CARGO_PROTOCOLO_TCE_VALIDO O protocolo deve ter sido cadastrado no banco do TCE
CARGO_TIPO_REGIME_TRABALHO_VALIDO

O tipo deve ser válido para o exercício do envio, conforme a

Tabela Tipo Regime Trabalho
CARGO_TIPO_REGIME_PREVIDENCIA_VALIDO

O tipo deve ser válido para o exercício do envio, conforme a

Tabela Tipo Regime Previdência

Código Agrupamento Folha Pagamento

Código Agrupamento Folha Pagamento

Código Agrupamento Folha Pagamento | 2025 ~

Tipo Envio: Balancete - Folha
Chave Unicidade

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

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
codigo ✅ –
descricao – –
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 Agrupamento Folha Pagamento",
  "description": "Lista de objetos representando a entidade Código Agrupamento 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": "Código Agrupamento Folha Pagamento",
        "description": "Representação do schema para envio da entidade Código Agrupamento Folha Pagamento",
        "type": "object",
        "properties": {
          "codigo": {
            "type": "string",
            "minLength": 10,
            "maxLength": 10,
            "pattern": "^[A-Z0-9]+$"
          },
          "descricao": {
            "type": "string",
            "minLength": 10,
            "maxLength": 100
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "codigo",
          "descricao",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}
Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "codigo": "0900000001",
      "descricao": "Agrupamento Folha Pagamento Setembro Servidores",
      "action": "CREATE"
    },
    {
      "codigo": "0900000002",
      "descricao": "Agrupamento Folha Pagamento Setembro Pensionistas",
      "action": "CREATE"
    }
  ]
}

Regras

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

Código Vantagem Desconto

Código Vantagem Desconto

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 ✅ –
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": {
          "tipoLancamentoFolhaPagamento": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-1]$"
          },
          "codigo": {
            "type": "string",
            "minLength": 10,
            "maxLength": 10,
            "pattern": "^[0-9]+$"
          },
          "descricao": {
            "type": "string",
            "minLength": 10,
            "maxLength": 100
          },
          "tipoContabilizacaoFolhaPagamento": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1
          },
          "baseCalculoPrevidenciario": {
            "type": "string",
            "enum": [
              "SIM",
              "NAO"
            ]
          },
          "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",
          "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",
      "protocoloTCELegVantagem": "654321/25",
      "action": "CREATE"
    },
    {
      "tipoLancamentoFolhaPagamento": "1",
      "codigo": "000002",
      "descricao": "Desconto contribuição sindical mensal",
      "tipoContabilizacaoFolhaPagamento": "0",
      "baseCalculoPrevidenciario": "NAO",
      "action": "CREATE"
    }
  ]
}

Regras

ID Regra
CODIGO_VANTAGEM_DESCONTO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
CODIGO_VANTAGEM_DESCONTO_PROTOCOLO_LEG_OBRIGATORIO Para registros com Tipo de Lançamento = 0 (Vantagem), o protocolo TCE é obrigatório e deve ter sido cadastrado no banco TCE

Folha Pagamento

Folha Pagamento

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 - 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 ✅ –
mes ✅ –
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
          },
          "mes": {
            "type": "string",
            "minLength": 2,
            "maxLength": 2,
            "pattern": "^(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",
          "mes",
          "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",
      "mes": "01",
      "tipoLancamento": "1",
      "codigoVantagemDesconto": "000001",
      "tipoFolha": "0",
      "valor": 1500.50,
      "codigoAgrupamento": "0900000001",
      "codigoUnidadeOrcamentaria": "12345",
      "action": "CREATE"
    },
    {
      "cpfServidor": "98765432109",
      "codigoCargo": "00000002",
      "numeroMatricula": "000000009876543",
      "mes": "12",
      "tipoLancamento": "0",
      "codigoVantagemDesconto": "000002",
      "tipoFolha": "1",
      "valor": 250.75,
      "codigoAgrupamento": "0900000002",
      "codigoUnidadeOrcamentaria": "54321",
      "action": "UPDATE"
    }
  ]
}

Regras

ID Regra
FOLHA_PAGAMENTO_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
FOLHA_PAGAMENTO_MES_INVALIDO O mês da folha não pode ser maior que o do envio
FOLHA_PAGAMENTO_MATRICULA_CADASTRADA A matrícula deve ter sido cadastrada para a unidade gestora
FOLHA_PAGAMENTO_UNIDADE_ORCAMENTARIA_CADASTRADA A unidade orçamentária deve ter sido cadastrado para a Unidade Gestora no exercício
FOLHA_PAGAMENTO_CODIGO_AGRUPAMENTO_CADASTRADO O código agrupamento deve ter sido cadastrado para a Unidade Gestora no exercício
FOLHA_PAGAMENTO_CODIGO_VANTAGEM_DESCONTO_CADASTRADO O código vantagem desconto deve ter sido cadastrado para a Unidade Gestora no exercício
FOLHA_PAGAMENTO_TIPO_LANCAMENTO_INVALIDO O Tipo lançamento deve ser válido conforme a Tabela Tipo Lançamento Folha Pagamento
FOLHA_PAGAMENTO_TIPO_FOLHA_INVALIDO O Tipo folha deve ser válido conforme a Tabela Tipo Folha
FOLHA_PAGAMENTO_MATRICULA_SITUACAO_INVALIDA Se a última situação da matrícula for 2 (Óbito), não é permitida sua inclusão na folha.

Matricula

Matricula

Matricula | 2025 ~

Tipo Envio: Balancete - Folha
Chave Unicidade

 [ Código Unidade Gestora - CPF Servidor - Código Cargo - Número - Data Situação - Situação Matrícula - Carga Horá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 ✅ –
numero ✅ –
dataSituacao ✅ –
situacaoMatricula ✅ Tabela Situação Matrícula
cargaHoraria ✅ –
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 Matrículas",
  "description": "Lista de objetos representando a entidade Matrícula",
  "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": "Matrícula",
        "description": "Representação do schema para envio da entidade Matrícula",
        "type": "object",
        "properties": {
          "cpfServidor": {
            "type": "string",
            "minLength": 11,
            "maxLength": 11,
            "pattern": "^[0-9]+$"
          },
          "codigoCargo": {
            "type": "string",
            "minLength": 8,
            "maxLength": 8
          },
          "numero": {
            "type": "string",
            "minLength": 15,
            "maxLength": 15,
            "pattern": "^[A-Z0-9]+$"
          },
          "dataSituacao": {
            "type": "string",
            "format": "date"
          },
          "situacaoMatricula": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1,
            "pattern": "^[0-9]+$"
          },
          "cargaHoraria": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "cpfServidor",
          "codigoCargo",
          "numero",
          "dataSituacao",
          "situacaoMatricula",
          "cargaHoraria",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}
Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "cpfServidor": "12345678901",
      "codigoCargo": "CAR00001",
      "numero": "000000001234567",
      "dataSituacao": "2015-03-15",
      "situacaoMatricula": "1",
      "cargaHoraria": "40",
      "action": "CREATE"
    },
    {
      "cpfServidor": "98765432109",
      "codigoCargo": "CAR00002",
      "numero": "000000009876543",
      "dataSituacao": "2018-07-22",
      "situacaoMatricula": "0",
      "cargaHoraria": "20",
      "action": "UPDATE"
    }
  ]
}

Regras

ID Regra
MATRICULA_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
MATRICULA_CARGO_CADASTRADO O cargo deve ter sido cadastrado para a Unidade Gestora
MATRICULA_SERVIDOR_CADASTRADO O servidor deve ter sido cadastrado para a Unidade Gestora
MATRICULA_TIPO_SITUACAO_VALIDO O Tipo de situação deve ser válido conforme a Tabela Situação Matrícula
MATRICULA_SITUACAO_INVALIDA Se a última situação da matrícula for 1 (Aposentadoria) ou 2 (Óbito), não é permitida a inclusão de novas situações.
MATRICULA_SITUACAO_TIPO_5_INVALIDO A inclusão de situação do tipo 5 (Retorno Afastamento Temporário) é permitida somente quando a última situação da matrícula for do tipo 4 (Afastamento Temporário).

Servidor

Servidor

Servidor | 2025 ~

Tipo Envio: Balancete - Folha
Chave Unicidade

 [ Código Unidade Gestora - CPF - Nome - Data Nascimento - Sexo - Possui Deficiência ]

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
cpf ✅ –
nome ✅ –
dataNascimento ✅ –
sexo ✅ –
possuiDeficiencia ✅ –
nomeMae – –
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 Servidores",
  "description": "Lista de objetos representando a entidade Servidor",
  "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": "Servidor",
        "description": "Representação do schema para envio da entidade Servidor",
        "type": "object",
        "properties": {
          "cpf": {
            "type": "string",
            "minLength": 11,
            "maxLength": 11,
            "pattern": "^[0-9]+$"
          },
          "nome": {
            "type": "string",
            "minLength": 1,
            "maxLength": 150
          },
          "dataNascimento": {
            "type": "string",
            "format": "date"
          },
          "sexo": {
            "type": "string",
            "enum": [
              "MASCULINO",
              "FEMININO"
            ]
          },
          "possuiDeficiencia": {
            "type": "string",
            "enum": [
              "SIM",
              "NAO"
            ]
          },
          "nomeMae": {
            "type": "string",
            "minLength": 1,
            "maxLength": 150
          },
          "action": {
            "type": "string",
            "enum": [
              "CREATE",
              "UPDATE",
              "DELETE"
            ]
          }
        },
        "required": [
          "cpf",
          "nome",
          "dataNascimento",
          "sexo",
          "possuiDeficiencia",
          "nomeMae",
          "action"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "timestamp",
    "elementos"
  ],
  "additionalProperties": false
}
Exemplo de Payload
{
  "timestamp": "2025-09-11T15:30:00.123456",
  "elementos": [
    {
      "cpf": "12345678901",
      "nome": "João da Silva Santos",
      "dataNascimento": "1985-03-15",
      "sexo": "MASCULINO",
      "possuiDeficiencia": "NAO",
      "nomeMae": "Maria de Lourdes Silva",
      "action": "CREATE"
    },
    {
      "cpf": "98765432109",
      "nome": "Ana Paula Costa Oliveira",
      "dataNascimento": "1990-07-22",
      "sexo": "FEMININO",
      "possuiDeficiencia": "SIM",
      "nomeMae": "Francisca Costa Pereira",
      "action": "UPDATE"
    }
  ]
}

Regras

ID Regra
SERVIDOR_DUPLICIDADE_NAO_PERMITIDA Não é permitido cadastrar registros duplicados pela chave de unicidade
SERVIDOR_NOME_INVALIDO O nome do servidor deve ser correspondente ao cadastrado na Receita Federal