Goal Progress

Goal Progress Documentation

Goal Progress [GET]

Goal Progress [GET]

Request

Endpoint

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

Body

Parameters

Filters

account_list_id

Type ID string

Description The account list to run the report on

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "reports::goalprogress",
    "type": "reports_goal_progresses",
    "attributes": {
      "balance": 0,
      "created_at": "2022-01-12T17:19:00Z",
      "default_currency": "USD",
      "in_hand_percent": null,
      "monthly_goal": null,
      "pledged_percent": null,
      "received_pledges": "0",
      "salary_balance": 0,
      "salary_currency_or_default": "USD",
      "salary_organization_id": "c9f3ae1b-11b3-4a56-9cd4-86187bec57dd",
      "total_pledges": "0",
      "updated_at": null,
      "updated_in_db_at": null
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "356a5f4a-9c8b-4739-a247-03e828a75d59",
          "type": "account_lists"
        }
      }
    }
  }
}

Fields

Attributes

balance

Type string

Description Balance of active designation accounts

created_at

Type date

Description The timestamp of when this resource was created

default_currency

Type string

Description Default currency of account_list

in_hand_percent

Type string

Description Percent of monthly goal in hand

monthly_goal

Type string

Description The account list monthly goal

pledged_percent

Type string

Description Percent of monthly goal pledged

received_pledges

Type string

Description Percent of monthly goal received

salary_balance

Type string

Description DEPRECATED replaced by balance

salary_currency_or_default

Type string

Description DEPRECATED replaced by default_currency

salary_organization_id

Type string

Description ID of salary Organization

total_pledges

Type string

Description Total pledges

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