eedm.contributions.v16.0.0.contributions.json Maven / Gradle / Ivy
{
"title" : "Contributions",
"description" : "The contributions (gifts, pledges, pledge payments, etc.) made to the institution.",
"version" : "16.0.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the contribution.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"title" : {
"title" : "Title",
"description" : "The full name of the contribution.",
"type" : "string",
"minLength" : 1
},
"type" : {
"title" : "Type",
"description" : "The type of the contribution (e.g. gift, pledge).",
"enum" : [ "gift", "pledge", "pledgePayment", "recurringContribution", "matchingGift", "bequestExpectancy", "bequestPayment", "membershipDuesPayment" ],
"type" : "string"
},
"activityDates" : {
"title" : "Activity Dates",
"description" : "A list of event dates associated with the contribution.",
"type" : "array",
"minItems" : 1,
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The type of the activity associated with the contribution.",
"enum" : [ "entered", "contributed", "transmittedToGL", "receipted", "canceled", "deposited", "adjusted", "acknowledged", "posted" ],
"type" : "string"
},
"occurredOn" : {
"title" : "Occurred On",
"description" : "The date on which the activity associated with the contribution occurred.",
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}
},
"additionalProperties" : false,
"required" : [ "type", "occurredOn" ]
}
},
"fiscalYear" : {
"title" : "Fiscal Year",
"description" : "The fiscal year to which the contribution is applied.",
"type" : "string"
},
"contributionNumber" : {
"title" : "Contribution Number",
"description" : "An assigned number to identify the contribution.",
"type" : "number"
},
"proposal" : {
"title" : "Proposal",
"description" : "The proposal associated with the contribution.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Proposal.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/proposals/{id}",
"targetSchema" : {
"$ref" : "proposals.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"amounts" : {
"title" : "Amounts",
"description" : "The monetary amounts associated with the contribution.",
"type" : "object",
"properties" : {
"primary" : {
"title" : "Primary",
"description" : "The primary amount of the contribution.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"initialValue" : {
"title" : "Initial Value",
"description" : "The initial value specified for the contribution.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"futureValue" : {
"title" : "Future Value",
"description" : "The future value specified for the contribution.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"remainderValue" : {
"title" : "Remainder Value",
"description" : "The remainder value specified for the contribution.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"faceValue" : {
"title" : "Face Value",
"description" : "The face value of the contribution.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"marketValue" : {
"title" : "Market Value",
"description" : "The market value of the contribution.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"deductible" : {
"title" : "Deductible",
"description" : "The deductible amount of the contribution.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"presentValue" : {
"title" : "Present Value",
"description" : "The present value of the contribution.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "primary" ]
},
"anonymity" : {
"title" : "anonymity",
"description" : "The level of anonymity that should be applied to the contribution.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"level" : {
"title" : "Level",
"description" : "The level of anonymity (withhold amount, name, or all information) of the contribution.",
"enum" : [ "amount", "name", "all" ],
"type" : "string"
},
"detail" : {
"title" : "Detail",
"description" : "A user defined level of anonymity to be applied to the contribution,",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Detail.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/anonymity-types/{id}",
"targetSchema" : {
"$ref" : "anonymity-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "level" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"paymentFor" : {
"title" : "Payment For",
"description" : "The contribution or membership for which the payment was made.",
"oneOf" : [ {
"title" : "Contribution",
"description" : "The contribution for which the payment was made.",
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The type of the contribution for which the payment was made.",
"enum" : [ "pledge", "bequest", "recurringContribution" ],
"type" : "string"
},
"contribution" : {
"title" : "Contribution",
"description" : "The contribution for which the payment was made.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Contribution.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/contributions/{id}",
"targetSchema" : {
"$ref" : "contributions.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "type", "contribution" ]
}, {
"title" : "Membership",
"description" : "The membership for which the payment was made.",
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "An indication that the contribution was a payment for a membership.",
"enum" : [ "membership" ],
"type" : "string"
},
"membership" : {
"title" : "Membership",
"description" : "The membership for which the payment was made.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Membership.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-program-level-memberships/{id}",
"targetSchema" : {
"$ref" : "constituent-program-level-memberships.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "type", "membership" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"allocations" : {
"title" : "Allocations",
"description" : "Allocation of the contribution among donors to assign donation credit and to map to designations.",
"type" : "array",
"minItems" : 1,
"items" : {
"type" : "object",
"properties" : {
"donor" : {
"title" : "Donor",
"description" : "A person or organization associated with the contribution.",
"oneOf" : [ {
"title" : "Person",
"description" : "The person associated with the contribution.",
"type" : "object",
"properties" : {
"person" : {
"title" : "Person",
"description" : "The person associated with the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Person.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-persons/{id}",
"targetSchema" : {
"$ref" : "constituent-persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "person" ]
}, {
"title" : "Organization",
"description" : "The organization associated with the contribution.",
"type" : "object",
"properties" : {
"organization" : {
"title" : "Organization",
"description" : "The organization associated with the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Organization.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-organizations/{id}",
"targetSchema" : {
"$ref" : "constituent-organizations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "organization" ]
} ]
},
"constituentTypes" : {
"title" : "Constituent Types",
"description" : "The types of constituent that the donor represents.",
"type" : "array",
"items" : {
"title" : "Constituent Types",
"description" : "The types of constituent that the donor represents.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Constituent Types.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-types/{id}",
"targetSchema" : {
"$ref" : "constituent-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"designation" : {
"title" : "Designation",
"description" : "The designated use of the donor's allocation of the contribution.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Designation.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/designations/{id}",
"targetSchema" : {
"$ref" : "designations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"designatedClassYear" : {
"title" : "Designated Class Year",
"description" : "The class year associated with the donor's allocation of the contribution.",
"oneOf" : [ {
"type" : "string",
"format" : "year",
"pattern" : "^([1-9][0-9]*)?[0-9]{4}$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"donorAssociationType" : {
"title" : "Donor Association Type",
"description" : "The association between the donor and the contribution for the allocation. For example, a donor can be primary or 'in memory of' with regard to the contribution allocation.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Donor Association Type.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/donor-association-types/{id}",
"targetSchema" : {
"$ref" : "donor-association-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"credits" : {
"title" : "Credits",
"description" : "The types and amounts of credit given to the donor for the allocation of the contribution.",
"type" : "array",
"minItems" : 1,
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The type of credit given to the donor.",
"enum" : [ "legal", "recognition", "match", "soft", "other", "campaign" ],
"type" : "string"
},
"amount" : {
"title" : "Amount",
"description" : "The amount of credit of the specified type given to the donor.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "type" ]
}
},
"campaign" : {
"title" : "Campaign",
"description" : "The fund-raising campaign associated with the donor's allocation of the contribution.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Campaign.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/campaigns/{id}",
"targetSchema" : {
"$ref" : "campaigns.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"appealCommunicationEffort" : {
"title" : "Appeal Communication Effort",
"description" : "The appeal communication effort associated with the donor's allocation of the contribution.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Appeal Communication Effort.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/communication-activity-efforts/{id}",
"targetSchema" : {
"$ref" : "communication-activity-efforts.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "donor", "donorAssociationType", "credits" ]
}
},
"givingClassifications" : {
"title" : "Giving Classifications",
"description" : "A categorization of the contribution for reporting and tracking purposes.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"classification" : {
"title" : "Classification",
"description" : "The user defined categorization of the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Classification.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/giving-classifications/{id}",
"targetSchema" : {
"$ref" : "giving-classifications.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"amount" : {
"title" : "Amount",
"description" : "The amount of the contribution associated with the giving classification.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"designation" : {
"title" : "Designation",
"description" : "The designated use of the amount associated with the giving classification.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Designation.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/designations/{id}",
"targetSchema" : {
"$ref" : "designations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"comment" : {
"title" : "Comment",
"description" : "The comment associated with the giving classification.",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "classification" ]
}
},
"solicitationMethod" : {
"title" : "Solicitation Method",
"description" : "The solicitation method associated with the contribution, e.g. direct mail, in person, online event, and phonathon, etc.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Solicitation Method.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/solicitation-methods/{id}",
"targetSchema" : {
"$ref" : "solicitation-methods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"communicationPlans" : {
"title" : "Communication Plans",
"description" : "The communication plans associated with the contribution.",
"type" : "array",
"items" : {
"title" : "Communication Plans",
"description" : "The communication plans associated with the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Communication Plans.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/communication-plans/{id}",
"targetSchema" : {
"$ref" : "communication-plans.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"specialHandlingInstructions" : {
"title" : "Special Handling Instructions",
"description" : "The list of special handling instructions applicable to the contribution, e.g. no reminders, notify comptroller, notify president's office, etc.",
"type" : "array",
"items" : {
"title" : "Special Handling Instructions",
"description" : "The list of special handling instructions applicable to the contribution, e.g. no reminders, notify comptroller, notify president's office, etc.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Special Handling Instructions.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/contribution-special-handling-instructions/{id}",
"targetSchema" : {
"$ref" : "contribution-special-handling-instructions.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"category" : {
"title" : "Category",
"description" : "A user defined category associated with the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Category.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/contribution-categories/{id}",
"targetSchema" : {
"$ref" : "contribution-categories.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"premiumAssignments" : {
"title" : "Premium Assignments",
"description" : "The premiums assigned as a result of the contribution.",
"type" : "array",
"items" : {
"title" : "Premium Assignments",
"description" : "The premiums assigned as a result of the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Premium Assignments.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-premiums/{id}",
"targetSchema" : {
"$ref" : "constituent-premiums.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"payments" : {
"title" : "Payments",
"description" : "Details of the payments included with the contribution.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"method" : {
"title" : "Method",
"description" : "The method by which the payment was received.",
"type" : "object",
"properties" : {
"tenderType" : {
"title" : "Tender Type",
"description" : "The type of payment (e.g. local currency, foreign currency, e-commerce) associated with the payment method.",
"enum" : [ "localCurrency", "eCommerce", "foreignCurrency", "insurance", "security", "giftInKind", "payrollDeduction" ],
"type" : "string"
},
"detail" : {
"title" : "Detail",
"description" : "The user defined payment type associated with the payment method.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Detail.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/contribution-payment-types/{id}",
"targetSchema" : {
"$ref" : "contribution-payment-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "tenderType" ]
},
"externalReference" : {
"title" : "External Reference",
"description" : "Reference information about a payment (as required based on payment method). This can be a confirmation number, credit card transaction code, or check number.",
"type" : "string"
},
"tenderTypeDetail" : {
"title" : "Tender Type Detail",
"description" : "Details associated with the type of payment.",
"oneOf" : [ {
"title" : "Foreign Currency",
"description" : "Details about a contribution payment when it is received in a foreign currency.",
"type" : "object",
"properties" : {
"foreignCurrency" : {
"title" : "Foreign Currency",
"description" : "Details about a contribution payment when it is received in a foreign currency.",
"type" : "object",
"properties" : {
"amount" : {
"title" : "Amount",
"description" : "The amount of the payment in the foreign currency.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"localCurrencyAmount" : {
"title" : "Local Currency Amount",
"description" : "The value of the payment in the local currency.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"exchangeRate" : {
"title" : "Exchange Rate",
"description" : "The rate of exchange used to convert the foreign currency to the local currency value.",
"type" : "number"
},
"exchangeFee" : {
"title" : "Exchange Fee",
"description" : "The fee paid to convert the foreign currency to the local currency.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "amount", "localCurrencyAmount", "exchangeRate" ]
}
},
"additionalProperties" : false,
"required" : [ "foreignCurrency" ]
}, {
"title" : "Gift In Kind",
"description" : "Details about the gift in kind asset exchanged as a contribution payment.",
"type" : "object",
"properties" : {
"giftInKind" : {
"title" : "Gift In Kind",
"description" : "Details about the gift in kind asset exchanged as a contribution payment.",
"type" : "object",
"properties" : {
"description" : {
"title" : "Description",
"description" : "A brief description of the gift in kind payment.",
"type" : "string"
},
"amount" : {
"title" : "Amount",
"description" : "The amount of the payment.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"liquidation" : {
"title" : "Liquidation",
"description" : "Details about the liquidation of the gift in kind payment such as amount, fee and date liquidated.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"amount" : {
"title" : "Amount",
"description" : "The amount received when the asset was liquidated.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"fee" : {
"title" : "Fee",
"description" : "The fee or cost involved in liquidating the asset.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"soldOn" : {
"title" : "Sold On",
"description" : "The date on which the asset was sold.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"appraisal" : {
"title" : "Appraisal",
"description" : "Details about the appraisal of the gift in kind payment such as amount, fee and date appraised.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"amount" : {
"title" : "Amount",
"description" : "The appraised amount of the gift in kind asset received from an external appraiser.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"fee" : {
"title" : "Fee",
"description" : "The fee incurred for an external appraisal of the gift in kind payment.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"asOf" : {
"title" : "As Of",
"description" : "The date when the external appraisal was acquired for the gift in kind payment.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "amount" ]
}
},
"additionalProperties" : false,
"required" : [ "giftInKind" ]
}, {
"title" : "Insurance",
"description" : "Details about the insurance policy received as a contribution payment.",
"type" : "object",
"properties" : {
"insurance" : {
"title" : "Insurance",
"description" : "Details about the insurance policy received as a contribution payment.",
"type" : "object",
"properties" : {
"description" : {
"title" : "Description",
"description" : "A brief description of the insurance policy received as a payment.",
"type" : "string"
},
"amount" : {
"title" : "Amount",
"description" : "The amount of the payment.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"policy" : {
"title" : "Policy",
"description" : "Details about the insurance policy that was received as a contribution payment.",
"type" : "object",
"properties" : {
"number" : {
"title" : "Number",
"description" : "The policy number assigned to the policy by the insurer at the time of issuance.",
"type" : "string"
},
"status" : {
"title" : "Status",
"description" : "The institution defined status of the insurance policy.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Status.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/contribution-insurance-policy-statuses/{id}",
"targetSchema" : {
"$ref" : "contribution-insurance-policy-statuses.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"policyDate" : {
"title" : "Policy Date",
"description" : "The date the insurance policy was issued.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"ownership" : {
"title" : "Ownership",
"description" : "An indication if the institution is the owner of the insurance policy.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "institutionOwned" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"minProperties" : 1
}
},
"additionalProperties" : false,
"required" : [ "amount" ]
}
},
"additionalProperties" : false,
"required" : [ "insurance" ]
}, {
"title" : "Security",
"description" : "Details about the security received as a contribution payment.",
"type" : "object",
"properties" : {
"security" : {
"title" : "Security",
"description" : "Details about the security received as a contribution payment.",
"type" : "object",
"properties" : {
"description" : {
"title" : "Description",
"description" : "A brief description of the security received as a payment.",
"type" : "string"
},
"amount" : {
"title" : "Amount",
"description" : "The amount of the payment.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"shareQuantity" : {
"title" : "Share Quantity",
"description" : "The number of shares of the security transferred as a contribution payment.",
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
"securityExchange" : {
"title" : "Security Exchange",
"description" : "The security exchange where the security is listed.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Security Exchange.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/security-exchanges/{id}",
"targetSchema" : {
"$ref" : "security-exchanges.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"symbol" : {
"title" : "Symbol",
"description" : "The stock symbol of the security received as a contribution payment.",
"type" : "string"
},
"transferDetail" : {
"title" : "Transfer Detail",
"description" : "Details about the transfer of the security received as a contribution payment.",
"type" : "object",
"properties" : {
"valuation" : {
"title" : "Valuation",
"description" : "Details about the valuation of the security received as a contribution payment.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"highValue" : {
"title" : "High Value",
"description" : "The highest trading value of the security on the valuation date.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"lowValue" : {
"title" : "Low Value",
"description" : "The lowest trading value of the security on the valuation date.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"shareValue" : {
"title" : "Share Value",
"description" : "The per share value determined for the security received as a contribution payment.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"shareValueOn" : {
"title" : "Share Value On",
"description" : "The date when the per share value was determined.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"transferOn" : {
"title" : "Transfer On",
"description" : "The date when the security was transferred to the institution.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"brokerageFirm" : {
"title" : "Brokerage Firm",
"description" : "The organization that executed the transfer of the security to the institution.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Brokerage Firm.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-organizations/{id}",
"targetSchema" : {
"$ref" : "constituent-organizations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false
},
"revaluation" : {
"title" : "Revaluation",
"description" : "The total reassessed amount for the security.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"revaluationOn" : {
"title" : "Revaluation On",
"description" : "The date when the security was reassessed.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"soldOn" : {
"title" : "Sold On",
"description" : "The date when the security was sold.",
"oneOf" : [ {
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"depositAmount" : {
"title" : "Deposit Amount",
"description" : "The amount deposited from the sale of the security.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "amount" ]
}
},
"additionalProperties" : false,
"required" : [ "security" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "method" ]
}
},
"specifics" : {
"title" : "Specifics",
"description" : "Attributes that are specific to the type of contribution.",
"oneOf" : [ {
"title" : "Pledge",
"description" : "Details for a pledge contribution.",
"type" : "object",
"properties" : {
"pledge" : {
"title" : "Pledge",
"description" : "Details for a pledge contribution.",
"type" : "object",
"properties" : {
"status" : {
"title" : "Status",
"description" : "The status of the pledge.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Status.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/pledge-statuses/{id}",
"targetSchema" : {
"$ref" : "pledge-statuses.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"paymentSchedule" : {
"title" : "Payment Schedule",
"description" : "The scheduled payments expected for the pledge.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"expectedOn" : {
"title" : "Expected On",
"description" : "The date the payment is expected.",
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"expectedAmount" : {
"title" : "Amount",
"description" : "The expected amount of the payment.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"paidOn" : {
"title" : "Paid On",
"description" : "The date the payment was received.",
"oneOf" : [ {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"paidAmount" : {
"title" : "Paid Amount",
"description" : "The actual amount of the payment.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"designation" : {
"title" : "Designation",
"description" : "The designation assigned to the expected payment.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Designation.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/designations/{id}",
"targetSchema" : {
"$ref" : "designations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "expectedOn", "expectedAmount" ]
}
},
"contributionRecurrence" : {
"title" : "Contribution Recurrence",
"description" : "The details of recurring contributions associated with the pledge.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"startOn" : {
"title" : "Start On",
"description" : "The date the first pledge payment is expected/received.",
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"frequency" : {
"title" : "Frequency",
"description" : "The frequency of the payments associated with the pledge.",
"enum" : [ "oneTime", "weekly", "biweekly", "semimonthly", "monthly", "bimonthly", "quarterly", "semiannually", "annually", "custom" ],
"type" : "string"
},
"numberOfInstallments" : {
"title" : "Number Of Installments",
"description" : "The number of payments specified by the pledge.",
"oneOf" : [ {
"type" : "number",
"minimum" : 0,
"format" : "positiveInteger"
}, {
"type" : "null"
} ]
},
"installmentAmount" : {
"title" : "Installment Amount",
"description" : "The planned amount for each installment.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "startOn", "frequency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"expectedMatchAmount" : {
"title" : "Expected Match Amount",
"description" : "The amount of a matching gift that is expected when the pledge is fulfilled.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"conditions" : {
"title" : "Conditions",
"description" : "The conditions the donor has specified for the pledge.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The type of the pledge condition.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Type.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/pledge-condition-types/{id}",
"targetSchema" : {
"$ref" : "pledge-condition-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"description" : {
"title" : "Description",
"description" : "The description of the pledge condition.",
"type" : "string"
},
"status" : {
"title" : "Status",
"description" : "The status (open or satisfied) of the pledge condition.",
"enum" : [ "open", "satisfied" ],
"type" : "string"
},
"expectedOn" : {
"title" : "Expected On",
"description" : "The date the pledge condition is expected to be satisfied.",
"oneOf" : [ {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"satisfiedOn" : {
"title" : "Satisfied On",
"description" : "The date the pledge condition was satisfied.",
"oneOf" : [ {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "type", "status" ]
}
}
},
"additionalProperties" : false,
"required" : [ "status" ]
}
},
"additionalProperties" : false,
"required" : [ "pledge" ]
}, {
"title" : "Recurring Donation",
"description" : "Details for a recurring donation contribution.",
"type" : "object",
"properties" : {
"recurringContribution" : {
"title" : "Recurring Contribution",
"description" : "Details for a recurring contribution.",
"type" : "object",
"properties" : {
"contributionRecurrence" : {
"title" : "Contribution Recurrence",
"description" : "The details of recurring contributions associated with the pledge.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"startOn" : {
"title" : "Start On",
"description" : "The date the first pledge payment is expected/received.",
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
},
"frequency" : {
"title" : "Frequency",
"description" : "The frequency of the payments associated with the pledge.",
"enum" : [ "oneTime", "weekly", "biweekly", "semimonthly", "monthly", "bimonthly", "quarterly", "semiannually", "annually", "custom" ],
"type" : "string"
},
"installmentAmount" : {
"title" : "Installment Amount",
"description" : "The planned amount for each installment.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "startOn", "frequency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false
}
},
"additionalProperties" : false,
"required" : [ "recurringContribution" ]
}, {
"title" : "Bequest Expectancy",
"description" : "Details for a bequest expectancy.",
"type" : "object",
"properties" : {
"bequestExpectancy" : {
"title" : "Bequest Expectancy",
"description" : "Details for a bequest expectancy.",
"type" : "object",
"properties" : {
"status" : {
"title" : "Status",
"description" : "The institution defined status of the bequest expectancy.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Status.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/planned-gift-statuses/{id}",
"targetSchema" : {
"$ref" : "planned-gift-statuses.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"revocation" : {
"title" : "Revocation",
"description" : "The indication if the bequest can be revoked.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "revocable", "irrevocable" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "status" ]
}
},
"additionalProperties" : false,
"required" : [ "bequestExpectancy" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"solicitors" : {
"title" : "Solicitors",
"description" : "The people, teams, or organizations responsible for generating the contribution.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"solicitor" : {
"title" : "Solicitor",
"description" : "A person, team, or organization responsible for generating the contribution.",
"oneOf" : [ {
"title" : "Constituent",
"description" : "A constituent responsible for generating the contribution.",
"type" : "object",
"properties" : {
"constituent" : {
"title" : "Constituent",
"description" : "A constituent (person or organization) responsible for generating the contribution.",
"oneOf" : [ {
"title" : "person",
"description" : "The person responsible for generating the contribution.",
"type" : "object",
"properties" : {
"person" : {
"title" : "Person",
"description" : "The person responsible for generating the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Person.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-persons/{id}",
"targetSchema" : {
"$ref" : "constituent-persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "person" ]
}, {
"title" : "organization",
"description" : "The organization responsible for generating the contribution.",
"type" : "object",
"properties" : {
"organization" : {
"title" : "Organization",
"description" : "The organization responsible for generating the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Organization.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-organizations/{id}",
"targetSchema" : {
"$ref" : "constituent-organizations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "organization" ]
} ]
}
},
"additionalProperties" : false,
"required" : [ "constituent" ]
}, {
"title" : "Representative",
"description" : "An advancement representative responsible for generating the contribution.",
"type" : "object",
"properties" : {
"representative" : {
"title" : "Representative",
"description" : "An advancement representative responsible for generating the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Representative.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/advancement-representatives/{id}",
"targetSchema" : {
"$ref" : "advancement-representatives.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "representative" ]
}, {
"title" : "Team",
"description" : "An advancement team responsible for generating the contribution.",
"type" : "object",
"properties" : {
"team" : {
"title" : "Team",
"description" : "An advancement team responsible for generating the contribution.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Team.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/advancement-teams/{id}",
"targetSchema" : {
"$ref" : "advancement-teams.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "team" ]
} ]
}
},
"additionalProperties" : false,
"required" : [ "solicitor" ]
}
},
"comment" : {
"title" : "Comment",
"description" : "The comment associated with the contribution.",
"type" : "string"
}
},
"required" : [ "id", "title", "type", "activityDates", "contributionNumber", "amounts", "allocations", "category" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"type\": {$type}}",
"title" : "Type",
"description" : "The type of the contribution (e.g. gift, pledge).",
"schema" : {
"type" : "object",
"properties" : {
"type" : {
"enum" : [ "gift", "pledge", "pledgePayment", "recurringContribution", "matchingGift", "bequestExpectancy", "bequestPayment", "membershipDuesPayment" ],
"type" : "string"
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"activityDates\":[{\"type\":$type,\"occurredOn\":$occurredOn}]}",
"title" : "Activity Dates",
"description" : "Filter based on type and occurred on activity dates.",
"schema" : {
"type" : "object",
"properties" : {
"activityDates" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"enum" : [ "contributed", "posted" ],
"type" : "string"
},
"occurredOn" : {
"type" : "string",
"format" : "date-time",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
}
},
"required" : [ "type", "occurredOn" ]
}
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"fiscalYear\": {$fiscalYear}}",
"title" : "Fiscal Year",
"description" : "The fiscal year to which the contribution is applied.",
"schema" : {
"type" : "object",
"properties" : {
"fiscalYear" : {
"type" : "string"
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"contributionNumber\": {$contributionNumber}}",
"title" : "Contribution Number",
"description" : "An assigned number to identify the contribution.",
"schema" : {
"type" : "object",
"properties" : {
"contributionNumber" : {
"type" : "number"
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"givingClassifications\":[{\"classification\":{\"id\":$id}}]}",
"title" : "Classification",
"description" : "The user defined categorization of the contribution.",
"schema" : {
"type" : "object",
"properties" : {
"givingClassifications" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"classification" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"category\": {\"id\": $id}}",
"title" : "Category",
"description" : "A user defined category associated with the contribution.",
"schema" : {
"type" : "object",
"properties" : {
"category" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"solicitors\":[{\"solicitor\":{\"constituent\":{\"person\": {\"id\": $id}}}}]}",
"title" : "Solicitor Constituent Person",
"description" : "The person responsible for generating the contribution.",
"schema" : {
"type" : "object",
"properties" : {
"solicitors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"solicitor" : {
"type" : "object",
"properties" : {
"constituent" : {
"type" : "object",
"properties" : {
"person" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"solicitors\":[{\"solicitor\":{\"constituent\":{\"organization\": {\"id\": $id}}}}]}",
"title" : "Solicitor Constituent Organization",
"description" : "The organization responsible for generating the contribution.",
"schema" : {
"type" : "object",
"properties" : {
"solicitors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"solicitor" : {
"type" : "object",
"properties" : {
"constituent" : {
"type" : "object",
"properties" : {
"organization" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"solicitors\":[{\"solicitor\":{\"representative\": {\"id\": $id}}}]}",
"title" : "Solicitor Representative",
"description" : "An advancement representative responsible for generating the contribution.",
"schema" : {
"type" : "object",
"properties" : {
"solicitors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"solicitor" : {
"type" : "object",
"properties" : {
"representative" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?criteria={\"solicitors\":[{\"solicitor\":{\"team\": {\"id\": $id}}}]}",
"title" : "Solicitor Team",
"description" : "An advancement team responsible for generating the contribution.",
"schema" : {
"type" : "object",
"properties" : {
"solicitors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"solicitor" : {
"type" : "object",
"properties" : {
"team" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?externalContribution={\"externalContribution\": {\"id\": $id}}",
"name" : "externalContribution",
"title" : "External Contribution",
"description" : "Filter to return contributions related to an external contribution.",
"schema" : {
"type" : "object",
"properties" : {
"externalContribution" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?financeTransmissionState={\"financeTransmissionState\": {$financeTransmissionState}}",
"name" : "financeTransmissionState",
"title" : "Finance Transmission State",
"description" : "Filter to return the finance transmission state.",
"schema" : {
"type" : "object",
"properties" : {
"financeTransmissionState" : {
"enum" : [ "transmitted", "doNotTransmit", "pendingTransmission" ],
"type" : "string"
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
}, {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/contributions?sessions={\"sessions\": [{$sessions}]}",
"name" : "sessions",
"title" : "Sessions",
"description" : "Filter to return session(s).",
"schema" : {
"type" : "object",
"properties" : {
"sessions" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"targetSchema" : {
"$ref" : "contributions.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy