Schemas
Esta página apresenta os JSON Schemas utilizados para o recebimento de dados de cada entidade no SAGRES Captura 2.0 . Esses schemas definem a estrutura, os tipos de dados e as validações esperadas para o envio das informações.
Como o sistema ainda está em evolução, os schemas e suas regras de validação podem sofrer alterações ao longo do tempo.
⚠️ Recomenda-se consultar esta página periodicamente para acompanhar possíveis atualizações.
JSON Schema
A validação a partir de um JSON Schema serve para garantir que um arquivo JSON esteja “no formato correto”.Sagres Captura 2.0 , seguirá exatamente esse formato de validação baseado em 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 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 schemas e os arquivos JSON , verificando se o conteúdo está de acordo com as regras definidas no schema .
Ação
Esta página apresenta as regras por vigência relacionadas à entidade AÇÃO no SAGRES Captura 2.0 .
Ação
Ação | Schema V1 | 2025 - ∞
Tipo Envio: Orçamento/Diário Objeto Raiz
Campo Informações
timestampCampo 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"
}
]
}
Atualização Orçamentária
Atualização Orçamentária
Atualização Orçamentária | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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
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": 8,
"maxLength": 8,
"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": "20260001",
"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": "20260002",
"tipoDecretoOficio": "OFICIO",
"tipoAlteracao": "2",
"valorAtualizacao": 82500.00,
"action": "UPDATE"
}
]
}
Conta Bancária
Conta Bancária
Conta Bancária | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
codigoBanco✅
Código da FEBRABAN
numeroAgencia✅
–
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]+$"
},
"codigoBanco": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"numeroAgencia": {
"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",
"codigoBanco",
"numeroAgencia",
"descricaoContaBancaria",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload {
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"numeroContaBancaria": "0012345678901",
"codigoBanco": "001",
"numeroAgencia": "1234A",
"descricaoContaBancaria": "Conta Principal Fundo Municipal de Saúde",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678000199",
"action": "CREATE"
},
{
"numeroContaBancaria": "0098765432100",
"codigoBanco": "033",
"numeroAgencia": "5678B",
"descricaoContaBancaria": "Conta Secundária Fundo Municipal de Educação",
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432000188",
"action": "UPDATE"
},
{
"numeroContaBancaria": "0011122233300",
"codigoBanco": "104",
"numeroAgencia": "9999C",
"descricaoContaBancaria": "Conta Reserva Fundo Municipal de Assistência Social",
"tipoContaBancaria": "3",
"cnpjGerenciaContaBancaria": "11122233000177",
"action": "DELETE"
}
]
}
Credor
Credor
Credor | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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
Regras
Consulte as regras de validaçã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": 80
},
"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"
}
]
}
Decreto e Oficio
Decreto e Oficio
Decreto Oficio | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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–
–
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": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"numeroDecretoOficio": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]+$"
},
"numeroLei": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]+$"
},
"dataDecretoOficio": {
"type": "string",
"format": "date"
},
"tipoDocumento": {
"type": "integer",
"enum": [
"DECRETO",
"OFICIO"
],
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"codigoUnidadeGestora",
"numeroDecretoOficio",
"numeroLei",
"dataDecretoOficio",
"tipoDocumento",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload {
"timestamp": "2026-03-02T11:32:45.123456",
"elementos": [
{
"codigoUnidadeGestora": "123456",
"numeroDecretoOficio": "000012026",
"numeroLei": "000452025",
"dataDecretoOficio": "2026-01-02",
"tipoDocumento": "DECRETO",
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"numeroDecretoOficio": "000022026",
"numeroLei": "000122024",
"dataDecretoOficio": "2025-02-21",
"tipoDocumento": "OFICIO",
"action": "UPDATE"
}
]
}
Despesa Extra
Despesa Extra
Despesa Extra | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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"
}
]
}
Dotação
Dotação
Dotação | Schema V1 | 2025 - 2026
Tipo Envio: Orçamento Objeto Raiz
Campo Informações
timestampCampo 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"
}
]
}
Dotação
Dotação | Schema V2 | 2027 - ∞
Tipo Envio: Orçamento Objeto Raiz
Campo Informações
timestampCampo 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
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]+$"
},
"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,
"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"
}
]
}
Empenho
Empenho
Empenho | Schema V1 | 2025 - 2026
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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": 2,
"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",
"codigoCO",
"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"
}
]
}
Empenho
Empenho | Schema V2 | 2027 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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
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": 2,
"pattern": "^[0-9]+$"
},
"codigoEmendaParlamentar": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^[0-9]+$"
},
"numeroObra": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"numeroLicitacao": {
"type": "string",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]+$"
},
"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",
"codigoCO",
"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": "000012025",
"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": "000012025",
"historico": "Empenho referente à aquisição de material de escritório conforme processo administrativo nº 002/2025.",
"cpfCnpjCredor": "98765432000110",
"cpfOrdenador": "12345678901",
"action": "CREATE"
}
]
}
Estorno Despesa Extra
Estorno Despesa Extra
Estorno Despesa Extra | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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"
}
]
}
Estorno Empenho
Estorno Empenho
Estorno Empenho | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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 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]+$"
},
"dataEstornoEmpenho": {
"type": "string",
"format": "date"
},
"valorEstornoEmpenho": {
"type": "number",
"exclusiveMinimum": 0
},
"motivo": {
"type": "string",
"maxLength": 500
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroEstornoEmpenho",
"dataEstornoEmpenho",
"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",
"dataEstornoEmpenho": "2026-03-01",
"valorEstornoEmpenho": 150000.50,
"motivo": "Estorno referente a empenho emitido com valor incorreto",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000002",
"numeroEstornoEmpenho": "0000002",
"dataEstornoEmpenho": "2026-03-02",
"valorEstornoEmpenho": 82500.00,
"motivo": "Estorno de empenho com despesa previamente liquidada",
"action": "UPDATE"
}
]
}
Estorno Liquidação
Estorno Liquidação
Estorno Liquidação | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
dataEstornoLiquidacao–
–
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]+$"
},
"dataEstornoLiquidacao": {
"type": "string",
"format": "date"
},
"motivoEstornoLiquidacao": {
"type": "string",
"maxLength": 500
},
"valorEstornoLiquidacao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroEstornoLiquidacao",
"dataEstornoLiquidacao",
"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",
"dataEstornoLiquidacao": "2026-03-01",
"motivoEstornoLiquidacao": "Estorno referente a liquidação emitida com valor incorreto",
"valorEstornoLiquidacao": 150000.50,
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000002",
"numeroLiquidacao": "0000002",
"numeroEstornoLiquidacao": "0000002",
"dataEstornoLiquidacao": "2026-03-02",
"motivoEstornoLiquidacao": "Estorno de liquidação com divergência no valor informado",
"valorEstornoLiquidacao": 82500.00,
"action": "UPDATE"
}
]
}
Estorno Liquidação Resto
Estorno Liquidação Resto
Estorno Liquidação Resto | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
dataEstornoLiquidacaoResto–
–
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]+$"
},
"dataEstornoLiquidacaoResto": {
"type": "string",
"format": "date"
},
"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",
"dataEstornoLiquidacaoResto",
"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"
}
]
}
Estorno Pagamento
Estorno Pagamento
Estorno Pagamento | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
numeroPagamento✅
–
numeroEstornoPagamento✅
–
dataEstornoPagamento–
–
motivoEstornoPagamento–
–
valorEstornoPagamento–
–
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 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]+$"
},
"numeroPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"numeroEstornoPagamento": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"dataEstornoPagamento": {
"type": "string",
"format": "date"
},
"motivoEstornoPagamento": {
"type": "string",
"maxLength": 500
},
"valorEstornoPagamento": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroPagamento",
"numeroEstornoPagamento",
"dataEstornoPagamento",
"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",
"numeroPagamento": "0000001",
"numeroEstornoPagamento": "0000001",
"dataEstornoPagamento": "2025-09-11",
"motivoEstornoPagamento": "Pagamento realizado em duplicidade referente ao processo administrativo nº 001/2025.",
"valorEstornoPagamento": 15000.00,
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001235",
"numeroPagamento": "0000002",
"numeroEstornoPagamento": "0000002",
"dataEstornoPagamento": "2025-09-12",
"motivoEstornoPagamento": "Erro na identificação do credor. Pagamento efetuado para fornecedor incorreto conforme processo nº 002/2025.",
"valorEstornoPagamento": 8500.50,
"action": "CREATE"
}
]
}
Estorno Pagamento Resto
Estorno Pagamento Resto
Estorno Pagamento Resto | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
numeroPagamento✅
–
numeroEstornoPagamentoResto✅
–
dataEstornoPagamentoResto–
–
motivo–
–
despesaLiquidada–
SIM / NAO
valorEstornoPagamentoResto–
–
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 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]+$"
},
"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"
}
]
}
Estorno Receita Extra
Estorno Receita Extra
Estorno Receita Extra | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
dataEstornoReceitaExtra–
–
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]+$"
},
"dataEstornoReceitaExtra": {
"type": "string",
"format": "date"
},
"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",
"dataEstornoReceitaExtra": "2025-09-11",
"valorEstornoReceitaExtra": 50000.00,
"motivo": "Estorno de receita extraorçamentária lançada indevidamente",
"action": "CREATE"
}
]
}
Estorno Resto
Estorno Resto
Estorno Resto | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
dataEstornoResto–
–
valorEstornoResto–
–
motivo–
–
despesaLiquidada–
SIM / NAO
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 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]+$"
},
"dataEstornoResto": {
"type": "string",
"format": "date"
},
"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"
}
]
}
Estorno Retenção
Estorno Retenção
Estorno Retenção | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
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]+$"
},
"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",
"numeroPagamento",
"tipoRetencao",
"numeroEstornoRetencao",
"valorEstornoRetencao",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload {
"timestamp": "2026-03-02T11:32:45.123456",
"elementos": [
{
"codigoUnidadeGestora": "123456",
"anoEmissaoEmpenho": "2026",
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000001",
"numeroPagamento": "0000001",
"tipoRetencao": "1",
"numeroEstornoRetencao": "0000001",
"valorEstornoRetencao": 15000.50,
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"anoEmissaoEmpenho": "2026",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000002",
"numeroPagamento": "0000002",
"tipoRetencao": "2",
"numeroEstornoRetencao": "0000002",
"valorEstornoRetencao": 8250.00,
"action": "UPDATE"
}
]
}
Estorno Retenção Resto
Estorno Retenção Resto
Estorno Retenção Resto | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
numeroPagamento✅
–
tipoRetencao✅
Tabela Tipo Retenção
numeroEstornoRetencaoResto✅
–
dataEstornoRetencaoResto–
–
motivo–
–
valorEstornoRetencaoResto–
–
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 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]+$"
},
"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"
}
]
}
Liquidação
Liquidação
Liquidação | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
dataLiquidacao–
–
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]+$"
},
"dataLiquidacao": {
"type": "string",
"format": "date",
},
"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",
"dataLiquidacao",
"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",
"dataLiquidacao": "2025-09-11",
"tipoNotaFiscal": "01",
"numeroChaveNotaFiscal": "35250912345678000195550010000012341234567890",
"numeroNotaFiscal": "000012341",
"serieNotaFiscal": "001",
"dataNotaFiscal": "2025-09-10",
"valorNotaFiscal": 15000.00,
"valorLiquidacao": 15000.00,
"codigoAgrupamentoFolha": "FOLHA0001",
"action": "CREATE"
},
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001235",
"numeroLiquidacao": "0000002",
"dataLiquidacao": "2025-09-11",
"valorLiquidacao": 8500.50,
"action": "CREATE"
}
]
}
Liquidação Resto
Liquidação Resto
Liquidação Resto | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
dataLiquidacaoResto–
–
tipoNotaFiscal–
Tabela Tipo Nota Fiscal
numeroChaveNotaFiscal–
–
numeroNotaFiscal–
–
serieNotaFiscal–
–
dataNotaFiscal–
–
valorNotaFiscal–
–
valorLiquidacaoResto–
–
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 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]+$"
},
"dataLiquidacaoResto": {
"type": "string",
"format": "date"
},
"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"
}
]
}
Movimentação Entre Contas Bancárias
Movimentação Entre Contas Bancárias
Movimentação Entre Contas Bancárias | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
Tabela Tipo Conta Bancária
codigoBancoContaBancariaDestino✅
Código da FEBRABAN
numeroAgenciaContaBancariaDestino✅
–
numeroContaBancariaDestino✅
–
tipoContaBancariaDestino✅
Tabela Tipo Conta Bancária
valorTransferencia–
–
dataMovimentacao✅
–
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 Transferências Bancárias",
"description": "Lista de objetos representando a entidade Transferência 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": "Transferência Bancária",
"description": "Representação do schema para envio da entidade Transferência Bancária",
"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
},
"dataMovimentacao": {
"type": "string",
"format": "date"
},
"codigoMovimentacao": {
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoBancoContaBancariaOrigem",
"numeroAgenciaContaBancariaOrigem",
"numeroContaBancariaOrigem",
"tipoContaBancariaOrigem",
"codigoBancoContaBancariaDestino",
"numeroAgenciaContaBancariaDestino",
"numeroContaBancariaDestino",
"tipoContaBancariaDestino",
"valorTransferencia",
"dataMovimentacao",
"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,
"dataMovimentacao": "2025-09-11",
"codigoMovimentacao": "1234567",
"action": "CREATE"
}
]
}
Norma Orçamentária
Norma Orçamentária
Norma Orçamentária | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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
exercicio✅
Exercício que se refere a Lei
numeroLei✅
NNNNNAAAA
dataPublicacao✅
–
tipoLei–
Tabela Tipo Lei
protocoloTCE–
Ex.: 000000/00
tipoAutorizacao–
SIM / NAO
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 Leis Orçamentárias",
"description": "Lista de objetos representando a entidade Lei 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": "Lei Orçamentária",
"description": "Representação do schema para envio da entidade Lei Orçamentária",
"type": "object",
"properties": {
"exercicio": {
"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": [
"competencia",
"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": [
{
"exercicio": "2025",
"numeroLei": "123456789",
"dataPublicacao": "2025-09-11",
"tipoLei": "0",
"protocoloTCE": "000000/00",
"tipoAutorizacao": "SIM",
"valor": 5000000.00,
"action": "CREATE"
}
]
}
Ordenador
Ordenador
Ordenador | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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": 50
},
"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"
}
]
}
Pagamento
Pagamento
Pagamento | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
numeroPagamento✅
–
dataPagamento–
–
valorPagamento–
–
codigoFonteRecurso–
Definido pela Secretaria do Tesouro Nacional e disponibilizada pela Matriz de Saldos Contábeis - MSC
exercicioFonteRecurso–
Atual / Anterior
codigoBancoContaBancaria–
Código da FEBRABAN
numeroContaBancaria–
Conta bancária cadastrada pela Unidade Gestora para o exercício
tipoContaBancaria–
Tabela Tipo Conta Bancária
numeroAgenciaContaBancaria–
Conta bancária cadastrada pela Unidade Gestora para o exercício
cnpjGerenciaContaBancaria–
–
numeroDocumentoDebito–
–
codigoBancoContaBancariaCredito–
Código da FEBRABAN
numeroAgenciaContaBancariaCredito–
Conta do credor do pagamento (adicionar para as outras)
numeroContaBancariaCredito–
–
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": "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]+$"
},
"dataPagamento": {
"type": "string",
"format": "date"
},
"valorPagamento": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"exercicioFonteRecurso": {
"type": "string",
"enum": ["ATUAL", "ANTERIOR"]
},
"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
},
"codigoBancoContaBancariaCredito": {
"type": "string",
"maxLength": 3
},
"numeroAgenciaContaBancariaCredito": {
"type": "string",
"maxLength": 6
},
"numeroContaBancariaCredito": {
"type": "string",
"maxLength": 13
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroPagamento",
"dataPagamento",
"valorPagamento",
"codigoFonteRecurso",
"exercicioFonteRecurso",
"codigoBancoContaBancaria",
"numeroContaBancaria",
"tipoContaBancaria",
"numeroAgenciaContaBancaria",
"cnpjGerenciaContaBancaria",
"numeroDocumentoDebito",
"codigoBancoContaBancariaCredito",
"numeroAgenciaContaBancariaCredito",
"numeroContaBancariaCredito",
"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",
"dataPagamento": "2025-09-11",
"valorPagamento": 15000.00,
"codigoFonteRecurso": "100",
"exercicioFonteRecurso": "ATUAL",
"codigoBancoContaBancaria": "001",
"numeroContaBancaria": "12345678901",
"tipoContaBancaria": "1",
"numeroAgenciaContaBancaria": "1234",
"cnpjGerenciaContaBancaria": "12345678000195",
"numeroDocumentoDebito": "12345678901",
"codigoBancoContaBancariaCredito": "341",
"numeroAgenciaContaBancariaCredito": "5678",
"numeroContaBancariaCredito": "98765432100",
"action": "CREATE"
}
]
}
Pagamento Resto
Pagamento Resto
Pagamento Resto | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
numeroPagamentoResto✅
–
dataPagamentoResto–
–
valorPagamentoResto–
–
codigoBancoContaBancariaDebito–
–
numeroContaBancariaDebito–
–
numeroAgenciaContaBancariaDebito–
–
tipoContaBancariaDebito–
–
cnpjGerenciaContaBancariaDebito–
–
numeroCheque–
–
numeroDocDebito–
–
codigoBancoContaBancariaCredito–
–
numeroAgenciaContaBancariaCredito–
–
numeroContaBancariaCredito–
–
exercicioFonteRecurso–
Atual / Anterior
codigoFonteRecurso–
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
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 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]+$"
},
"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"
}
]
}
Programa
Programa
Programa | Schema V1 | 2025 - ∞
Tipo Envio: Orçamento/Diário Objeto Raiz
Campo Informações
timestampCampo 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"
}
]
}
Receita Extra
Receita Extra
Receita Extra | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente
elementos–
Campo Chave Informações
numeroReceitaExtra✅
–
exercicio✅ –
codigoContaContabil–
Constituído pela IPC 00 – STN e Ajustes do TCE-PB
dataReceitaExtra– –
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
anoEmissaoEmpenho –
–
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 Exemplo de Payload
Receita Orçamentária
Receita Orçamentária
Receita Orçamentária | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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",
"dataReceitaOrcamentaria",
"codigoCO",
"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"
}
]
}
Receita Prevista
Receita Prevista
Receita Prevista | Schema V1 | 2025 - ∞
Tipo Envio: Orçamento Objeto Raiz
Campo Informações
timestampCampo 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"
}
]
}
Retenção
Retenção
Retenção | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
numeroPaganmento✅
–
numeroRetencao✅
–
tipoRetencao✅
Tabela Tipo Retenção
dataRetencao–
–
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]+$"
},
"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]+$"
},
"dataRetencao": {
"type": "string",
"format": "date"
},
"valorRetencao": {
"type": "number",
"exclusiveMinimum": 0
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroPagamento",
"numeroRetencao",
"tipoRetencao",
"dataRetencao",
"valorRetencao",
"action"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "elementos"],
"additionalProperties": false
}Exemplo de Payload {
"timestamp": "2025-09-11T15:30:00.123456",
"elementos": [
{
"codigoUnidadeOrcamentaria": "17050",
"numeroEmpenho": "0001234",
"numeroPagamento": "0000001",
"numeroRetencao": "0000001",
"tipoRetencao": "1",
"dataRetencao": "2025-09-11",
"valorRetencao": 1500.00,
"action": "CREATE"
}
]
}
Retenção Resto
Retenção Resto
Retenção Resto | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
numeroPagamento✅
–
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]+$"
},
"numeroPagamento": {
"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"
}
]
}
Transferência Concedida
Transferência Concedida
Transferência Concedida| Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
dataTransferencia✅
–
tipoTransferencia✅
Tabela Tipo Transferência
tipoLancamento✅
Tabela Tipo Lancamento
valor–
–
numeroContaBancaria✅
–
codigoBancoContaBancaria✅
Código da FEBRABAN
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 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]+$"
},
"dataTransferencia": {
"type": "string",
"format": "date"
},
"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": "^[0-9]+$"
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeGestoraRecebedora",
"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": [
{
"codigoUnidadeGestoraRecebedora": "654321",
"dataTransferencia": "2025-09-11",
"tipoTransferencia": "1",
"tipoLancamento": "2",
"valor": 150000.50,
"numeroContaBancaria": "1234567890123",
"codigoBancoContaBancaria": "001",
"numeroAgenciaContaBancaria": "123456",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678000190",
"action": "CREATE"
},
{
"codigoUnidadeGestoraRecebedora": "789012",
"dataTransferencia": "2025-08-15",
"tipoTransferencia": "3",
"tipoLancamento": "1",
"valor": 75000.00,
"numeroContaBancaria": "9876543210987",
"codigoBancoContaBancaria": "033",
"numeroAgenciaContaBancaria": "654321",
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432000199",
"action": "DELETE"
}
]
}
Transferência Recebida
Transferência Recebida
Transferência Recebida | Schema V1 | 2025 - ∞
Tipo Envio: Diário Objeto Raiz
Campo Informações
timestampCampo 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✅
–
dataTransferencia✅
–
tipoTransferencia✅
Tabela Tipo Transferência
tipoLancamento✅
Tabela Tipo Lancamento
valor–
–
numeroContaBancaria✅
–
codigoBancoContaBancaria✅
Código da FEBRABAN
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 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]+$"
},
"dataTransferencia": {
"type": "string",
"format": "date"
},
"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": "^[0-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"
}
]
}
Unidade Orçamentária
Unidade Orçamentária
Unidade Orçamentária | Schema V1 | 2025 - ∞
Tipo Envio: Orçamento/Diário Objeto Raiz
Campo Informações
timestampCampo 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"
}
]
}