GET api/Goal?accountID={accountID}&suffixID={suffixID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountID

integer

Required

suffixID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Goal
NameDescriptionTypeAdditional information
ID

integer

None.

Name

string

None.

Description

string

None.

Amount

decimal number

None.

PredictedBalance

decimal number

None.

PredictedPercentage

decimal number

None.

ActualBalance

decimal number

None.

ActualPercentage

decimal number

None.

StartDate

date

None.

Status

string

None.

BalanceDate

date

None.

GoalDate

date

None.

AccountSuffixes

Collection of AccountSuffix

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "ID": 1,
    "Name": "sample string 1",
    "Description": "sample string 2",
    "Amount": 3.0,
    "PredictedBalance": 1.0,
    "PredictedPercentage": 1.0,
    "ActualBalance": 1.0,
    "ActualPercentage": 1.0,
    "StartDate": "2021-05-17T09:51:38.1018038Z",
    "Status": "sample string 5",
    "BalanceDate": "2021-05-17T09:51:38.1018038Z",
    "GoalDate": "2021-05-17T09:51:38.1018038Z",
    "AccountSuffixes": [
      {
        "$id": "2",
        "AccountID": 1,
        "SuffixID": 2,
        "Percentage": 1.0
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]