Query Gifts with Full Details

POST

/api/Gift/Query/FullGift

POST

/api/Gift/Query/FullGift

curl -X POST "https://api.virtuoussoftware.com/api/Gift/Query/FullGift?skip=1&take=1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "groups": [
    {
      "conditions": [
        {
          "parameter": "<string>",
          "operator": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>",
            "<string>"
          ]
        },
        {
          "parameter": "<string>",
          "operator": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>",
            "<string>"
          ]
        }
      ]
    },
    {
      "conditions": [
        {
          "parameter": "<string>",
          "operator": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>",
            "<string>"
          ]
        },
        {
          "parameter": "<string>",
          "operator": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>",
            "<string>"
          ]
        }
      ]
    }
  ],
  "sortBy": "<string>",
  "descending": "<boolean>"
}'

200Giving_queryGiftsWithFullDetails_example

{
  "list": [
    {
      "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>"
        },
        {
          "id": "<integer>",
          "premiumId": "<integer>",
          "premium": "<string>",
          "premiumUrl": "<string>",
          "quantity": "<integer>",
          "display": "<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>"
        },
        {
          "id": "<integer>",
          "premiumId": "<integer>",
          "premium": "<string>",
          "premiumUrl": "<string>",
          "quantity": "<integer>",
          "display": "<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>"
        }
      ]
    }
  ],
  "total": "<integer>"
}

Returns the full gift info along with the query. This can cause performance issues. We recommend using the Gift Query endpoint for quicker results. You can sort by Id, Amount, GiftDate, ReceiptDate and Batch.

Authentication

AuthorizationBearer

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

Query parameters

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10. Max is 1000.

Request

This endpoint expects an object.

groupslist of objectsOptional

sortBystringOptional

descendingstringOptional

Response

listlist of objectsOptional

totalstringOptional