Expected Monthly Totals

Expected Monthly Totals Documentation

Expected Monthly Total [GET]

Expected Monthly Total [GET]

Request

Endpoint

GET /api/v2/reports/expected_monthly_totals
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::expectedmonthlytotals",
    "type": "reports_expected_monthly_totals",
    "attributes": {
      "created_at": "2022-01-12T17:18:51Z",
      "expected_donations": [

      ],
      "total_currency": "USD",
      "total_currency_symbol": "$",
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "196e577c-5522-448f-9ce1-2a37e2457bf3",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

expected_donations

Type [Object]

Description Info about recieved and possible donations

total_currency

Type string

Description Total currency

total_currency_symbol

Type string

Description Total currency symbol

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