# Entidades - Folha

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

  
<span>⚠️ Páginas com a tag </span>**\[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 | 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**

<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-informacoes"><table class="has-fixed-layout" style="width: 100%;"><thead><tr><td style="width: 12.1549%;">**Campo**</td><td style="width: 87.8451%;">**Informações**</td></tr></thead><tbody><tr><td style="width: 12.1549%;">`timestamp`</td><td style="width: 87.8451%;">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 **<span style="color: rgb(186, 55, 42);">data mais antiga para a mais recente</span>**</td></tr><tr><td style="width: 12.1549%;">`elementos`</td><td style="width: 87.8451%;">–</td></tr></tbody></table>

</figure>---

##### **Item**  


<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-chave-informacoes"><table class="has-fixed-layout" style="width: 100%; height: 228.438px;"><thead><tr style="height: 29.7969px;"><td style="width: 35.5185%; height: 29.7969px;">**Campo**</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.79323%; height: 29.7969px;">**Chave**</td><td style="width: 57.6883%; height: 29.7969px;">**Informações**</td></tr></thead><tbody><tr style="height: 30.6094px;"><td style="width: 35.5185%; height: 30.6094px;">`codigoVantagemDesconto`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.79323%; height: 30.6094px;">✅</td><td style="width: 57.6883%; height: 30.6094px;">–</td></tr><tr style="height: 29.6094px;"><td style="width: 35.5185%; height: 29.6094px;">`aliquotaSegurado`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.79323%; height: 29.6094px;">–</td><td style="width: 57.6883%; height: 29.6094px;">–</td></tr><tr style="height: 30.6094px;"><td style="width: 35.5185%; height: 30.6094px;">`aliquotaPatronal`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.79323%; height: 30.6094px;">–</td><td style="width: 57.6883%; height: 30.6094px;">–</td></tr><tr style="height: 30.6094px;"><td style="width: 35.5185%; height: 30.6094px;">`protocoloLegislativoAliquotaSegurado`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.79323%; height: 30.6094px;">–</td><td style="width: 57.6883%; height: 30.6094px;">–</td></tr><tr style="height: 30.6094px;"><td style="width: 35.5185%; height: 30.6094px;">`protocoloLegislativoAliquotaPatronal`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.79323%; height: 30.6094px;">–</td><td style="width: 57.6883%; height: 30.6094px;">–</td></tr><tr style="height: 46.5938px;"><td style="width: 35.5185%; height: 46.5938px;">`action`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.79323%; height: 46.5938px;">–</td><td style="width: 57.6883%; height: 46.5938px;">Define a operação a ser realizada com a informação, seja ela **criação, atualização ou exclusão**</td></tr></tbody></table>

</figure>---

##### **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

<table id="bkmrk-id-regra-aliquotas" style="width: 100%; height: 262.766px;"><thead><tr style="height: 29.7969px;"><td style="width: 60.9058%; height: 29.7969px;">ID</td><td style="width: 39.0942%; height: 29.7969px;">Regra</td></tr></thead><tbody><tr style="height: 46.5938px;"><td style="width: 60.9058%; height: 46.5938px;">**ALIQUOTA\_PREVIDENCIARIA\_DUPLICIDADE\_NAO\_PERMITIDA**</td><td style="width: 39.0942%; height: 46.5938px;">Não é permitido cadastrar registros duplicados pela chave de unicidade</td></tr><tr style="height: 29.7969px;"><td style="width: 60.9058%; height: 29.7969px;">**ALIQUOTA\_PREVIDENCIARIA\_UNIDADE\_GESTORA\_RPPS**</td><td style="width: 39.0942%; height: 29.7969px;">Só deve ser cadastrada para unidades gestoras com RPPS</td></tr><tr><td style="width: 60.9058%;">**ALIQUOTA\_PREVIDENCIARIA\_OBRIGATORIO\_RPPS\_JANEIRO**</td><td style="width: 39.0942%;">Para municípios com **RPPS**, é obrigatório que todas as **UGs** realizem envio no mês de **janeiro**.</td></tr></tbody></table>

# 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**

<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-informacoes"><table class="has-fixed-layout" style="width: 100%;"><thead><tr><td style="width: 12.1549%;">**Campo**</td><td style="width: 87.8451%;">**Informações**</td></tr></thead><tbody><tr><td style="width: 12.1549%;">`timestamp`</td><td style="width: 87.8451%;">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 **<span style="color: rgb(186, 55, 42);">data mais antiga para a mais recente</span>**</td></tr><tr><td style="width: 12.1549%;">`elementos`</td><td style="width: 87.8451%;">–</td></tr></tbody></table>

</figure>---

<table class="has-fixed-layout" id="bkmrk-campo-chave-informa%C3%A7" style="width: 100%; height: 426.681px;"><thead><tr style="height: 29.7917px;"><td style="width: 25.5066%; height: 29.7917px;">**Campo**</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 29.7917px;">**Chave**</td><td style="width: 67.101%; height: 29.7917px;">**Informações**</td></tr></thead><tbody><tr style="height: 30.5556px;"><td style="width: 25.5066%; height: 30.5556px;">`codigoCargo`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 30.5556px;">✅</td><td style="width: 67.101%; height: 30.5556px;">–</td></tr><tr style="height: 30.5556px;"><td style="width: 25.5066%; height: 30.5556px;">`descricao`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 30.5556px;">✅</td><td style="width: 67.101%; height: 30.5556px;">–</td></tr><tr style="height: 35.2847px;"><td style="width: 25.5066%; height: 35.2847px;">`tipoCargo`</td><td class="align-center" style="width: 7.39245%; height: 35.2847px;">✅</td><td style="width: 67.101%; height: 35.2847px;">**[Tabela Tipo Cargo](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-cargo-W5b)**</td></tr><tr style="height: 35.2847px;"><td style="width: 25.5066%; height: 35.2847px;">`tipoNaturezaAcumulacao`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 35.2847px;">✅</td><td style="width: 67.101%; height: 35.2847px;">**[Tabela Tipo Natureza Acumulação](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-natureza-acumulacao)**</td></tr><tr style="height: 35.2847px;"><td style="width: 25.5066%; height: 35.2847px;">`escolaridadeMinima`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 35.2847px;">✅</td><td style="width: 67.101%; height: 35.2847px;">**[Tabela Tipo Escolaridade](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-escolaridade)**</td></tr><tr style="height: 30.5556px;"><td style="width: 25.5066%; height: 30.5556px;">`protocoloTCE`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 30.5556px;">✅</td><td style="width: 67.101%; height: 30.5556px;">–</td></tr><tr style="height: 30.5556px;"><td style="width: 25.5066%; height: 30.5556px;">`atribuicoesLei`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 30.5556px;">✅</td><td style="width: 67.101%; height: 30.5556px;">–</td></tr><tr style="height: 30.5556px;"><td style="width: 25.5066%; height: 30.5556px;">`requisitosInvestidura`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 30.5556px;">✅</td><td style="width: 67.101%; height: 30.5556px;">–</td></tr><tr style="height: 30.5556px;"><td style="width: 25.5066%; height: 30.5556px;">`quantidadeVagasTotal`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 30.5556px;">✅</td><td style="width: 67.101%; height: 30.5556px;">–</td></tr><tr style="height: 30.5556px;"><td style="width: 25.5066%; height: 30.5556px;">`tipoRegimeTrabalho`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 30.5556px;">✅</td><td style="width: 67.101%; height: 30.5556px;">[**Tabela Tipo Regime Trabalho**](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-regime-trabalho)</td></tr><tr style="height: 30.5556px;"><td style="width: 25.5066%; height: 30.5556px;">`tipoRegimePrevidencia`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 30.5556px;">✅</td><td style="width: 67.101%; height: 30.5556px;">**[Tabela Tipo Regime Previdência](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-regime-previdencia)**</td></tr><tr style="height: 46.5903px;"><td style="width: 25.5066%; height: 46.5903px;">`action`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.39245%; height: 46.5903px;">–</td><td style="width: 67.101%; height: 46.5903px;">Define a operação a ser realizada com a informação, seja ela **criação, atualização ou exclusão**</td></tr></tbody></table>

---


##### **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

<table id="bkmrk-id-regra-cargo" style="width: 100%; height: 305.521px;"><thead><tr style="height: 29.7917px;"><td style="width: 41.2396%; height: 29.7917px;">ID</td><td style="width: 58.7604%; height: 29.7917px;">Regra</td></tr></thead><tbody><tr style="height: 29.7917px;"><td style="width: 41.2396%; height: 29.7917px;">**CARGO\_DUPLICIDADE\_NAO\_PERMITIDA**</td><td style="width: 58.7604%; height: 29.7917px;">Não é permitido cadastrar registros duplicados pela chave de unicidade</td></tr><tr style="height: 52.1875px;"><td style="width: 41.2396%; height: 52.1875px;">**CARGO\_TIPO\_ESCOLARIDADE\_VALIDO**</td><td style="width: 58.7604%; height: 52.1875px;">O tipo deve ser válido para o exercício do envio, conforme a

[**Tabela Tipo Escolaridade**](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-escolaridade)

</td></tr><tr style="height: 52.1875px;"><td style="width: 41.2396%; height: 52.1875px;">**CARGO\_TIPO\_VALIDO**</td><td style="width: 58.7604%; height: 52.1875px;">O tipo deve ser válido para o exercício do envio, conforme a

[**Tabela Tipo Cargo**](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-cargo)

</td></tr><tr style="height: 52.1875px;"><td style="width: 41.2396%; height: 52.1875px;">**CARGO\_TIPO\_NATUREZA\_ACUMULACAO\_VALIDO**</td><td style="width: 58.7604%; height: 52.1875px;">O tipo deve ser válido para o exercício do envio, conforme a

[**Tabela Tipo Natureza Acumulação**](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-natureza-acumulacao)

</td></tr><tr style="height: 29.7917px;"><td style="width: 41.2396%; height: 29.7917px;">**CARGO\_PROTOCOLO\_TCE\_VALIDO**</td><td style="width: 58.7604%; height: 29.7917px;">O protocolo deve ter sido cadastrado no banco do TCE</td></tr><tr style="height: 29.7917px;"><td style="width: 41.2396%; height: 29.7917px;">**CARGO\_TIPO\_REGIME\_TRABALHO\_VALIDO**</td><td style="width: 58.7604%; height: 29.7917px;">O tipo deve ser válido para o exercício do envio, conforme a

[**Tabela Tipo Regime Trabalho**](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-regime-trabalho)  
</td></tr><tr style="height: 29.7917px;"><td style="width: 41.2396%; height: 29.7917px;">**CARGO\_TIPO\_REGIME\_PREVIDENCIA\_VALIDO**</td><td style="width: 58.7604%; height: 29.7917px;">O tipo deve ser válido para o exercício do envio, conforme a

**[Tabela Tipo Regime Previdência](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-regime-previdencia)**  
</td></tr></tbody></table>

# 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**

<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-informacoes"><table class="has-fixed-layout" style="width: 100%;"><thead><tr><td style="width: 12.1549%;">**Campo**</td><td style="width: 87.8451%;">**Informações**</td></tr></thead><tbody><tr><td style="width: 12.1549%;">`timestamp`</td><td style="width: 87.8451%;">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 **<span style="color: rgb(186, 55, 42);">data mais antiga para a mais recente</span>**</td></tr><tr><td style="width: 12.1549%;">`elementos`</td><td style="width: 87.8451%;">–</td></tr></tbody></table>

</figure>---

##### **Item**  


<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-chave-informacoes"><table class="has-fixed-layout"><thead><tr><td>**Campo**</td><td class="has-text-align-left align-center" data-align="left">**Chave**</td><td>**Informações**</td></tr></thead><tbody><tr><td>`codigo`</td><td class="has-text-align-left align-center" data-align="left">✅</td><td>–</td></tr><tr><td>`descricao`</td><td class="has-text-align-left align-center" data-align="left">–</td><td>–</td></tr><tr><td>`action`</td><td class="has-text-align-left align-center" data-align="left">–</td><td>Define a operação a ser realizada com a informação, seja ela **criação, atualização ou exclusão**</td></tr></tbody></table>

</figure>---

##### **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

<table id="bkmrk-regra-agrupamento" style="width: 100%;"><thead><tr><td style="width: 67.4567%;">ID</td><td style="width: 32.5433%;">Regra</td></tr></thead><tbody><tr><td style="width: 67.4567%;">**CODIGO\_AGRUPAMENTO\_FOLHA\_PAGAMENTO\_DUPLICIDADE\_NAO\_PERMITIDA**</td><td style="width: 32.5433%;">Não é permitido cadastrar registros duplicados pela chave de unicidade</td></tr></tbody></table>

# 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**

<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-informacoes"><table class="has-fixed-layout" style="width: 100%;"><thead><tr><td style="width: 12.1549%;">**Campo**</td><td style="width: 87.8451%;">**Informações**</td></tr></thead><tbody><tr><td style="width: 12.1549%;">`timestamp`</td><td style="width: 87.8451%;">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 **<span style="color: rgb(186, 55, 42);">data mais antiga para a mais recente</span>**</td></tr><tr><td style="width: 12.1549%;">`elementos`</td><td style="width: 87.8451%;">–</td></tr></tbody></table>

</figure>---

##### **Item**  


<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-chave-informacoes"><table class="has-fixed-layout" style="width: 100%; height: 331.077px;"><thead><tr style="height: 29.6875px;"><td style="width: 30.0356%; height: 29.6875px;">**Campo**</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.03232%; height: 29.6875px;">**Chave**</td><td style="width: 62.9321%; height: 29.6875px;">**Informações**</td></tr></thead><tbody><tr style="height: 35.2847px;"><td style="width: 30.0356%; height: 35.2847px;">`tipoLancamentoFolhaPagamento`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.03232%; height: 35.2847px;">✅</td><td style="width: 62.9321%; height: 35.2847px;">**[Tabela Tipo Lançamento Folha Pagamento](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-lancamento-folha-pagamento)**</td></tr><tr style="height: 30.5556px;"><td style="width: 30.0356%; height: 30.5556px;">`codigo`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.03232%; height: 30.5556px;">✅</td><td style="width: 62.9321%; height: 30.5556px;">–</td></tr><tr style="height: 30.5556px;"><td style="width: 30.0356%; height: 30.5556px;">`descricao`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.03232%; height: 30.5556px;">✅</td><td style="width: 62.9321%; height: 30.5556px;">–</td></tr><tr style="height: 35.2847px;"><td style="width: 30.0356%; height: 35.2847px;">`tipoContabilizacaoFolhaPagamento`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.03232%; height: 35.2847px;">✅</td><td style="width: 62.9321%; height: 35.2847px;">**[Tabela Tipo Contabilização Folha Pagamento](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-contabilizacao-folha-pagamento)**</td></tr><tr style="height: 30.5556px;"><td style="width: 30.0356%; height: 30.5556px;">`baseCalculoPrevidenciario`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.03232%; height: 30.5556px;">✅</td><td style="width: 62.9321%; height: 30.5556px;">–</td></tr><tr style="height: 30.5556px;"><td style="width: 30.0356%; height: 30.5556px;">`protocoloTCELegVantagem`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.03232%; height: 30.5556px;">✅</td><td style="width: 62.9321%; height: 30.5556px;">–</td></tr><tr style="height: 46.4861px;"><td style="width: 30.0356%; height: 46.4861px;">`action`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.03232%; height: 46.4861px;">–</td><td style="width: 62.9321%; height: 46.4861px;">Define a operação a ser realizada com a informação, seja ela **criação, atualização ou exclusão**</td></tr></tbody></table>

</figure>---

##### **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

<table id="bkmrk-regra-codigo" style="width: 100%; height: 398.75px;"><thead><tr style="height: 29.7969px;"><td style="width: 69.8338%; height: 29.7969px;">ID</td><td style="width: 30.1662%; height: 29.7969px;">Regra</td></tr></thead><tbody><tr style="height: 46.5938px;"><td style="width: 69.8338%; height: 46.5938px;">**CODIGO\_VANTAGEM\_DESCONTO\_DUPLICIDADE\_NAO\_PERMITIDA**</td><td style="width: 30.1662%; height: 46.5938px;">Não é permitido cadastrar registros duplicados pela chave de unicidade</td></tr><tr><td style="width: 69.8338%;">**CODIGO\_VANTAGEM\_DESCONTO\_PROTOCOLO\_LEG\_OBRIGATORIO**</td><td style="width: 30.1662%;">Para registros com **Tipo de Lançamento = 0 (Vantagem)**, o **protocolo TCE** é obrigatório e deve ter sido cadastrado no banco **TCE**</td></tr></tbody></table>

# 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**

<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-informacoes"><table class="has-fixed-layout" style="width: 100%;"><thead><tr><td style="width: 12.1549%;">**Campo**</td><td style="width: 87.8451%;">**Informações**</td></tr></thead><tbody><tr><td style="width: 12.1549%;">`timestamp`</td><td style="width: 87.8451%;">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 **<span style="color: rgb(186, 55, 42);">data mais antiga para a mais recente</span>**</td></tr><tr><td style="width: 12.1549%;">`elementos`</td><td style="width: 87.8451%;">–</td></tr></tbody></table>

</figure>---

##### **Item**  


<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-chave-informacoes"><table class="has-fixed-layout" style="width: 100%; height: 391.547px;"><thead><tr style="height: 29.7969px;"><td style="width: 24.6722%; height: 29.7969px;">**Campo**</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 29.7969px;">**Chave**</td><td style="width: 68.4148%; height: 29.7969px;">**Informações**</td></tr></thead><tbody><tr style="height: 30.6094px;"><td style="width: 24.6722%; height: 30.6094px;">`cpfServidor`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 30.6094px;">✅</td><td style="width: 68.4148%; height: 30.6094px;">–</td></tr><tr style="height: 30.6094px;"><td style="width: 24.6722%; height: 30.6094px;">`codigoCargo`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 30.6094px;">✅</td><td style="width: 68.4148%; height: 30.6094px;">–</td></tr><tr style="height: 30.6094px;"><td style="width: 24.6722%; height: 30.6094px;">`numeroMatricula`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 30.6094px;">✅</td><td style="width: 68.4148%; height: 30.6094px;">–</td></tr><tr style="height: 30.6094px;"><td style="width: 24.6722%; height: 30.6094px;">`mes`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 30.6094px;">✅</td><td style="width: 68.4148%; height: 30.6094px;">–</td></tr><tr style="height: 35.3906px;"><td style="width: 24.6722%; height: 35.3906px;">`tipoLancamento`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 35.3906px;">✅</td><td style="width: 68.4148%; height: 35.3906px;">**[Tabela Tipo Lançamento Folha Pagamento](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-lancamento-folha-pagamento)**</td></tr><tr style="height: 30.6094px;"><td style="width: 24.6722%; height: 30.6094px;">`codigoVantagemDesconto`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 30.6094px;">✅</td><td style="width: 68.4148%; height: 30.6094px;">–</td></tr><tr style="height: 35.3906px;"><td style="width: 24.6722%; height: 35.3906px;">`tipoFolha`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 35.3906px;">✅</td><td style="width: 68.4148%; height: 35.3906px;">**[Tabela Tipo Folha](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-folha)**</td></tr><tr style="height: 30.6094px;"><td style="width: 24.6722%; height: 30.6094px;">`codigoAgrupamento`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 30.6094px;">✅</td><td style="width: 68.4148%; height: 30.6094px;">–</td></tr><tr style="height: 30.6094px;"><td style="width: 24.6722%; height: 30.6094px;">`codigoUnidadeOrcamentaria`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 30.6094px;">✅</td><td style="width: 68.4148%; height: 30.6094px;">–</td></tr><tr style="height: 30.1094px;"><td style="width: 24.6722%; height: 30.1094px;">`valor`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 30.1094px;">–</td><td style="width: 68.4148%; height: 30.1094px;">–</td></tr><tr style="height: 46.5938px;"><td style="width: 24.6722%; height: 46.5938px;">`action`</td><td class="has-text-align-left align-center" data-align="left" style="width: 6.91299%; height: 46.5938px;">–</td><td style="width: 68.4148%; height: 46.5938px;">Define a operação a ser realizada com a informação, seja ela **criação, atualização ou exclusão**</td></tr></tbody></table>

</figure>---

##### **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

<table id="bkmrk-regra-folha" style="width: 100%; height: 168.656px;"><thead><tr style="height: 29.7969px;"><td style="width: 57.925%; height: 29.7969px;">ID</td><td style="width: 42.075%; height: 29.7969px;">Regra</td></tr></thead><tbody><tr style="height: 45.4688px;"><td style="width: 57.925%; height: 45.4688px;">**FOLHA\_PAGAMENTO\_DUPLICIDADE\_NAO\_PERMITIDA**</td><td style="width: 42.075%; height: 45.4688px;">Não é permitido cadastrar registros duplicados pela chave de unicidade</td></tr><tr><td style="width: 57.925%;">**FOLHA\_PAGAMENTO\_MES\_INVALIDO**</td><td style="width: 42.075%;">O mês da folha não pode ser maior que o do envio</td></tr><tr><td style="width: 57.925%;">**FOLHA\_PAGAMENTO\_MATRICULA\_CADASTRADA**</td><td style="width: 42.075%;">A matrícula deve ter sido cadastrada para a unidade gestora</td></tr><tr style="height: 29.7969px;"><td style="width: 57.925%; height: 29.7969px;">**FOLHA\_PAGAMENTO\_UNIDADE\_ORCAMENTARIA\_CADASTRADA**</td><td style="width: 42.075%; height: 29.7969px;">A unidade orçamentária deve ter sido cadastrado para a Unidade Gestora no exercício</td></tr><tr style="height: 33.7969px;"><td style="width: 57.925%; height: 33.7969px;">**FOLHA\_PAGAMENTO\_CODIGO\_AGRUPAMENTO\_CADASTRADO**</td><td style="width: 42.075%; height: 33.7969px;">O código agrupamento deve ter sido cadastrado para a Unidade Gestora no exercício</td></tr><tr style="height: 29.7969px;"><td style="width: 57.925%; height: 29.7969px;">**FOLHA\_PAGAMENTO\_CODIGO\_VANTAGEM\_DESCONTO\_CADASTRADO**</td><td style="width: 42.075%; height: 29.7969px;">O código vantagem desconto deve ter sido cadastrado para a Unidade Gestora no exercício</td></tr><tr><td style="width: 57.925%;">**FOLHA\_PAGAMENTO\_TIPO\_LANCAMENTO\_INVALIDO**</td><td style="width: 42.075%;">O Tipo lançamento deve ser válido conforme a **[Tabela Tipo Lançamento Folha Pagamento](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-lancamento-folha-pagamento)**</td></tr><tr><td style="width: 57.925%;">**FOLHA\_PAGAMENTO\_TIPO\_FOLHA\_INVALIDO**</td><td style="width: 42.075%;">O Tipo folha deve ser válido conforme a **[Tabela Tipo Folha](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-folha)**</td></tr><tr><td style="width: 57.925%;">**FOLHA\_PAGAMENTO\_MATRICULA\_SITUACAO\_INVALIDA**</td><td style="width: 42.075%;">Se a última situação da matrícula for **2 (Óbito)**, não é permitida sua inclusão na **folha**.</td></tr></tbody></table>

# 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**

<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-informacoes"><table class="has-fixed-layout" style="width: 100%;"><thead><tr><td style="width: 12.1549%;">**Campo**</td><td style="width: 87.8451%;">**Informações**</td></tr></thead><tbody><tr><td style="width: 12.1549%;">`timestamp`</td><td style="width: 87.8451%;">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 **<span style="color: rgb(186, 55, 42);">data mais antiga para a mais recente</span>**</td></tr><tr><td style="width: 12.1549%;">`elementos`</td><td style="width: 87.8451%;">–</td></tr></tbody></table>

</figure>---

##### **Item**  


<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-chave-informacoes"><table class="has-fixed-layout" style="width: 93.4524%;"><thead><tr><td style="width: 18.6198%;">**Campo**</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.77879%;">**Chave**</td><td style="width: 73.5872%;">**Informações**</td></tr></thead><tbody><tr><td style="width: 18.6198%;">`cpfServidor`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.77879%;">✅</td><td style="width: 73.5872%;">–</td></tr><tr><td style="width: 18.6198%;">`codigoCargo`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.77879%;">✅</td><td style="width: 73.5872%;">–</td></tr><tr><td style="width: 18.6198%;">`numero`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.77879%;">✅</td><td style="width: 73.5872%;">–</td></tr><tr><td style="width: 18.6198%;">`dataSituacao`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.77879%;">✅</td><td style="width: 73.5872%;">–</td></tr><tr><td style="width: 18.6198%;">`situacaoMatricula`</td><td class="align-center" style="width: 7.77879%;">✅</td><td style="width: 73.5872%;">**[Tabela Situação Matrícula](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-situacao-matricula)**</td></tr><tr><td style="width: 18.6198%;">`cargaHoraria`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.77879%;">✅</td><td style="width: 73.5872%;">–</td></tr><tr><td style="width: 18.6198%;">`action`</td><td class="has-text-align-left align-center" data-align="left" style="width: 7.77879%;">–</td><td style="width: 73.5872%;">Define a operação a ser realizada com a informação, seja ela **criação, atualização ou exclusão**</td></tr></tbody></table>

</figure>---

##### **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

<table id="bkmrk-regra-matricula" style="width: 100%; height: 151.578px;"><thead><tr style="height: 29.7969px;"><td style="width: 41.8317%; height: 29.7969px;">ID</td><td style="width: 58.1683%; height: 29.7969px;">Regra</td></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 41.8317%; height: 29.7969px;">**MATRICULA\_DUPLICIDADE\_NAO\_PERMITIDA**</td><td style="width: 58.1683%; height: 29.7969px;">Não é permitido cadastrar registros duplicados pela chave de unicidade</td></tr><tr style="height: 29.7969px;"><td style="width: 41.8317%; height: 29.7969px;">**MATRICULA\_CARGO\_CADASTRADO**</td><td style="width: 58.1683%; height: 29.7969px;">O cargo deve ter sido cadastrado para a Unidade Gestora</td></tr><tr style="height: 29.7969px;"><td style="width: 41.8317%; height: 29.7969px;">**MATRICULA\_SERVIDOR\_CADASTRADO**</td><td style="width: 58.1683%; height: 29.7969px;">O servidor deve ter sido cadastrado para a Unidade Gestora</td></tr><tr style="height: 32.3906px;"><td style="width: 41.8317%; height: 32.3906px;">**MATRICULA\_TIPO\_SITUACAO\_VALIDO**</td><td style="width: 58.1683%; height: 32.3906px;">O Tipo de situação deve ser válido conforme a [**Tabela Situação Matrícula**](https://docs.tcepb.tc.br/books/tabelas-de-dominio/page/tipo-situacao-matricula)</td></tr><tr><td style="width: 41.8317%;">**MATRICULA\_SITUACAO\_INVALIDA**</td><td style="width: 58.1683%;">Se a última situação da matrícula for **1 (Aposentadoria)** ou **2 (Óbito)**, não é permitida a inclusão de novas situações.</td></tr><tr><td style="width: 41.8317%;">**MATRICULA\_SITUACAO\_TIPO\_5\_INVALIDO**</td><td style="width: 58.1683%;">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)**.</td></tr></tbody></table>

# Servidor

# Servidor | 2025 ~

##### **Tipo Envio: Balancete - Folha**

---

##### **Chave Unicidade**

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

---

##### **Objeto Raiz**

<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-informacoes"><table class="has-fixed-layout" style="width: 100%;"><thead><tr><td style="width: 12.1549%;">**Campo**</td><td style="width: 87.8451%;">**Informações**</td></tr></thead><tbody><tr><td style="width: 12.1549%;">`timestamp`</td><td style="width: 87.8451%;">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 **<span style="color: rgb(186, 55, 42);">data mais antiga para a mais recente</span>**</td></tr><tr><td style="width: 12.1549%;">`elementos`</td><td style="width: 87.8451%;">–</td></tr></tbody></table>

</figure>---

##### **Item**  


<figure class="wp-block-table is-style-stripes" id="bkmrk-campo-chave-informacoes"><table class="has-fixed-layout"><thead><tr><td>**Campo**</td><td class="has-text-align-left align-center" data-align="left">**Chave**</td><td>**Informações**</td></tr></thead><tbody><tr><td>`cpf`</td><td class="has-text-align-left align-center" data-align="left">✅</td><td>–</td></tr><tr><td>`nome`</td><td class="has-text-align-left align-center" data-align="left">✅</td><td>–</td></tr><tr><td>`dataNascimento`</td><td class="has-text-align-left align-center" data-align="left">✅</td><td>–</td></tr><tr><td>`sexo`</td><td class="has-text-align-left align-center" data-align="left">✅</td><td>–</td></tr><tr><td>`possuiDeficiencia`</td><td class="has-text-align-left align-center" data-align="left">✅</td><td>–</td></tr><tr><td>`nomeMae`</td><td class="has-text-align-left align-center" data-align="left">–</td><td>–</td></tr><tr><td>`action`</td><td class="has-text-align-left align-center" data-align="left">–</td><td>Define a operação a ser realizada com a informação, seja ela **criação, atualização ou exclusão**</td></tr></tbody></table>

</figure>---

##### **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

<table id="bkmrk-id-regra-servidor" style="width: 100%;"><thead><tr><td style="width: 37.6591%;">ID</td><td style="width: 62.3409%;">Regra</td></tr></thead><tbody><tr><td style="width: 37.6591%;">**SERVIDOR\_DUPLICIDADE\_NAO\_PERMITIDA**</td><td style="width: 62.3409%;">Não é permitido cadastrar registros duplicados pela chave de unicidade</td></tr><tr><td style="width: 37.6591%;">**SERVIDOR\_NOME\_INVALIDO**</td><td style="width: 62.3409%;">O nome do servidor deve ser correspondente ao cadastrado na Receita Federal</td></tr></tbody></table>