Get Receipt

GET

/api/Contact/Receipts/:receiptId

GET

/api/Contact/Receipts/:receiptId

curl https://api.virtuoussoftware.com/api/Contact/Receipts/receiptId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

200Retrieved

{
  "isCurrentUserFollowing": "false",
  "id": "123456",
  "contactType": "Individual",
  "isPrivate": "false",
  "name": "John and Jane Doe",
  "informalName": "John & Jane",
  "description": "Longtime donors and community supporters.",
  "website": "https://johndoeexample.org",
  "maritalStatus": "Married",
  "anniversaryMonth": "6",
  "anniversaryDay": "15",
  "anniversaryYear": "2005",
  "mergedIntoContactId": null,
  "address": {
    "id": "78910",
    "label": "Home",
    "address1": "123 Maple Street",
    "address2": "Apt 4B",
    "city": "Springfield",
    "state": "IL",
    "postal": "62704",
    "country": "USA",
    "isPrimary": "true",
    "canBePrimary": "true",
    "startMonth": "1",
    "startDay": "1",
    "endMonth": null,
    "endDay": null
  },
  "giftAskAmount": "500",
  "giftAskType": "Annual Fund",
  "lifeToDateGiving": "15000",
  "yearToDateGiving": "1200",
  "lastGiftAmount": "250",
  "lastGiftDate": "2024-04-10T00:00:00Z",
  "contactIndividuals": [
    {
      "id": "111",
      "contactId": "123456",
      "prefix": "Mr.",
      "firstName": "John",
      "middleName": "A.",
      "lastName": "Doe",
      "suffix": "Jr.",
      "gender": "Male",
      "isPrimary": "true",
      "canBePrimary": "true",
      "isSecondary": "false",
      "canBeSecondary": "true",
      "birthMonth": "3",
      "birthDay": "22",
      "birthYear": "1980",
      "birthDate": "1980-03-22",
      "approximateAge": "44",
      "isDeceased": "false",
      "passion": "Education",
      "avatarUrl": "https://example.com/avatars/johndoe.jpg",
      "contactMethods": [
        {
          "id": "201",
          "type": "Email",
          "value": "john.doe@example.com",
          "isOptedIn": "true",
          "isPrimary": "true",
          "canBePrimary": "true"
        },
        {
          "id": "202",
          "type": "Phone",
          "value": "+1-555-123-4567",
          "isOptedIn": "true",
          "isPrimary": "false",
          "canBePrimary": "true"
        }
      ],
      "createDateTimeUtc": "2010-05-01T12:00:00Z",
      "modifiedDateTimeUtc": "2024-04-01T08:30:00Z",
      "customFields": [
        {
          "name": "Preferred Language",
          "value": "English",
          "displayName": "Preferred Language"
        },
        {
          "name": "Volunteer Status",
          "value": "Active",
          "displayName": "Volunteer Status"
        }
      ],
      "customCollections": [
        {
          "customCollectionId": "301",
          "customCollectionName": "Event Attendance",
          "collectionInstanceId": "401",
          "fields": [
            {
              "name": "Last Event",
              "value": "Annual Gala 2023"
            },
            {
              "name": "Attendance Count",
              "value": "5"
            }
          ]
        },
        {
          "customCollectionId": "302",
          "customCollectionName": "Donation Preferences",
          "collectionInstanceId": "402",
          "fields": [
            {
              "name": "Preferred Method",
              "value": "Credit Card"
            },
            {
              "name": "Receive Receipts",
              "value": "Yes"
            }
          ]
        }
      ]
    },
    {
      "id": "112",
      "contactId": "123456",
      "prefix": "Mrs.",
      "firstName": "Jane",
      "middleName": "B.",
      "lastName": "Doe",
      "suffix": "",
      "gender": "Female",
      "isPrimary": "false",
      "canBePrimary": "true",
      "isSecondary": "true",
      "canBeSecondary": "true",
      "birthMonth": "7",
      "birthDay": "10",
      "birthYear": "1982",
      "birthDate": "1982-07-10",
      "approximateAge": "41",
      "isDeceased": "false",
      "passion": "Healthcare",
      "avatarUrl": "https://example.com/avatars/janedoe.jpg",
      "contactMethods": [
        {
          "id": "203",
          "type": "Email",
          "value": "jane.doe@example.com",
          "isOptedIn": "true",
          "isPrimary": "true",
          "canBePrimary": "true"
        },
        {
          "id": "204",
          "type": "Phone",
          "value": "+1-555-987-6543",
          "isOptedIn": "false",
          "isPrimary": "false",
          "canBePrimary": "true"
        }
      ],
      "createDateTimeUtc": "2011-06-15T09:00:00Z",
      "modifiedDateTimeUtc": "2024-03-20T14:45:00Z",
      "customFields": [
        {
          "name": "Preferred Language",
          "value": "English",
          "displayName": "Preferred Language"
        },
        {
          "name": "Volunteer Status",
          "value": "Inactive",
          "displayName": "Volunteer Status"
        }
      ],
      "customCollections": [
        {
          "customCollectionId": "303",
          "customCollectionName": "Event Attendance",
          "collectionInstanceId": "403",
          "fields": [
            {
              "name": "Last Event",
              "value": "Charity Run 2022"
            },
            {
              "name": "Attendance Count",
              "value": "3"
            }
          ]
        },
        {
          "customCollectionId": "304",
          "customCollectionName": "Donation Preferences",
          "collectionInstanceId": "404",
          "fields": [
            {
              "name": "Preferred Method",
              "value": "Check"
            },
            {
              "name": "Receive Receipts",
              "value": "No"
            }
          ]
        }
      ]
    }
  ],
  "contactGiftsUrl": "https://api.virtuoussoftware.com/api/Contact/123456/Gifts",
  "contactPassthroughGiftsUrl": "https://api.virtuoussoftware.com/api/Contact/123456/PassthroughGifts",
  "contactPlannedGiftsUrl": "https://api.virtuoussoftware.com/api/Contact/123456/PlannedGifts",
  "contactRecurringGiftsUrl": "https://api.virtuoussoftware.com/api/Contact/123456/RecurringGifts",
  "contactImportantNotesUrl": "https://api.virtuoussoftware.com/api/Contact/123456/ImportantNotes",
  "contactNotesUrl": "https://api.virtuoussoftware.com/api/Contact/123456/Notes",
  "contactTagsUrl": "https://api.virtuoussoftware.com/api/Contact/123456/Tags",
  "contactRelationshipsUrl": "https://api.virtuoussoftware.com/api/Contact/123456/Relationships",
  "primaryAvatarUrl": "https://example.com/avatars/johndoe_primary.jpg",
  "contactReferences": [
    {
      "source": "CRM",
      "id": "CRM-7890"
    },
    {
      "source": "LegacySystem",
      "id": "LS-4567"
    }
  ],
  "originSegmentId": "555",
  "originSegment": "Major Donors",
  "createDateTimeUtc": "2010-04-01T10:00:00Z",
  "createdByUser": "admin_user",
  "modifiedDateTimeUtc": "2024-04-15T16:00:00Z",
  "modifiedByUser": "data_manager",
  "tags": [
    "VIP",
    "Newsletter Subscriber"
  ],
  "organizationGroups": [
    "Board Members",
    "Annual Gala Committee"
  ],
  "customFields": [
    {
      "name": "Preferred Contact Time",
      "value": "Afternoon",
      "displayName": "Preferred Contact Time"
    },
    {
      "name": "Membership Level",
      "value": "Gold",
      "displayName": "Membership Level"
    }
  ],
  "customCollections": [
    {
      "customCollectionId": "601",
      "customCollectionName": "Engagement History",
      "collectionInstanceId": "701",
      "fields": [
        {
          "name": "Last Meeting Date",
          "value": "2024-03-10"
        },
        {
          "name": "Notes",
          "value": "Interested in new community projects."
        }
      ]
    },
    {
      "customCollectionId": "602",
      "customCollectionName": "Communication Preferences",
      "collectionInstanceId": "702",
      "fields": [
        {
          "name": "Email Frequency",
          "value": "Monthly"
        },
        {
          "name": "Phone Calls",
          "value": "No"
        }
      ]
    }
  ]
}

Authentication

AuthorizationBearer

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

Path parameters

receiptIdstringRequired

Response

Get Receipt