Year Donations

Year Donations Documentation

Year Donation [GET]

Year Donation [GET]

Request

Endpoint

GET /api/v2/reports/year_donations
Content-Type: application/vnd.api+json

Body

Parameters

Filters

account_list_id

Type string

Description The account list to run the report on

Required No

designation_account_id

Type ID string

Description Filter by designation account ID; Accepts comma separated ids

Required No

donor_account_id

Type ID string

Description Filter by donor account ID; Accepts comma separated ids

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "reports::yeardonations",
    "type": "reports_year_donations",
    "attributes": {
      "created_at": "2021-11-23T14:38:18Z",
      "donation_infos": [

      ],
      "donor_infos": [

      ],
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "96037efd-af6d-40c3-8154-61080a755a1d",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

donation_infos

Type [Object]

Description Info on donations

donor_infos

Type [Object]

Description Info on donors

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list the report was run on