Common Models

Designation

The following is an example designation:

{
    "designationId": 123456789,
    "name": "Jane for Congress Committee",
    "officialName": "Committee to Elect Jane to Congress",
    "paymentTypes": [
        {
            "paymentType": "CreditCard",
            "name": "Credit Card",
            "isDefault": false
        },
        {
            "paymentType": "ElectronicFundsTransfer",
            "name": "Electronic Funds Transfer",
            "isDefault": false
        },
        {
            "paymentType": "Unknown",
            "name": "Debit Card",
            "isDefault": false
        },
        {
            "paymentType": "ElectronicPaySystem",
            "name": "Electronic Pay System",
            "isDefault": false
        }
    ],
    "attributionTypes": [
        {
            "financialAttributionTypeId": 1,
            "name": "Attribution",
            "attributionType": "DefaultAttribution"
        },
        {
            "financialAttributionTypeId": 2,
            "name": "Board Member Giving",
            "attributionType": "BoardMemberGiving"
        },
        {
            "financialAttributionTypeId": 3,
            "name": "Corporate Matching",
            "attributionType": "CorporateMatch"
        },
        {
            "financialAttributionTypeId": 4,
            "name": "Donor-Advised Fund",
            "attributionType": "DonorAdvisedFund"
        }
    ]
}

The following is an overview of the Designation object:

PropertyTypeDescription
designationIdintUnique identifier for a Designation in this context.
namestringA name for this designation
officialNamestringAn official name for the designation
paymentTypesarrayAn array of Payment Types accepted by this designation. Requested via $expand.
attributionTypesarrayAn array of Attribution Types accepted by this designation. Requested via $expand.

Payment Types

PropertyTypeDescription
paymentTypestringPayment type that can be specified in /contributions
namestringName of the payment type
isDefaultbooleantrue if this is a designation's default payment type (not all designations have default payment types)

Attribution Types

PropertyTypeDescription
financialAttributionTypeIdintegerUnique identifier for this attribution type
namestringName of this attribution type
attributionTypestringAttribution type that can be specified in /contributions/{contributionId}/attributions/{vanId}