Donor Accounts

Donor Accounts Documentation

Donor Account [LIST]

Donor Account [LIST]

Request

Endpoint

GET /api/v2/account_lists/79b9697a-3201-4152-ba28-e0136f44c396/donor_accounts
Content-Type: application/vnd.api+json

Body

Parameters

Filters

contacts

Type ID string

Description Filter where donor account is connected with contacts with ids in the collection; Accepts ids separated by comma

Required No

wildcard_search

Type Unknown

Description filter.wildcard search

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "cc224fc4-5205-41d3-ad4c-972b972f7ea9",
      "type": "donor_accounts",
      "attributes": {
        "account_number": "MyString",
        "created_at": "2022-01-12T17:17:59Z",
        "display_name": "Christiansen, Versie (MyString)",
        "donor_type": "Type",
        "first_donation_date": "2022-01-12",
        "last_donation_date": "2022-01-12",
        "legacy_account_number": null,
        "total_donations": "3.0",
        "updated_at": "2022-01-12T17:17:59Z",
        "updated_in_db_at": "2022-01-12T17:17:59Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "f9b6f80a-1d27-4e54-8202-b6970577714d",
            "type": "organizations"
          }
        },
        "contacts": {
          "data": [
            {
              "id": "80b03330-8a50-4a8e-9474-c1cb59d78e8f",
              "type": "contacts"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Designation Account]

Description An array of Designation Accounts

Donor Account [GET]

Donor Account [GET]

Request

Endpoint

GET /api/v2/account_lists/0fda4eec-bb06-4b76-9f51-88c707a06d40/donor_accounts/50de19b2-9dc7-4652-8976-8eabfed58d81
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "50de19b2-9dc7-4652-8976-8eabfed58d81",
    "type": "donor_accounts",
    "attributes": {
      "account_number": "MyString",
      "created_at": "2022-01-12T17:18:00Z",
      "display_name": "Hettinger, Tod (MyString)",
      "donor_type": "Type",
      "first_donation_date": "2022-01-12",
      "last_donation_date": "2022-01-12",
      "legacy_account_number": null,
      "total_donations": "3.0",
      "updated_at": "2022-01-12T17:18:00Z",
      "updated_in_db_at": "2022-01-12T17:18:00Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "bfbbb237-723d-4f15-9825-0f01404b6f86",
          "type": "organizations"
        }
      },
      "contacts": {
        "data": [
          {
            "id": "0ed05342-dab5-42c1-981e-e3fe3b9f7f2f",
            "type": "contacts"
          }
        ]
      }
    }
  }
}

Fields

Attributes

account_number

Type ID string

Description the account number that is provided by the origin system

created_at

Type date

Description The timestamp of when this resource was created

display_name

Type string

Description name to display to the user

donor_type

Type string

Description indicates if the donor is an individual, household, organization or company

first_donation_date

Type date

Description the date of the first donation the donor made

last_donation_date

Type date

Description the date of the last donation the donor made

legacy_account_number

Type ID string

Description the account number that is provided by the legacy origin system

total_donations

Type number

Description the total amount of donations the donor has made

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

contacts.data

Type [Contact]

Description Contacts that this donor account is connected with

organization.data

Type Organization

Description The Organization the designation account belongs to