Convênios

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "document": {
      "type": "string",
      "pattern": "^(?:[0-9A-Za-z]{12}\\d{2}|[0-9A-Za-z]{2}\\.[0-9A-Za-z]{3}\\.[0-9A-Za-z]{3}\\/[0-9A-Za-z]{4}-\\d{2})$",
      "description": "CNPJ completo, com ou sem pontuação.",
      "title": "CNPJ"
    }
  },
  "required": [
    "document"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "document": "19131243000197"
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "const": "list",
      "description": "Coleção de objetos Base39."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "const": "public_agreement",
            "description": "Tipo do objeto Base39."
          },
          "record_type": {
            "type": "string",
            "enum": [
              "agreement",
              "bank_order"
            ],
            "description": "Tipo de registro."
          },
          "number": {
            "type": "string",
            "description": "Número de identificação."
          },
          "original_number": {
            "type": "string",
            "description": "Número original do convênio."
          },
          "case_number": {
            "type": "string",
            "description": "Número do processo administrativo."
          },
          "purpose": {
            "type": "string",
            "description": "Objeto informado."
          },
          "status": {
            "type": "string",
            "description": "Situação informada."
          },
          "instrument_type": {
            "type": "string",
            "description": "Tipo de instrumento."
          },
          "recipient_type": {
            "type": "string",
            "description": "Tipo do convenente."
          },
          "recipient_entity_type": {
            "type": "string",
            "description": "Tipo de ente convenente."
          },
          "recipient_name": {
            "type": "string",
            "description": "Nome do convenente."
          },
          "city_code": {
            "type": "string",
            "description": "Código do município."
          },
          "city": {
            "type": "string",
            "description": "Município."
          },
          "state": {
            "type": "string",
            "description": "Unidade federativa."
          },
          "parent_authority_code": {
            "type": "string",
            "description": "Código do órgão superior."
          },
          "parent_authority_name": {
            "type": "string",
            "description": "Nome do órgão superior."
          },
          "granting_authority_code": {
            "type": "string",
            "description": "Código do órgão concedente."
          },
          "granting_authority_name": {
            "type": "string",
            "description": "Nome do órgão concedente."
          },
          "granting_management_unit_code": {
            "type": "string",
            "description": "Código da unidade gestora concedente."
          },
          "granting_management_unit_name": {
            "type": "string",
            "description": "Nome da unidade gestora concedente."
          },
          "amount": {
            "type": "string",
            "pattern": "^-?\\d+(?:\\.\\d+)?$",
            "description": "Valor em reais, como texto decimal."
          },
          "released_amount": {
            "type": "string",
            "pattern": "^-?\\d+(?:\\.\\d+)?$",
            "description": "Valor liberado em reais."
          },
          "counterpart_amount": {
            "type": "string",
            "pattern": "^-?\\d+(?:\\.\\d+)?$",
            "description": "Valor da contrapartida em reais."
          },
          "publication_date": {
            "type": "string",
            "format": "date",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
            "description": "Data da publicação."
          },
          "start_date": {
            "type": "string",
            "format": "date",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
            "description": "Data de início."
          },
          "end_date": {
            "type": "string",
            "format": "date",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
            "description": "Data de término."
          },
          "last_release_date": {
            "type": "string",
            "format": "date",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
            "description": "Data da última liberação."
          },
          "last_release_amount": {
            "type": "string",
            "pattern": "^-?\\d+(?:\\.\\d+)?$",
            "description": "Valor da última liberação em reais."
          },
          "agreement_number": {
            "type": "string",
            "description": "Número do convênio."
          },
          "bank_order_number": {
            "type": "string",
            "description": "Número da ordem bancária."
          },
          "issued_at": {
            "type": "string",
            "format": "date",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
            "description": "Data de emissão."
          }
        },
        "required": [
          "object",
          "record_type"
        ],
        "additionalProperties": false
      },
      "description": "Objetos da coleção."
    },
    "next_cursor": {
      "description": "Cursor opaco da próxima página; ausente ao final.",
      "type": "string"
    },
    "document": {
      "type": "string",
      "minLength": 1,
      "description": "CPF ou CNPJ informado pela fonte; pode estar mascarado."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "description": "Data e hora da última atualização publicada, em ISO 8601."
    }
  },
  "required": [
    "object",
    "data",
    "document"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "object": "list",
      "data": [
        {
          "object": "public_agreement",
          "record_type": "agreement",
          "number": "V1",
          "purpose": "Objeto de teste",
          "recipient_name": "Empresa de teste",
          "amount": "100.00",
          "released_amount": "0.00",
          "start_date": "2025-01-02"
        }
      ],
      "document": "19131243000197",
      "updated_at": "2026-11-01T00:00:00Z"
    }
  ]
}