Query Gifts with Abbreviated Details

POST

/api/Gift/Query

POST

/api/Gift/Query

curl -X POST "https://api.virtuoussoftware.com/api/Gift/Query?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_queryGiftsWithAbbreviatedDetails_example

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

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