PaymentPositionsInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pagopa/main/json-schema/pagopa-payment-positions-info-schema.json",
  "title": "PaymentPositionsInfo",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pagopa-gpd-aca-openapi.yml#/components/schemas/PaymentPositionsInfo",
  "required": [
    "page_info",
    "payment_position_list"
  ],
  "type": "object",
  "properties": {
    "payment_position_list": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PaymentPositionModelBaseResponse"
      }
    },
    "page_info": {
      "$ref": "#/$defs/PageInfo"
    }
  },
  "$defs": {
    "PageInfo": {
      "required": [
        "items_found",
        "limit",
        "page",
        "total_pages"
      ],
      "type": "object",
      "properties": {
        "page": {
          "type": "integer",
          "description": "Page number",
          "format": "int32"
        },
        "limit": {
          "type": "integer",
          "description": "Required number of items per page",
          "format": "int32"
        },
        "items_found": {
          "type": "integer",
          "description": "Number of items found. (The last page may have fewer elements than required)",
          "format": "int32"
        },
        "total_pages": {
          "type": "integer",
          "description": "Total number of pages",
          "format": "int32"
        }
      }
    },
    "PaymentOptionMetadataModelResponse": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "PaymentOptionModelResponse": {
      "type": "object",
      "properties": {
        "nav": {
          "type": "string"
        },
        "iuv": {
          "type": "string"
        },
        "organizationFiscalCode": {
          "type": "string"
        },
        "amount": {
          "type": "integer",
          "format": "int64"
        },
        "description": {
          "type": "string"
        },
        "isPartialPayment": {
          "type": "boolean"
        },
        "dueDate": {
          "type": "string",
          "format": "date-time"
        },
        "retentionDate": {
          "type": "string",
          "format": "date-time"
        },
        "paymentDate": {
          "type": "string",
          "format": "date-time"
        },
        "reportingDate": {
          "type": "string",
          "format": "date-time"
        },
        "insertedDate": {
          "type": "string",
          "format": "date-time"
        },
        "paymentMethod": {
          "type": "string"
        },
        "fee": {
          "type": "integer",
          "format": "int64"
        },
        "notificationFee": {
          "type": "integer",
          "format": "int64"
        },
        "pspCompany": {
          "type": "string"
        },
        "idReceipt": {
          "type": "string"
        },
        "idFlowReporting": {
          "type": "string"
        },
        "status": {
          "enum": [
            "PO_UNPAID",
            "PO_PAID",
            "PO_PARTIALLY_REPORTED",
            "PO_REPORTED"
          ],
          "type": "string"
        },
        "lastUpdatedDate": {
          "type": "string",
          "format": "date-time"
        },
        "paymentOptionMetadata": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PaymentOptionMetadataModelResponse"
          }
        },
        "transfer": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TransferModelResponse"
          }
        }
      }
    },
    "PaymentPositionModelBaseResponse": {
      "type": "object",
      "properties": {
        "iupd": {
          "type": "string"
        },
        "organizationFiscalCode": {
          "type": "string"
        },
        "type": {
          "enum": [
            "F",
            "G"
          ],
          "type": "string"
        },
        "companyName": {
          "type": "string"
        },
        "officeName": {
          "type": "string"
        },
        "insertedDate": {
          "type": "string",
          "format": "date-time"
        },
        "publishDate": {
          "type": "string",
          "format": "date-time"
        },
        "validityDate": {
          "type": "string",
          "format": "date-time"
        },
        "paymentDate": {
          "type": "string",
          "format": "date-time"
        },
        "status": {
          "enum": [
            "DRAFT",
            "PUBLISHED",
            "VALID",
            "INVALID",
            "EXPIRED",
            "PARTIALLY_PAID",
            "PAID",
            "REPORTED"
          ],
          "type": "string"
        },
        "lastUpdatedDate": {
          "type": "string",
          "format": "date-time"
        },
        "paymentOption": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PaymentOptionModelResponse"
          }
        }
      }
    },
    "Stamp": {
      "required": [
        "hashDocument",
        "provincialResidence",
        "stampType"
      ],
      "type": "object",
      "properties": {
        "hashDocument": {
          "maxLength": 72,
          "minLength": 0,
          "type": "string",
          "description": "Document hash type is stBase64Binary72 as described in https://github.com/pagopa/pagopa-api."
        },
        "stampType": {
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "description": "The type of the stamp"
        },
        "provincialResidence": {
          "pattern": "[A-Z]{2}",
          "type": "string",
          "description": "The provincial of the residence"
        }
      }
    },
    "TransferMetadataModelResponse": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "TransferModelResponse": {
      "type": "object",
      "properties": {
        "organizationFiscalCode": {
          "type": "string"
        },
        "companyName": {
          "type": "string"
        },
        "idTransfer": {
          "type": "string"
        },
        "amount": {
          "type": "integer",
          "format": "int64"
        },
        "remittanceInformation": {
          "type": "string"
        },
        "category": {
          "type": "string"
        },
        "iban": {
          "type": "string"
        },
        "postalIban": {
          "type": "string"
        },
        "stamp": {
          "$ref": "#/$defs/Stamp"
        },
        "insertedDate": {
          "type": "string",
          "format": "date-time"
        },
        "status": {
          "enum": [
            "T_UNREPORTED",
            "T_REPORTED"
          ],
          "type": "string"
        },
        "lastUpdatedDate": {
          "type": "string",
          "format": "date-time"
        },
        "transferMetadata": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TransferMetadataModelResponse"
          }
        }
      }
    }
  }
}