Ir para o conteúdo principal

Liquidação Resto | 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
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"
    }
  ]
}

Nenhum comentário para exibir

Voltar ao topo