Financial Accounts

Financial Accounts Documentation

Financial Account [LIST]

Financial Account [LIST]

Request

Endpoint

GET /api/v2/account_lists/9dad6d20-3928-44c1-bbc1-51da1654c338/financial_accounts
Content-Type: application/vnd.api+json

Body

Parameters

Filters

wildcard_search

Type string

Description where name contains string

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "7058b669-b240-4e67-8a26-abf93e8446d0",
      "type": "financial_accounts",
      "attributes": {
        "active": false,
        "balance": "0.0",
        "code": "Greenfelder-Robel",
        "converted_balance": 0.0,
        "converted_currency": "USD",
        "created_at": "2022-01-12T17:19:01Z",
        "currency": "USD",
        "last_download_at": null,
        "name": "Pacocha-Frami",
        "updated_at": "2022-01-12T17:19:01Z",
        "updated_in_db_at": "2022-01-12T17:19:01Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "4c5a0e00-ad96-4a42-b999-78f467a577d5",
            "type": "organizations"
          }
        },
        "categories": {
          "data": [

          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Financial Account]

Description An array of Financial Account Objects

Financial Account [GET]

Financial Account [GET]

Request

Endpoint

GET /api/v2/account_lists/31eebe01-06cb-424f-b77c-bf3a516fdb85/financial_accounts/432f50ed-452f-4741-bb71-161347ff00e8
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "432f50ed-452f-4741-bb71-161347ff00e8",
    "type": "financial_accounts",
    "attributes": {
      "active": false,
      "balance": "0.0",
      "code": "Beier, Farrell and Reinger",
      "converted_balance": 0.0,
      "converted_currency": "USD",
      "created_at": "2022-01-12T17:19:01Z",
      "currency": "USD",
      "last_download_at": null,
      "name": "Weber, Rosenbaum and Grimes",
      "updated_at": "2022-01-12T17:19:01Z",
      "updated_in_db_at": "2022-01-12T17:19:01Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "f166d17e-c67c-498e-991b-83e6cda32a08",
          "type": "organizations"
        }
      },
      "categories": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

active

Type boolean

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

balance

Type number

Description The balance in its native currency

code

Type string

Description The remote system code

converted_balance

Type number

Description The balance in the account_list default currency

converted_currency

Type string

Description The converted currency of the financial_account

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The native currency of the financial_account

last_download_at

Type string

Description The DateTime when the last entries were fetched

name

Type float

Description The name of the financial_account

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

categories.data

Type [Financial Account Entry Category]

Description Categories that entries are connected to

organization.data

Type Organization

Description The Organization the financial account belongs to

Financial Account [PUT]

Financial Account [PUT]

Request

Endpoint

PUT /api/v2/account_lists/8ba9d511-d89a-4fd2-bee0-910bc58e660a/financial_accounts/6f47c109-0a5a-412e-9e0f-620b74391934
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "financial_accounts",
    "attributes": {
      "active": true,
      "overwrite": true,
      "updated_in_db_at": "2022-01-12 17:19:01 UTC"
    }
  }
}

Parameters

Attributes

active

Type boolean

Description If this financial_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": "6f47c109-0a5a-412e-9e0f-620b74391934",
    "type": "financial_accounts",
    "attributes": {
      "active": true,
      "balance": "0.0",
      "code": "Crooks, Breitenberg and Schmidt",
      "converted_balance": 0.0,
      "converted_currency": "USD",
      "created_at": "2022-01-12T17:19:01Z",
      "currency": "USD",
      "last_download_at": null,
      "name": "Hermiston-Reinger",
      "updated_at": "2022-01-12T17:19:01Z",
      "updated_in_db_at": "2022-01-12T17:19:01Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "5e170cac-04f4-43b8-93c0-770d91c21d92",
          "type": "organizations"
        }
      },
      "categories": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

active

Type boolean

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

balance

Type number

Description The balance in its native currency

code

Type string

Description The remote system code

converted_balance

Type number

Description The balance in the account_list default currency

converted_currency

Type string

Description The converted currency of the financial_account

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The native currency of the financial_account

last_download_at

Type string

Description The DateTime when the last entries were fetched

name

Type float

Description The name of the financial_account

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

categories.data

Type [Financial Account Entry Category]

Description Categories that entries are connected to

organization.data

Type Organization

Description The Organization the financial account belongs to