List donations

2 of 19 fields have no description in the spec.

• limit#numberin query

  The max number of items to return.

• cursor#stringin query

  The id of the last item from the previous page. Used to fetch the next page.

• createdAt_lt#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_lte#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_gt#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_gte#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• campaignId_notIn#string[]in queryat least 1 itemsUUID

• campaignId_in#string[]in queryat least 1 itemsUUID

• campaignId#stringin queryUUID

  Id of one your campaigns

• status#stringin query

  Filter on donation status

  PENDINGDONEPROCESSEDCANCELED

• externalId#stringin query

  An optional internal id of your system e.g orderId or customerId. Can be used to link a donation to an entity in your system.

• uniqueExternalId#stringin query

  Similar to externalId but should be unique across all donations. Can be used to prevent duplicate donations.

• accountId#stringin queryUUID

  Id of the account. Only useful for Platform customers to filter donations by child accounts

• includeUrl#booleanin query

  Include the url to the page where the donation can be claimed

• includeAssets#booleanin query

  Include dynamic assets such as donation cards and QR code

• includeMatchedDonations#booleanin query

  Include matched donations made by and charged to the beneficiary after using their free donation.

• donorId#stringin queryUUID

  Id of the donor.

• includeChildDonations#booleanin query

  Include child donations i.e matched donations linked to a given donation

• hasBeenCharged#booleanin query

  Include only donations which have been charged to the donor

No field is described in the spec.

• donationId#stringalways returned

• amount#integer (int64)

• externalId#string

• uniqueExternalId#string

• status#DonationStatusalways returned

  PENDINGDONEPROCESSEDCANCELED

• secret#stringalways returned

• withFiscalReceipt#booleanalways returned

• hasBeenCharged#booleanalways returned

• claimedAt#string (date-time)

• validatedAt#string (date-time)

• processedAt#string (date-time)

• billingStatus#BillingStatusalways returned

  PENDINGBILLEDPAID

• hideAmount#booleanalways returned

• billedOn#DonationBilledOnalways returned

  CREATIONCLAIM

• autoAssigned#boolean

• expiryDate#string (date-time)

• sendingMode#CampaignSendingModealways returned

  MANUALEMAILPHYSICALSLACKPOSTAL

• sendingDate#string (date-time)

• sendingStatus#DonationSendingStatusalways returned

  PENDINGFAILEDDONE

• externalSendingId#string

• lastReminderId#string

• message#string

• reminderMessage#string

• from#string

• language#Languagealways returned

  fren

• sharedOn#SocialNetwork

  LINKEDININSTAGRAMFACEBOOKTWITTERWHATSAPP

• ptoType#PaidTimeOffTypealways returned

  NONEPAID_TIME_OFFWORKING_TIME_REDUCTION

• accountId#stringalways returned

• campaignId#stringalways returned

• charityId#string

• recurringDonationId#string

• transactionId#string

• donorId#string

• orderPlatformUserId#string

• usageId#string

• parentDonationId#string

• parentVoteId#string

• parentRecurringDonationId#string

• createdAt#string (date-time)always returned

• updatedAt#string (date-time)always returned

Errors

• 400Invalid parameter includeDonor

  {
    "statusCode": 400,
    "message": "Invalid parameter includeDonor",
    "error": "Bad Request"
  }

• 400A field is missing, has the wrong type, or is not part of the request schema.

  Every request with a body or query is validated.

  {
    "statusCode": 400,
    "message": [
      "amount must not be less than 1",
      "property foo should not exist"
    ],
    "error": "Bad Request"
  }

• 401Unauthorized

  Missing, expired or invalid access token.

  {
    "statusCode": 401,
    "message": "Unauthorized"
  }

• 403Account closed

  {
    "message": "Account closed",
    "code": "ACCOUNT_CLOSED"
  }