Get Gifts Applied to a Planned Gift

GET

/api/PlannedGift/:plannedGiftId/Gifts

GET

/api/PlannedGift/:plannedGiftId/Gifts

curl https://api.virtuoussoftware.com/api/PlannedGift/plannedGiftId/Gifts \
     -H "Authorization: Bearer <token>"

[
  {
    "id": "<integer>",
    "transactionSource": "<string>",
    "transactionId": "<string>",
    "contactId": "<integer>",
    "contactName": "<string>",
    "contactUrl": "<string>",
    "giftType": "<string>",
    "giftTypeFormatted": "<string>",
    "giftDate": "<dateTime>",
    "giftDateFormatted": "<string>",
    "amount": "<double>",
    "amountFormatted": "<string>",
    "currencyCode": "<string>",
    "exchangeRate": "<decimal>",
    "baseCurrencyCode": "<string>",
    "batch": "<string>",
    "createDateTimeUtc": "<dateTime>",
    "createdByUser": "<string>",
    "modifiedDateTimeUtc": "<dateTime>",
    "modifiedByUser": "<string>",
    "segmentId": "<integer>",
    "segment": "<string>",
    "segmentCode": "<string>",
    "segmentUrl": "<string>",
    "mediaOutletId": "<integer>",
    "mediaOutlet": "<string>",
    "grantId": "<integer>",
    "grant": "<string>",
    "grantUrl": "<string>",
    "notes": "<string>",
    "tribute": "<string>",
    "tributeId": "<integer>",
    "tributeType": "<string>",
    "acknowledgeeIndividualId": "<integer>",
    "receiptDate": "<dateTime>",
    "receiptDateFormatted": "<string>",
    "contactPassthroughId": "<integer>",
    "contactPassthroughUrl": "<string>",
    "contactIndividualId": "<integer>",
    "cashAccountingCode": "<string>",
    "giftAskId": "<integer>",
    "contactMembershipId": "<integer>",
    "giftDesignations": [
      {
        "id": "<integer>",
        "projectId": "<integer>",
        "project": "<string>",
        "projectCode": "<string>",
        "externalAccountingCode": "<string>",
        "projectType": "<string>",
        "projectLocation": "<string>",
        "projectUrl": "<string>",
        "amountDesignated": "<double>",
        "display": "<string>"
      },
      {
        "id": "<integer>",
        "projectId": "<integer>",
        "project": "<string>",
        "projectCode": "<string>",
        "externalAccountingCode": "<string>",
        "projectType": "<string>",
        "projectLocation": "<string>",
        "projectUrl": "<string>",
        "amountDesignated": "<double>",
        "display": "<string>"
      }
    ],
    "giftPremiums": [
      {
        "id": "<integer>",
        "premiumId": "<integer>",
        "premium": "<string>",
        "premiumUrl": "<string>",
        "quantity": "<integer>",
        "display": "<string>",
        "createDateTimeUtc": "<dateTime>",
        "createdByUser": "<string>",
        "modifiedDateTimeUtc": "<dateTime>",
        "modifiedByUser": "<string>"
      },
      {
        "id": "<integer>",
        "premiumId": "<integer>",
        "premium": "<string>",
        "premiumUrl": "<string>",
        "quantity": "<integer>",
        "display": "<string>",
        "createDateTimeUtc": "<dateTime>",
        "createdByUser": "<string>",
        "modifiedDateTimeUtc": "<dateTime>",
        "modifiedByUser": "<string>"
      }
    ],
    "pledgePayments": [
      {
        "id": "<integer>",
        "expectedPaymentDate": "<dateTime>",
        "expectedAmount": "<double>",
        "giftId": "<integer>",
        "actualAmount": "<double>"
      },
      {
        "id": "<integer>",
        "expectedPaymentDate": "<dateTime>",
        "expectedAmount": "<double>",
        "giftId": "<integer>",
        "actualAmount": "<double>"
      }
    ],
    "recurringGiftPayments": [
      {
        "id": "<integer>",
        "gift": {
          "id": "<integer>",
          "contactId": "<integer>",
          "giftDate": "<dateTime>",
          "amount": "<double>"
        },
        "expectedAmount": "<double>",
        "expectedPaymentDate": "<dateTime>",
        "dismissPaymentDate": "<dateTime>",
        "fulfillPaymentDate": "<dateTime>"
      },
      {
        "id": "<integer>",
        "gift": {
          "id": "<integer>",
          "contactId": "<integer>",
          "giftDate": "<dateTime>",
          "amount": "<double>"
        },
        "expectedAmount": "<double>",
        "expectedPaymentDate": "<dateTime>",
        "dismissPaymentDate": "<dateTime>",
        "fulfillPaymentDate": "<dateTime>"
      }
    ],
    "giftUrl": "<string>",
    "isPrivate": "<boolean>",
    "isTaxDeductible": "<boolean>",
    "customFields": [
      {
        "name": "<string>",
        "value": "<string>",
        "displayName": "<string>"
      },
      {
        "name": "<string>",
        "value": "<string>",
        "displayName": "<string>"
      }
    ]
  },
  {
    "id": "<integer>",
    "transactionSource": "<string>",
    "transactionId": "<string>",
    "contactId": "<integer>",
    "contactName": "<string>",
    "contactUrl": "<string>",
    "giftType": "<string>",
    "giftTypeFormatted": "<string>",
    "giftDate": "<dateTime>",
    "giftDateFormatted": "<string>",
    "amount": "<double>",
    "amountFormatted": "<string>",
    "currencyCode": "<string>",
    "exchangeRate": "<decimal>",
    "baseCurrencyCode": "<string>",
    "batch": "<string>",
    "createDateTimeUtc": "<dateTime>",
    "createdByUser": "<string>",
    "modifiedDateTimeUtc": "<dateTime>",
    "modifiedByUser": "<string>",
    "segmentId": "<integer>",
    "segment": "<string>",
    "segmentCode": "<string>",
    "segmentUrl": "<string>",
    "mediaOutletId": "<integer>",
    "mediaOutlet": "<string>",
    "grantId": "<integer>",
    "grant": "<string>",
    "grantUrl": "<string>",
    "notes": "<string>",
    "tribute": "<string>",
    "tributeId": "<integer>",
    "tributeType": "<string>",
    "acknowledgeeIndividualId": "<integer>",
    "receiptDate": "<dateTime>",
    "receiptDateFormatted": "<string>",
    "contactPassthroughId": "<integer>",
    "contactPassthroughUrl": "<string>",
    "contactIndividualId": "<integer>",
    "cashAccountingCode": "<string>",
    "giftAskId": "<integer>",
    "contactMembershipId": "<integer>",
    "giftDesignations": [
      {
        "id": "<integer>",
        "projectId": "<integer>",
        "project": "<string>",
        "projectCode": "<string>",
        "externalAccountingCode": "<string>",
        "projectType": "<string>",
        "projectLocation": "<string>",
        "projectUrl": "<string>",
        "amountDesignated": "<double>",
        "display": "<string>"
      },
      {
        "id": "<integer>",
        "projectId": "<integer>",
        "project": "<string>",
        "projectCode": "<string>",
        "externalAccountingCode": "<string>",
        "projectType": "<string>",
        "projectLocation": "<string>",
        "projectUrl": "<string>",
        "amountDesignated": "<double>",
        "display": "<string>"
      }
    ],
    "giftPremiums": [
      {
        "id": "<integer>",
        "premiumId": "<integer>",
        "premium": "<string>",
        "premiumUrl": "<string>",
        "quantity": "<integer>",
        "display": "<string>",
        "createDateTimeUtc": "<dateTime>",
        "createdByUser": "<string>",
        "modifiedDateTimeUtc": "<dateTime>",
        "modifiedByUser": "<string>"
      },
      {
        "id": "<integer>",
        "premiumId": "<integer>",
        "premium": "<string>",
        "premiumUrl": "<string>",
        "quantity": "<integer>",
        "display": "<string>",
        "createDateTimeUtc": "<dateTime>",
        "createdByUser": "<string>",
        "modifiedDateTimeUtc": "<dateTime>",
        "modifiedByUser": "<string>"
      }
    ],
    "pledgePayments": [
      {
        "id": "<integer>",
        "expectedPaymentDate": "<dateTime>",
        "expectedAmount": "<double>",
        "giftId": "<integer>",
        "actualAmount": "<double>"
      },
      {
        "id": "<integer>",
        "expectedPaymentDate": "<dateTime>",
        "expectedAmount": "<double>",
        "giftId": "<integer>",
        "actualAmount": "<double>"
      }
    ],
    "recurringGiftPayments": [
      {
        "id": "<integer>",
        "gift": {
          "id": "<integer>",
          "contactId": "<integer>",
          "giftDate": "<dateTime>",
          "amount": "<double>"
        },
        "expectedAmount": "<double>",
        "expectedPaymentDate": "<dateTime>",
        "dismissPaymentDate": "<dateTime>",
        "fulfillPaymentDate": "<dateTime>"
      },
      {
        "id": "<integer>",
        "gift": {
          "id": "<integer>",
          "contactId": "<integer>",
          "giftDate": "<dateTime>",
          "amount": "<double>"
        },
        "expectedAmount": "<double>",
        "expectedPaymentDate": "<dateTime>",
        "dismissPaymentDate": "<dateTime>",
        "fulfillPaymentDate": "<dateTime>"
      }
    ],
    "giftUrl": "<string>",
    "isPrivate": "<boolean>",
    "isTaxDeductible": "<boolean>",
    "customFields": [
      {
        "name": "<string>",
        "value": "<string>",
        "displayName": "<string>"
      },
      {
        "name": "<string>",
        "value": "<string>",
        "displayName": "<string>"
      }
    ]
  }
]

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

plannedGiftIdstringRequired

Response

idstringOptional

transactionSourcestringOptional

transactionIdstringOptional

contactIdstringOptional

contactNamestringOptional

contactUrlstringOptional

giftTypestringOptional

giftTypeFormattedstringOptional

giftDatestringOptional

giftDateFormattedstringOptional

amountstringOptional

amountFormattedstringOptional

currencyCodestringOptional

exchangeRatestringOptional

baseCurrencyCodestringOptional

batchstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

segmentIdstringOptional

segmentstringOptional

segmentCodestringOptional

segmentUrlstringOptional

mediaOutletIdstringOptional

mediaOutletstringOptional

grantIdstringOptional

grantstringOptional

grantUrlstringOptional

notesstringOptional

tributestringOptional

tributeIdstringOptional

tributeTypestringOptional

acknowledgeeIndividualIdstringOptional

receiptDatestringOptional

receiptDateFormattedstringOptional

contactPassthroughIdstringOptional

contactPassthroughUrlstringOptional

contactIndividualIdstringOptional

cashAccountingCodestringOptional

giftAskIdstringOptional

contactMembershipIdstringOptional

giftDesignationslist of objectsOptional

giftPremiumslist of objectsOptional

pledgePaymentslist of objectsOptional

recurringGiftPaymentslist of objectsOptional

giftUrlstringOptional

isPrivatestringOptional

isTaxDeductiblestringOptional

customFieldslist of objectsOptional

Errors

404

Not Found Error