Designation Accounts

Designation Accounts Documentation

Designation Account [GET]

Designation Account [GET]

Request

Endpoint

GET /api/v2/public/designation_accounts/2
Content-Type: application/vnd.api+json
Authorization: Bearer yZWKUSAF1cQLFKALLmPGuUGp

Body

Response

Headers

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

Body

{
  "data": {
    "id": "fb1b4808-2b3c-4246-bee8-e8630a48b97f",
    "type": "designation_accounts",
    "attributes": {
      "active": true,
      "balance": "9.99",
      "balance_updated_at": null,
      "converted_balance": 9.99,
      "created_at": "-4712-01-01T00:00:00Z",
      "currency": "USD",
      "currency_symbol": "$",
      "designation_number": "2",
      "display_name": "Designation Name (2)",
      "exchange_rate": 1.0,
      "legacy_designation_number": null,
      "name": "Designation Name",
      "organization_name": "Organization69",
      "updated_at": "-4712-01-01T00:00:00Z",
      "updated_in_db_at": "-4712-01-01T00:00:00Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "bf169488-a3f6-4f6b-8c2c-88f9fe026ad6",
          "type": "organizations"
        }
      },
      "balances": {
        "data": [
          {
            "id": "fbbd18bb-6c82-4844-9a60-a794907e9658",
            "type": "balances"
          }
        ]
      }
    }
  }
}

Fields

Attributes

active

Type boolean

Description If this designation_account is active then the balance should be added into the profile total

balance

Type number

Description The balance in its native currency

balance_updated_at

Type string

Description The DateTime when the balance was updated

converted_balance

Type number

Description The balance in the account_list default currency

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The native currency of the designation_account

currency_symbol

Type string

Description The native currency symbol of the designation_account

designation_number

Type string

Description The remote system designation number

display_name

Type string

Description The name to display

exchange_rate

Type number

Description The exchange rate from the native currency to the account_list default currency

legacy_designation_number

Type -

Description The legacy remote system designation number

name

Type float

Description The name of the designation

organization_name

Type string

Description The name of the organization this designation belongs to

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

balances.data

Type [Balance]

Description Balance changes to the designation account over time

organization.data

Type Organization

Description The Organization the designation account belongs to