v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Donations

all receipts

Returns a list of the receipts attached to this donation

For custom components:

RaiselyComponents.api.one('donations', '{uuid}').get('receipts', params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

get/donations/{uuid}/receipts

Path parameters

uuidstring required

The uuid of the record

Query parameters

privateboolean

Returns the full record when authenticated

qstring

Search query to find records matching

limitnumber

The number of records to limit per page

offsetnumber

The pagination offset (in number of records)

sortstring

The record attribute to filter on (use in conjunction with order)

order'asc' | 'desc'

The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending

postcodestring

Filter User based on their postcode value

countrystring

Filter User based on their country value

facebookIdstring

Filter User based on their facebookId value

emailstring

Filter User based on their email value

fullNamestring

Filter User based on their fullName value

phone_numberstring

Filter User based on their phone_number value

statusstring

Filter Receipt based on their status value

receipt_templatesstring

Filter by receipt templates uuid

donationstring

Filter by donation uuid

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Response

The resulting collection of Receipt records

Example response

{
  "data": [
    {
      "campaignUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "createdAt": "2020-12-03T06:52:46.330Z",
      "donationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "id": 12345,
      "isReissue": true,
      "templateUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "updatedAt": "2020-12-03T06:52:46.330Z",
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    }
  ],
  "pagination": {
    "total": 10,
    "pages": 2,
    "offset": 5,
    "limit": 5
  }
}