Pagamento | Schema V1 | 2025 - ∞
Tipo Envio: Diário
Objeto Raiz
Campo
Informações
timestamp
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente
liquidacoespagamentos
–
Item
Campo
Chave
Informações
codigoUnidadeGestora
✅
–
anoEmissaoEmpenho
✅
–
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
✅
–
numeroPagamento
✅
–
competencia
–
–
tipoNotaFiscal
–
Tabela Tipo Nota Fiscal
numeroChaveNotaFiscalvalorPagamento
–
–
numeroNotaFiscalnumeroContaBancaria
–
–
serieNotaFiscalnumeroAgencia
–
–
dataNotaFiscalcodigoBanco
–
–
valorNotaFiscalnumeroCheque
–
–
valorLiquidacaonumeroDocDebito
–
–
codigoAgrupamentoFolhacodigoBancoCredito
–
–
numeroAgenciaCredito
–
–
numeroContaBancariaCredito
–
–
exercicioFonteRecurso
–
Atual / Anterior
codigoFonteRecurso
–
–
tipoContaBancaria
–
–
cnpjGerenciaContaBancaria
–
–
action
–
Define a operação a ser realizada com a informação, seja ela c criação,riação, atualização ou exclusão
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Liquidações"Pagamentos" ,
"description": "Schema para envio de liquidaçõespagamentos 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"]
},
"liquidacoes"pagamentos" : {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"codigoUnidadeGestora": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"anoEmissaoEmpenho": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"pattern": "^(19|20)[0-9]{2}$"
},
"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]+$"
},
" competencia": {
"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"valorPagamento" : {
"type": "number",
"exclusiveMinimum": 0
},
"valorLiquidacao": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoAgrupamentoFolha"numeroContaBancaria" : {
"type": "string",
"maxLength": 1013
},
"numeroAgencia": {
"type": "string",
"maxLength": 6
},
"codigoBanco": {
"type": "string",
"maxLength": 3
},
"numeroCheque": {
"type": "string",
"maxLength": 6
},
"numeroDocDebito": {
"type": "string",
"maxLength": 11
},
"codigoBancoCredito": {
"type": "string",
"maxLength": 3
},
"numeroAgenciaCredito": {
"type": "string",
"maxLength": 6
},
"numeroContaBancariaCredito": {
"type": "string",
"maxLength": 13
},
"exercicioFonteRecurso": {
"type": "string",
"enum": ["ATUAL", "ANTERIOR"]
},
"codigoFonteRecurso": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]+$"
},
"tipoContaBancaria": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"pattern": "^[0-9]+$"
},
"cnpjGerenciaContaBancaria": {
"type": "string",
"minLength": 14,
"maxLength": 14
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeGestora",
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"numeroPagamento",
" competencia",
"valorLiquidacao"valorPagamento",
"numeroContaBancaria",
"numeroAgencia",
"codigoBanco",
"codigoFonteRecurso",
"tipoContaBancaria",
"cnpjGerenciaContaBancaria"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "liquidacoes"pagamentos" ],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2026-03-02T11:32:45.123456",
"liquidacoes"pagamentos" : [
{
"codigoUnidadeGestora": "123456",
"anoEmissaoEmpenho": "2026",
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000001",
"numero"numeroLiquidacao" : "0000001",
"data"numeroPagamento" : "2023-01-02"0000001" ,
"tipoNotaFiscal"competencia" : "55"2026-03-01" ,
"numeroChaveNotaFiscal"valorPagamento": 150000.50,
"numeroContaBancaria" : "35260312345678000195550010000012341234567890"0123456789012" ,
"numeroNotaFiscal"numeroAgencia" : "000012026"00123" ,
"serieNotaFiscal"codigoBanco" : "001",
"dataNotaFiscal"numeroCheque" : "2026-02-02"000001" ,
"valorNotaFiscal": 150000.50,
"valorLiquidacao": 150000.50,
"codigoAgrupamentoFolha"numeroDocDebito" : "FOLHA2026"00000000001",
"codigoBancoCredito": "341",
"numeroAgenciaCredito": "00456",
"numeroContaBancariaCredito": "9876543210001",
"exercicioFonteRecurso": "ATUAL",
"codigoFonteRecurso": "500",
"tipoContaBancaria": "1",
"cnpjGerenciaContaBancaria": "12345678000195" ,
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"anoEmissaoEmpenho": "2026",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000002",
"numero"numeroLiquidacao" : "0000002",
"data"numeroPagamento": "0000002",
"competencia" : "2026-02-03"03-02" ,
"valorLiquidacao"valorPagamento" : 82500.00,
"numeroContaBancaria": "9876543210987",
"numeroAgencia": "00789",
"codigoBanco": "237",
"codigoFonteRecurso": "501",
"tipoContaBancaria": "2",
"cnpjGerenciaContaBancaria": "98765432000187",
"action": "UPDATE"
}
]
}