Designation Accounts

Designation Accounts Documentation

Designation Account [LIST]

Designation Account [LIST]

Request

Endpoint

GET /api/v2/account_lists/3248c4e1-be7a-45dd-9422-9fbd794f1bdf/designation_accounts
Content-Type: application/vnd.api+json

Body

Parameters

Filters

wildcard_search

Type string

Description where name contains or designation_number starts with wildcard_search

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "417c11b9-aade-451c-870e-19c84cc3f66c",
      "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": "10",
        "display_name": "Designation Name (10)",
        "exchange_rate": 1.0,
        "legacy_designation_number": null,
        "name": "Designation Name",
        "organization_name": "Organization307",
        "updated_at": "-4712-01-01T00:00:00Z",
        "updated_in_db_at": "-4712-01-01T00:00:00Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "2e9de5ba-a587-4e00-b4da-39ce34898d99",
            "type": "organizations"
          }
        },
        "balances": {
          "data": [
            {
              "id": "27cde328-81db-4507-80da-d86e5b4cf7df",
              "type": "balances"
            }
          ]
        }
      }
    }
  ],
  "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 Account Objects

Designation Account [GET]

Designation Account [GET]

Request

Endpoint

GET /api/v2/account_lists/5196d221-55fd-4689-9c49-1262c1a9b45d/designation_accounts/caf96c3f-1fa4-4fd9-97f8-0efa43f7da0d
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "caf96c3f-1fa4-4fd9-97f8-0efa43f7da0d",
    "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": "11",
      "display_name": "Designation Name (11)",
      "exchange_rate": 1.0,
      "legacy_designation_number": null,
      "name": "Designation Name",
      "organization_name": "Organization310",
      "updated_at": "-4712-01-01T00:00:00Z",
      "updated_in_db_at": "-4712-01-01T00:00:00Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "61780ee9-43b1-4739-8643-964cd18d0712",
          "type": "organizations"
        }
      },
      "balances": {
        "data": [
          {
            "id": "bbaa2955-f3d0-4f31-a30d-8999dec6e418",
            "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

Designation Account [PUT]

Designation Account [PUT]

Request

Endpoint

PUT /api/v2/account_lists/09fbf906-a4d4-4973-8b53-1fa4445db423/designation_accounts/c35d2bfc-624a-40c5-91cb-3814dda7f95e
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "designation_accounts",
    "attributes": {
      "active": true,
      "overwrite": true,
      "updated_in_db_at": "-4712-01-01 00:00:00 UTC"
    }
  }
}

Parameters

Attributes

active

Type boolean

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

Required No

created_at

Type date

Description The timestamp of when this resource was created

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

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

Response

Headers

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

Body

{
  "data": {
    "id": "c35d2bfc-624a-40c5-91cb-3814dda7f95e",
    "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": "12",
      "display_name": "Designation Name (12)",
      "exchange_rate": 1.0,
      "legacy_designation_number": null,
      "name": "Designation Name",
      "organization_name": "Organization313",
      "updated_at": "-4712-01-01T00:00:00Z",
      "updated_in_db_at": "-4712-01-01T00:00:00Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "e0cb36b1-c002-4dcb-9927-84bd3a34b862",
          "type": "organizations"
        }
      },
      "balances": {
        "data": [
          {
            "id": "8910a689-9d40-4e93-b143-fe4f0124da8a",
            "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