Payment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wildapricot/refs/heads/main/json-schema/wildapricot-payment-schema.json",
  "title": "Payment",
  "description": "Payment schema from WildApricot Admin API",
  "allOf": [
    {
      "$ref": "#/components/schemas/FinanceDocument"
    },
    {
      "type": "object",
      "properties": {
        "Tender": {
          "$ref": "#/components/schemas/LinkedResourceWithName"
        },
        "Comment": {
          "type": "string",
          "description": "Internal note on payment. Visible to administrators only."
        },
        "PublicComment": {
          "type": "string",
          "description": "Comment on payment. Visible to both administrators and payors."
        },
        "AllocatedValue": {
          "type": "number",
          "format": "float",
          "description": "Total amount allocated to another finance documents (invoices or refunds)."
        },
        "RefundedAmount": {
          "type": "number",
          "format": "decimal",
          "description": "Amount of a refund assigned to the payment."
        },
        "Type": {
          "$ref": "#/components/schemas/PaymentType"
        },
        "DonationId": {
          "type": "integer",
          "description": "Identifyer of Donation for payment of type DonationPayment."
        },
        "FieldValues": {
          "type": "array",
          "description": "For each custom field you have added to your Wild Apricot database, the name of the field, its system code, and its value for this donation are returned. The system code is a unique field identifier that can be used instead of the field name to identify the field. As well, a number of system fields are returned.",
          "items": {
            "$ref": "#/components/schemas/FieldValue"
          }
        }
      }
    }
  ]
}