Skip to main content

Nova Página

Manual institucional consolidado

SAGRES Captura 2.0

Documentação Funcional do Módulo Contabilidade — Catálogo completo das 48 fichas

Versão 1.6.0Lotes 1 a 6Julho de 2026

Apresentação

Este documento consolida em um único arquivo HTML a documentação funcional do módulo Contabilidade do SAGRES Captura 2.0. As fichas foram reconstruídas a partir da matriz funcional consolidada v1.6.0, preservando atributos, regras, dependências, observações e referências oficiais.

48Fichas documentadas
476Atributos catalogados
213Regras catalogadas
44Observações documentais
Acompanhamento da implementação

Dashboard das tarefas


Não concluídas 48 100%
Em andamento 0 0%
Concluídas 0 0%
Progresso geral 0% Em andamento vale 50%
Progresso ponderado 0%

Ailton

0 atribuídas 0 em andamento 0 concluídas

Odair

0 atribuídas 0 em andamento 0 concluídas

Diego

0 atribuídas 0 em andamento 0 concluídas

Sem responsável

48 entidades
Desenvolvedor Atribuídas Não concluídas Em andamento Concluídas Conclusão
Não concluído Em andamento Concluído
Filtrar por status:

Objetivos

  • Disponibilizar uma referência única para análise, desenvolvimento, implantação e homologação.
  • Consolidar chaves, atributos, regras, dependências e inconsistências por entidade.
  • Facilitar a navegação e a consulta técnica das equipes de ERP.
  • Preservar a rastreabilidade com as páginas oficiais do TCE-PB.

Fluxo funcional resumido

Planejamento → Programa → Ação → Unidade Orçamentária → Dotação → Empenho → Liquidação → Pagamento → Retenção → Restos → Estornos → Saldos e Transferências.

Índice geral das entidades

Planejamento e orçamento

CTB-001AçãoCadastro orçamentárioCTB-002ProgramaCadastro orçamentárioCTB-003Unidade OrçamentáriaCadastro orçamentárioCTB-004Atualização OrçamentáriaMovimentação orçamentáriaCTB-008Decreto OfícioInstrumento orçamentárioCTB-009Despesa ExtraMovimento extraorçamentárioCTB-010Dotação 2025-2026Cadastro orçamentárioCTB-011Dotação 2027Cadastro orçamentárioCTB-012Emenda ImpositivaCadastro orçamentárioCTB-013Empenho 2025-2026Execução orçamentáriaCTB-014Empenho 2027Execução orçamentáriaCTB-025LiquidaçãoExecução orçamentáriaCTB-028Norma OrçamentáriaCadastro orçamentário

Cadastros

CTB-007CredorCadastro de pessoaCTB-029OrdenadorCadastro de pessoa

Receitas

CTB-033Receita ExtraReceita extraorçamentáriaCTB-034Receita OrçamentáriaReceita orçamentáriaCTB-035Receita PrevistaPlanejamento da receita

Execução financeira e bancos

CTB-005Conta BancáriaCadastro financeiroCTB-006Conta Bancária CredorCadastro financeiroCTB-027Movimentação entre Contas BancáriasMovimentação financeiraCTB-030PagamentoExecução financeiraCTB-044Saldo Inicial ConciliadoConciliação bancáriaCTB-045Saldo Mensal ExtratoConciliação bancáriaCTB-046Transferência ConcedidaTransferências financeirasCTB-047Transferência RecebidaTransferências financeiras

Restos a pagar

CTB-026Liquidação RestoRestos a pagarCTB-031Pagamento RestoRestos a pagarCTB-041Resto InscritoRestos a pagar

Retenções e estornos

CTB-015Estorno Despesa ExtraEstorno extraorçamentárioCTB-016Estorno EmpenhoEstorno orçamentárioCTB-017Estorno LiquidaçãoEstorno orçamentárioCTB-018Estorno Liquidação RestoRestos a pagarCTB-019Estorno PagamentoEstorno financeiroCTB-020Estorno Pagamento RestoRestos a pagarCTB-021Estorno Receita ExtraEstorno extraorçamentárioCTB-022Estorno RestoRestos a pagarCTB-023Estorno RetençãoEstorno financeiroCTB-024Estorno Retenção RestoRestos a pagarCTB-042RetençãoRetençõesCTB-043Retenção RestoRetenções de restos

Integrações

CTB-036Relacionamento Empenho LicitaçãoIntegração LicitaçõesCTB-037Relacionamento Empenho Natureza ContrataçãoIntegração contratualCTB-038Relacionamento Empenho ObraIntegração ObrasCTB-039Relacionamento Liquidação Agrupamento FolhaIntegração FolhaCTB-040Responsável SIAFICGovernança SIAFIC

Referências documentais

CTB-032Programa (referência duplicada)Cadastro orçamentárioCTB-048Unidade Orçamentária (referência duplicada)Cadastro orçamentário
CTB-001

Ação

Cadastrar as ações orçamentárias da unidade gestora, com descrição, tipo, meta e unidade de medida.


Desenvolvedor
Versão2025 ~
EnvioOrçamento/Diário
Atributos7
Regras5
ComplexidadeNão classificada
CriticidadeNão classificada

1. Identificação funcional

Categoria Cadastro orçamentário
Chave de unicidade Exercício + Código Unidade Gestora + Código Ação
Objeto raiz timestamp + elementos
Dependências Dependências não registradas de forma consolidada.
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/acao-2025

2. Objetivo e finalidade

Cadastrar as ações orçamentárias da unidade gestora, com descrição, tipo, meta e unidade de medida.

Identificar os instrumentos de execução dos programas orçamentários utilizados no orçamento e em movimentações posteriores.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
codigoUnidadeGestora string Sim 6 / 6 ^[0-9]+$   Chave Código da unidade gestora.
codigoAcao string Sim 4 / 4 ^[0-9]+$   Chave Código da ação.
descricaoAcao string Sim 10 / 70       Descrição da ação.
tipoAcao string Sim 1 / 1 ^[0-9]+$ Tabela Tipo Ação   Tipo da ação válido para o exercício.
descricaoMeta string Sim 10 / 150       Descrição da meta.
unidadeMedida string Sim 1 / 50       Unidade de medida da meta.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave de unicidade.
  • A unidade gestora deve estar homologada pelo TCE antes do cadastro.
  • O tipo da ação deve ser válido para o exercício, conforme a tabela oficial.
  • Somente prefeituras e consórcios podem enviar ações.
  • A prefeitura informa UGs do mesmo município; o consórcio informa apenas a si próprio.
Catálogo completo de regras (5)
Identificador Descrição Classificação
ACAO_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave de unicidade. Validação
UNIDADE_GESTORA_HOMOLOGADA A unidade gestora deve estar homologada pelo TCE antes do cadastro. Validação
ACAO_TIPO_VALIDO O tipo da ação deve ser válido para o exercício, conforme a tabela oficial. Validação
RESPONSABILIDADE_PROTOCOLO Somente prefeituras e consórcios podem enviar ações. Validação
ACAO_ESCOPO_CADASTRO A prefeitura informa UGs do mesmo município; o consórcio informa apenas a si próprio. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Situação: nenhuma divergência documental relevante registrada.

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-002

Programa

Cadastrar os programas orçamentários e sua associação ao objetivo do milênio.


Desenvolvedor
Versão2025 ~
EnvioOrçamento/Diário
Atributos6
Regras5
ComplexidadeNão classificada
CriticidadeNão classificada

1. Identificação funcional

Categoria Cadastro orçamentário
Chave de unicidade Exercício + Código Unidade Gestora + Código Programa
Objeto raiz timestamp + elementos
Dependências Dependências não registradas de forma consolidada.
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/programa-2025

2. Objetivo e finalidade

Cadastrar os programas orçamentários e sua associação ao objetivo do milênio.

Organizar ações e objetivos governamentais em programas utilizados na estrutura do orçamento.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
codigoUnidadeGestora string Sim 6 / 6 ^[0-9]+$   Chave Código da unidade gestora.
codigoPrograma string Sim 4 / 4 ^[0-9]+$   Chave Código do programa.
descricaoPrograma string Sim 10 / 70       Descrição do programa.
descricaoObjetivoMilenio string Sim 10 / 150       Descrição do objetivo do milênio.
tipoObjetivoMilenio string Sim 2 / 2 ^[0-9]+$ Tabela Tipo Objetivo Milênio   Tipo do objetivo do milênio.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave de unicidade.
  • A unidade gestora deve estar homologada pelo TCE antes do cadastro.
  • O tipo de objetivo do milênio deve constar na tabela oficial.
  • Somente prefeituras e consórcios podem enviar programas.
  • A prefeitura cadastra programas das UGs vinculadas; o consórcio, apenas os próprios.
Catálogo completo de regras (5)
Identificador Descrição Classificação
PROGRAMA_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave de unicidade. Validação
UNIDADE_GESTORA_HOMOLOGADA A unidade gestora deve estar homologada pelo TCE antes do cadastro. Validação
PROGRAMA_TIPO_OBJETIVO_MILENIO_VALIDO O tipo de objetivo do milênio deve constar na tabela oficial. Validação
RESPONSABILIDADE_PROTOCOLO Somente prefeituras e consórcios podem enviar programas. Validação
PROGRAMA_ESCOPO_CADASTRO A prefeitura cadastra programas das UGs vinculadas; o consórcio, apenas os próprios. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Inconsistência/observação documental

O payload publicado utiliza a coleção 'programas', enquanto o schema define a coleção raiz como 'elementos'.

Tratamento recomendado: Revisar antes da implementação

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-003

Unidade Orçamentária

Cadastrar as unidades orçamentárias vinculadas às unidades gestoras.


Desenvolvedor
Versão2025 ~
EnvioOrçamento/Diário
Atributos4
Regras4
ComplexidadeNão classificada
CriticidadeNão classificada

1. Identificação funcional

Categoria Cadastro orçamentário
Chave de unicidade Exercício + Código Unidade Gestora + Código Unidade Orçamentária
Objeto raiz timestamp + elementos
Dependências Dependências não registradas de forma consolidada.
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/unidade-orcamentaria-2025

2. Objetivo e finalidade

Cadastrar as unidades orçamentárias vinculadas às unidades gestoras.

Identificar a estrutura administrativa responsável por dotações e execução orçamentária.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
codigoUnidadeGestora string Sim 6 / 6 ^[0-9]+$   Chave Código da unidade gestora.
codigoUnidadeOrcamentaria string Sim 5 / 5 ^[0-9]+$   Chave Código da unidade orçamentária.
descricaoUnidadeOrcamentaria string Sim 10 / 50       Descrição da unidade orçamentária.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave de unicidade.
  • A unidade gestora deve estar homologada pelo TCE antes do cadastro.
  • Somente prefeituras e consórcios podem enviar unidades orçamentárias.
  • A prefeitura cadastra UOs das UGs vinculadas; o consórcio, apenas as próprias.
Catálogo completo de regras (4)
Identificador Descrição Classificação
UNIDADE_ORCAMENTARIA_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave de unicidade. Validação
UNIDADE_GESTORA_HOMOLOGADA A unidade gestora deve estar homologada pelo TCE antes do cadastro. Validação
RESPONSABILIDADE_PROTOCOLO Somente prefeituras e consórcios podem enviar unidades orçamentárias. Validação
UNIDADE_ORCAMENTARIA_ESCOPO_CADASTRO A prefeitura cadastra UOs das UGs vinculadas; o consórcio, apenas as próprias. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Inconsistência/observação documental

O payload publicado utiliza a coleção 'unidadesOrcamentarias', enquanto o schema define 'elementos'.

Tratamento recomendado: Revisar antes da implementação

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-004

Atualização Orçamentária

Registrar alterações orçamentárias realizadas por decreto ou ofício sobre dotações e fontes de recursos.


Desenvolvedor
Versão2025 ~
EnvioDiário
Atributos17
Regras28
ComplexidadeNão classificada
CriticidadeNão classificada

1. Identificação funcional

Categoria Movimentação orçamentária
Chave de unicidade Exercício + UG + UO + Função + Subfunção + Programa + Ação + Categoria Econômica + Natureza + Modalidade + Elemento + Fonte + Exercício Fonte + Número Decreto/Ofício + Tipo Decreto/Ofício + Tipo Alteração
Objeto raiz timestamp + elementos
Dependências Dependências não registradas de forma consolidada.
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/atualizacao-orcamentaria-2025

2. Objetivo e finalidade

Registrar alterações orçamentárias realizadas por decreto ou ofício sobre dotações e fontes de recursos.

Controlar suplementações, anulações, transposições e demais tipos de alteração previstos na tabela oficial.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
codigoUnidadeGestora string Sim 6 / 6 ^[0-9]+$   Chave Código da unidade gestora.
codigoUnidadeOrcamentaria string Sim 5 / 5 ^[0-9]+$   Chave Unidade orçamentária cadastrada.
codigoFuncao string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Código de função.
codigoSubfuncao string Sim 3 / 3 ^[0-9]+$ MSC/STN Chave Código de subfunção.
codigoPrograma string Sim 4 / 4 ^[0-9]+$   Chave Programa cadastrado.
codigoAcao string Sim 4 / 4 ^[0-9]+$   Chave Ação cadastrada.
codigoCategoriaEconomica string Sim 1 / 1 ^[0-9]+$ MSC/STN Chave Categoria econômica.
codigoNaturezaDespesa string Sim 1 / 1 ^[0-9]+$ MSC/STN Chave Natureza da despesa.
codigoModalidadeDespesa string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Modalidade de aplicação.
codigoElementoDespesa string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Elemento de despesa.
codigoFonteRecurso string Sim 3 / 3 ^[0-9]+$ MSC/STN Chave Fonte de recurso.
exercicioFonteRecurso string Sim     ATUAL; ANTERIOR Chave Exercício da fonte.
numeroDecretoOficio string Sim 9 / 9 ^[0-9]+$   Chave Número do instrumento.
tipoDecretoOficio string/integer Sim     DECRETO; OFICIO Chave Tipo do instrumento.
tipoAlteracao string Sim 1 / 1 ^[0-9]+$ Tabela Tipo Alteração Chave Tipo da alteração.
valorAtualizacao number Sim   > 0     Valor da atualização.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave.
  • Somente UGs do mesmo município; consórcio apenas a si próprio.
  • Prefeituras e consórcios enviam decreto/ofício; câmaras apenas ofício.
  • A unidade orçamentária deve existir no exercício.
  • O programa deve existir no exercício.
Catálogo completo de regras (28)
Identificador Descrição Classificação
ATUALIZACAO_ORCAMENTARIA_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave. Validação
ATUALIZACAO_ORCAMENTARIA_UNIDADE_GESTORA_MUNICIPIO Somente UGs do mesmo município; consórcio apenas a si próprio. Validação
ATUALIZACAO_ORCAMENTARIA_RESPONSABILIDADE_PROTOCOLO Prefeituras e consórcios enviam decreto/ofício; câmaras apenas ofício. Validação
ATUALIZACAO_ORCAMENTARIA_UNIDADE_ORCAMENTARIA_CADASTRADA A unidade orçamentária deve existir no exercício. Validação
ATUALIZACAO_ORCAMENTARIA_PROGRAMA_CADASTRADO O programa deve existir no exercício. Validação
ATUALIZACAO_ORCAMENTARIA_ACAO_CADASTRADA A ação deve existir no exercício. Validação
ATUALIZACAO_ORCAMENTARIA_FUNCAO_STN Função deve seguir a MSC/STN. Validação
ATUALIZACAO_ORCAMENTARIA_SUBFUNCAO_STN Subfunção deve seguir a MSC/STN. Validação
ATUALIZACAO_ORCAMENTARIA_CATEGORIA_ECONOMICA_STN Categoria econômica deve seguir a MSC/STN. Validação
ATUALIZACAO_ORCAMENTARIA_NATUREZA_DESPESA_STN Natureza de despesa deve seguir a MSC/STN. Validação
ATUALIZACAO_ORCAMENTARIA_ELEMENTO_DESPESA_STN Elemento de despesa deve seguir a MSC/STN. Validação
ATUALIZACAO_ORCAMENTARIA_FONTE_RECURSO_STN Fonte de recurso deve seguir a MSC/STN. Validação
ATUALIZACAO_ORCAMENTARIA_SUPLEMENTACAO_ANULACAO Tipos 4 e 8 devem equilibrar com tipo 11 por decreto. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_14_15 Tipo 14 exige tipo 15 com o mesmo valor. Validação
ATUALIZACAO_ORCAMENTARIA_DECRETO_OFICIO_OBRIGATORIO Toda atualização deve estar vinculada a decreto/ofício. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_6_7_8_9_16_DOTACAO_INEXISTENTE Tipos 6, 7, 8, 9 e 16 só podem ser inseridos se a dotação não existir; ela será criada. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_2 Tipo 2 usa fonte ANTERIOR; a dotação ATUAL deve existir e a ANTERIOR pode ser criada. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_10 Se a dotação não existir, será criada; se existir, registra-se somente a atualização. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_7_16_EXERCICIO_FONTE Tipos 7 e 16 exigem fonte ANTERIOR e criam equivalente ATUAL com valor zero. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_6_8_9_EXERCICIO_FONTE Tipos 6, 8 e 9 exigem fonte ATUAL. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_REQUER_DOTACAO_EXISTIR Tipos 1, 3, 4, 11, 12 e 14 exigem dotação existente. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_15_DOTACAO Tipo 15 deve corresponder ao tipo 14, alterando apenas o elemento; soma por ofício deve ser igual. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_13_DOTACAO Tipo 13 deve igualar a soma dos tipos 12 por fonte e exercício; pode criar dotação. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_11_SOMA_SUPLEMENTACAO Soma do tipo 11 por decreto deve igualar tipos 4 ou 8. Validação
ATUALIZACAO_ORCAMENTARIA_DECRETO_TIPO_4_8_NAO_PERMITIDO Um decreto não pode conter tipos 4 e 8 simultaneamente. Validação
ATUALIZACAO_ORCAMENTARIA_DECRETO_TIPOS_INCOMPATIVEIS Não combinar tipos 1–4 com tipos 6, 7, 8, 9, 10 e 15 no mesmo decreto. Validação
ATUALIZACAO_ORCAMENTARIA_OFICIO_TIPO_OBRIGATORIO Ofício só admite tipo 14 ou 15. Validação
ATUALIZACAO_ORCAMENTARIA_TIPO_ALTERACAO_VALIDO O tipo de alteração deve constar na tabela oficial. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Inconsistência/observação documental

O schema lista 'dataAtualizacao' como obrigatório, mas esse atributo não aparece na relação de propriedades nem no payload publicado.

Tratamento recomendado: Revisar antes da implementação
Inconsistência/observação documental

O tipo do campo tipoDecretoOficio está declarado como integer, embora o enum e o payload usem textos DECRETO/OFICIO.

Tratamento recomendado: Revisar antes da implementação
Inconsistência/observação documental

Há uma vírgula aparentemente ausente entre codigoPrograma e codigoAcao no schema publicado.

Tratamento recomendado: Revisar antes da implementação

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-005

Conta Bancária

Cadastrar contas bancárias utilizadas pela unidade gestora.


Desenvolvedor
Versão2025 ~
EnvioDiário
Atributos7
Regras3
ComplexidadeNão classificada
CriticidadeNão classificada

1. Identificação funcional

Categoria Cadastro financeiro
Chave de unicidade Código Unidade Gestora + Número Conta + Banco + Agência + Tipo Conta + CNPJ Gerência + Descrição
Objeto raiz timestamp + elementos
Dependências Dependências não registradas de forma consolidada.
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/conta-bancaria-2025

2. Objetivo e finalidade

Cadastrar contas bancárias utilizadas pela unidade gestora.

Identificar contas para pagamentos, movimentações e conciliações bancárias.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
numeroContaBancaria string Sim 1 / 13 ^[A-Z0-9]+$   Chave Número da conta.
codigoBancoContaBancaria string Sim 3 / 3 ^[0-9]+$ FEBRABAN Chave Código do banco.
numeroAgenciaContaBancaria string Sim 1 / 6 ^[A-Z0-9]+$   Chave Número da agência.
descricaoContaBancaria string Sim 10 / 100     Chave Descrição da conta.
tipoContaBancaria string Sim 1 / 1 ^[0-9]+$ Tabela Tipo Conta Bancária Chave Tipo da conta.
cnpjGerenciaContaBancaria string Sim 14 / 14 ^[A-Z0-9]+$   Chave CNPJ da gerência.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave.
  • Tipo de conta deve constar na tabela oficial.
  • Código do banco deve ser válido na FEBRABAN.
Catálogo completo de regras (3)
Identificador Descrição Classificação
CONTA_BANCARIA_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave. Validação
CONTA_BANCARIA_TIPO_VALIDO Tipo de conta deve constar na tabela oficial. Validação
CONTA_BANCARIA_CODIGO_BANCO_VALIDO Código do banco deve ser válido na FEBRABAN. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Inconsistência/observação documental

A chave publicada inclui Código Unidade Gestora, mas o atributo não aparece no item/schema da página.

Tratamento recomendado: Revisar antes da implementação

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-006

Conta Bancária Credor

Cadastrar as contas bancárias dos credores.


Desenvolvedor
Versão2025 ~
EnvioDiário
Atributos5
Regras3
ComplexidadeNão classificada
CriticidadeNão classificada

1. Identificação funcional

Categoria Cadastro financeiro
Chave de unicidade Código Unidade Gestora + Número Conta + Banco + Agência + CPF/CNPJ Credor
Objeto raiz timestamp + elementos
Dependências Dependências não registradas de forma consolidada.
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/conta-bancaria-credor-2025

2. Objetivo e finalidade

Cadastrar as contas bancárias dos credores.

Disponibilizar dados bancários vinculados ao credor para operações financeiras.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
cpfCnpjCredor string Sim 11 / 14 ^[A-Z0-9]+$   Chave CPF/CNPJ do credor.
numeroContaBancariaCredor string Sim 1 / 13 ^[A-Z0-9]+$   Chave Número da conta do credor.
codigoBancoContaBancariaCredor string Sim 3 / 3 ^[0-9]+$ FEBRABAN Chave Código do banco.
numeroAgenciaContaBancariaCredor string Sim 1 / 6 ^[A-Z0-9]+$   Chave Número da agência.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave.
  • Código do banco deve ser válido na FEBRABAN.
  • O credor deve estar previamente cadastrado para a unidade gestora.
Catálogo completo de regras (3)
Identificador Descrição Classificação
CONTA_BANCARIA_CREDOR_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave. Validação
CONTA_BANCARIA_CREDOR_CODIGO_BANCO_VALIDO Código do banco deve ser válido na FEBRABAN. Validação
CONTA_BANCARIA_CREDOR_CREDOR_CADASTRADO O credor deve estar previamente cadastrado para a unidade gestora. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Inconsistência/observação documental

A chave publicada inclui Código Unidade Gestora, mas o atributo não aparece no item/schema da página.

Tratamento recomendado: Revisar antes da implementação

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-007

Credor

Cadastrar pessoas físicas ou jurídicas que atuam como credores da unidade gestora.


Desenvolvedor
Versão2025 ~
EnvioDiário
Atributos4
Regras3
ComplexidadeNão classificada
CriticidadeNão classificada

1. Identificação funcional

Categoria Cadastro de pessoa
Chave de unicidade Código Unidade Gestora + CPF/CNPJ + Nome
Objeto raiz timestamp + elementos
Dependências Dependências não registradas de forma consolidada.
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/credor-2025

2. Objetivo e finalidade

Cadastrar pessoas físicas ou jurídicas que atuam como credores da unidade gestora.

Permitir a vinculação do credor a empenhos, liquidações, pagamentos e contas bancárias.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
cpfCnpj string Sim 11 / 14 ^[A-Z0-9]+$   Chave CPF/CNPJ.
nome string Sim 1 / 150     Chave Nome do credor.
tipo string Sim 1 / 1 ^[0-9]+$ Tabela Tipo Credor   Tipo do credor.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave.
  • Tipo de credor deve constar na tabela oficial.
  • O nome deve corresponder ao cadastro na Receita Federal.
Catálogo completo de regras (3)
Identificador Descrição Classificação
CREDOR_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave. Validação
CREDOR_TIPO_VALIDO Tipo de credor deve constar na tabela oficial. Validação
CREDOR_NOME_INVALIDO O nome deve corresponder ao cadastro na Receita Federal. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Inconsistência/observação documental

O payload usa cpfCnpjCredor, nomeCredor e tipoCredor, enquanto o schema define cpfCnpj, nome e tipo.

Tratamento recomendado: Revisar antes da implementação
Inconsistência/observação documental

A chave publicada inclui Código Unidade Gestora, mas o atributo não aparece no item/schema da página.

Tratamento recomendado: Revisar antes da implementação

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-008

Decreto Ofício

Registrar decretos e ofícios que fundamentam atualizações orçamentárias.


Desenvolvedor
Versão2025 ~
EnvioDiário
Atributos6
Regras6
ComplexidadeNão classificada
CriticidadeNão classificada

1. Identificação funcional

Categoria Instrumento orçamentário
Chave de unicidade Exercício + Código Unidade Gestora + Número Decreto/Ofício + Tipo Documento
Objeto raiz timestamp + elementos
Dependências Dependências não registradas de forma consolidada.
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/decreto-oficio-2025

2. Objetivo e finalidade

Registrar decretos e ofícios que fundamentam atualizações orçamentárias.

Vincular o instrumento legal, seu protocolo e anexo às alterações do orçamento.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
numeroDecretoOficio string Sim 9 / 9 ^[0-9]+$   Chave Número do decreto ou ofício.
tipoDocumento string/integer Sim     DECRETO; OFICIO Chave Tipo do documento.
protolocoLei string Sim 9 / 9 ^\d{6}/\d{2}$     Protocolo da lei no banco do TCE.
dataDecretoOficio string/date Sim   format: date     Data do documento.
referenciaAnexo string Sim 33 / 33 ^[0-9]{6}\.[A-Z2-7]{26}$     Hash do anexo PDF.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave.
  • O protocolo da lei deve existir no banco de legislação do TCE.
  • O número deve existir em atualização orçamentária no mesmo envio.
  • Não enviar decreto/ofício sem atualização orçamentária no mesmo envio.
  • Prefeituras e consórcios enviam decretos/ofícios; câmaras enviam ofícios.
Catálogo completo de regras (6)
Identificador Descrição Classificação
DECRETO_OFICIO_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave. Validação
DECRETO_OFICIO_PROTOCOLO_LEI_EXISTENTE O protocolo da lei deve existir no banco de legislação do TCE. Validação
DECRETO_OFICIO_NUMERO_ATUALIZACAO_COMPETENCIA O número deve existir em atualização orçamentária no mesmo envio. Validação
DECRETO_OFICIO_ATUALIZACAO_OBRIGATORIA Não enviar decreto/ofício sem atualização orçamentária no mesmo envio. Validação
DECRETO_OFICIO_RESPONSABILIDADE_PROTOCOLO Prefeituras e consórcios enviam decretos/ofícios; câmaras enviam ofícios. Validação
DECRETO_OFICIO_ANEXO_OBRIGATORIO O arquivo PDF do instrumento deve ser enviado. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Inconsistência/observação documental

A propriedade está grafada como 'protolocoLei' na documentação.

Tratamento recomendado: Revisar antes da implementação
Inconsistência/observação documental

O tipoDocumento é declarado como integer, mas o enum e o payload usam DECRETO/OFICIO.

Tratamento recomendado: Revisar antes da implementação
Inconsistência/observação documental

O schema exige codigoUnidadeGestora, mas essa propriedade não aparece na lista de propriedades.

Tratamento recomendado: Revisar antes da implementação
Inconsistência/observação documental

Há uma vírgula aparentemente ausente antes da propriedade action no schema publicado.

Tratamento recomendado: Revisar antes da implementação

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-009

Despesa Extra

Registrar despesas extraorçamentárias, seus credores, contas contábeis, fontes de recursos e eventual vínculo com receita extra.


Desenvolvedor
Versão2025 ~
EnvioDiário
Atributos19
Regras5
ComplexidadeAlta
CriticidadeAlta

1. Identificação funcional

Categoria Movimento extraorçamentário
Chave de unicidade Exercício + Código Unidade Gestora + Número Despesa Extra
Objeto raiz timestamp + elementos
Dependências Credor; Conta Bancária; Receita Extra (condicional); tabelas STN/MSC
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/despesa-extra-2025

2. Objetivo e finalidade

Registrar despesas extraorçamentárias, seus credores, contas contábeis, fontes de recursos e eventual vínculo com receita extra.

Atender às exigências funcionais e de prestação de contas relacionadas à entidade Despesa Extra.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
numeroDespesaExtra string Sim 7 / 7 ^[0-9]+$   Chave Número da despesa extra.
codigoContaContabil string Sim 9 / 9 ^[0-9]+$ IPC 00/STN e ajustes TCE-PB   Conta contábil.
cpfCnpjCredor string Sim 14 / 14 ^[0-9]+$     CPF/CNPJ do credor.
exercicioFonteRecurso string Sim     ATUAL; ANTERIOR   Exercício da fonte.
codigoFonteRecurso string Sim 3 / 3 ^[0-9]+$ MSC/STN   Fonte de recurso.
codigoBancoContaBancaria string Sim 3 / 3 ^[0-9]+$ FEBRABAN   Banco.
numeroContaBancaria string Sim 1 / 13 ^[0-9]+$     Conta bancária.
numeroAgenciaContaBancaria string Sim 1 / 6 ^[0-9]+$     Agência.
tipoContaBancaria string Sim 1 / 1 ^[0-9]+$ Tabela Tipo Conta Bancária   Tipo da conta.
cnpjGerenciaContaBancaria string Sim 14 / 14 ^[0-9]+$     CNPJ da gerência.
valorDespesaExtra number Sim > 0       Valor da despesa extra.
historico string Sim 10 / 500       Histórico.
codigoDespesaExtra string Sim 8 / 8 ^[0-9]+$ Tabela Código Despesa Extra   Código da despesa extra.
codigoFonteRecursoPagamento string Sim 3 / 3 ^[0-9]+$ MSC/STN   Fonte do pagamento.
co string Sim 4 / 4 ^[0-9]+$ MSC/STN   Código de acompanhamento.
codigoUnidadeGestoraReceitaExtra string Condicional 6 / 6 ^[0-9]+$     UG da receita extra vinculada.
exercicioReceitaExtra string Condicional 4 / 4 ^[0-9]+$     Exercício da receita extra.
numeroReceitaExtra string Condicional 7 / 7 ^[0-9]+$     Número da receita extra.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave.
  • A receita extra vinculada deve existir quando a conta contábil assim exigir.
  • A conta contábil deve seguir os códigos definidos pelo STN.
  • O credor deve estar previamente cadastrado.
  • A UG da receita extra deve estar homologada e pertencer ao mesmo município.
Catálogo completo de regras (5)
Identificador Descrição Classificação
DESPESA_EXTRA_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave. Validação
DESPESA_EXTRA_RECEITA_EXTRA_EXISTENTE A receita extra vinculada deve existir quando a conta contábil assim exigir. Validação
DESPESA_EXTRA_CONTA_CONTABIL A conta contábil deve seguir os códigos definidos pelo STN. Validação
DESPESA_EXTRA_CREDOR_CADASTRADO O credor deve estar previamente cadastrado. Validação
UNIDADE_GESTORA_HOMOLOGADA A UG da receita extra deve estar homologada e pertencer ao mesmo município. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Inconsistência/observação oficial

O schema exige cpfCnpjFornecedor, mas a propriedade e o payload utilizam cpfCnpjCredor.

Tratamento recomendado: Revisar antes da implementação
Inconsistência/observação oficial

A tabela usa codigoCO, enquanto schema e payload usam co.

Tratamento recomendado: Revisar antes da implementação
Inconsistência/observação oficial

O payload possui exercicio e dataDespesaExtra, mas essas propriedades não constam no schema.

Tratamento recomendado: Revisar antes da implementação

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-010

Dotação 2025-2026

Cadastrar dotações orçamentárias para os exercícios de 2025 e 2026.


Desenvolvedor
Versão2025-2026
EnvioOrçamento
Atributos14
Regras11
ComplexidadeAlta
CriticidadeCrítica

1. Identificação funcional

Categoria Cadastro orçamentário
Chave de unicidade Exercício + UG + UO + Função + Subfunção + Programa + Ação + Categoria Econômica + Natureza + Modalidade + Elemento + Fonte + Exercício Fonte
Objeto raiz timestamp + elementos
Dependências Unidade Gestora; Unidade Orçamentária; Programa; Ação; MSC/STN
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/dotacao-2025-2026

2. Objetivo e finalidade

Cadastrar dotações orçamentárias para os exercícios de 2025 e 2026.

Atender às exigências funcionais e de prestação de contas relacionadas à entidade Dotação 2025-2026.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
codigoUnidadeGestora string Sim 6 / 6 ^[0-9]+$   Chave Código da unidade gestora.
codigoUnidadeOrcamentaria string Sim 5 / 5 ^[0-9]+$   Chave Unidade orçamentária cadastrada.
codigoFuncao string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Função.
codigoSubfuncao string Sim 3 / 3 ^[0-9]+$ MSC/STN Chave Subfunção.
codigoPrograma string Sim 4 / 4 ^[0-9]+$   Chave Programa cadastrado.
codigoAcao string Sim 4 / 4 ^[0-9]+$   Chave Ação cadastrada.
codigoCategoriaEconomica string Sim 1 / 1 ^[0-9]+$ MSC/STN Chave Categoria econômica.
codigoNaturezaDespesa string Sim 1 / 1 ^[0-9]+$ MSC/STN Chave Natureza da despesa.
codigoModalidadeDespesa string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Modalidade de aplicação.
codigoElementoDespesa string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Elemento de despesa.
exercicioFonteRecurso string Sim     ATUAL; ANTERIOR Chave Exercício da fonte de recurso.
codigoFonteRecurso string Sim 3 / 3 ^[0-9]+$ MSC/STN Chave Fonte de recurso.
valorDotacao number Sim > 0       Valor da dotação.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave de unicidade.
  • A unidade gestora deve estar homologada pelo TCE.
  • Função deve seguir a MSC/STN.
  • Subfunção deve seguir a MSC/STN.
  • Categoria econômica deve seguir a MSC/STN.
Catálogo completo de regras (11)
Identificador Descrição Classificação
DOTACAO_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave de unicidade. Validação
UNIDADE_GESTORA_HOMOLOGADA A unidade gestora deve estar homologada pelo TCE. Validação
DOTACAO_CODIGO_FUNCAO_VALIDO Função deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_SUBFUNCAO_VALIDO Subfunção deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_CATEGORIA_ECONOMICA_VALIDO Categoria econômica deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_NATUREZA_DESPESA_VALIDO Natureza da despesa deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_MODALIDADE_DESPESA_VALIDO Modalidade de aplicação deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_ELEMENTO_DESPESA_VALIDO Elemento de despesa deve seguir a MSC/STN. Validação
DOTACAO_PROGRAMA_CADASTRADO Programa deve estar cadastrado para o exercício. Validação
DOTACAO_ACAO_CADASTRADA Ação deve estar cadastrada para o exercício. Validação
DOTACAO_UNIDADE_ORCAMENTARIA_CADASTRADA Unidade orçamentária deve estar cadastrada para o exercício. Validação

6. Casos de teste recomendados

Cenário Condição Resultado esperado
Inclusão válida O registro atende ao schema, às regras e às dependências. Aceite do registro.
Chave duplicada Registro com a mesma chave funcional já enviado. Rejeição ou atualização controlada.
Campo obrigatório ausente Um campo obrigatório não foi informado. Erro de validação.
Relacionamento inexistente A entidade referenciada ainda não foi cadastrada. Rejeição por integridade.
Operação DELETE Exclusão solicitada para registro existente. Processamento conforme regras do layout.

7. Observações e inconsistências

Situação: nenhuma divergência documental relevante registrada.

8. Recomendações de implementação

  • Versionar schemas e regras por exercício.
  • Aplicar idempotência com base na chave funcional.
  • Validar dependências antes de montar o payload.
  • Registrar logs de envio, resposta, rejeição e reprocessamento.
  • Preservar o payload transmitido e a versão do layout para auditoria.
↑ Voltar ao índice
CTB-011

Dotação 2027

Cadastrar dotações orçamentárias a partir de 2027, com referências opcionais a emendas.


Desenvolvedor
Versão2027 ~
EnvioOrçamento
Atributos16
Regras11
ComplexidadeAlta
CriticidadeCrítica

1. Identificação funcional

Categoria Cadastro orçamentário
Chave de unicidade Mesma chave funcional da Dotação 2025-2026
Objeto raiz timestamp + elementos
Dependências Dependências da dotação; Emenda Impositiva (quando informada); Tabela Emenda Parlamentar
Fonte oficial https://docs.tcepb.tc.br/books/entidades-contabilidade/page/dotacao-2027

2. Objetivo e finalidade

Cadastrar dotações orçamentárias a partir de 2027, com referências opcionais a emendas.

Atender às exigências funcionais e de prestação de contas relacionadas à entidade Dotação 2027.

3. Contexto de negócio

A entidade participa do fluxo de prestação de contas do módulo Contabilidade e deve ser processada observando a ordem de dependências, a chave funcional e as validações do exercício correspondente.

4. Estrutura de atributos

Campo JSON Tipo Obrigatório Min./Máx. Pattern Domínio Chave Descrição
codigoUnidadeGestora string Sim 6 / 6 ^[0-9]+$   Chave Código da unidade gestora.
codigoUnidadeOrcamentaria string Sim 5 / 5 ^[0-9]+$   Chave Unidade orçamentária cadastrada.
codigoFuncao string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Função.
codigoSubfuncao string Sim 3 / 3 ^[0-9]+$ MSC/STN Chave Subfunção.
codigoPrograma string Sim 4 / 4 ^[0-9]+$   Chave Programa cadastrado.
codigoAcao string Sim 4 / 4 ^[0-9]+$   Chave Ação cadastrada.
codigoCategoriaEconomica string Sim 1 / 1 ^[0-9]+$ MSC/STN Chave Categoria econômica.
codigoNaturezaDespesa string Sim 1 / 1 ^[0-9]+$ MSC/STN Chave Natureza da despesa.
codigoModalidadeDespesa string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Modalidade de aplicação.
codigoElementoDespesa string Sim 2 / 2 ^[0-9]+$ MSC/STN Chave Elemento de despesa.
exercicioFonteRecurso string Sim     ATUAL; ANTERIOR Chave Exercício da fonte de recurso.
codigoFonteRecurso string Sim 3 / 3 ^[0-9]+$ MSC/STN Chave Fonte de recurso.
codigoEmendaParlamentar string Não 4 / 4 ^[0-9]+$ Tabela Emenda Parlamentar   Código da emenda parlamentar.
numeroEmendaImpositiva string Não 1 / 4 ^[0-9]+$     Número da emenda impositiva.
valorDotacao number Sim > 0       Valor da dotação.
action string Sim     CREATE; UPDATE; DELETE   Operação solicitada.

5. Principais regras de negócio

  • Não permitir registros duplicados pela chave de unicidade.
  • A unidade gestora deve estar homologada pelo TCE.
  • Função deve seguir a MSC/STN.
  • Subfunção deve seguir a MSC/STN.
  • Categoria econômica deve seguir a MSC/STN.
Catálogo completo de regras (11)
Identificador Descrição Classificação
DOTACAO_DUPLICIDADE_NAO_PERMITIDA Não permitir registros duplicados pela chave de unicidade. Validação
UNIDADE_GESTORA_HOMOLOGADA A unidade gestora deve estar homologada pelo TCE. Validação
DOTACAO_CODIGO_FUNCAO_VALIDO Função deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_SUBFUNCAO_VALIDO Subfunção deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_CATEGORIA_ECONOMICA_VALIDO Categoria econômica deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_NATUREZA_DESPESA_VALIDO Natureza da despesa deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_MODALIDADE_DESPESA_VALIDO Modalidade de aplicação deve seguir a MSC/STN. Validação
DOTACAO_CODIGO_ELEMENTO_DESPESA_VALIDO Elemento de despesa deve seguir a MSC/STN. Validação
DOTACAO_PROGRAMA_CADASTRADO Programa deve estar cadastrado para o exercício. Validação
DOTACAO_ACAO_CADASTRADA Ação deve estar cadastrada para o exercício. Validação
DOTACAO_UNIDADE_ORCAMENTARIA_CADASTRADA Unidade orçamentária deve estar cadastrada para o exercício. Validação
Back to top