Salary Currency Donations

Salary Currency Donations Documentation

Salary Currency Donation [GET]

Salary Currency Donation [GET]

Request

Endpoint

GET /api/v2/reports/salary_currency_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::salarycurrencydonations",
    "type": "reports_salary_currency_donations",
    "attributes": {
      "created_at": "2022-01-12T17:18:10Z",
      "currency_groups": {
      },
      "default_currency": "USD",
      "donor_infos": [

      ],
      "months": [
        "2021-01-01",
        "2021-02-01",
        "2021-03-01",
        "2021-04-01",
        "2021-05-01",
        "2021-06-01",
        "2021-07-01",
        "2021-08-01",
        "2021-09-01",
        "2021-10-01",
        "2021-11-01",
        "2021-12-01",
        "2022-01-01"
      ],
      "salary_currency": "USD",
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "bf5d9eab-61bc-4839-8936-fd66a780a145",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

currency_groups

Type [Object]

Description The donations made each month, per contact, grouped by currencies

default_currency

Type string

Description Default currency of account_list

donor_infos

Type [Object]

Description Info on donors

months

Type [Object]

Description The months represented in the data

salary_currency

Type string

Description DEPRECATED replaced by default_currency

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