Liquidação | 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
liquidacoes
–
Item
Campo
Chave
Informações
codigoUnidadeGestora
✅
–
anoEmissaoEmpenho
✅
–
codigoUnidadeOrcamentaria
✅
Código da unidade orçamentária cadastrada pela Unidade Gestora para o exercício
numeroEmpenho
✅
–
numeroLiquidacao
✅
–
competencia
–
–
tipoNotaFiscal
–
–
numeroChaveNotaFiscal
–
–
numeroNotaFiscal
–
–
serieNotaFiscal
–
–
dataNotaFiscal
–
–
valorNotaFiscal
–
–
valorLiquidacao
–
–
codigoAgrupamentoFolha
–
–
action
–
Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "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"]
},
"liquidacoes": {
"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]+$"
},
"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": {
"type": "number",
"exclusiveMinimum": 0
},
"valorLiquidacao": {
"type": "number",
"exclusiveMinimum": 0
},
"codigoAgrupamentoFolha": {
"type": "string",
"maxLength": 10
},
"action": {
"type": "string",
"enum": ["CREATE", "UPDATE", "DELETE"]
}
},
"required": [
"codigoUnidadeGestora",
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"numeroLiquidacao",
"competencia",
"valorLiquidacao"
],
"additionalProperties": false
}
}
},
"required": ["timestamp", "liquidacoes"],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2026-03-02T11:32:45.123456",
"liquidacoes": [
{
"codigoUnidadeGestora": "123456",
"anoEmissaoEmpenho": "2026",
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000001",
"numeroLiquidacao"numero" : "0000001",
"competencia"data" : "2026-03-01"01032026" ,
"tipoNotaFiscal": "55",
"numeroChaveNotaFiscal": "35260312345678000195550010000012341234567890",
"numeroNotaFiscal": "000012026",
"serieNotaFiscal": "001",
"dataNotaFiscal": "2026-02-28"28022026" ,
"valorNotaFiscal": 150000.50,
"valorLiquidacao": 150000.50,
"codigoAgrupamentoFolha": "FOLHA2026",
"action": "CREATE"
},
{
"codigoUnidadeGestora": "654321",
"anoEmissaoEmpenho": "2026",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000002",
"numeroLiquidacao"numero" : "0000002",
"competencia"data" : "2026-03-02"02032026" ,
"tipoNotaFiscal": "65",
"numeroChaveNotaFiscal": "35260398765432000187550010000002341234567891",
"numeroNotaFiscal": "000022026",
"serieNotaFiscal": "002",
"dataNotaFiscal": "2026-03-01",
"valorNotaFiscal": 82500.00,
"valorLiquidacao": 82500.00,
"codigoAgrupamentoFolha": "FOLHA2026",
"action": "UPDATE"
}
]
}