Get Gifts for a Contact by Reference ID

GET

/api/Gift/ByReference/:referenceId

GET

/api/Gift/ByReference/:referenceId

curl -G https://api.virtuoussoftware.com/api/Gift/ByReference/referenceId \
     -H "Authorization: Bearer <token>" \
     -d skip=1 \
     -d take=1 \
     --data-urlencode excludeReferenceOriginatedGifts=<boolean>

200Giving_getGiftsForAContactByReferenceId_example

{
  "list": [
    {
      "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>"
        }
      ],
      "id": "<integer>",
      "contactId": "<integer>",
      "contactIndividualId": "<integer>",
      "giftType": "<string>",
      "giftDate": "<string>",
      "amount": "<string>",
      "segment": "<string>",
      "batch": "<string>",
      "giftUrl": "<string>",
      "culture": "<string>",
      "exchangeRate": "<double>"
    },
    {
      "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>"
        }
      ],
      "id": "<integer>",
      "contactId": "<integer>",
      "contactIndividualId": "<integer>",
      "giftType": "<string>",
      "giftDate": "<string>",
      "amount": "<string>",
      "segment": "<string>",
      "batch": "<string>",
      "giftUrl": "<string>",
      "culture": "<string>",
      "exchangeRate": "<double>"
    }
  ],
  "total": "<integer>"
}

HMAC Auth only.

Authentication

AuthorizationBearer

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

Path parameters

referenceIdstringRequired

Query parameters

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10.

excludeReferenceOriginatedGiftsstringOptional

if set to true [exclude reference originated gifts].

Response

listlist of objectsOptional

totalstringOptional