Account Lists

Account Lists Documentation

Account List [LIST]

Account List [LIST]

Request

Endpoint

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

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "7f00cdc1-fbe7-42ff-a5f4-4e5cd56e9529",
      "type": "account_lists",
      "attributes": {
        "active_mpd_finish_at": null,
        "active_mpd_monthly_goal": null,
        "active_mpd_start_at": null,
        "balance": 0,
        "committed": 0,
        "created_at": "2021-11-23T14:38:20Z",
        "currency": null,
        "default_currency": "USD",
        "home_country": null,
        "last_prayer_letter_at": null,
        "monthly_goal": null,
        "name": "Clifford ",
        "primary_appeal": null,
        "progress": {
          "monthly_goal": null,
          "in_hand_percent": null,
          "pledged_percent": null,
          "received_pledges": 0,
          "salary_balance": 0,
          "balance": 0,
          "total_pledges": 0
        },
        "received": 0,
        "salary_organization": "e004c7ee-6758-465d-b146-6f4940137cb7",
        "staff_account_ids": [

        ],
        "tester": null,
        "total_pledges": 0,
        "updated_at": "2021-11-23T14:38:20Z",
        "updated_in_db_at": "2021-11-23T14:38:20Z",
        "weeks_on_mpd": 0
      },
      "relationships": {
        "primary_appeal": {
          "data": null
        },
        "users": {
          "data": [
            {
              "id": "0f8619fc-a4c8-4bdb-b456-43f890f943bb",
              "type": "users"
            }
          ]
        },
        "coaches": {
          "data": [

          ]
        },
        "notification_preferences": {
          "data": [

          ]
        },
        "organization_accounts": {
          "data": [
            {
              "id": "715bfed3-f968-41dc-8599-5667053da73b",
              "type": "organization_accounts"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Account List]

Description An array of Account Lists

Account List [GET]

Account List [GET]

Request

Endpoint

GET /api/v2/account_lists/f7f90278-ebcd-453a-8d89-b28a95366d3e
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "f7f90278-ebcd-453a-8d89-b28a95366d3e",
    "type": "account_lists",
    "attributes": {
      "active_mpd_finish_at": null,
      "active_mpd_monthly_goal": null,
      "active_mpd_start_at": null,
      "balance": 0,
      "committed": 0,
      "created_at": "2021-11-23T14:38:20Z",
      "currency": null,
      "default_currency": "USD",
      "home_country": null,
      "last_prayer_letter_at": null,
      "monthly_goal": null,
      "name": "Laurel ",
      "primary_appeal": null,
      "progress": {
        "monthly_goal": null,
        "in_hand_percent": null,
        "pledged_percent": null,
        "received_pledges": 0,
        "salary_balance": 0,
        "balance": 0,
        "total_pledges": 0
      },
      "received": 0,
      "salary_organization": "76846353-3681-4306-89f0-59a2182ea0d0",
      "staff_account_ids": [

      ],
      "tester": null,
      "total_pledges": 0,
      "updated_at": "2021-11-23T14:38:20Z",
      "updated_in_db_at": "2021-11-23T14:38:20Z",
      "weeks_on_mpd": 0
    },
    "relationships": {
      "primary_appeal": {
        "data": null
      },
      "users": {
        "data": [
          {
            "id": "6628463e-4d61-4c9b-9088-73dfd1603fd8",
            "type": "users"
          }
        ]
      },
      "coaches": {
        "data": [

        ]
      },
      "notification_preferences": {
        "data": [

        ]
      },
      "organization_accounts": {
        "data": [
          {
            "id": "87362020-83be-436a-a4dd-80b5b01509fb",
            "type": "organization_accounts"
          }
        ]
      }
    }
  }
}

Fields

Attributes

active_mpd_finish_at

Type string

Description The date when the account list users aim to finish MPD

active_mpd_monthly_goal

Type string

Description The monthly goal users of the account list are aiming to raise in the set period

active_mpd_start_at

Type string

Description The date when the account list users will start MPD

balance

Type float

Description The total converted balance of active designation accounts associated with this account list

committed

Type number

Description The monthly amount total pledged to the Account List

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The currency code for the Account List, such as 'USD', 'CAD'

default_currency

Type string

Description The default currency code, 'USD'

home_country

Type string

Description The country of the Account List

last_prayer_letter_at

Type date

Description Date prayer letter last sent over MailChimp

monthly_goal

Type number

Description The monthly financial goal of the Account List

name

Type string

Description The name of the Account List

primary_appeal

Type Appeal

Description The appeal that is marked as primary

progress

Type object

Description Hash containing monthly_goal, in_hand_percent, pledged_percent, received_pledges, balance, total_pledges

received

Type number

Description The monthly amount total received to the Account List

salary_organization

Type string

Description The ID of the organization that is responsible for paying the user

staff_account_ids

Type ["string"]

Description Array of staff account ids on designation accounts for the Account List

tester

Type boolean

Description Whether or not the Account List is a testing account

total_pledges

Type float

Description The total amount of pledges donated for the Account List

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.

weeks_on_mpd

Type number

Description Number of weeks since active_mpd_start_at if active_mpd_finish_at is after current date

Relationships

coaches.data

Type ["Person"]

Description collection of coaches who have access to the account list

notification_preferences.data

Type [Notification Preference]

Description An array of Notification Preference references for the Account List

organization_accounts.data

Type [Organization Account]

Description An array of Organization Accounts connected to the Account List

primary_appeal.data

Type Appeal

Description The appeal that is marked as primary

users.data

Type ["Person"]

Description collection of users who have access to the account list

Account List [PUT]

Account List [PUT]

Request

Endpoint

PUT /api/v2/account_lists/1d11cbf7-4ed6-49bd-b6c3-7eb5d1284c21
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "account_lists",
    "attributes": {
      "currency": "USD",
      "home_country": "United States",
      "monthly_goal": 5005,
      "name": "Dare LLC",
      "tester": false,
      "updated_in_db_at": "2021-11-23 14:38:20 UTC"
    }
  }
}

Parameters

Attributes

active_mpd_finish_at

Type string

Description The date when the account list users aim to finish MPD

Required No

active_mpd_monthly_goal

Type string

Description The monthly goal users of the account list are aiming to raise in the set period

Required No

active_mpd_start_at

Type string

Description The date when the account list users will start MPD

Required No

balance

Type float

Description The total converted balance of active designation accounts associated with this account list

Required No

committed

Type number

Description The monthly amount total pledged to the Account List

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

currency

Type string

Description The currency code for the Account List, such as 'USD', 'CAD'

Required No

home_country

Type string

Description The country of the Account List

Required No

last_prayer_letter_at

Type date

Description Date prayer letter last sent over MailChimp

Required No

monthly_goal

Type number

Description The monthly financial goal of the Account List

Required No

name

Type string

Description The name of the Account List

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

primary_appeal

Type Appeal

Description The appeal that is marked as primary

Required No

progress

Type object

Description Hash containing monthly_goal, in_hand_percent, pledged_percent, received_pledges, balance, total_pledges

Required No

received

Type number

Description The monthly amount total received to the Account List

Required No

salary_organization

Type string

Description The ID of the organization that is responsible for paying the user

Required No

staff_account_ids

Type ["string"]

Description Array of staff account ids on designation accounts for the Account List

Required No

tester

Type boolean

Description Whether or not the Account List is a testing account

Required No

total_pledges

Type float

Description The total amount of pledges donated for the Account List

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

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.

Required No

weeks_on_mpd

Type number

Description Number of weeks since active_mpd_start_at if active_mpd_finish_at is after current date

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "1d11cbf7-4ed6-49bd-b6c3-7eb5d1284c21",
    "type": "account_lists",
    "attributes": {
      "active_mpd_finish_at": null,
      "active_mpd_monthly_goal": null,
      "active_mpd_start_at": null,
      "balance": 0,
      "committed": 0,
      "created_at": "2021-11-23T14:38:20Z",
      "currency": "USD",
      "default_currency": "USD",
      "home_country": "United States",
      "last_prayer_letter_at": null,
      "monthly_goal": 5005,
      "name": "Dare LLC",
      "primary_appeal": null,
      "progress": {
        "monthly_goal": 5005,
        "in_hand_percent": 0,
        "pledged_percent": 0,
        "received_pledges": 0,
        "salary_balance": 0,
        "balance": 0,
        "total_pledges": 0
      },
      "received": 0,
      "salary_organization": "70526368-2705-4217-ac90-9b209fdaa298",
      "staff_account_ids": [

      ],
      "tester": false,
      "total_pledges": 0,
      "updated_at": "2021-11-23T14:38:20Z",
      "updated_in_db_at": "2021-11-23T14:38:20Z",
      "weeks_on_mpd": 0
    },
    "relationships": {
      "primary_appeal": {
        "data": null
      },
      "users": {
        "data": [
          {
            "id": "62674cc8-6dd8-4e13-bddc-d0f1dd04d792",
            "type": "users"
          }
        ]
      },
      "coaches": {
        "data": [

        ]
      },
      "notification_preferences": {
        "data": [

        ]
      },
      "organization_accounts": {
        "data": [
          {
            "id": "dc916352-632c-41e5-891b-5676e9b14c7f",
            "type": "organization_accounts"
          }
        ]
      }
    }
  }
}

Fields

Attributes

active_mpd_finish_at

Type string

Description The date when the account list users aim to finish MPD

active_mpd_monthly_goal

Type string

Description The monthly goal users of the account list are aiming to raise in the set period

active_mpd_start_at

Type string

Description The date when the account list users will start MPD

balance

Type float

Description The total converted balance of active designation accounts associated with this account list

committed

Type number

Description The monthly amount total pledged to the Account List

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The currency code for the Account List, such as 'USD', 'CAD'

default_currency

Type string

Description The default currency code, 'USD'

home_country

Type string

Description The country of the Account List

last_prayer_letter_at

Type date

Description Date prayer letter last sent over MailChimp

monthly_goal

Type number

Description The monthly financial goal of the Account List

name

Type string

Description The name of the Account List

primary_appeal

Type Appeal

Description The appeal that is marked as primary

progress

Type object

Description Hash containing monthly_goal, in_hand_percent, pledged_percent, received_pledges, balance, total_pledges

received

Type number

Description The monthly amount total received to the Account List

salary_organization

Type string

Description The ID of the organization that is responsible for paying the user

staff_account_ids

Type ["string"]

Description Array of staff account ids on designation accounts for the Account List

tester

Type boolean

Description Whether or not the Account List is a testing account

total_pledges

Type float

Description The total amount of pledges donated for the Account List

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.

weeks_on_mpd

Type number

Description Number of weeks since active_mpd_start_at if active_mpd_finish_at is after current date

Relationships

coaches.data

Type ["Person"]

Description collection of coaches who have access to the account list

notification_preferences.data

Type [Notification Preference]

Description An array of Notification Preference references for the Account List

organization_accounts.data

Type [Organization Account]

Description An array of Organization Accounts connected to the Account List

primary_appeal.data

Type Appeal

Description The appeal that is marked as primary

users.data

Type ["Person"]

Description collection of users who have access to the account list