Entidades - Contabilidade
Esta página apresenta todas as informações para o recebimento dos dados de contabilidade no SAGRES Captura 2.0.
⚠️ Páginas com a tag [WIP] ainda estão em revisão pelo TCE e/ou não foram implementadas, podendo sofrer alterações.
- JSON Schema
- Orçamento
- Ação
- Atualização Orçamentária
- Conciliação Bancária
- Conta Bancária
- Conta Bancária Credor
- Credor
- Decreto Oficio
- Despesa Extra
- Dotação
- Emenda Impositiva
- Empenho
- Estorno Despesa Extra
- Estorno Empenho
- Estorno Liquidação
- Estorno Liquidação Resto
- Estorno Pagamento
- Estorno Pagamento Resto
- Estorno Receita Extra
- Estorno Resto
- Estorno Retenção
- Estorno Retenção Resto
- Liquidação
- Liquidação Resto
- Movimentação Entre Contas Bancárias
- Norma Orçamentária
- Ordenador
- Pagamento
- Pagamento Resto
- Programa
- Receita Extra
- Receita Orçamentária
- Receita Prevista
- Relacionamento Empenho Licitação
- Relacionamento Empenho Natureza Contratação
- Relacionamento Empenho Obra
- Relacionamento Liquidação Código Agrupamento Folha Pagamento
- Responsável Siafic
- Resto Inscrito
- Retenção
- Retenção Resto
- Saldo Inicial Conciliado
- Saldo Mensal Extrato
- Transferência Concedida
- Transferência Recebida
- Unidade Orçamentária
JSON Schema
A validação a partir de um JSON Schema serve para garantir que um arquivo JSON esteja “no formato correto”.
É um processo que confere se o conteúdo do arquivo segue um modelo previamente definido, como um checklist que verifica se todos os campos obrigatórios estão presentes, se os tipos de dados estão corretos (por exemplo, texto, número, verdadeiro/falso) e se os valores respeitam determinadas regras. Isso ajuda a evitar erros antes que as informações sejam enviadas ou processadas.
O envio das informações Sagres Captura 2.0, seguirá exatamente esse formato de validação baseado em JSON Schema.
Validação com JSON Schema
O schema abaixo define que o objeto JSON deve conter:
🔹 Um campo nome do tipo texto (string);
🔹 Um campo idade do tipo número inteiro (integer) com valor mínimo igual a 0;
🔹 Um campo opcional ativo do tipo booleano (true ou false).
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"nome": { "type": "string" },
"idade": { "type": "integer", "minimum": 0 },
"ativo": { "type": "boolean" }
},
"required": ["nome", "idade"]
}Processo
Durante a validação, o JSON enviado é comparado com o Schema
🔹Se todos os campos estiverem corretos e seguirem as regras, o JSON é considerado válido
🔹Caso contrário, é retornado mensagens de erro indicando quais campos estão incorretos ou ausentes
✅ Exemplo Válido
{
"nome": "Maria",
"idade": 25,
"ativo": true
}❌ Exemplo Inválido
{
"nome": 123,
"idade": -5
}Ferramenta Online
No site JSON Schema Validator permite testar facilmente os schemas e os arquivos JSON, verificando se o conteúdo está de acordo com as regras definidas no schema.
Ir para Schemas das Entidades
Orçamento
Orçamento
Equilíbrio Orçamentário | 2025 ~
Regras
| ID | Regra |
| DESEQUILIBRIO_ORCAMENTARIO_TOTAL | O total da receita prevista deve ser igual ao total das dotações |
| DESEQUILIBRIO_ORCAMENTARIO_POR_FONTE_RECURSO | O total da receita prevista por fonte de recurso deve ser igual ao total das dotações por fonte de recurso |
Ação
Ação
Ação | 2025 ~
Tipo Envio: Orçamento/Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Ação ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestora |
✅ | – |
codigoAcao |
✅ | – |
descricaoAcao |
– | – |
tipoAcao |
– | Tabela Tipo Ação |
descricaoMeta |
– | – |
unidadeMedida |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Ações",
"description": "Lista de objetos representando a entidade Ação",
"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": "Ação",
"description": "Representação do schema para envio da entidade Ação",
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoAcao": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"descricaoAcao": {
"type": "string",
"minLength": 10,
"maxLength": 70
},
"tipoAcao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"descricaoMeta": {
"type": "string",
"minLength": 10,
"maxLength": 150
},
"unidadeMedida": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"codigoAcao",
"descricaoAcao",
"tipoAcao",
"descricaoMeta",
"unidadeMedida",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeGestora": "123456",
"codigoAcao": "9876",
"descricaoAcao": "Construção de escolas municipais",
"tipoAcao": "1",
"descricaoMeta": "Construir 5 novas unidades escolares até o final do exercício",
"unidadeMedida": "unidade",
"action": "CREATE"
},
{
"codigoUnidadeGestora": "123456",
"codigoAcao": "3331",
"descricaoAcao": "Construção de hospitais",
"tipoAcao": "1",
"descricaoMeta": "Construir 5 hospitais",
"unidadeMedida": "Medida",
"action": "DELETE"
}
]
}Regras
| ID | Regra |
| ACAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora deve estar homologada pelo TCE antes do cadastro |
| ACAO_TIPO_VALIDO |
O tipo da ação deve ser válido para o exercício do envio, conforme a |
| RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar ações, pois são os responsáveis pelo protocolo do orçamento |
| ACAO_ESCOPO_CADASTRO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
Atualização Orçamentária
Atualização Orçamentária
Atualização Orçamentária | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Código Função - Código Subfunção - Código Programa - Código Ação - Código Categoria Econômica - Código Natureza Despesa - Código Modalidade Despesa - Código Elemento Despesa - Código Fonte Recurso - Exercício Fonte Recurso - Número Decreto Ofício - Tipo Decreto Ofício - Tipo Alteração ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestora |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício |
codigoFuncao |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoSubfuncao |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoPrograma |
✅ | Código do programa cadastrado pela Unidade Gestora para o exercício |
codigoAcao |
✅ | Código da ação cadastrado pela Unidade Gestora para o exercício |
codigoCategoriaEconomica |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoNaturezaDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoModalidadeDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoElementoDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoFonteRecurso |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
exercicioFonteRecurso |
✅ |
|
numeroDecretoOficio |
✅ | – |
tipoDecretoOficio |
✅ | Decreto / Oficio |
tipoAlteracao |
✅ | Tabela Tipo Alteração |
valorAtualizacao |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Alterações Orçamentárias",
"description": "Schema para envio de alterações orçamentárias por ação",
"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": {
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"codigoFuncao": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoSubfuncao": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoPrograma": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
}
"codigoAcao": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoCategoriaEconomica": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoNaturezaDespesa": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoModalidadeDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoElementoDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": [
"ATUAL",
"ANTERIOR"
]
},
"numeroDecretoOficio": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]+$"
},
"tipoDecretoOficio": {
"type": "integer",
"enum": [
"DECRETO",
"OFICIO"
],
},
"tipoAlteracao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valorAtualizacao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"codigoUnidadeOrcamentaria",
"codigoFuncao",
"codigoSubfuncao",
"codigoPrograma",
"codigoAcao",
"codigoCategoriaEconomica",
"codigoNaturezaDespesa",
"codigoModalidadeDespesa",
"codigoElementoDespesa",
"codigoFonteRecurso",
"exercicioFonteRecurso",
"numeroDecretoOficio",
"tipoDecretoOficio",
"tipoAlteracao",
"dataAtualizacao",
"valorAtualizacao",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2026-03-02T11:32:45.123456",
"elementos": [
{
"codigoUnidadeGestora": "123456",
"codigoUnidadeOrcamentaria": "54321",
"codigoFuncao": "10",
"codigoSubfuncao": "301",
"codigoPrograma": "2045",
"codigoAcao": "1001",
"codigoCategoriaEconomica": "3",
"codigoNaturezaDespesa": "3",
"codigoModalidadeDespesa": "90",
"codigoElementoDespesa": "30",
"codigoFonteRecurso": "500",
"exercicioFonteRecurso": "ATUAL",
"numeroDecretoOficio": "202600001",
"tipoDecretoOficio": "DECRETO",
"tipoAlteracao": "1",
"valorAtualizacao": 150000.50,
"action": "CREATE"
},
{
"codigoUnidadeGestora": "123456",
"codigoUnidadeOrcamentaria": "54321",
"codigoFuncao": "12",
"codigoSubfuncao": "361",
"codigoPrograma": "3050",
"codigoAcao": "2002",
"codigoCategoriaEconomica": "4",
"codigoNaturezaDespesa": "4",
"codigoModalidadeDespesa": "90",
"codigoElementoDespesa": "52",
"codigoFonteRecurso": "501",
"exercicioFonteRecurso": "ANTERIOR",
"numeroDecretoOficio": "202600002",
"tipoDecretoOficio": "OFICIO",
"tipoAlteracao": "2",
"valorAtualizacao": 82500.00,
"action": "UPDATE"
}
]
}Regras
| ID | Regra |
| ATUALIZACAO_ORCAMENTARIA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ATUALIZACAO_ORCAMENTARIA_UNIDADE_GESTORA_MUNICIPIO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
| ATUALIZACAO_ORCAMENTARIA_RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar atualizações orçamentárias por Decreto/Ofício e as Câmaras atualizações quando o instrumento for Ofício |
| ATUALIZACAO_ORCAMENTARIA_UNIDADE_ORCAMENTARIA_CADASTRADA | A Unidade Orçamentária deve ter sido criada para o exercício do envio |
| ATUALIZACAO_ORCAMENTARIA_PROGRAMA_CADASTRADO | O Programa deve ter sido criado para o exercício do envio |
| ATUALIZACAO_ORCAMENTARIA_ACAO_CADASTRADA | A Ação deve ter sido criada para o exercício do envio |
| ATUALIZACAO_ORCAMENTARIA_FUNCAO_STN | O código de Função deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| ATUALIZACAO_ORCAMENTARIA_SUBFUNCAO_STN | O código de Subfunção deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| ATUALIZACAO_ORCAMENTARIA_CATEGORIA_ECONOMICA_STN | O código de Categoria Econômica deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| ATUALIZACAO_ORCAMENTARIA_NATUREZA_DESPESA_STN | O código de Natureza Despesa deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| ATUALIZACAO_ORCAMENTARIA_ELEMENTO_DESPESA_STN | O código de Elemento Despesa deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| ATUALIZACAO_ORCAMENTARIA_FONTE_RECURSO_STN | O código de Fonte Recurso deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| ATUALIZACAO_ORCAMENTARIA_SUPLEMENTACAO_ANULACAO | Para atualizações do tipo 4 e 8, o valor suplementado deve ser igual ao valor das atualizações do tipo 11 por decreto |
| ATUALIZACAO_ORCAMENTARIA_TIPO_14_15 | Para atualizações do tipo 14, deve existir uma atualização do tipo 15 com o mesmo valor |
| ATUALIZACAO_ORCAMENTARIA_DECRETO_OFICIO_OBRIGATORIO | Se houver atualização, deve existir um registro de decreto/ofício vinculado |
| ATUALIZACAO_ORCAMENTARIA_TIPO_6_7_8_9_16_DOTACAO_INEXISTENTE | Para as atualizações dos tipos 6, 7, 8, 9 e 16, só é permitido inserir se a dotação não existir. A dotação será criada automaticamente pelo sistema. |
| ATUALIZACAO_ORCAMENTARIA_TIPO_2 |
Para o Tipo 2, o exercício da fonte de recurso deve ser ANTERIOR.
A Dotação com exercício da fonte de recurso ATUAL deve existir previamente. Caso contrário, deverá falhar.
Se a Dotação com exercício da fonte de recurso ANTERIOR não existir, uma nova deverá ser criada automaticamente. |
| ATUALIZACAO_ORCAMENTARIA_TIPO_10 | Caso a dotação não exista, o sistema a criará automaticamente. Se já existir, deverá inserir apenas a atualização. |
| ATUALIZACAO_ORCAMENTARIA_TIPO_7_16_EXERCICIO_FONTE | Para atualizações do tipo 7 ou 16, o exercício da fonte deve ser anterior. O sistema irá criar uma dotação igual com exercício da fonte recurso ATUAL e valor inicial ZERO. |
| ATUALIZACAO_ORCAMENTARIA_TIPO_6_8_9_EXERCICIO_FONTE | Para atualizações dos tipos 6, 8 e 9 , o exercício da fonte recurso deve ser ATUAL. |
| ATUALIZACAO_ORCAMENTARIA_TIPO_REQUER_DOTACAO_EXISTIR | Atualizações dos tipos 1, 3, 4, 11, 12 e 14 devem possuir Dotação já cadastrada. |
| ATUALIZACAO_ORCAMENTARIA_TIPO_15_DOTACAO | Para atualizações do tipo 15, a dotação informada deve ser igual à do tipo 14, diferindo apenas pelo elemento de despesa. A soma dos valores por ofício deve ser igual à do Tipo 14. Caso a dotação do tipo 15 não exista, ela será criada automaticamente pelo sistema |
| ATUALIZACAO_ORCAMENTARIA_TIPO_13_DOTACAO | O valor da atualizações do tipo 13 deve ser igual à soma das atualizações do tipo 12, considerando [ Código Fonte Recurso + Exercício da Fonte Recurso ] Caso a dotação do tipo 13 não exista, ela será criada automaticamente pelo sistema |
| ATUALIZACAO_ORCAMENTARIA_TIPO_11_SOMA_SUPLEMENTACAO | A soma dos valores das atualizações do tipo 11 agrupadas por decreto deve ser igual à soma dos valores das atualizações dos tipos 4 ou 8 correspondentes ao mesmo decreto. |
| ATUALIZACAO_ORCAMENTARIA_DECRETO_TIPO_4_8_NAO_PERMITIDO | Não é permitido incluir em um decreto atualizações orçamentárias dos tipos 4 e 8 simultaneamente. |
| ATUALIZACAO_ORCAMENTARIA_DECRETO_TIPOS_INCOMPATIVEIS | Um mesmo decreto não pode conter simultaneamente atualizações orçamentárias dos tipos 1, 2, 3 e 4 e atualizações dos tipos 6, 7, 8, 9, 10, 15. |
| ATUALIZACAO_ORCAMENTARIA_OFICIO_TIPO_OBRIGATORIO | Quando o tipo for OFÍCIO, o tipo de alteração deve ser 14 ou 15 |
| ATUALIZACAO_ORCAMENTARIA_TIPO_ALTERACAO_VALIDO | O Tipo de Alteração deve ser válido conforme a Tabela de Tipo de Alteração Orçamentária |
Conciliação Bancária
Conciliação Bancária
Conciliação Bancária | 2025 -
Tipo Envio: Balancete - Contabilidade
Chave Unicidade
[ Exercício - Mês - Código Unidade Gestora - Número Conta Bancária - Número Agência Conta Bancária - Código Banco Conta Bancária - Número - Tipo Conta Bancária - CNPJ Gerência Conta Bancária ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroContaBancaria |
✅ | – |
numeroAgenciaContaBancaria |
✅ | – |
codigoBancoContaBancaria |
✅ | – |
tipoContaBancaria |
✅ | – |
cnpjGerenciaContaBancaria |
✅ | – |
numeroConciliacao |
✅ | – |
tipoConciliacao |
– | Tabela Tipo Conciliação |
descricao |
– | – |
data |
– | – |
numeroCheque |
– | – |
numeroDocDebito |
– | – |
valorConciliacao |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Conciliações Bancárias",
"description": "Lista de objetos representando a entidade Conciliação Bancária",
"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": "Conciliação Bancária",
"description": "Representação do schema para envio da entidade Conciliação Bancária",
"type": "object",
"properties": {
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"pattern": "^[A-Z0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^[A-Z0-9]+$"
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numero": {
"type": "string",
"minLength": 8,
"maxLength": 8,
"pattern": "^[0-9]+$"
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"tipoConciliacao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"descricao": {
"type": "string",
"minLength": 10,
"maxLength": 150
},
"data": {
"type": "string",
"format": "date"
},
"numeroCheque": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"numeroDocDebito": {
"type": "string",
"minLength": 11,
"maxLength": 11
},
"valorConciliacao": {
"type": "number",
"minimum": 0
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"numeroContaBancaria",
"numeroAgenciaContaBancaria",
"codigoBancoContaBancaria",
"numero",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria",
"tipoConciliacao",
"descricao",
"data",
"numeroCheque",
"numeroDocDebito",
"valorConciliacao",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroContaBancaria": "1234567890123",
"numeroAgenciaContaBancaria": "123456",
"codigoBancoContaBancaria": "001",
"numero": "00000001",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678901234",
"tipoConciliacao": "1",
"descricao": "Conciliação de depósito bancário realizado no dia",
"data": "2025-09-11",
"numeroCheque": "123456",
"numeroDocDebito": "12345678901",
"valorConciliacao": 5000.50,
"action": "CREATE"
},
{
"numeroContaBancaria": "9876543210987",
"numeroAgenciaContaBancaria": "654321",
"codigoBancoContaBancaria": "002",
"numero": "00000002",
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432109876",
"tipoConciliacao": "2",
"descricao": "Conciliação de transferencia bancária disponível em conta",
"data": "2025-09-10",
"numeroCheque": "654321",
"numeroDocDebito": "98765432109",
"valorConciliacao": 7500.75,
"action": "UPDATE"
}
]
}
Regras
| ID | Regra |
| CONCILIACAO_BANCARIA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| CONCILIACAO_BANCARIA_TIPO_VALIDO |
O tipo da conciliação deve ser válido para o exercício do envio, conforme a Tabela Tipo Conciliação |
Conta Bancária
Conta Bancária
Conta Bancária | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Código Unidade Gestora - Número Conta Bancária - Código Banco - Número Agência - Tipo Conta Bancária - CNPJ Gerência Conta Bancária - Descrição Conta Bancária ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
|---|---|---|
numeroContaBancaria |
✅ | – |
codigoBancoContaBancaria |
✅ | Código da FEBRABAN |
numeroAgenciaContaBancaria |
✅ | – |
tipoContaBancaria |
✅ | Tabela Tipo Conta Bancária |
cnpjGerenciaContaBancaria |
✅ | – |
descricaoContaBancaria |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Conta Bancária",
"description": "Schema para envio de contas bancárias por unidade gestora",
"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": {
"type": "object",
"properties": {
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"pattern": "^[A-Z0-9]+$"
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^[A-Z0-9]+$"
},
"descricaoContaBancaria": {
"type": "string",
"minLength": 10,
"maxLength": 100
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"numeroContaBancaria",
"codigoBancoContaBancaria",
"numeroAgenciaContaBancaria",
"descricaoContaBancaria",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroContaBancaria": "0012345678901",
"codigoBancoContaBancaria": "001",
"numeroAgenciaContaBancaria": "1234A",
"descricaoContaBancaria": "Conta Principal Fundo Municipal de Saúde",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678000199",
"action": "CREATE"
},
{
"numeroContaBancaria": "0098765432100",
"codigoBancoContaBancaria": "033",
"numeroAgenciaContaBancaria": "5678B",
"descricaoContaBancaria": "Conta Secundária Fundo Municipal de Educação",
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432000188",
"action": "UPDATE"
},
{
"numeroContaBancaria": "0011122233300",
"codigoBancoContaBancaria": "104",
"numeroAgenciaContaBancaria": "9999C",
"descricaoContaBancaria": "Conta Reserva Fundo Municipal de Assistência Social",
"tipoContaBancaria": "3",
"cnpjGerenciaContaBancaria": "11122233000177",
"action": "DELETE"
}
]
}Regras
| ID | Regra |
| CONTA_BANCARIA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| CONTA_BANCARIA_TIPO_VALIDO |
O Tipo de Conta Bancária deve ser válido conforme a |
| CONTA_BANCARIA_CODIGO_BANCO_VALIDO |
O código do banco deve ser válido conforme a tabela do FEBRABAN |
Conta Bancária Credor
Conta Bancária Credor
Conta Bancária Credor | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Código Unidade Gestora - Número Conta Bancária - Código Banco - Número Agência - CPF/CNPJ Credor ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
|---|---|---|
cpfCnpjCredor |
✅ | – |
numeroContaBancariaCredor |
✅ | – |
codigoBancoContaBancariaCredor |
✅ | Código da FEBRABAN |
numeroAgenciaContaBancariaCredor |
✅ | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Conta Bancária Credor",
"description": "Schema para envio de contas bancárias dos credores por unidade gestora",
"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": {
"type": "object",
"properties": {
"cpfCnpjCredor": {
"type": "string",
"minLength": 11,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"numeroContaBancariaCredor": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"pattern": "^[A-Z0-9]+$"
},
"codigoBancoContaBancariaCredor": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancariaCredor": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^[A-Z0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"cpfCnpjCredor",
"numeroContaBancariaCredor",
"codigoBancoContaBancariaCredor",
"numeroAgenciaContaBancariaCredor",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"cpfCnpjCredor": "12312312312",
"numeroContaBancariaCredor": "0012345678901",
"codigoBancoContaBancariaCredor": "001",
"numeroAgenciaContaBancariaCredor": "1234A",
"action": "CREATE"
},
{
"cpfCnpjCredor": "12312312312ACZ",
"numeroContaBancariaCredor": "0098765432100",
"codigoBancoContaBancariaCredor": "033",
"numeroAgenciaContaBancariaCredor": "5678B",
"action": "UPDATE"
},
{
"cpfCnpjCredor": "12312312312ACZ",
"numeroContaBancariaCredor": "0011122233300",
"codigoBancoContaBancariaCredor": "104",
"numeroAgenciaContaBancariaCredor": "9999C",
"action": "DELETE"
}
]
}Regras
| ID | Regra |
| CONTA_BANCARIA_CREDOR_ DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| CONTA_BANCARIA_CREDOR_CODIGO_BANCO_VALIDO |
O código do banco deve ser válido conforme a tabela do FEBRABAN |
| CONTA_BANCARIA_CREDOR_CREDOR_CADASTRADO |
O credor informado deve estar cadastrado para a unidade gestora |
Credor
Credor
Credor | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Código Unidade Gestora - CPF/CNPJ - Nome ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
|---|---|---|
cpfCnpj |
✅ | – |
nome |
– | – |
tipo |
– | Tabela Tipo Credor |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Credor",
"description": "Schema para envio de credores por unidade gestora",
"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": {
"type": "object",
"properties": {
"cpfCnpj": {
"type": "string",
"minLength": 11,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"nome": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"tipo": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"cpfCnpj",
"nome",
"tipo",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"cpfCnpjCredor": "12345678000199",
"nomeCredor": "Empresa Fornecedora de Materiais LTDA",
"tipoCredor": "1",
"action": "CREATE"
},
{
"cpfCnpjCredor": "98765432100",
"nomeCredor": "João da Silva Pereira",
"tipoCredor": "2",
"action": "UPDATE"
},
{
"cpfCnpjCredor": "11122233000177",
"nomeCredor": "Construtora Municipal S.A.",
"tipoCredor": "3",
"action": "DELETE"
}
]
}Regras
| ID | Regra |
| CREDOR_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| CREDOR_TIPO_VALIDO | O Tipo de Credor deve ser válido conforme a Tabela de Tipo de Credor |
| CREDOR_NOME_INVALIDO | O nome do credor deve ser correspondente ao cadastrado na Receita Federal |
Decreto Oficio
Decreto Oficio
Decreto Oficio | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Número Decreto Ofício - Tipo Documento ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroDecretoOficio |
✅ | – |
tipoDocumento |
✅ | Decreto / Oficio |
protolocoLei |
– | Número do protocolo da Lei no banco de legislação do TCE |
dataDecretoOficio |
– | – |
referenciaAnexo |
– | Hash retornada pelo endpoint de upload de anexos, utilizada para identificar e associar o anexo ao decreto. |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Decretos e Ofícios",
"description": "Schema para envio de decretos e ofícios por unidade gestora",
"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": {
"type": "object",
"properties": {
"numeroDecretoOficio": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]+$"
},
"protolocoLei": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^\\d{6}/\\d{2}$"
},
"dataDecretoOficio": {
"type": "string",
"format": "date"
},
"tipoDocumento": {
"type": "integer",
"enum": [
"DECRETO",
"OFICIO"
],
},
"referenciaAnexo": {
"type": "string",
"minLength": 33,
"maxLength": 33,
"pattern": "^[0-9]{6}\\.[A-Z2-7]{26}$"
}
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"numeroDecretoOficio",
"protolocoLei",
"dataDecretoOficio",
"tipoDocumento",
"referenciaAnexo",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2026-03-02T11:32:45.123456",
"elementos": [
{
"numeroDecretoOficio": "000012026",
"protolocoLei": "065111/25",
"tipoDocumento": "DECRETO",
"dataDecretoOficio": "2025-10-10",
"referenciaAnexo": "123456.ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"action": "CREATE"
},
{
"numeroDecretoOficio": "000022026",
"protolocoLei": "065111/26",
"dataDecretoOficio": "2025-12-31",
"tipoDocumento": "OFICIO",
"referenciaAnexo": "123456.ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"action": "UPDATE"
}
]
}Regras
| ID | Regra |
| DECRETO_OFICIO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| DECRETO_OFICIO_PROTOCOLO_LEI_EXISTENTE | O Protocolo da Lei deve existir no banco de legislação do TCE |
| DECRETO_OFICIO_NUMERO_ATUALIZACAO_COMPETENCIA | O número do decreto ou ofício deve existir em uma atualização orçamentária no mesmo envio |
| DECRETO_OFICIO_ATUALIZACAO_OBRIGATORIA | Não é permitido enviar um decreto ou ofício sem que exista ao menos uma atualização orçamentária no mesmo envio |
| DECRETO_OFICIO_RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar Decretos/Ofícios e as câmaras poderão enviar ofícios |
| DECRETO_OFICIO_ANEXO_OBRIGATORIO | Deve ser enviado o arquivo PDF do decreto ou ofício |
Despesa Extra
Despesa Extra
Despesa Extra | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Número Despesa Extra ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroDespesaExtra |
✅ | – |
codigoContaContabil |
– | Constituído pela IPC 00 – STN e Ajustes do TCE-PB |
cpfCnpjCredor |
– | CPF/CNPJ do Credor cadastrado pela Unidade Gestora |
exercicioFonteRecurso |
– | ATUAL / ANTERIOR |
codigoFonteRecurso |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoBancoContaBancaria |
– | Código da FEBRABAN |
numeroContaBancaria |
– | – |
numeroAgenciaContaBancaria |
– | – |
tipoContaBancaria |
– | Tabela Tipo Conta Bancária |
cnpjGerenciaContaBancaria |
– | – |
valorDespesaExtra |
– | – |
historico |
– | – |
codigoDespesaExtra |
– | Tabela Código Despesa Extra |
codigoFonteRecursoPagamento |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoCO |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoUnidadeGestoraReceitaExtra |
– | – |
exercicioReceitaExtra |
– | – |
numeroReceitaExtra |
– | Número da Receita Extra cadastrado pela Unidade Gestora para o exercício |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Despesas Extraorçamentárias",
"description": "Lista de objetos representando a entidade Despesa Extraorçamentária",
"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": "Despesa Extraorçamentária",
"description": "Representação do schema para envio da entidade Despesa Extraorçamentária",
"type": "object",
"properties": {
"numeroDespesaExtra": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"codigoContaContabil": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]+$"
},
"cpfCnpjCredor": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": ["ATUAL", "ANTERIOR"]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[0-9]+$"
},
"valorDespesaExtra": {
"type": "number",
"exclusiveMinimum": 0
},
"historico": {
"type": "string",
"minLength": 10,
"maxLength": 500
},
"codigoDespesaExtra": {
"type": "string",
"minLength": 8,
"maxLength": 8,
"pattern": "^[0-9]+$"
},
"codigoFonteRecursoPagamento": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"co": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeGestoraReceitaExtra": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"exercicioReceitaExtra": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroReceitaExtra": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"numeroDespesaExtra",
"codigoContaContabil",
"cpfCnpjFornecedor",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"codigoBancoContaBancaria",
"numeroContaBancaria",
"numeroAgenciaContaBancaria",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria",
"valorDespesaExtra",
"historico",
"codigoDespesaExtra",
"codigoFonteRecursoPagamento",
"co",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroDespesaExtra": "1234567",
"exercicio": "2025",
"codigoContaContabil": "123456789",
"dataDespesaExtra": "2025-09-11",
"cpfCnpjCredor": "12345678000190",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "100",
"codigoBancoContaBancaria": "001",
"numeroContaBancaria": "1234567890123",
"numeroAgenciaContaBancaria": "123456",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678000190",
"valorDespesaExtra": 50000.00,
"historico": "Despesa extraorçamentária referente a retenção de tributos",
"codigoDespesaExtra": "12345678",
"codigoFonteRecursoPagamento": "100",
"co": "0001",
"codigoUnidadeGestoraReceitaExtra": "123456",
"exercicioReceitaExtra": "2025",
"numeroReceitaExtra": "1234567",
"action": "CREATE"
},
{
"numeroDespesaExtra": "1234567",
"exercicio": "2025",
"codigoContaContabil": "123456789",
"dataDespesaExtra": "2025-09-11",
"cpfCnpjCredor": "12345678000190",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "100",
"codigoBancoContaBancaria": "001",
"numeroContaBancaria": "1234567890123",
"numeroAgenciaContaBancaria": "123456",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678000190",
"valorDespesaExtra": 50000.00,
"historico": "Despesa extraorçamentária referente a retenção de tributos",
"codigoDespesaExtra": "12345678",
"codigoFonteRecursoPagamento": "100",
"co": "0001",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| DESPESA_EXTRA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| DESPESA_EXTRA_RECEITA_EXTRA_EXISTENTE | A Receita Extra informada deve existir no sistema quando o código da conta contábil exigir receita extra |
| DESPESA_EXTRA_CONTA_CONTABIL | O código de conta contábil deve seguir os códigos definidos pelo STN |
| DESPESA_EXTRA_CREDOR_CADASTRADO | O credor deve ter sido cadastrado para a Unidade Gestora |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora da receita extra deve estar homologada pelo TCE e deve pertencer ao mesmo município |
Dotação
Dotação
Dotação | 2025 - 2026
Tipo Envio: Orçamento
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Código Função - Código Subfunção - Código Programa - Código Ação - Código Categoria Econômica - Código Natureza Despesa - Código Modalidade Despesa - Código Elemento Despesa - Código Fonte Recurso - Exercício Fonte Recurso ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestora |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício |
codigoFuncao |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoSubfuncao |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoPrograma |
✅ | Código do programa cadastrado pela Unidade Gestora para o exercício |
codigoAcao |
✅ | Código da ação cadastrado pela Unidade Gestora para o exercício |
codigoCategoriaEconomica |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoNaturezaDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoModalidadeDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoElementoDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoFonteRecurso |
✅ |
Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
exercicioFonteRecurso |
✅ | Atual / Anterior |
valorDotacao |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Dotações",
"description": "Lista de objetos representando a entidade Dotação",
"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": "Dotação",
"description": "Representação do schema para envio da entidade Dotação",
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"codigoFuncao": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoSubfuncao": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoPrograma": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoAcao": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoCategoriaEconomica": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoNaturezaDespesa": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoModalidadeDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoElementoDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": [
"ATUAL",
"ANTERIOR"
]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"valorDotacao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"codigoUnidadeOrcamentaria",
"codigoFuncao",
"codigoSubfuncao",
"codigoPrograma",
"codigoAcao",
"codigoCategoriaEconomica",
"codigoNaturezaDespesa",
"codigoModalidadeDespesa",
"codigoElementoDespesa",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"valorDotacao",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeGestora": "123456",
"codigoUnidadeOrcamentaria": "54321",
"codigoFuncao": "01",
"codigoSubfuncao": "123",
"codigoPrograma": "0001",
"codigoAcao": "1001",
"codigoCategoriaEconomica": "4",
"codigoNaturezaDespesa": "3",
"codigoModalidadeDespesa": "90",
"codigoElementoDespesa": "39",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "101",
"valorDotacao": 250000.75,
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"codigoUnidadeOrcamentaria": "12345",
"codigoFuncao": "02",
"codigoSubfuncao": "456",
"codigoPrograma": "0002",
"codigoAcao": "2002",
"codigoCategoriaEconomica": "3",
"codigoNaturezaDespesa": "1",
"codigoModalidadeDespesa": "30",
"codigoElementoDespesa": "11",
"exercicioFonteRecurso": "ANTERIOR",
"codigoFonteRecurso": "202",
"valorDotacao": 180000.00,
"action": "UPDATE"
}
]
}Regras
| ID | Regra |
| DOTACAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora deve estar homologada pelo TCE antes do cadastro |
| DOTACAO_CODIGO_FUNCAO_VALIDO | O código de Função deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_SUBFUNCAO_VALIDO | O código de Subfunção deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_CATEGORIA_ECONOMICA_VALIDO | O código de Categoria Econômica deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_NATUREZA_DESPESA_VALIDO | O código de Natureza Despesa deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_MODALIDADE_DESPESA_VALIDO | O código de Modalidade Despesa deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_ELEMENTO_DESPESA_VALIDO | O código de Elemento Despesa deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_FONTE_RECURSO_VALIDO | O código de Fonte Recurso deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_EXERCICIO_FONTE_RECURSO_VALIDO | O exercício da Fonte de Recurso só pode ser ANTERIOR caso a Unidade Gestora seja previdenciária e para códigos fonte recurso relacionados ao RPPS |
| DOTACAO_ACAO_NAO_CADASTRADA | A ação deve ter sido criada para o exercício do envio |
| DOTACAO_PROGRAMA_NAO_CADASTRADO | O Programa deve ter sido criado para o exercício do envio |
| DOTACAO_UNIDADE_ORCAMENTARIA_NAO_CADASTRADA | A Unidade Orçamentária deve ter sido criada para o exercício do envio |
| RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar dotações, pois são os responsáveis pelo protocolo do orçamento |
| DOTACAO_ESCOPO_CADASTRO | A Prefeitura cadastra dotações de todas as UGs vinculadas a ela, enquanto o Consórcio cadastra apenas suas próprias dotações |
Dotação
Dotação | 2027 ~
Tipo Envio: Orçamento
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestora |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício |
codigoFuncao |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoSubfuncao |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoPrograma |
✅ | Código do programa cadastrado pela Unidade Gestora para o exercício |
codigoAcao |
✅ | Código da ação cadastrado pela Unidade Gestora para o exercício |
codigoCategoriaEconomica |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoNaturezaDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoModalidadeDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoElementoDespesa |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoFonteRecurso |
✅ |
Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
exercicioFonteRecurso |
✅ | Atual / Anterior |
codigoEmendaParlamentar |
– | Tabela Emenda Parlamentar |
numeroEmendaImpositiva |
– | – |
valorDotacao |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Dotações",
"description": "Lista de objetos representando a entidade Dotação",
"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": "Dotação",
"description": "Representação do schema para envio da entidade Dotação",
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"codigoFuncao": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoSubfuncao": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoPrograma": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoAcao": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoCategoriaEconomica": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoNaturezaDespesa": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoModalidadeDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoElementoDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": [
"ATUAL",
"ANTERIOR"
]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoEmendaParlamentar": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroEmendaImpositiva": {
"type": "string",
"minLength": 1,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"valorDotacao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"codigoUnidadeOrcamentaria",
"codigoFuncao",
"codigoSubfuncao",
"codigoPrograma",
"codigoAcao",
"codigoCategoriaEconomica",
"codigoNaturezaDespesa",
"codigoModalidadeDespesa",
"codigoElementoDespesa",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"valorDotacao",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeGestora": "123456",
"codigoUnidadeOrcamentaria": "54321",
"codigoFuncao": "01",
"codigoSubfuncao": "123",
"codigoPrograma": "0001",
"codigoAcao": "1001",
"codigoCategoriaEconomica": "4",
"codigoNaturezaDespesa": "3",
"codigoModalidadeDespesa": "90",
"codigoElementoDespesa": "39",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "101",
"codigoEmendaParlamentar": "1001",
"numeroEmendaImpositiva": "0001",
"valorDotacao": 250000.75,
"codigoEmendaParlamentar": "1021",
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"codigoUnidadeOrcamentaria": "12345",
"codigoFuncao": "02",
"codigoSubfuncao": "456",
"codigoPrograma": "0002",
"codigoAcao": "2002",
"codigoCategoriaEconomica": "3",
"codigoNaturezaDespesa": "1",
"codigoModalidadeDespesa": "30",
"codigoElementoDespesa": "11",
"exercicioFonteRecurso": "ANTERIOR",
"codigoFonteRecurso": "202",
"valorDotacao": 180000.00,
"action": "UPDATE"
}
]
}Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Código Função - Código Subfunção - Código Programa - Código Ação - Código Categoria Econômica - Código Natureza Despesa - Código Modalidade Despesa - Código Elemento Despesa - Código Fonte Recurso - Exercício Fonte Recurso ]
Regras
| ID | Regra |
| DOTACAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora deve estar homologada pelo TCE antes do cadastro |
| DOTACAO_CODIGO_FUNCAO_VALIDO | O código de Função deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_SUBFUNCAO_VALIDO | O código de Subfunção deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_CATEGORIA_ECONOMICA_VALIDO | O código de Categoria Econômica deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_NATUREZA_DESPESA_VALIDO | O código de Natureza Despesa deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_MODALIDADE_DESPESA_VALIDO | O código de Modalidade Despesa deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_ELEMENTO_DESPESA_VALIDO | O código de Elemento Despesa deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_CODIGO_FONTE_RECURSO_VALIDO | O código de Fonte Recurso deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| DOTACAO_EXERCICIO_FONTE_RECURSO_VALIDO | O exercício da Fonte de Recurso só pode ser ANTERIOR caso a Unidade Gestora seja previdenciária e para códigos fonte recurso relacionados ao RPPS |
| DOTACAO_ACAO_NAO_CADASTRADA | A ação deve ter sido criada para o exercício do envio |
| DOTACAO_PROGRAMA_NAO_CADASTRADO | O Programa deve ter sido criado para o exercício do envio |
| DOTACAO_UNIDADE_ORCAMENTARIA_NAO_CADASTRADA | A Unidade Orçamentária deve ter sido criada para o exercício do envio |
| RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar dotações, pois são os responsáveis pelo protocolo do orçamento |
| DOTACAO_ESCOPO_CADASTRO | A Prefeitura cadastra dotações de todas as UGs vinculadas a ela, enquanto o Consórcio cadastra apenas suas próprias dotações |
| DOTACAO_EMENDA_PARLAMENTAR_VALIDA | O código da emenda parlamentar deve ser válido conforme a Tabela Emenda Parlamentar |
| DOTACAO_EMENDA_IMPOSITIVA_OBRIGATORIA | Quando o código da emenda parlamentar for informado, a emenda impositiva deve ter sido cadastrada para a unidade gestora no exercício |
Emenda Impositiva
Emenda Impositiva
Emenda Impositiva | 2027 ~
Tipo Envio: Orçamento/Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Número Emenda Impositiva ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestora |
✅ | – |
numeroEmendaImpositiva |
✅ | – |
cpfAutor |
– | – |
nomeAutor |
– | – |
cnpjBeneficiario |
– | – |
nomeBeneficiario |
– | – |
finalidade |
– | – |
valorEmendaImpositiva |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Emendas Impositivas",
"description": "Lista de objetos representando a entidade Emenda Impositiva",
"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": "Emenda Impositiva",
"description": "Representação do schema para envio da entidade Emenda Impositiva",
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"numeroEmendaImpositiva": {
"type": "string",
"minLength": 1,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"cpfAutor": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"nomeAutor": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"cnpjBeneficiario": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"nomeBeneficiario": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"finalidade": {
"type": "string",
"minLength": 10,
"maxLength": 500
},
"valorEmendaImpositiva": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeGestora",
"numeroEmendaImpositiva",
"cpfAutor",
"nomeAutor",
"cnpjBeneficiario",
"nomeBeneficiario",
"finalidade",
"valorEmenda",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T13:40:55.111222",
"elementos": [
{
"codigoUnidadeGestora": "777888",
"numeroEmendaImpositiva": "5004",
"cpfAutor": "99988877766",
"nomeAutor": "Roberto Lima",
"cnpjBeneficiario": "QWE123RTY45678",
"nomeBeneficiario": "Hospital Municipal Esperança",
"finalidade": "Aquisição de ambulância",
"valorEmendaImpositiva": 200000,
"action": "CREATE"
},
{
"codigoUnidadeGestora": "777888",
"numeroEmendaImpositiva": "5005",
"cpfAutor": "22233344455",
"nomeAutor": "Fernanda Costa",
"cnpjBeneficiario": "ASD456FGH78901",
"nomeBeneficiario": "Creche Pequenos Sonhos",
"finalidade": "Ampliação da infraestrutura",
"valorEmendaImpositiva": 90000,
"action": "UPDATE"
}
]
}Regras
| ID | Regra |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora deve estar homologada pelo TCE antes do cadastro |
| RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar emendas impositivas, pois são os responsáveis pelo protocolo do orçamento |
| EMENDA_IMPOSITIVA_ESCOPO_CADASTRO | A Prefeitura cadastra emendas impositivas de todas as UGs vinculadas a ela, enquanto o Consórcio cadastra apenas suas próprias dotações |
| EMENDA_IMPOSITIVA_NOME_AUTOR_INVALIDO | O nome do autor deve ser correspondente ao cadastrado na Receita Federal |
| EMENDA_IMPOSITIVA_NOME_BENEFICIARIO_INVALIDO | O nome do beneficiário deve ser correspondente ao cadastrado na Receita Federal |
Empenho
Empenho
Empenho | 2025 - 2026
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício |
numeroEmpenho |
✅ | – |
tipoEmpenho |
– | Tabela Tipo Empenho |
valorEmpenho |
– | – |
codigoPrograma |
– | Código do programa cadastrado pela Unidade Gestora para o exercício |
codigoAcao |
– | Código da ação cadastrado pela Unidade Gestora para o exercício |
codigoFuncao |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoSubfuncao |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoCategoriaEconomica |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoNaturezaDespesa |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoModalidadeDespesa |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoElementoDespesa |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoSubelementoDespesa |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoCO |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoFonteRecurso |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
exercicioFonteRecurso |
– | Atual / Anterior |
codigoNaturezaContratacao |
– | Tabela Natureza Contratação |
codigoModalidadeLicitacao |
– | Tabela Modalidade Licitação |
numeroObra |
– | – |
numeroLicitacao |
– | – |
historico |
– | – |
cpfCnpjCredor |
– | CPF/CNPJ do credor cadastrado pela Unidade Gestora |
cpfOrdenador |
– | CPF do ordenador cadastrado pela Unidade Gestora |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Empenhos",
"description": "Schema para envio de empenhos por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"tipoEmpenho": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valorEmpenho": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoFuncao": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoSubfuncao": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoPrograma": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoAcao": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoCategoriaEconomica": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoNaturezaDespesa": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoModalidadeDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoElementoDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoSubelementoDespesa": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoCO": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": [
"ATUAL",
"ANTERIOR"
]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoNaturezaContratacao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoModalidadeLicitacao": {
"type": "string",
"minLength": 2,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroObra": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"numeroLicitacao": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^\\d{5}/\\d{4}$"
},
"historico": {
"type": "string",
"maxLength": 4000
},
"cpfCnpjCredor": {
"type": "string",
"minLength": 11,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"cpfOrdenador": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"tipoEmpenho",
"valorEmpenho",
"codigoFuncao",
"codigoSubfuncao",
"codigoPrograma",
"codigoAcao",
"codigoCategoriaEconomica",
"codigoNaturezaDespesa",
"codigoModalidadeDespesa",
"codigoElementoDespesa",
"codigoSubelementoDespesa",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"codigoNaturezaContratacao",
"historico",
"cpfCnpjCredor",
"cpfOrdenador",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001234",
"tipoEmpenho": "1",
"valorEmpenho": 15000.00,
"codigoFuncao": "12",
"codigoSubfuncao": "361",
"codigoPrograma": "2080",
"codigoAcao": "2050",
"codigoCategoriaEconomica": "3",
"codigoNaturezaDespesa": "3",
"codigoModalidadeDespesa": "90",
"codigoElementoDespesa": "39",
"codigoSubelementoDespesa": "014",
"codigoCO": "0001",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "100",
"codigoNaturezaContratacao": "1",
"codigoModalidadeLicitacao": "06",
"numeroObra": "00012345",
"numeroLicitacao": "00001/2025",
"historico": "Empenho referente à contratação de serviços de manutenção predial conforme processo administrativo nº 001/2025.",
"cpfCnpjCredor": "12345678000195",
"cpfOrdenador": "12345678901",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001235",
"tipoEmpenho": "1",
"valorEmpenho": 8500.50,
"codigoFuncao": "12",
"codigoSubfuncao": "361",
"codigoPrograma": "2080",
"codigoAcao": "2050",
"codigoCategoriaEconomica": "3",
"codigoNaturezaDespesa": "3",
"codigoModalidadeDespesa": "90",
"codigoElementoDespesa": "39",
"codigoSubelementoDespesa": "014",
"codigoCO": "0001",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "100",
"codigoNaturezaContratacao": "1",
"codigoModalidadeLicitacao": "06",
"numeroLicitacao": "00001/2025",
"historico": "Empenho referente à aquisição de material de escritório conforme processo administrativo nº 002/2025.",
"cpfCnpjCredor": "98765432000110",
"cpfOrdenador": "12345678901",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| EMPENHO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| EMPENHO_DOTACAO_CADASTRADA | A Dotação referenciada deve ter sido criada para o exercício do envio |
| EMPENHO_ORDENADOR_CADASTRADO | O Ordenador deve ter sido cadastrado para a Unidade Gestora |
| EMPENHO_CREDOR_CADASTRADO | O Credor deve ter sido cadastrado para a Unidade Gestora |
| EMPENHO_TIPO_VALIDO |
Válido conforme a Tabela de Tipo de Empenho |
| EMPENHO_MODALIDADE_LICITACAO_VALIDA |
Válida conforme a Tabela de Modalidade de Licitação |
| EMPENHO_NATUREZA_CONTRATACAO_VALIDA |
Válida conforme a Tabela de Natureza de Contratação |
| EMPENHO_SUBELEMENTO_VALIDO |
Válido conforme a Tabela de Subelemento |
| EMPENHO_CODIGO_CO_VALIDO | O Código CO deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| EMPENHO_LICITACAO_OBRIGATORIA | Quando a Natureza de Contratação for diferente de ZERO (Outros), é obrigatório informar o número e a modalidade da licitação |
| EMPENHO_NATUREZA_CONTRATACAO_ZERO | Quando a Natureza de Contratação for 0 (Outros), não deve ser informado Número de Licitação nem Modalidade da Licitação |
| EMPENHO_NATUREZA_CONTRATACAO_ELEMENTO_DESPESA_INVALIDO | Não é admitida Natureza de Contratação igual a ZERO quando o Código Elemento Despesa for 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 51, 52 e, ainda, 92 e 93 quando o Código Natureza Despesa for 3 ou 4 |
| EMPENHO_NATUREZA_CONTRATACAO_SUBELEMENTO_INVALIDO | A Natureza de Contratação poderá ser ZERO quando o elemento de despesa for 92 ou 93 e o código natureza de despesa for 3 ou 4, desde que o subelemento de despesa seja um dos seguintes: 106 (Indenização paga a servidor), 107 (Obrigações tributárias), 108 (Obrigações patronais), 109 (Sentenças judiciais), 110 (Jetons), 111 (Devolução de recursos) |
| EMPENHO_OBRA_OBRIGATORIA | Quando a Natureza de Contratação for 4 (Realização de Obras), o número da obra é obrigatório |
| EMPENHO_NATUREZA_CONTRATACAO_QUATRO | Quando a Natureza de Contratação não for 4 (Realização de Obras), não deve ser informado número da obra |
| EMPENHO_OBRA_CADASTRADA_GEO_OBRAS | Quando informada, a obra deve ter sido cadastrada no Geo Obras |
| EMPENHO_LICITACAO_CADASTRADA_TRAMITA | Quando informada, a licitação deve ter sido cadastrada no Tramita |
| EMPENHO_VALOR_EMPENHADO_EXCEDE_DOTACAO | O valor empenhado não pode ser maior que o saldo da dotação referenciada |
Empenho
Empenho | 2027 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício |
numeroEmpenho |
✅ | – |
tipoEmpenho |
– | Tabela Tipo Empenho |
valorEmpenho |
– | – |
codigoPrograma |
– | Código do programa cadastrado pela Unidade Gestora para o exercício |
codigoAcao |
– | Código da ação cadastrado pela Unidade Gestora para o exercício |
codigoFuncao |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoSubfuncao |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoCategoriaEconomica |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoNaturezaDespesa |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoModalidadeDespesa |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoElementoDespesa |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoSubelementoDespesa |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoCO |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoFonteRecurso |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
exercicioFonteRecurso |
– | Atual / Anterior |
codigoNaturezaContratacao |
– | Tabela Natureza Contratação |
codigoModalidadeLicitacao |
– | Tabela Modalidade Licitação |
codigoEmendaParlamentar |
– | Tabela Emenda Parlamentar |
numeroEmendaImpositiva |
– | Emenda impositiva cadastrada pela Unidade Gestora para o exercício |
numeroObra |
– | – |
numeroLicitacao |
– | – |
historico |
– | – |
cpfCnpjCredor |
– | CPF/CNPJ do credor cadastrado pela Unidade Gestora |
cpfOrdenador |
– | CPF do ordenador cadastrado pela Unidade Gestora |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Empenhos",
"description": "Schema para envio de empenhos por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"tipoEmpenho": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valorEmpenho": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoFuncao": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoSubfuncao": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoPrograma": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoAcao": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoCategoriaEconomica": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoNaturezaDespesa": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoModalidadeDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoElementoDespesa": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"codigoSubelementoDespesa": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoCO": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": ["ATUAL", "ANTERIOR"]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoNaturezaContratacao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoModalidadeLicitacao": {
"type": "string",
"minLength": 2,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoEmendaParlamentar": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroEmendaImpositiva": {
"type": "string",
"minLength": 1,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroObra": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"numeroLicitacao": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^\\d{5}/\\d{4}$"
},
"historico": {
"type": "string",
"maxLength": 4000
},
"cpfCnpjCredor": {
"type": "string",
"minLength": 11,
"maxLength": 14
},
"cpfOrdenador": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"tipoEmpenho",
"valorEmpenho",
"codigoFuncao",
"codigoSubfuncao",
"codigoPrograma",
"codigoAcao",
"codigoCategoriaEconomica",
"codigoNaturezaDespesa",
"codigoModalidadeDespesa",
"codigoElementoDespesa",
"codigoSubelementoDespesa",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"codigoNaturezaContratacao",
"historico",
"cpfCnpjFornecedor",
"cpfOrdenador",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001234",
"tipoEmpenho": "1",
"valorEmpenho": 15000.00,
"codigoFuncao": "12",
"codigoSubfuncao": "361",
"codigoPrograma": "2080",
"codigoAcao": "2050",
"codigoCategoriaEconomica": "3",
"codigoNaturezaDespesa": "3",
"codigoModalidadeDespesa": "90",
"codigoElementoDespesa": "39",
"codigoSubelementoDespesa": "014",
"codigoCO": "0001",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "100",
"codigoNaturezaContratacao": "1",
"codigoEmendaParlamentar": "2131",
"codigoModalidadeLicitacao": "06",
"numeroObra": "00012345",
"numeroLicitacao": "00001/2025",
"historico": "Empenho referente à contratação de serviços de manutenção predial conforme processo administrativo nº 001/2025.",
"cpfCnpjCredor": "12345678000195",
"cpfOrdenador": "12345678901",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001235",
"tipoEmpenho": "1",
"valorEmpenho": 8500.50,
"codigoFuncao": "12",
"codigoSubfuncao": "361",
"codigoPrograma": "2080",
"codigoAcao": "2050",
"codigoCategoriaEconomica": "3",
"codigoNaturezaDespesa": "3",
"codigoModalidadeDespesa": "90",
"codigoElementoDespesa": "39",
"codigoSubelementoDespesa": "014",
"codigoCO": "0001",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "100",
"codigoNaturezaContratacao": "1",
"codigoModalidadeLicitacao": "06",
"numeroLicitacao": "00001/2025",
"historico": "Empenho referente à aquisição de material de escritório conforme processo administrativo nº 002/2025.",
"cpfCnpjCredor": "98765432000110",
"cpfOrdenador": "12345678901",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| EMPENHO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| EMPENHO_DOTACAO_CADASTRADA | A Dotação referenciada deve ter sido criada para o exercício do envio |
| EMPENHO_ORDENADOR_CADASTRADO | O Ordenador deve ter sido cadastrado para a Unidade Gestora |
| EMPENHO_CREDOR_CADASTRADO | O Credor deve ter sido cadastrado para a Unidade Gestora |
| EMPENHO_TIPO_VALIDO |
Válido conforme a Tabela de Tipo de Empenho |
| EMPENHO_MODALIDADE_LICITACAO_VALIDA |
Válida conforme a Tabela de Modalidade de Licitação |
| EMPENHO_NATUREZA_CONTRATACAO_VALIDA |
Válida conforme a Tabela de Natureza de Contratação |
| EMPENHO_SUBELEMENTO_VALIDO |
Válido conforme a Tabela de Subelemento |
| EMPENHO_CODIGO_CO_VALIDO | O Código CO deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| EMPENHO_LICITACAO_OBRIGATORIA | Quando a Natureza de Contratação for diferente de ZERO (Outros), é obrigatório informar o número e a modalidade da licitação |
| EMPENHO_NATUREZA_CONTRATACAO_ZERO | Quando a Natureza de Contratação for 0 (Outros), não deve ser informado Número de Licitação nem Modalidade da Licitação |
| EMPENHO_NATUREZA_CONTRATACAO_ELEMENTO_DESPESA_INVALIDO | Não é admitida Natureza de Contratação igual a ZERO quando o Código Elemento Despesa for 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 51, 52 e, ainda, 92 e 93 quando o Código Natureza Despesa for 3 ou 4 |
| EMPENHO_NATUREZA_CONTRATACAO_SUBELEMENTO_INVALIDO | A Natureza de Contratação poderá ser ZERO quando o elemento de despesa for 92 ou 93 e o código natureza de despesa for 3 ou 4, desde que o subelemento de despesa seja um dos seguintes: 106 (Indenização paga a servidor), 107 (Obrigações tributárias), 108 (Obrigações patronais), 109 (Sentenças judiciais), 110 (Jetons), 111 (Devolução de recursos) |
| EMPENHO_OBRA_OBRIGATORIA | Quando a Natureza de Contratação for 4 (Realização de Obras), o número da obra é obrigatório |
| EMPENHO_NATUREZA_CONTRATACAO_QUATRO | Quando a Natureza de Contratação não for 4 (Realização de Obras), não deve ser informado número da obra |
| EMPENHO_OBRA_CADASTRADA_GEO_OBRAS | Quando informada, a obra deve ter sido cadastrada no Geo Obras |
| EMPENHO_LICITACAO_CADASTRADA_TRAMITA | Quando informada, a licitação deve ter sido cadastrada no Tramita |
| EMPENHO_VALOR_EMPENHADO_EXCEDE_DOTACAO | O valor empenhado não pode ser maior que o saldo da dotação referenciada |
| DOTACAO_EMENDA_PARLAMENTAR_VALIDA | O código da emenda parlamentar deve ser válido conforme a Tabela Emenda Parlamentar |
| DOTACAO_EMENDA_IMPOSITIVA_OBRIGATORIA | Quando o código da emenda parlamentar for informado, a emenda impositiva deve ter sido cadastrada para a unidade gestora no exercício |
Estorno Despesa Extra
Estorno Despesa Extra
Estorno Despesa Extra | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Número Receita Extra ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroDespesaExtra |
✅ | – |
numeroEstornoDespesaExtra |
✅ | – |
dataEstornoDespesaExtra |
– | – |
valorEstornoDespesaExtra |
– | – |
motivo |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Estornos de Despesas Extraorçamentárias",
"description": "Lista de objetos representando a entidade Estorno de Despesa Extraorçamentária",
"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": "Estorno de Despesa Extraorçamentária",
"description": "Representação do schema para envio da entidade Estorno de Despesa Extraorçamentária",
"type": "object",
"properties": {
"numeroDespesaExtra": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoDespesaExtra": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"dataEstornoDespesaExtra": {
"type": "string",
"format": "date"
},
"valorEstornoDespesaExtra": {
"type": "number",
"exclusiveMinimum": 0
},
"motivo": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"numeroDespesaExtra",
"numeroEstornoDespesaExtra",
"dataEstornoDespesaExtra",
"valorEstornoDespesaExtra",
"motivo",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroDespesaExtra": "1234567",
"numeroEstornoDespesaExtra": "7654321",
"dataEstornoDespesaExtra": "2025-09-11",
"valorEstornoDespesaExtra": 50000.00,
"motivo": "Estorno de despesa extraorçamentária lançada indevidamente",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_DESPESA_EXTRA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_DESPESA_EXTRA_DESPESA_EXTRA_CADASTRADA | A despesa extra referenciada deve ter sido cadastrado para a Unidade Gestora no exercício do envio |
| ESTORNO_DESPESA_EXTRA_VALOR_ESTORNADO_EXCEDE_VALOR | A soma do valor estornado não pode superar o valor da despesa extra |
Estorno Empenho
Estorno Empenho
Estorno Empenho | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Estorno ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício |
numeroEmpenho |
✅ | – |
numeroEstornoEmpenho |
✅ | – |
valorEstornoEmpenho |
– | – |
motivo |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Estornos de Empenho",
"description": "Schema para envio de estornos de empenho por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"valorEstornoEmpenho": {
"type": "number",
"exclusiveMinimum": 0
},
"motivo": {
"type": "string",
"maxLength": 500
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroEstornoEmpenho",
"valorEstornoEmpenho",
"motivo",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2026-03-02T11:32:45.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000001",
"numeroEstornoEmpenho": "0000001",
"valorEstornoEmpenho": 150000.50,
"motivo": "Estorno referente a empenho emitido com valor incorreto",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000002",
"numeroEstornoEmpenho": "0000002",
"valorEstornoEmpenho": 82500.00,
"motivo": "Estorno de empenho com despesa previamente liquidada",
"action": "UPDATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_EMPENHO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_EMPENHO_EMPENHO_CADASTRADO | O Empenho deve ter sido cadastrado para a Unidade Gestora no exercício do envio |
| ESTORNO_EMPENHO_VALOR_ESTORNADO_EXCEDE_EMPENHADO | A soma do valor estornado não pode superar o valor empenhado |
Estorno Liquidação
Estorno Liquidação
Estorno Liquidação | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Liquidação ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
numeroEstornoLiquidacao |
✅ | – |
motivoEstornoLiquidacao |
– | – |
valorEstornoLiquidacao |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Estornos de Liquidação",
"description": "Schema para envio de estornos de liquidação por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"motivoEstornoLiquidacao": {
"type": "string",
"maxLength": 500
},
"valorEstornoLiquidacao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroEstornoLiquidacao",
"motivoEstornoLiquidacao",
"valorEstornoLiquidacao",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2026-03-02T11:32:45.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000001",
"numeroLiquidacao": "0000001",
"numeroEstornoLiquidacao": "0000001",
"motivoEstornoLiquidacao": "Estorno referente a liquidação emitida com valor incorreto",
"valorEstornoLiquidacao": 150000.50,
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000002",
"numeroLiquidacao": "0000002",
"numeroEstornoLiquidacao": "0000002",
"motivoEstornoLiquidacao": "Estorno de liquidação com divergência no valor informado",
"valorEstornoLiquidacao": 82500.00,
"action": "UPDATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_LIQUIDACAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_LIQUIDACAO_LIQUIDACAO_CADASTRADA | A Liquidação deve ter sido cadastrada para a Unidade Gestora no exercício do envio |
| ESTORNO_LIQUIDACAO_VALOR_ESTORNADO_EXCEDE_LIQUIDADO | A soma do valor estornado não pode superar o valor liquidado |
Estorno Liquidação Resto
Estorno Liquidação Resto
Estorno Liquidação Resto | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Ano Emissão Empenho - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Número Estorno Liquidação Resto ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
anoEmissaoEmpenho |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
numeroEstornoLiquidacaoResto |
✅ | – |
motivo |
– | – |
valorEstornoLiquidacaoResto |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Estornos de Liquidação de Restos a Pagar",
"description": "Lista de objetos representando a entidade Estorno Liquidação Resto",
"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": "Estorno Liquidação Resto",
"description": "Representação do schema para envio da entidade Estorno Liquidação Resto",
"type": "object",
"properties": {
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoLiquidacaoResto": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"motivo": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"valorEstornoLiquidacaoResto": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroEstornoLiquidacaoResto",
"motivo",
"valorEstornoLiquidacaoResto",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"anoEmissaoEmpenho": "2025",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "7654321",
"numeroLiquidacao": "1234567",
"numeroEstornoLiquidacaoResto": "9876543",
"dataEstornoLiquidacaoResto": "2025-09-11",
"motivo": "Estorno de liquidação de restos a pagar lançado indevidamente",
"valorEstornoLiquidacaoResto": 5000.00,
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_LIQUIDACAO_RESTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_LIQUIDACAO_RESTO_LIQUIDACAO_CADASTRADA | A Liquidação deve ter sido cadastrada para a Unidade Gestora |
| ESTORNO_LIQUIDACAO_RESTO_VALOR_ESTORNADO_EXCEDE_LIQUIDADO | A soma do valor estornado não pode superar o valor liquidado |
Estorno Pagamento
Estorno Pagamento
Estorno Pagamento | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Número Empenho - Número Pagamento - Número Estorno Liquidação - Número Estorno Pagamento ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
numeroPagamento |
✅ | – |
numeroEstornoPagamento |
✅ | – |
motivoEstornoPagamento |
– | – |
valorEstornoPagamento |
– | – |
action |
– | CREATE / UPDATE / DELETE |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Estornos de Pagamento",
"description": "Schema para envio de estornos de pagamento por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"motivoEstornoPagamento": {
"type": "string",
"maxLength": 500
},
"valorEstornoPagamento": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroPagamento",
"numeroEstornoPagamento",
"motivoEstornoPagamento",
"valorEstornoPagamento",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"estornosPagamento": [
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001234",
"numeroLiquidacao": "0000001",
"numeroPagamento": "0000001",
"numeroEstornoPagamento": "0000001",
"motivoEstornoPagamento": "Pagamento realizado em duplicidade referente ao processo administrativo nº 001/2025.",
"valorEstornoPagamento": 15000.00,
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001235",
"numeroLiquidacao": "0000021",
"numeroPagamento": "0000002",
"numeroEstornoPagamento": "0000002",
"motivoEstornoPagamento": "Erro na identificação do credor. Pagamento efetuado para fornecedor incorreto conforme processo nº 002/2025.",
"valorEstornoPagamento": 8500.50,
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_PAGAMENTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_PAGAMENTO_PAGAMENTO_CADASTRADO | O pagamento deve ter sido cadastrado para a Unidade Gestora no exercício do envio |
| ESTORNO_PAGAMENTO_VALOR_ESTORNADO_EXCEDE_VALOR_PAGO | A soma do valor estornado não pode superar o valor pago |
Estorno Pagamento Resto
Estorno Pagamento Resto
Estorno Pagamento Resto | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Ano Emissão Empenho - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Número Pagamento - Número Estorno Pagamento Resto ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
anoEmissaoEmpenho |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | |
numeroPagamento |
✅ | – |
numeroEstornoPagamentoResto |
✅ | – |
codigoUnidadeGestoraOrigem |
– | – |
motivo |
– | – |
despesaLiquidada |
– | SIM / NAO |
valorEstornoPagamentoResto |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Estornos de Pagamento de Restos a Pagar",
"description": "Lista de objetos representando a entidade Estorno Pagamento Resto",
"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": "Estorno Pagamento Resto",
"description": "Representa\u00e7\u00e3o do schema para envio da entidade Estorno Pagamento Resto",
"type": "object",
"properties": {
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoPagamentoResto": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"dataEstornoPagamentoResto": {
"type": "string",
"format": "date"
},
"motivo": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"despesaLiquidada": {
"type": "string",
"enum": ["SIM", "NAO"]
},
"valorEstornoPagamentoResto": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoUnidadeGestoraOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroPagamento",
"numeroEstornoPagamentoResto",
"dataEstornoPagamentoResto",
"motivo",
"despesaLiquidada",
"valorEstornoPagamentoResto",
"codigoUnidadeGestoraOrigem",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"anoEmissaoEmpenho": "2025",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "7654321",
"numeroPagamento": "1234567",
"numeroEstornoPagamentoResto": "9876543",
"dataEstornoPagamentoResto": "2025-09-11",
"motivo": "Estorno de pagamento de restos a pagar lan\u00e7ado indevidamente",
"despesaLiquidada": "NAO",
"valorEstornoPagamentoResto": 5000.00,
"codigoUnidadeGestoraOrigem": "654321",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_PAGAMENTO_RESTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_PAGAMENTO_RESTO_PAGAMENTO_CADASTRADO | O pagamento deve ter sido cadastrado para a Unidade Gestora |
| ESTORNO_PAGAMENTO_RESTO_VALOR_ESTORNADO_EXCEDE_LIQUIDADO | A soma do valor estornado não pode exceder o pago |
| ESTORNO_PAGAMENTO_RESTO_ESCOPO_CADASTRO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
Estorno Receita Extra
Estorno Receita Extra
Estorno Receita Extra | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Número Estorno - Número Receita Extra ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroReceitaExtra |
✅ | – |
numeroEstornoReceitaExtra |
✅ | – |
valorEstornoReceitaExtra |
– | – |
motivo |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Estornos de Receitas Extraorçamentárias",
"description": "Lista de objetos representando a entidade Estorno de Receita Extraorçamentária",
"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": "Estorno de Receita Extraorçamentária",
"description": "Representação do schema para envio da entidade Estorno de Receita Extraorçamentária",
"type": "object",
"properties": {
"numeroReceitaExtra": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoReceitaExtra": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"valorEstornoReceitaExtra": {
"type": "number",
"exclusiveMinimum": 0
},
"motivo": {
"type": "string",
"minLength": 10,
"maxLength": 255
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"numeroReceitaExtra",
"numeroEstornoReceitaExtra",
"dataEstornoReceitaExtra",
"valorEstornoReceitaExtra",
"motivo",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroReceitaExtra": "1234567",
"numeroEstornoReceitaExtra": "7654321",
"valorEstornoReceitaExtra": 50000.00,
"motivo": "Estorno de receita extraorçamentária lançada indevidamente",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_RECEITA_EXTRA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_RECEITA_EXTRA_RECEITA_EXTRA_CADASTRADA | A receita extra referenciada deve ter sido cadastrado para a Unidade Gestora no exercício do envio |
| ESTORNO_RECEITA_EXTRA_VALOR_ESTORNADO_EXCEDE_VALOR | A soma do valor estornado não pode superar o valor da receita extra |
Estorno Resto
Estorno Resto
Estorno Resto | 2025 ~
Tipo Envio: Diário
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
anoEmissaoEmpenho |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroEstornoResto |
✅ | – |
codigoUnidadeGestoraOrigem |
– | – |
valorEstornoResto |
– | – |
motivo |
– | – |
despesaLiquidada |
– | SIM / NAO |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Estornos de Restos a Pagar",
"description": "Lista de objetos representando a entidade Estorno Restos",
"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": "Estorno Restos",
"description": "Representação do schema para envio da entidade Estorno Restos",
"type": "object",
"properties": {
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoResto": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"valorEstornoResto": {
"type": "number",
"exclusiveMinimum": 0
},
"motivo": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"despesaLiquidada": {
"type": "string",
"enum": ["SIM", "NAO"]
},
"codigoUnidadeGestoraOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroEstornoResto",
"dataEstornoResto",
"valorEstornoResto",
"motivo",
"despesaLiquidada",
"codigoUnidadeGestoraOrigem",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"anoEmissaoEmpenho": "2025",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "7654321",
"numeroEstornoResto": "9876543",
"dataEstornoResto": "2025-09-11",
"valorEstornoResto": 5000.00,
"motivo": "Estorno de restos a pagar lançado indevidamente",
"despesaLiquidada": "NAO",
"codigoUnidadeGestoraOrigem": "654321",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_RESTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_RESTO_RESTO_CADASTRADO | A Resto Inscrito deve ter sido cadastrado para a Unidade Gestora |
| ESTORNO_RESTO_VALOR_ESTORNADO_EXCEDE_INSCRITO | A soma do valor estornado não pode superar o valor inscrito |
Estorno Retenção
Estorno Retenção
Estorno Retenção | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Número Pagamento - Tipo Retenção - Número Retenção - Número Estorno Retenção ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
numeroPagamento |
✅ | – |
tipoRetencao |
✅ | Tabela Tipo Retenção |
numeroRetencao |
✅ | – |
numeroEstornoRetencao |
✅ | – |
valorEstornoRetencao |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Estornos de Retenção",
"description": "Schema para envio de estornos de retenção por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"tipoRetencao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"numeroEstornoRetencao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"valorEstornoRetencao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroPagamento",
"tipoRetencao",
"numeroEstornoRetencao",
"valorEstornoRetencao",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2026-03-02T11:32:45.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000001",
"numeroLiquidacao": "0000002",
"numeroPagamento": "0000001",
"numeroRetencao": "0000002",
"tipoRetencao": "1",
"numeroEstornoRetencao": "0000001",
"valorEstornoRetencao": 15000.50,
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000002",
"numeroLiquidacao": "0000012",
"numeroPagamento": "0000002",
"numeroRetencao": "0000002",
"tipoRetencao": "2",
"numeroEstornoRetencao": "0000002",
"valorEstornoRetencao": 8250.00,
"action": "UPDATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_RETENCAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_RETENCAO_RETENCAO_CADASTRADA | A retenção deve ter sido cadastrada para a Unidade Gestora no exercício do envio |
| ESTORNO_RETENCAO_VALOR_ESTORNADO_EXCEDE_VALOR_RETIDO | A soma do valor estornado não pode superar o valor retido |
Estorno Retenção Resto
Estorno Retenção Resto
Estorno Retenção Resto | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Ano Emissão Empenho - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Número Pagamento - Tipo Retenção - Número Estorno Retenção Resto ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
anoEmissaoEmpenho |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | |
numeroPagamento |
✅ | – |
tipoRetencao |
✅ | Tabela Tipo Retenção |
numeroEstornoRetencaoResto |
✅ | – |
codigoUnidadeGestoraOrigem |
– | – |
motivo |
– | – |
valorEstornoRetencaoResto |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Estornos de Retenção de Restos a Pagar",
"description": "Lista de objetos representando a entidade Estorno Retenção Resto",
"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": "Estorno Retenção Resto",
"description": "Representação do schema para envio da entidade Estorno Retenção Resto",
"type": "object",
"properties": {
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"tipoRetencao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"numeroEstornoRetencaoResto": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"dataEstornoRetencaoResto": {
"type": "string",
"format": "date"
},
"motivo": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"valorEstornoRetencaoResto": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoUnidadeGestoraOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroPagamento",
"tipoRetencao",
"numeroEstornoRetencaoResto",
"dataEstornoRetencaoResto",
"motivo",
"valorEstornoRetencaoResto",
"codigoUnidadeGestoraOrigem",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"anoEmissaoEmpenho": "2025",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "7654321",
"numeroPagamento": "1234567",
"tipoRetencao": "1",
"numeroEstornoRetencaoResto": "9876543",
"dataEstornoRetencaoResto": "2025-09-11",
"motivo": "Estorno de retenção de restos a pagar lançado indevidamente",
"valorEstornoRetencaoResto": 1500.00,
"codigoUnidadeGestoraOrigem": "654321",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| ESTORNO_RETENCAO_RESTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ESTORNO_RETENCAO_RESTO_LIQUIDACAO_CADASTRADA | A Liquidação deve ter sido cadastrada para a Unidade Gestora |
| ESTORNO_RETENCAO_RESTO_VALOR_ESTORNADO_EXCEDE_RETIDO | A soma do valor estornado não pode superar o valor retido |
| ESTORNO_RETENCAO_RESTO_ESCOPO_CADASTRO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
Liquidação
Liquidação
Liquidação | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Liquidação ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício |
numeroEmpenho |
✅ | Número do empenho referente à liquidação |
numeroLiquidacao |
✅ | – |
tipoNotaFiscal |
– | Tabela Tipo Nota Fiscal |
numeroChaveNotaFiscal |
– | – |
numeroNotaFiscal |
– | – |
serieNotaFiscal |
– | – |
dataNotaFiscal |
– | – |
valorNotaFiscal |
– | – |
valorLiquidacao |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Liquidações",
"description": "Schema para envio de liquidações por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"tipoNotaFiscal": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"numeroChaveNotaFiscal": {
"type": "string",
"minLength": 44,
"maxLength": 44,
"pattern": "^[0-9]+$"
},
"numeroNotaFiscal": {
"type": "string",
"maxLength": 15
},
"serieNotaFiscal": {
"type": "string",
"maxLength": 12
},
"dataNotaFiscal": {
"type": "string",
"format": "date"
},
"valorNotaFiscal": {
"type": "number",
"exclusiveMinimum": 0
},
"valorLiquidacao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"valorLiquidacao"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001234",
"numeroLiquidacao": "0000001",
"tipoNotaFiscal": "01",
"numeroChaveNotaFiscal": "35250912345678000195550010000012341234567890",
"numeroNotaFiscal": "000012341",
"serieNotaFiscal": "001",
"dataNotaFiscal": "2025-09-10",
"valorNotaFiscal": 15000.00,
"valorLiquidacao": 15000.00,
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001235",
"numeroLiquidacao": "0000002",
"valorLiquidacao": 8500.50,
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| LIQUIDACAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| LIQUIDACAO_EMPENHO_CADASTRADO | O Empenho referenciado deve ter sido cadastrado para a Unidade Gestora no exercício do envio |
Tabela de Regras Nota Fiscal |
|
| LIQUIDACAO_NOTA_FISCAL_EMPENHO_CREDOR | O CPF/CNPJ da NFE precisa igual ao informado no empenho |
| LIQUIDACAO_TIPO_NOTA_ELEMENTO_SUBELEMENTO_INVALIDO | Para os elementos de despesa 30 e 52, o tipo de nota deverá ser 01 ou 02. Exceto para o elemento de despesa 30 com subelementos 098 e 013, onde o tipo de nota poderá ser 01, 02, 03, 06, 07 ou 08 |
| LIQUIDACAO_TIPO_NOTA_01_PESSOA_FISICA | Para o tipo de nota 01 (A Nota Fiscal Avulsa Eletrônica – Estadual), o Fornecedor deverá ser Pessoa Física |
| LIQUIDACAO_NOTA_FISCAL_OBRIGATORIA | A nota fiscal é obrigatória para determinadas combinações de elementos e subelementos de despesa. Conforme a Tabela de Elemento e Subelemento Nota Fiscal Obrigatória |
| LIQUIDACAO_TIPO_NOTA_FISCAL_VALIDO |
O Tipo de Nota Fiscal deve ser válido conforme a |
| LIQUIDACAO_VALOR_LIQUIDADO_EXCEDE_VALOR_EMPENHADO | A soma do valor liquidado não pode superar o valor empenhado |
Elemento e Subelemento Nota Fiscal Obrigatória
| Elemento | Subelementos |
| 30 | 001, 002, 003, 004, 005, 006, 007, 008, 009, 010, 011, 012, 013, 014, 015, 016, 018, 019 e 098 |
| 32 | 099 |
| 35 | 099 |
| 36 | 023, 027, 028, 029, 030, 031, 033, 036, 038, 090, 099, 112, 114, 115, 116, 117 |
| 39 | 027, 028, 029, 030, 031, 032, 033, 034, 035, 036, 040, 042, 043, 044, 045, 046, 047, 048, 051, 052, 053, 054, 055, 056, 058, 059, 061, 099, 112, 114, 115, 116, 117, |
| 51 | 099, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131 |
| 52 | 062, 063, 064, 065, 066, 067, 068, 069, 070, 071, 072, 073, 074, 075, 076, 077, 078, 079 e 080 |
Liquidação Resto
Liquidação Resto
Liquidação Resto | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Ano Emissão Empenho - Código Unidade Orçamentária - Número Empenho - Número Liquidação Resto ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
anoEmissaoEmpenho |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacaoResto |
✅ | – |
codigoUnidadeGestoraOrigem |
– | – |
tipoNotaFiscal |
– | Tabela Tipo Nota Fiscal |
numeroChaveNotaFiscal |
– | – |
numeroNotaFiscal |
– | – |
serieNotaFiscal |
– | – |
dataNotaFiscal |
– | – |
valorNotaFiscal |
– | – |
valorLiquidacaoResto |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Liquidações de Restos a Pagar",
"description": "Lista de objetos representando a entidade Liquidação Resto",
"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": "Liquidação Resto",
"description": "Representação do schema para envio da entidade Liquidação Resto",
"type": "object",
"properties": {
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacaoResto": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"tipoNotaFiscal": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"numeroChaveNotaFiscal": {
"type": "string",
"minLength": 44,
"maxLength": 44,
"pattern": "^[0-9]+$"
},
"numeroNotaFiscal": {
"type": "string",
"minLength": 1,
"maxLength": 15
},
"serieNotaFiscal": {
"type": "string",
"minLength": 1,
"maxLength": 12
},
"dataNotaFiscal": {
"type": "string",
"format": "date"
},
"valorNotaFiscal": {
"type": "number",
"exclusiveMinimum": 0
},
"valorLiquidacaoResto": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoUnidadeGestoraOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacaoResto",
"dataLiquidacaoResto",
"tipoNotaFiscal",
"numeroChaveNotaFiscal",
"numeroNotaFiscal",
"serieNotaFiscal",
"dataNotaFiscal",
"valorNotaFiscal",
"valorLiquidacaoResto",
"codigoUnidadeGestoraOrigem",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"anoEmissaoEmpenho": "2025",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "7654321",
"numeroLiquidacaoResto": "1234567",
"dataLiquidacaoResto": "2025-09-11",
"tipoNotaFiscal": "01",
"numeroChaveNotaFiscal": "12345678901234567890123456789012345678901234",
"numeroNotaFiscal": "123456",
"serieNotaFiscal": "001",
"dataNotaFiscal": "2025-09-10",
"valorNotaFiscal": 10000.00,
"valorLiquidacaoResto": 10000.00,
"codigoUnidadeGestoraOrigem": "654321",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| LIQUIDACAO_RESTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| LIQUIDACAO_RESTO_LIQUIDACAO_CADASTRADA | A liquidação deve ter sido cadastrado para a Unidade Gestora |
| LIQUIDACAO_RESTO_VALOR_LIQUIDADO_EXCEDE_INSCRITO | A soma do valor liquidado não pode exceder o inscrito não processado |
| LIQUIDACAO_RESTO_ESCOPO_CADASTRO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
Movimentação Entre Contas Bancárias
Movimentação Entre Contas Bancárias
Movimentação Entre Contas Bancárias | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Banco Conta Bancária Origem - Número Agência Conta Bancária Origem - Número Conta Bancária Origem - Tipo Conta Bancária Origem - Código Banco Conta Bancária Destino - Número Agência Conta Bancária Destino - Número Conta Bancária Destino - Tipo Conta Bancária Destino - Código Movimentação ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoBancoContaBancariaOrigem |
✅ | Código da FEBRABAN |
numeroAgenciaContaBancariaOrigem |
✅ | – |
numeroContaBancariaOrigem |
✅ | – |
tipoContaBancariaOrigem |
✅ | – |
codigoBancoContaBancariaDestino |
✅ | – |
numeroAgenciaContaBancariaDestino |
✅ | – |
numeroContaBancariaDestino |
✅ | – |
tipoContaBancariaDestino |
✅ | – |
valorTransferencia |
– | – |
codigoMovimentacao |
✅ | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Movimentação Entre Contas Bancárias",
"description": "Lista de objetos representando a entidade Movimentação Entre Contas Bancárias",
"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": "Transferência Bancária",
"description": "Representação do schema para envio da entidade Movimentação Entre Contas Bancárias",
"type": "object",
"properties": {
"codigoBancoContaBancariaOrigem": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancariaOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"numeroContaBancariaOrigem": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"pattern": "^[0-9]+$"
},
"tipoContaBancariaOrigem": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoBancoContaBancariaDestino": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancariaDestino": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"numeroContaBancariaDestino": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"pattern": "^[0-9]+$"
},
"tipoContaBancariaDestino": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valorTransferencia": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoMovimentacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[A-Z0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoBancoContaBancariaOrigem",
"numeroAgenciaContaBancariaOrigem",
"numeroContaBancariaOrigem",
"tipoContaBancariaOrigem",
"codigoBancoContaBancariaDestino",
"numeroAgenciaContaBancariaDestino",
"numeroContaBancariaDestino",
"tipoContaBancariaDestino",
"valorTransferencia",
"codigoMovimentacao",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoBancoContaBancariaOrigem": "001",
"numeroAgenciaContaBancariaOrigem": "123456",
"numeroContaBancariaOrigem": "0001234567890",
"tipoContaBancariaOrigem": "1",
"codigoBancoContaBancariaDestino": "341",
"numeroAgenciaContaBancariaDestino": "654321",
"numeroContaBancariaDestino": "0009876543210",
"tipoContaBancariaDestino": "2",
"valorTransferencia": 15000.00,
"codigoMovimentacao": "1234567",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| MOV_ENTRE_CONTAS_BANCARIAS_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| MOV_ENTRE_CONTAS_BANCARIAS_CONTA_BANCARIA_CADASTRADA | A conta bancária deve ter sido cadastrada para a unidade gestora |
| MOV_ENTRE_CONTAS_BANCARIAS_CONTA_BANCARIA_DESTINO_CADASTRADA | A conta bancária destino deve ter sido cadastrada para a unidade gestora |
Norma Orçamentária
Norma Orçamentária
Norma Orçamentária | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Codigo Unidade Gestora - Código Unidade Gestora - Número Lei - Data Publicação ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
exercicioLei |
✅ | – |
numeroLei |
✅ | – |
dataPublicacao |
✅ | – |
tipoLei |
– | Tabela Tipo Lei |
protocoloTCE |
– | – |
autorizacaoPercentual |
– |
|
valor |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Norma Orçamentária",
"description": "Lista de objetos representando a entidade Norma Orçamentária",
"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": "Norma Orçamentária",
"description": "Representação do schema para envio da entidade Norma Orçamentária",
"type": "object",
"properties": {
"exercicioLei": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroLei": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]+$"
},
"dataPublicacao": {
"type": "string",
"format": "date"
},
"tipoLei": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"protocoloTCE": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]{6}/[0-9]{2}$"
},
"tipoAutorizacao": {
"type": "string",
"enum": ["SIM", "NAO"]
},
"valor": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"exercicioLei",
"numeroLei",
"dataPublicacao",
"tipoLei",
"protocoloTCE",
"tipoAutorizacao",
"valor",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"exercicioLei": "2025",
"numeroLei": "123456789",
"dataPublicacao": "2025-09-11",
"tipoLei": "0",
"protocoloTCE": "000000/00",
"tipoAutorizacao": "SIM",
"valor": 5000000.00,
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| NORMA_ORCAMENTARIA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| NORMA_ORCAMENTARIA_TIPO_LEI_VALIDO |
O tipo deve ser válido para o exercício do envio, conforme a |
| NORMA_ORCAMENTARIA_PROTOCOLO_VALIDO | O Protocolo deve estar cadastrado no banco do TCE |
Ordenador
Ordenador
Ordenador | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - CPF Ordenador - Nome Ordenador ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
|---|---|---|
cpfOrdenador |
✅ | – |
nomeOrdenador |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Ordenador",
"description": "Schema para envio de ordenadores por unidade gestora",
"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": {
"type": "object",
"properties": {
"cpfOrdenador": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"nomeOrdenador": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"cpfOrdenador",
"nomeOrdenador",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"cpfOrdenador": "12345678901",
"nomeOrdenador": "Carlos Alberto Souza",
"action": "CREATE"
},
{
"cpfOrdenador": "98765432100",
"nomeOrdenador": "Maria José Ferreira",
"action": "UPDATE"
},
{
"cpfOrdenador": "11122233344",
"nomeOrdenador": "José Antônio Lima",
"action": "DELETE"
}
]
}Regras
| ID | Regra |
| ORDENADOR_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| ORDENADOR_NOME_INVALIDO | O nome do ordenador deve ser correspondente ao cadastrado na Receita Federal |
Pagamento
Pagamento
Pagamento | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Número Pagamento ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
numeroPagamento |
✅ | – |
valorPagamento |
– | – |
codigoBancoContaBancaria |
– | – |
numeroContaBancaria |
– | – |
tipoContaBancaria |
– | – |
numeroAgenciaContaBancaria |
– | – |
cnpjGerenciaContaBancaria |
– | – |
numeroDocumentoDebito |
– | – |
codigoBancoContaBancariaCredor |
– | – |
numeroAgenciaContaBancariaCredor |
– | – |
numeroContaBancariaCredor |
– | – |
action |
– | CREATE / UPDATE / DELETE |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Pagamentos",
"description": "Schema para envio de pagamentos por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"valorPagamento": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoBancoContaBancaria": {
"type": "string",
"maxLength": 3
},
"numeroContaBancaria": {
"type": "string",
"maxLength": 13
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"maxLength": 6
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14
},
"numeroDocumentoDebito": {
"type": "string",
"maxLength": 11
},
"codigoBancoContaBancariaCredor": {
"type": "string",
"maxLength": 3
},
"numeroAgenciaContaBancariaCredor": {
"type": "string",
"maxLength": 6
},
"numeroContaBancariaCredor": {
"type": "string",
"maxLength": 13
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroPagamento",
"valorPagamento",
"codigoBancoContaBancaria",
"numeroContaBancaria",
"tipoContaBancaria",
"numeroAgenciaContaBancaria",
"cnpjGerenciaContaBancaria",
"numeroDocumentoDebito",
"codigoBancoContaBancariaCredor",
"numeroAgenciaContaBancariaCredor",
"numeroContaBancariaCredor",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"pagamentos": [
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001234",
"numeroLiquidacao": "0000001",
"numeroPagamento": "0000001",
"valorPagamento": 15000.00,
"codigoBancoContaBancaria": "001",
"numeroContaBancaria": "12345678901",
"tipoContaBancaria": "1",
"numeroAgenciaContaBancaria": "1234",
"cnpjGerenciaContaBancaria": "12345678000195",
"numeroDocumentoDebito": "12345678901",
"codigoBancoContaBancariaCredor": "341",
"numeroAgenciaContaBancariaCredor": "5678",
"numeroContaBancariaCredor": "98765432100",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| PAGAMENTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| PAGAMENTO_CONTA_BANCARIA_CADASTRADA | A conta bancária deve ter sido cadastrada para a Unidade Gestora no exercício do envio |
| PAGAMENTO_CONTA_CREDOR_CADASTRADA | A conta do credor deve ter sido cadastrada para a Unidade Gestora |
| PAGAMENTO_LIQUIDACAO_CADASTRADA | A Liquidação referenciada deve ter sido cadastrada para a Unidade Gestora no exercício do envio |
| PAGAMENTO_VALOR_PAGO_EXCEDE_VALOR_LIQUIDADO | A soma do valor pago não pode superar o valor liquidado O valor líquido pago (pago - estornado pago) não pode exceder o valor líquido liquidado (liquidado - estornado liquidado) até a data do envio. |
Pagamento Resto
Pagamento Resto
Pagamento Resto | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Ano Emissão Empenho - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Número Pagamento Resto ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
anoEmissaoEmpenho |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
numeroPagamentoResto |
✅ | – |
codigoUnidadeGestoraOrigem |
– | – |
valorPagamentoResto |
– | – |
codigoBancoContaBancariaDebito |
– | – |
numeroContaBancariaDebito |
– | – |
numeroAgenciaContaBancariaDebito |
– | – |
tipoContaBancariaDebito |
– | – |
cnpjGerenciaContaBancariaDebito |
– | – |
numeroCheque |
– | – |
numeroDocDebito |
– | – |
codigoBancoContaBancariaCredor |
– | – |
numeroAgenciaContaBancariaCredor |
– | – |
numeroContaBancariaCredor |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Pagamentos de Restos a Pagar",
"description": "Lista de objetos representando a entidade Pagamento Resto",
"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": "Pagamento Resto",
"description": "Representa\u00e7\u00e3o do schema para envio da entidade Pagamento Resto",
"type": "object",
"properties": {
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamentoResto": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"dataPagamentoResto": {
"type": "string",
"format": "date"
},
"valorPagamentoResto": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoBancoContaBancariaDebito": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroContaBancariaDebito": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancariaDebito": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"tipoContaBancariaDebito": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancariaDebito": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[0-9]+$"
},
"numeroCheque": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"numeroDocDebito": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"codigoBancoContaBancariaCredito": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancariaCredito": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"numeroContaBancariaCredito": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": ["ATUAL", "ANTERIOR"]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"codigoCO": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeGestoraOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroPagamentoResto",
"dataPagamentoResto",
"valorPagamentoResto",
"codigoBancoContaBancariaDebito",
"numeroContaBancariaDebito",
"numeroAgenciaContaBancariaDebito",
"tipoContaBancariaDebito",
"cnpjGerenciaContaBancariaDebito",
"numeroCheque",
"numeroDocDebito",
"codigoBancoContaBancariaCredito",
"numeroAgenciaContaBancariaCredito",
"numeroContaBancariaCredito",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"codigoCO",
"codigoUnidadeGestoraOrigem",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"anoEmissaoEmpenho": "2025",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "7654321",
"numeroPagamentoResto": "1234567",
"dataPagamentoResto": "2025-09-11",
"valorPagamentoResto": 5000.00,
"codigoBancoContaBancariaDebito": "001",
"numeroContaBancariaDebito": "0001234567890",
"numeroAgenciaContaBancariaDebito": "123456",
"tipoContaBancariaDebito": "1",
"cnpjGerenciaContaBancariaDebito": "00000000000000",
"numeroCheque": "123456",
"numeroDocDebito": "12345678901",
"codigoBancoContaBancariaCredito": "341",
"numeroAgenciaContaBancariaCredito": "654321",
"numeroContaBancariaCredito": "0009876543210",
"exercicioFonteRecurso": "1",
"codigoFonteRecurso": "123",
"codigoCO": "1234",
"codigoUnidadeGestoraOrigem": "654321",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| PAGAMENTO_RESTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| PAGAMENTO_RESTO_LIQUIDACAO_CADASTRADA | A liquidação deve ter sido cadastrado para a Unidade Gestora |
| PAGAMENTO_RESTO_VALOR_PAGO_EXCEDE_LIQUIDADO | A soma do valor pago não pode exceder o liquidado |
| PAGAMENTO_RESTO_ESCOPO_CADASTRO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
Programa
Programa
Programa | 2025 ~
Tipo Envio: Orçamento/Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Programa ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestora |
✅ | – |
codigoPrograma |
✅ | – |
descricaoPrograma |
– | – |
descricaoObjetivoMilenio |
– | – |
tipoObjetivoMilenio |
– | Tabela Tipo Objetivo Milênio |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Programas",
"description": "Lista de objetos representando a entidade Programa",
"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": "Programa",
"description": "Representação do schema para envio da entidade Programa",
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoPrograma": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"descricaoPrograma": {
"type": "string",
"minLength": 10,
"maxLength": 70
},
"descricaoObjetivoMilenio": {
"type": "string",
"minLength": 10,
"maxLength": 150
},
"tipoObjetivoMilenio": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"codigoPrograma",
"descricaoPrograma",
"descricaoObjetivoMilenio",
"tipoObjetivoMilenio",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"programas": [
{
"codigoUnidadeGestora": "123456",
"codigoPrograma": "0001",
"descricaoPrograma": "Programa de Desenvolvimento Urbano Sustentável",
"descricaoObjetivoMilenio": "Promover melhorias na infraestrutura e na qualidade de vida urbana.",
"tipoObjetivoMilenio": "01",
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"codigoPrograma": "0002",
"descricaoPrograma": "Programa de Educação Inclusiva e Inovadora",
"descricaoObjetivoMilenio": "Garantir acesso à educação de qualidade e promover a inclusão social.",
"tipoObjetivoMilenio": "02",
"action": "UPDATE"
}
]
}
Regras
| ID | Regra |
| PROGRAMA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora deve estar homologada pelo TCE antes do cadastro |
| PROGRAMA_TIPO_OBJETIVO_MILENIO_VALIDO |
O Tipo Objetivo Milênio deve ser válido conforme a |
| RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar programas, pois são os responsáveis pelo protocolo do orçamento |
| PROGRAMA_ESCOPO_CADASTRO | A Prefeitura cadastra programas de todas as UGs vinculadas a ela, enquanto o Consórcio cadastra apenas seus próprios programas |
Receita Extra
Receita Extra
Receita Extra | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Número Receita Extra ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroReceitaExtra |
✅ | – |
codigoContaContabil |
– | Constituído pela IPC 00 – STN e Ajustes do TCE-PB |
cpfCnpjCredor |
– | CPF/CNPJ do Credor cadastrado pela Unidade Gestora para o exercício |
exercicioFonteRecurso |
– | ATUAL / ANTERIOR |
codigoFonteRecurso |
– | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
codigoBancoContaBancaria |
– | Código da FEBRABAN |
numeroContaBancaria |
– | – |
numeroAgenciaContaBancaria |
– | – |
tipoContaBancaria |
– | Tabela Tipo Conta Bancária |
cnpjGerenciaContaBancaria |
– | – |
valorReceitaExtra |
– | – |
historico |
– | – |
codigoReceitaExtra |
– | Tabela Código Receita Extra |
codigoUnidadeGestoraRetencao |
– | – |
codigoUnidadeOrcamentariaRetencao |
– | Código da Unidade Orçamentária cadastrado pela Unidade Gestora para o exercício |
numeroEmpenho |
– | – |
numeroPagamento |
– | – |
numeroRetencao |
– | – |
tipoRetencao |
– | Tabela Tipo Retenção |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Receitas Extraorçamentárias",
"description": "Lista de objetos representando a entidade Receita Extraorçamentária",
"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": "Receita Extraorçamentária",
"description": "Representação do schema para envio da entidade Receita Extraorçamentária",
"type": "object",
"properties": {
"numeroReceitaExtra": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"codigoContaContabil": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]+$"
},
"cpfCnpjCredor": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": ["ATUAL", "ANTERIOR"]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valorReceitaExtra": {
"type": "number",
"exclusiveMinimum": 0
},
"historico": {
"type": "string",
"minLength": 10,
"maxLength": 500
},
"codigoReceitaExtra": {
"type": "string",
"minLength": 8,
"maxLength": 8,
"pattern": "^[0-9]+$"
},
"codigoUnidadeGestoraRetencao": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentariaRetencao": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"tipoRetencao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"numeroReceitaExtra",
"codigoContaContabil",
"cpfCnpjCredor",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"numeroContaBancaria",
"numeroAgenciaContaBancaria",
"codigoBancoContaBancaria",
"cnpjGerenciaContaBancariaContaBancaria",
"tipoContaBancaria",
"valorReceitaExtra",
"historico",
"codigoReceitaExtra",
"codigoUnidadeGestoraRetencao",
"codigoUnidadeOrcamentariaRetencao",
"numeroEmpenho",
"numeroPagamento",
"tipoRetencao",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroReceitaExtra": "1234567",
"codigoContaContabil": "123456789",
"dataReceitaExtra": "2025-09-11",
"cpfCnpjCredor": "12345678000190",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "100",
"numeroContaBancaria": "1234567890123",
"numeroAgenciaContaBancaria": "123456",
"codigoBancoContaBancaria": "001",
"tipoContaBancaria": "1",
"valorReceitaExtra": 50000.00,
"historico": "Receita de imposto sobre serviços",
"codigoReceitaExtra": "12345678",
"codigoUnidadeGestoraRetencao": "123456",
"codigoUnidadeOrcamentariaRetencao": "12345",
"numeroEmpenho": "1234567",
"numeroPagamento": "0001001",
"tipoRetencao": "1",
"cnpjGerenciaContaBancaria": "12345678000190",
"action": "CREATE"
},
{
"numeroReceitaExtra": "7654321",
"codigoContaContabil": "987654321",
"dataReceitaExtra": "2025-08-20",
"cpfCnpjCredor": "98765432000188",
"exercicioFonteRecurso": "ANTERIOR",
"codigoFontRecurso": "200",
"numeroContaBancaria": "9876543210987",
"numeroAgenciaContaBancaria": "654321",
"codigoBancoContaBancaria": "033",
"tipoContaBancaria": "2",
"valorReceitaExtra": 25000.50,
"historico": "Receita de taxa de licença",
"codigoReceitaExtra": "87654321",
"codigoUnidadeGestoraRetencao": "654321",
"codigoUnidadeOrcamentariaRetencao": "54321",
"numeroEmpenho": "7654321",
"numeroPagamento": "0002001",
"tipoRetencao": "2",
"cnpjGerenciaContaBancaria": "98765432000199",
"action": "DELETE"
}
]
}Regras
| ID | Regra |
| RECEITA_EXTRA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RECEITA_EXTRA_RECEITA_EXTRA_EXISTENTE | A Receita Extra informada deve existir no sistema quando o código da conta contábil exigir receita extra |
| RECEITA_EXTRA_CONTA_CONTABIL | O código de conta contábil deve seguir os códigos definidos pelo STN |
| RECEITA_EXTRA_RETENCAO_OBRIGATORIA | Campos de retenção são obrigatórios conforme a tabela do Plano de Contas |
| RECEITA_EXTRA_CREDOR_CADASTRADO | O credor deve ter sido cadastrado para a Unidade Gestora |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora da receita extra deve estar homologada pelo TCE e deve pertencer ao mesmo município |
Receita Orçamentária
Receita Orçamentária
Receita Orçamentária | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Data Receita Orçamentária - Número Receita - Código Receita Orçamentária - Tipo Lançamento - Tipo Receita - Código Fonte Recurso - Código CO - Código Banco - Número Conta - Número Agência - Tipo Conta Bancária - CNPJ Gerência ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroReceita |
✅ | – |
codigoReceitaOrcamentaria |
✅ | Código da Receita Orçamentária Prevista padrão da STN/TCE |
tipoLancamentoReceita |
✅ | Tabela Tipo Lançamento |
tipoReceitaLancada |
✅ | Tabela Tipo Receita Lançada |
codigoCO |
✅ |
Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
exercicioFonteRecurso |
– | ATUAL |
codigoFonteRecurso |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
valorReceitaOrcamentaria |
– | – |
codigoBancoContaBancaria |
✅ | Código da FEBRABAN |
numeroContaBancaria |
✅ | – |
numeroAgenciaContaBancaria |
✅ | – |
tipoContaBancaria |
✅ | Tabela Tipo Conta Bancária |
cnpjGerenciaContaBancaria |
✅ | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Receitas Orçamentárias",
"description": "Lista de objetos representando a entidade Receita Orçamentária",
"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": "Receita Orçamentária",
"description": "Representação do schema para envio da entidade Receita Orçamentária",
"type": "object",
"properties": {
"numeroReceita": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[A-Z0-9]+$"
},
"codigoReceitaOrcamentaria": {
"description": "Código da Receita Orçamentária Prevista padrão da STN/TCE",
"type": "string",
"minLength": 8,
"maxLength": 8,
"pattern": "^[0-9]+$"
},
"tipoLancamentoReceita": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"tipoReceitaLancada": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": ["ATUAL"]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"valorReceitaOrcamentaria": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoCO": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"pattern": "^[A-Z0-9]+$"
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^[A-Z0-9]+$"
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"numeroReceita",
"codigoReceitaOrcamentaria",
"tipoLancamentoReceita",
"tipoReceitaLancada",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"valorReceitaOrcamentaria",
"tipoContaBancaria",
"numeroContaBancaria",
"codigoBancoContaBancaria",
"numeroAgenciaContaBancaria",
"cnpjGerenciaContaBancaria",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroReceita": "0001234",
"codigoReceitaOrcamentaria": "11210100",
"tipoLancamentoReceita": "1",
"tipoReceitaLancada": "1",
"codigoFonteRecurso": "100",
"exercicioFonteRecurso": "ATUAL",
"valorReceitaOrcamentaria": 25000.00,
"codigoCO": "0001",
"tipoContaBancaria": "1",
"numeroContaContaBancaria": "12345678901",
"codigoBancoContaBancaria": "001",
"numeroAgenciaContaBancaria": "1234",
"cnpjGerenciaContaBancaria": "12345678000195",
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| RECEITA_ORCAMENTARIA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RECEITA_ORCAMENTARIA_TIPO_LANCAMENTO_VALIDO |
O Tipo de Lançamento deve ser válido conforme a Tabela de Tipo de Lançamento |
| RECEITA_ORCAMENTARIA_TIPO_VALIDO |
O Tipo de Receita deve ser válido conforme a |
| RECEITA_ORCAMENTARIA_CODIGO_RECEITA_ORCAMENTARIA_VALIDO | O Código de Receita Orçamentária deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| RECEITA_ORCAMENTARIA_CODIGO_FONTE_RECURSO_VALIDO | O Fonte Recurso deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, dis |
| RECEITA_ORCAMENTARIA_CODIGO_CO_VALIDO | O Código CO deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| RECEITA_ORCAMENTARIA_CONTA_BANCARIA_NAO_CADASTRADA | A conta bancária deve ter sido cadastrada para a Unidade Gestora no exercício do envio |
| RECEITA_ORCAMENTARIA_EXERCICIO_FONTE_RECURSO_VALIDO | A receita orçamentária só aceita Exercício Fonte Recurso ATUAL |
Receita Prevista
Receita Prevista
Receita Prevista | 2025 ~
Tipo Envio: Orçamento
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Receita Orçamentária - Código Fonte Recurso - Tipo Receita ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestora |
✅ | – |
codigoReceitaOrcamentaria |
✅ | Código da Receita Orçamentária Prevista padrão da STN/TCE |
tipoReceitaLancada |
✅ | Tabela Tipo Receita Lançada |
codigoFonteRecurso |
✅ | Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC |
exercicioFonteRecurso |
– | Atual / Anterior |
valorReceita |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Receitas Previstas",
"description": "Lista de objetos representando a entidade Receita Prevista",
"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": "Receita Prevista",
"description": "Representação do schema para envio da entidade Receita Prevista",
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoReceitaOrcamentaria": {
"type": "string",
"minLength": 8,
"maxLength": 8,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": [
"ATUAL",
"ANTERIOR"
]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"tipoReceitaLancada": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valorReceita": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"codigoReceitaOrcamentaria",
"exercicioFonteRecurso",
"codigoFonteRecurso",
"tipoReceitaLancada",
"valorReceita",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"receitasPrevistas": [
{
"codigoUnidadeGestora": "123456",
"codigoReceitaOrcamentaria": "11213001",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "101",
"tipoReceitaLancada": "1",
"valorReceita": 1500000.75,
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"codigoReceitaOrcamentaria": "13322002",
"exercicioFonteRecurso": "ANTERIOR",
"codigoFonteRecurso": "202",
"tipoReceitaLancada": "2",
"valorReceita": 835000.50,
"action": "UPDATE"
}
]
}Regras
| ID | Regra |
| RECEITA_PREVISTA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora deve estar homologada pelo TCE antes do cadastro |
| RECEITA_PREVISTA_TIPO_VALIDO |
O Tipo Receita Lançada deve ser válido conforme a |
| RECEITA_PREVISTA_CODIGO_FONTE_RECURSO_VALIDO | O Fonte Recurso deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| RECEITA_PREVISTA_CODIGO_RECEITA_ORCAMENTARIA_VALIDO | O Código de Receita Orçamentária deve seguir os códigos definidos pela Secretaria do Tesouro Nacional, disponibilizados pela Matriz de Saldos Contábeis (MSC) |
| RECEITA_PREVISTA_EXERCICIO_FONTE_RECURSO_VALIDO | O exercício da Fonte de Recurso só pode ser ANTERIOR ao do envio caso a Unidade Gestora seja previdenciária e para códigos fonte recurso relacionados ao RPPS |
| RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar receitas previstas, pois são os responsáveis pelo protocolo do Orçamento |
| RECEITA_PREVISTA_ESCOPO_CADASTRO | A Prefeitura cadastra receitas previstas de todas as UGs vinculadas a ela, enquanto o Consórcio cadastra apenas suas próprias receitas previstas |
Relacionamento Empenho Licitação
Relacionamento Empenho Licitação
Relacionamento Empenho Licitação | 2025 -
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Código Unidade Gestora Licitação - Número Licitação - Modalidade Licitação ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
codigoUnidadeGestoraLicitacao |
✅ | – |
numeroLicitacao |
✅ | – |
codigoModalidadeLicitacao |
✅ | Tabela Modalidade Licitação |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Relacionamentos Empenho Licitação",
"description": "Lista de objetos representando a entidade Relacionamento Empenho Licitação",
"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": "Relacionamento Empenho Licitação",
"description": "Representação do schema para envio da entidade Relacionamento Empenho Licitação",
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"codigoUnidadeGestoraLicitacao": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"numeroLicitacao": {
"type": "string",
"minLength": 10,
"maxLength": 10,
"pattern": "^\\d{5}/\\d{4}$"
},
"codigoModalidadeLicitacao": {
"type": "string",
"minLength": 2,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"codigoUnidadeGestoraLicitacao",
"numeroLicitacao",
"codigoModalidadeLicitacao",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000001",
"codigoUnidadeGestoraLicitacao": "123456",
"numeroLicitacao": "00001/2025",
"modalidadeLicitacao": "01",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000002",
"codigoUnidadeGestoraLicitacao": "654321",
"numeroLicitacao": "00002/2025",
"modalidadeLicitacao": "02",
"action": "UPDATE"
}
]
}
Regras
| ID | Regra |
| RELACIONAMENTO_EMPENHO_LICITACAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RELACIONAMENTO_EMPENHO_LICITACAO_EMPENHO_CADASTRADO | O empenho deve ter sido cadastrado para a unidade gestora |
| EMPENHO_LICITACAO_CADASTRADA_TRAMITA | A licitação deve ter sido cadastrada no Tramita |
Relacionamento Empenho Natureza Contratação
Relacionamento Empenho Natureza Contratação
Relacionamento Empenho Natureza Contratação | 2025 -
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Ano Emissão Empenho - Número Empenho - Natureza Contratação ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | – |
anoEmissaoEmpenho |
✅ | – |
numeroEmpenho |
✅ | – |
codigoNaturezaContratacao |
✅ | Tabela Natureza Contratação |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Relacionamentos Empenho Natureza Contratação",
"description": "Lista de objetos representando a entidade Relacionamento Empenho Natureza Contratação",
"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[.\\d{3,6}$",
"examples": ["2025-09-11T15:30:00.123456"]
},
"elementos": {
"type": "array",
"uniqueItems": true,
"items": {
"title": "Relacionamento Empenho Natureza Contratação",
"description": "Representação do schema para envio da entidade Relacionamento Empenho Natureza Contratação",
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"codigoNaturezaContratacao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"anoEmissaoEmpenho",
"numeroEmpenho",
"naturezaContratacao",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "12345",
"anoEmissaoEmpenho": "2025",
"numeroEmpenho": "0000001",
"codigoNaturezaContratacao": "1",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "54321",
"anoEmissaoEmpenho": "2025",
"numeroEmpenho": "0000002",
"codigoNaturezaContratacao": "2",
"action": "CREATE"
}
]
}
Regras
| ID | Regra |
| RELACIONAMENTO_EMPENHO_NATUREZA_CONTRATACAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RELACIONAMENTO_EMPENHO_NATUREZA_CONTRATACAO_EMPENHO_CADASTRADO | O empenho deve ter sido cadastrado para a unidade gestora |
| RELACIONAMENTO_EMPENHO_NATUREZA_CONTRATACAO_NATUREZA_CONTRATACAO_VALIDA | Válida conforme a Tabela de Natureza de Contratação |
Relacionamento Empenho Obra
Relacionamento Empenho Obra
Relacionamento Empenho Obra | 2025 -
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Código Unidade Gestora Obra - Número Obra - Ano Empenho ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
codigoUnidadeGestoraObra |
✅ | – |
numeroObra |
✅ | – |
anoEmpenho |
✅ | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://jso
"title": "Lista de Relacionamentos Empenho Obra",
"description": "Lista de objetos representando a entidade Relacionamento Empenho Obra",
"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": "Relacionamento Empenho Obra",
"description": "Representação do schema para envio da entidade Relacionamento Empenho Obra",
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho":
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroObra": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"anoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"codigoUnidadeGestoraObra",
"numeroObra",
"anoEmpenho",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000001",
"codigoUnidadeGestoraObra": "123456",
"numeroObra": "OBRA0001",
"anoEmpenho": "2025",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000002",
"codigoUnidadeGestoraObra": "654321",
"numeroObra": "OBRA0002",
"anoEmpenho": "2024",
"action": "UPDATE"
}
]
}
Regras
| ID | Regra |
| RELACIONAMENTO_EMPENHO_OBRA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RELACIONAMENTO_EMPENHO_OBRA_EMPENHO_CADASTRADO | O empenho deve ter sido cadastrado para a unidade gestora |
| RELACIONAMENTO_EMPENHO_OBRA_CADASTRADA_GEO_OBRAS | Quando informada, a obra deve ter sido cadastrada no Geo Obras |
Relacionamento Liquidação Código Agrupamento Folha Pagamento
Relacionamento Liquidação Código Agrupamento Folha Pagamento
Relacionamento Liquidação Código Agrupamento Folha Pagamento | 2025 -
Tipo Envio: Balancete - Contabilidade
Chave Unicidade
[ Exercício - Mês - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Código Agrupamento Folha ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
codigoAgrupamentoFolha |
✅ | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Relacionamentos Liquidação Código Agrupamento Folha Pagamento",
"description": "Lista de objetos representando a entidade Relacionamento Liquidação 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": "Relacionamento Liquidação Código Agrupamento Folha Pagamento",
"description": "Representação do schema para envio da entidade Relacionamento Liquidação Código Agrupamento Folha Pagamento",
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"codigoAgrupamentoFolha": {
"type": "string",
"minLength": 10,
"maxLength": 10
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"codigoAgrupamentoFolha",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000001",
"numeroLiquidacao": "0000001",
"codigoAgrupamentoFolha": "AGRUP00001",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000002",
"numeroLiquidacao": "0000002",
"codigoAgrupamentoFolha": "AGRUP00002",
"action": "CREATE"
}
]
}
Regras
| ID | Regra |
| RELACIONAMENTO_LIQUIDACAO_CODIGO_AGRUPAMENTO_FOLHA_PAGAMENTO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RELACIONAMENTO_LIQUIDACAO_CODIGO_AGRUPAMENTO_FOLHA_PAGAMENTO_UMA_LIQUIDACAO | Só pode ter uma liquidação por agrupamento |
| RELACIONAMENTO_LIQUIDACAO_CODIGO_AGRUPAMENTO_FOLHA_PAGAMENTO_EXISTE_EMPENHOS_FOLHA_NAO_INFORMADO | É obrigatório informar todos os empenhos de folha no relacionamento |
Responsável Siafic
Responsável Siafic
Responsável Siafic | 2025 -
Tipo Envio: Balancete - Contabilidade
Chave Unicidade
[ Exercício - Código Unidade Gestora - CNPJ Empresa - Nome Empresa - Tipo Logradouro - Número Logradouro - Complemento Logradouro - CEP Logradouro - Telefone Empresa - E-mail Empresa - CPF Responsável Técnico- Nome Responsável Técnico - E-mail Responsável Técnico- Telefone Responsável Técnico ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
cnpjEmpresa |
✅ | – |
nomeEmpresa |
– | – |
tipoLogradouro |
– | – |
numeroLogradouro |
– | – |
complementoLogradouro |
– | – |
cepLogradouro |
– | – |
telefoneEmpresa |
– | – |
emailEmpresa |
– | – |
denominacaoSiafic |
– | – |
cpfResponsavelTecnico |
– | – |
nomeResponsavelTecnico |
– | – |
emailResponsavelTecnico |
– | – |
telefoneResponsavelTecnico |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Responsaveis Siafic",
"description": "Lista de objetos representando a entidade Responsavel Siafic",
"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": "Responsavel Siafic",
"description": "Representação do schema para envio da entidade Responsavel Siafic",
"type": "object",
"properties": {
"cnpjEmpresa": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"tipoLogradouro": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"numeroLogradouro": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"cepLogradouro": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"complementoLogradouro": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"nomeEmpresa": {
"type": "string",
"minLength": 10,
"maxLength": 80
},
"telefoneEmpresa": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"emailEmpresa": {
"type": "string",
"minLength": 10,
"maxLength": 50,
"format": "email"
},
"denominacaoSiafic": {
"type": "string",
"minLength": 10,
"maxLength": 30
},
"cpfResponsavelTecnico": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"nomeResponsavelTecnico": {
"type": "string",
"minLength": 10,
"maxLength": 60
},
"emailResponsavelTecnico": {
"type": "string",
"minLength": 10,
"maxLength": 30,
"format": "email"
},
"telefoneResponsavelTecnico": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"cnpjEmpresa",
"nomeEmpresa",
"numeroLogradouro",
"cepLogradouro",
"tipoLogradouro",
"complementoLogradouro",
"telefoneEmpresa",
"emailEmpresa",
"denominacaoSiafic",
"cpfResponsavelTecnico",
"nomeResponsavelTecnico",
"emailResponsavelTecnico",
"telefoneResponsavelTecnico",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"cnpjEmpresa": "12345678901234",
"nomeEmpresa": "Empresa de TI Solutions Ltda",
"telefoneEmpresa": "08333334444",
"emailEmpresa": "contato@empresati.com.br",
"denominacaoSiafic": "Sistema Financeiro Integrado",
"cpfResponsavelTecnico": "12345678901",
"nomeResponsavelTecnico": "João da Silva Santos",
"emailResponsavelTecnico": "joao.silva@empresati.com.br",
"telefoneResponsavelTecnico": "08399998888",
"action": "CREATE"
},
{
"cnpjEmpresa": "98765432109876",
"nomeEmpresa": "Tecnologia e Consultoria Empresarial",
"telefoneEmpresa": "08344445555",
"emailEmpresa": "suporte@teconsult.com.br",
"denominacaoSiafic": "Gestor de Dados Contabeis",
"cpfResponsavelTecnico": "98765432109",
"nomeResponsavelTecnico": "Maria Oliveira Costa",
"emailResponsavelTecnico": "maria.costa@teconsult.com.br",
"telefoneResponsavelTecnico": "08388887777",
"action": "UPDATE"
}
]
}
Regras
| ID | Regra |
| RESPONSAVEL_SIAFIC_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RESPONSAVEL_SIAFIC_NOME_INVALIDO | O nome do responsável siafic deve ser correspondente ao cadastrado na Receita Federal |
| RESPONSAVEL_SIAFIC_NOME_EMPRESA_INVALIDO | O nome da empresa deve ser correspondente ao cadastrado na Receita Federal |
Resto Inscrito
Resto Inscrito
Resto Inscrito | 2025 -
Tipo Envio: Balancete - Contabilidade
Chave Unicidade
[ Exercício - Código Unidade Gestora - Ano Emissão Empenho - Código Unidade Orçamentária - Número Empenho ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentariaOrigem |
✅ | – |
numeroEmpenhoOrigem |
✅ | – |
codigoUnidadeGestoraOrigem |
✅ | – |
valorInscrito |
– | – |
valorProcessado |
– | – |
valorNaoProcessado |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Restos Inscritos",
"description": "Lista de objetos representando a entidade Restos Inscritos",
"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": "Restos Inscritos",
"description": "Representação do schema para envio da entidade Restos Inscritos",
"type": "object",
"properties": {
"codigoUnidadeOrcamentariaOrigem": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenhoOrigem": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"codigoUnidadeGestoraOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"valorInscrito": {
"type": "number",
"exclusiveMinimum": 0
},
"valorProcessado": {
"type": "number",
"minimum": 0
},
"valorNaoProcessado": {
"type": "number",
"minimum": 0
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeOrcamentariaOrigem",
"numeroEmpenhoOrigem",
"codigoUnidadeGestoraOrigem",
"valorInscrito",
"valorProcessado",
"valorNaoProcessado",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-12-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentariaOrigem": "12345",
"numeroEmpenhoOrigem": "0000001",
"codigoUnidadeGestoraOrigem": "123456",
"valorInscrito": 10000.00,
"valorProcessado": 8000.00,
"valorNaoProcessado": 2000.00,
"action": "CREATE"
},
{
"codigoUnidadeOrcamentariaOrigem": "54321",
"numeroEmpenhoOrigem": "0000002",
"codigoUnidadeGestoraOrigem": "654321",
"valorInscrito": 15000.00,
"valorProcessado": 12000.00,
"valorNaoProcessado": 3000.00,
"action": "CREATE"
}
]
}
Regras
| ID | Regra |
| RESTO_INSCRITO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RESTO_INSCRITO_EMPENHO_CADASTRADO | O empenho deve ter sido cadastrado |
| RESTO_INSCRITO_APENAS_DEZEMBRO | Restos a pagar são aceitos apenas no balancete de dezembro |
| RESTO_INSCRITO_VALORES_CONSISTENTES | Valores inscritos devem ser os mesmos valores a pagar dos empenhos do exercício |
| RESTO_INSCRITO_ESCOPO_CADASTRO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
Retenção
Retenção
Retenção | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária - Número Empenho - Número Liquidação - Número Retenção - Tipo Retenção ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
numeroPagamento |
✅ | – |
numeroRetencao |
✅ | – |
tipoRetencao |
✅ | Tabela Tipo Retenção |
valorRetencao |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Retenções",
"description": "Schema para envio de retenções por unidade gestora",
"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": {
"type": "object",
"properties": {
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroRetencao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"tipoRetencao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valorRetencao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroPagamento",
"numeroRetencao",
"tipoRetencao",
"valorRetencao",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001234",
"numeroLiquidacao": "0000002",
"numeroPagamento": "0000001",
"numeroRetencao": "0000001",
"tipoRetencao": "1",
"valorRetencao": 1500.00,
"action": "CREATE"
}
]
}Regras
| ID | Regra |
| RETENCAO_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| RETENCAO_VALOR_RETIDO_EXCEDE_VALOR_PAGO | A soma do valor retido não pode superar o valor pago O valor líquido retido (retenção - estorno de retenção) não pode exceder o valor líquido pago (pagamento - estorno de pagamento) até a data do envio. |
| RETENCAO_PAGAMENTO_CADASTRADO | O pagamento referenciado deve ter sido cadastrado para a Unidade Gestora no exercício do envio |
| RETENCAO_TIPO_VALIDO | O Tipo de Retenção deve ser válido conforme a Tabela de Tipo de Retenção |
Retenção Resto
Retenção Resto
Retenção Resto | 2025 ~
Tipo Envio: Diário
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
anoEmissaoEmpenho |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | – |
numeroEmpenho |
✅ | – |
numeroLiquidacao |
✅ | – |
numeroPagamento |
✅ | – |
numeroRetencao |
✅ | |
valorRetencaoResto |
– | – |
tipoRetencao |
✅ | Tabela Tipo Retenção |
codigoUnidadeGestoraOrigem |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Retenções de Restos a Pagar",
"description": "Lista de objetos representando a entidade Retenção Resto",
"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": "Retenção Resto",
"description": "Representação do schema para envio da entidade Retenção Resto",
"type": "object",
"properties": {
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"numeroEmpenho": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroLiquidacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroRetencao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"valorRetencaoResto": {
"type": "number",
"exclusiveMinimum": 0
},
"tipoRetencao": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"codigoUnidadeGestoraOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroPagamento",
"valorRetencaoResto",
"tipoRetencao",
"codigoUnidadeGestoraOrigem",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"anoEmissaoEmpenho": "2025",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "7654321",
"numeroPagamento": "1234567",
"valorRetencaoResto": 1500.00,
"tipoRetencao": "1",
"codigoUnidadeGestoraOrigem": "654321",
"action": "CREATE"
}
]
}Saldo Inicial Conciliado
Saldo Inicial Conciliado
Saldo Inicial Conciliado | 2025 -
Tipo Envio: Balancete - Contabilidade
Chave Unicidade
[ Exercício - Código Unidade Gestora - Número Conta Bancária - Número Agência Conta Bancária - Código Banco Conta Bancária - Tipo Conta Bancária - CNPJ Gerência Conta Bancária ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroContaBancaria |
✅ | – |
numeroAgenciaContaBancaria |
✅ | – |
codigoBancoContaBancaria |
✅ | – |
tipoContaBancaria |
✅ | Tabela Tipo Conta Bancária |
cnpjGerenciaContaBancaria |
✅ | – |
valorSaldoInicial |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Saldos Iniciais",
"description": "Lista de objetos representando a entidade Saldo Inicial",
"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": "Saldo Inicial",
"description": "Representação do schema para envio da entidade Saldo Inicial",
"type": "object",
"properties": {
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"pattern": "^[A-Z0-9]+$"
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^[A-Z0-9]+$"
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"valorSaldoInicial": {
"type": "number"
}
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"numeroContaBancaria",
"numeroAgenciaContaBancaria",
"codigoBancoContaBancaria",
"valorSaldoInicial",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroContaBancaria": "1234567890123",
"numeroAgenciaContaBancaria": "123456",
"codigoBancoContaBancaria": "001",
"valorSaldoInicial": 1000,
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678901234",
"action": "CREATE"
},
{
"numeroContaBancaria": "9876543210987",
"numeroAgenciaContaBancaria": "654321",
"codigoBancoContaBancaria": "002",
"valorSaldoInicial": 250,
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432109876",
"action": "DELETE"
}
]
}
Regras
| ID | Regra |
| SALDO_INICIAL_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| SALDO_INICIAL_JANEIRO | Só pode ser enviado no mês de janeiro |
| SALDO_INICIAL_CONTA_BANCARIA_CADASTRADA | A conta bancária deve ter sido cadastrada para a unidade gestora |
Saldo Mensal Extrato
Saldo Mensal Extrato
Saldo Mensal Extrato | 2025 -
Tipo Envio: Balancete - Contabilidade
Chave Unicidade
[ Exercício - Mês - Código Unidade Gestora - Número Conta Bancária - Número Agência Conta Bancária - Código Banco Conta Bancária - Tipo Conta Bancária - CNPJ Gerência Conta Bancária ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
numeroContaBancaria |
✅ | – |
numeroAgenciaContaBancaria |
✅ | – |
codigoBancoContaBancaria |
✅ | – |
tipoContaBancaria |
✅ | Tabela Tipo Conta Bancária |
cnpjGerenciaContaBancaria |
✅ | – |
valorSaldoMensal |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Saldos Mensais",
"description": "Lista de objetos representando a entidade Saldo Mensal",
"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": "Saldo Mensal",
"description": "Representação do schema para envio da entidade Saldo Mensal",
"type": "object",
"properties": {
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"pattern": "^[A-Z0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"pattern": "^[A-Z0-9]+$"
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"valorSaldoMensal": {
"type": "number"
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"numeroContaBancaria",
"numeroAgenciaContaBancaria",
"codigoBancoContaBancaria",
"valorSaldoMensal",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroContaBancaria": "1234567890123",
"numeroAgenciaContaBancaria": "123456",
"codigoBancoContaBancaria": "001",
"valorSaldoMensal": 500,
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678901234",
"action": "CREATE"
},
{
"numeroContaBancaria": "9876543210987",
"numeroAgenciaContaBancaria": "654321",
"codigoBancoContaBancaria": "002",
"valorSaldoMensal": 7500,
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432109876",
"action": "UPDATE"
}
]
}
Regras
| ID | Regra |
| SALDO_MENSAL_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| SALDO_MENSAL_CONTA_BANCARIA_CADASTRADA | A conta bancária deve ter sido cadastrada para a unidade gestora |
Transferência Concedida
Transferência Concedida
Transferência Concedida | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Gestora Recebedora - Tipo Transferência - Tipo Lançamento - Número Conta Bancária - Código Banco Conta Bancária - Tipo Conta Bancária - CNPJ Gerência Conta Bancária ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestoraRecebedora |
✅ | – |
tipoTransferencia |
✅ | Tabela Tipo Transferência |
tipoLancamento |
✅ | Tabela Tipo Lancamento |
valor |
– | – |
numeroContaBancaria |
✅ | – |
codigoBancoContaBancaria |
✅ | – |
numeroAgenciaContaBancaria |
✅ | – |
tipoContaBancaria |
✅ | – |
cnpjGerenciaContaBancaria |
✅ | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Transferências Concedidas",
"description": "Lista de objetos representando a entidade Transferência Concedida",
"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": "Transferência Concedida",
"description": "Representação do schema para envio da entidade Transferência Concedida",
"type": "object",
"properties": {
"codigoUnidadeGestoraRecebedora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"tipoTransferencia": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"tipoLancamento": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valor": {
"type": "number",
"exclusiveMinimum": 0
},
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeGestoraRecebedora",
"tipoTransferencia",
"tipoLancamento",
"valor",
"numeroContaBancaria",
"codigoBancoContaBancaria",
"numeroAgenciaContaBancaria",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeGestoraRecebedora": "654321",
"tipoTransferencia": "1",
"tipoLancamento": "2",
"valor": 150000.50,
"numeroContaBancaria": "1234567890123",
"codigoBancoContaBancaria": "001",
"numeroAgenciaContaBancaria": "123456",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678000190",
"action": "CREATE"
},
{
"codigoUnidadeGestoraRecebedora": "789012",
"tipoTransferencia": "3",
"tipoLancamento": "1",
"valor": 75000.00,
"numeroContaBancaria": "9876543210987",
"codigoBancoContaBancaria": "033",
"numeroAgenciaContaBancaria": "654321",
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432000199",
"action": "DELETE"
}
]
}Regras
| ID | Regra |
| TRANSFERENCIA_CONCEDIDA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| TRANSFERENCIA_CONCEDIDA_TIPO_VALIDO |
O tipo da transferência deve ser válido para o exercício do envio, conforme a Tabela Tipo Transferência |
| TRANSFERENCIA_CONCEDIDA_TIPO_LANCAMENTO_VALIDO |
O tipo da transferência deve ser válido para o exercício do envio, conforme a Tabela Tipo Lancamento |
| TRANSFERENCIA_CONCEDIDA_CONTA_BANCARIA_CADASTRADA |
A conta bancária precisa estar cadastrada para a unidade gestora |
| TRANSFERENCIA_CONCEDIDA_ESCOPO_CADASTRO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
Transferência Recebida
Transferência Recebida
Transferência Recebida | 2025 ~
Tipo Envio: Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Gestora Transferência - Tipo Transferência - Tipo Lançamento - Número Conta Bancária - Código Banco Conta Bancária - Tipo Conta Bancária - CNPJ Gerência Conta Bancária ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestoraTransferencia |
✅ | – |
tipoTransferencia |
✅ | Tabela Tipo Transferência |
tipoLancamento |
✅ | Tabela Tipo Lancamento |
valor |
– | – |
numeroContaBancaria |
✅ | – |
codigoBancoContaBancaria |
✅ | – |
numeroAgenciaContaBancaria |
✅ | – |
tipoContaBancaria |
✅ | – |
cnpjGerenciaContaBancaria |
✅ | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Transferências",
"description": "Lista de objetos representando a entidade Transferência",
"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": "Transferência",
"description": "Representação do schema para envio da entidade Transferência",
"type": "object",
"properties": {
"codigoUnidadeGestoraTransferencia": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"tipoTransferencia": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"tipoLancamento": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"valor": {
"type": "number",
"exclusiveMinimum": 0
},
"numeroContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 13
},
"codigoBancoContaBancaria": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgenciaContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 6
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"pattern": "^[A-Z0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeGestoraTransferencia",
"dataTransferencia",
"tipoTransferencia",
"tipoLancamento",
"valor",
"numeroContaBancaria",
"codigoBancoContaBancaria",
"numeroAgenciaContaBancaria",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeGestoraTransferencia": "654321",
"dataTransferencia": "2025-09-11",
"tipoTransferencia": "1",
"tipoLancamento": "2",
"valor": 150000.50,
"numeroContaBancaria": "1234567890123",
"codigoBancoContaBancaria": "001",
"numeroAgenciaContaBancaria": "123456",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678000190",
"action": "CREATE"
},
{
"codigoUnidadeGestoraTransferencia": "789012",
"dataTransferencia": "2025-08-15",
"tipoTransferencia": "3",
"tipoLancamento": "1",
"valor": 75000.00,
"numeroContaBancaria": "9876543210987",
"codigoBancoContaBancaria": "033",
"numeroAgenciaContaBancaria": "654321",
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432000199",
"action": "DELETE"
}
]
}Regras
| ID | Regra |
| TRANSFERENCIA_RECEBIDA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| TRANSFERENCIA_RECEBIDA_TIPO_VALIDO |
O tipo da transferência deve ser válido para o exercício do envio, conforme a Tabela Tipo Transferência |
| TRANSFERENCIA_RECEBIDA_TIPO_LANCAMENTO_VALIDO |
O tipo da transferência deve ser válido para o exercício do envio, conforme a Tabela Tipo Lancamento |
| TRANSFERENCIA_RECEBIDA_CONTA_BANCARIA_CADASTRADA |
A conta bancária precisa estar cadastrada para a unidade gestora |
| TRANSFERENCIA_RECEBIDA_ESCOPO_CADASTRO | É permitido informar apenas unidades gestoras do mesmo município. O Consórcio só pode informar a si mesmo |
Unidade Orçamentária
Unidade Orçamentária
Unidade Orçamentária | 2025 ~
Tipo Envio: Orçamento/Diário
Chave Unicidade
[ Exercício - Código Unidade Gestora - Código Unidade Orçamentária ]
Objeto Raiz
| Campo | Informações |
timestamp |
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente |
elementos |
– |
Item
| Campo | Chave | Informações |
codigoUnidadeGestora |
✅ | – |
codigoUnidadeOrcamentaria |
✅ | – |
descricaoUnidadeOrcamentaria |
– | – |
action |
– | Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão |
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Unidades Orçamentárias",
"description": "Lista de objetos representando a entidade Unidade Orçamentária",
"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": "Unidade Orçamentária",
"description": "Representação do schema para envio da entidade Orçamentária",
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"codigoUnidadeOrcamentaria": {
"type": "string",
"minLength": 5,
"maxLength": 5,
"pattern": "^[0-9]+$"
},
"descricaoUnidadeOrcamentaria": {
"type": "string",
"minLength": 10,
"maxLength": 50
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"codigoUnidadeOrcamentaria",
"descricaoUnidadeOrcamentaria",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-09-11T15:30:00.123456",
"unidadesOrcamentarias": [
{
"codigoUnidadeGestora": "123456",
"codigoUnidadeOrcamentaria": "10001",
"descricaoUnidadeOrcamentaria": "Secretaria Municipal de Administração Pública",
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"codigoUnidadeOrcamentaria": "20002",
"descricaoUnidadeOrcamentaria": "Secretaria de Planejamento e Finanças Municipais",
"action": "UPDATE"
}
]
}
Regras
| ID | Regra |
| UNIDADE_ORCAMENTARIA_DUPLICIDADE_NAO_PERMITIDA | Não é permitido cadastrar registros duplicados pela chave de unicidade |
| UNIDADE_GESTORA_HOMOLOGADA | A unidade gestora deve estar homologada pelo TCE antes do cadastro |
| RESPONSABILIDADE_PROTOCOLO | Apenas prefeituras e consórcios podem enviar unidades orçamentárias, pois são os responsáveis pelo protocolo do orçamento |
| UNIDADE_ORCAMENTARIA_ESCOPO_CADASTRO | A Prefeitura cadastra unidades orçamentárias de todas as UGs vinculadas a ela, enquanto o Consórcio cadastra apenas suas próprias unidades orçamentárias |