[WIP] - Resto Inscrito | 2025 -
Tipo Envio: Balancete - Contabilidade
Chave Unicidade
[ Exercício - Código Unidade Gestora - Ano Emissão Empenho - Código Unidade Orçamentária - Número Empenho ]
Objeto Raiz
Campo
Informações
timestamp
Campo utilizado para ordenar a validação das informações enviadas. Caso sejam enviados múltiplos payloads do mesmo tipo, a ordenação ocorrerá da data mais antiga para a mais recente
elementos
–
Item
Campo
Chave
Informações
anoEmissaoEmpenho
✅
–
codigoUnidadeOrcamentaria
✅
–
numeroEmpenho
✅
–
codigoUnidadeGestoraOrigem
–
–
valorInscrito
–
–
valorProcessado
–
–
valorNaoProcessado
–
–
action
–
Define a operação a ser realizada com a informação, seja ela criação, atualização ou exclusão
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Lista de Restos Inscritos",
"description": "Lista de objetos representando a entidade Restos Inscritos",
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)\\.\\d{3,6}$",
"examples": ["2025-09-11T15:30:00.123456"]
},
"elementos": {
"type": "array",
"uniqueItems": true,
"items": {
"title": "Restos Inscritos",
"description": "Representação do schema para envio da entidade Restos Inscritos",
"type": "object",
"properties": {
"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]+$"
},
"codigoUnidadeGestoraOrigem": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "^[0-9]+$"
},
"valorInscrito": {
"type": "number",
"exclusiveMinimum": 0
},
"valorProcessado": {
"type": "number",
"minimum": 0
},
"valorNaoProcessado": {
"type": "number",
"minimum": 0
},
"action": {
"type": "string",
"enum": [
"CREATE",
"UPDATE",
"DELETE"
]
}
},
"required": [
"anoEmissaoEmpenho",
"codigoUnidadeOrcamentaria",
"numeroEmpenho",
"codigoUnidadeGestoraOrigem",
"valorInscrito",
"valorProcessado",
"valorNaoProcessado",
"action"
],
"additionalProperties": false
}
}
},
"required": [
"timestamp",
"elementos"
],
"additionalProperties": false
}
Exemplo de Payload
{
"timestamp": "2025-12-11T15:30:00.123456",
"elementos": [
{
"anoEmissaoEmpenho": "2025",
"codigoUnidadeOrcamentaria": "12345",
"numeroEmpenho": "0000001",
"codigoUnidadeGestoraOrigem": "123456",
"valorInscrito": 10000.00,
"valorProcessado": 8000.00,
"valorNaoProcessado": 2000.00,
"action": "CREATE"
},
{
"anoEmissaoEmpenho": "2024",
"codigoUnidadeOrcamentaria": "54321",
"numeroEmpenho": "0000002",
"codigoUnidadeGestoraOrigem": "654321",
"valorInscrito": 15000.00,
"valorProcessado": 12000.00,
"valorNaoProcessado": 3000.00,
"action": "CREATE"
}
]
}
Regras
ID
Regra
RESTOS_INSCRITOS_DUPLICIDADE_NAO_PERMITIDA
Não é permitido cadastrar registros duplicados pela chave de unicidade
RESTOS_INSCRITOS_APENAS_DEZEMBRO
Restos a pagar são aceitos apenas no balancete de dezembro
RESTOS_INSCRITOS_VALORES_CONSISTENTES
Valores inscritos devem ser os mesmos valores a pagar dos empenhos do exercício