Entries

Entries Documentation

Entry [LIST]

Entry [LIST]

Request

Endpoint

GET /api/v2/account_lists/d0aa746d-7daf-450b-8f5c-35d4512609ce/entries
Content-Type: application/vnd.api+json

Body

Parameters

Sorts

entry_date

Type Unknown

Description Sort by entry_date date

Required No

Filters

category_id

Type ID string

Description Filter where entry category_id is in the collection; accepts ids separated by comma

Required No

entry_date

Type date

Description Filter where entry_date is within provided date range

Required No

financial_account_id

Type ID string

Description Filter where entry financial_account_id is in the collection; accepts ids separated by comma

Required No

wildcard_search

Type string

Description Filter where string is in description, code, category name, or category code

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "4e3630c7-142e-4b26-b045-5105a389fa35",
      "type": "financial_account_entry_credits",
      "attributes": {
        "amount": "9.99",
        "code": null,
        "created_at": "2022-01-12T17:18:55Z",
        "currency": "NZD",
        "description": "Universal maximized instruction set",
        "entry_date": "2022-01-12",
        "remote_id": "3",
        "type": "FinancialAccount::Entry::Credit",
        "updated_at": "2022-01-12T17:18:55Z",
        "updated_in_db_at": "2022-01-12T17:18:55Z"
      },
      "relationships": {
        "financial_account": {
          "data": {
            "id": "dedd96c3-6849-4f97-9cec-0bd33fc41d96",
            "type": "financial_accounts"
          }
        },
        "category": {
          "data": {
            "id": "1ed7f9db-1d6a-4ac2-87d6-9d2e3fdbc40c",
            "type": "financial_account_entry_categories"
          }
        }
      }
    },
    {
      "id": "7a4ed193-1b67-45b4-8c92-ae24dd451c4b",
      "type": "financial_account_entry_credits",
      "attributes": {
        "amount": "9.99",
        "code": null,
        "created_at": "2022-01-12T17:18:55Z",
        "currency": "NZD",
        "description": "Public-key cohesive Graphic Interface",
        "entry_date": "2022-01-12",
        "remote_id": "4",
        "type": "FinancialAccount::Entry::Credit",
        "updated_at": "2022-01-12T17:18:55Z",
        "updated_in_db_at": "2022-01-12T17:18:55Z"
      },
      "relationships": {
        "financial_account": {
          "data": {
            "id": "dedd96c3-6849-4f97-9cec-0bd33fc41d96",
            "type": "financial_accounts"
          }
        },
        "category": {
          "data": {
            "id": "1ed7f9db-1d6a-4ac2-87d6-9d2e3fdbc40c",
            "type": "financial_account_entry_categories"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 2,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    },
    "credits": "19.98",
    "debits": "0.0",
    "difference": "19.98",
    "currency": "USD",
    "closing_balance": 0,
    "opening_balance": 0
  }
}

Fields

data

Type [Financial Account Entry]

Description An array of Entries

Entry [GET]

Entry [GET]

Request

Endpoint

GET /api/v2/account_lists/909be3fd-c1a7-4852-9fba-14cabf75289f/entries/af902feb-5957-4d87-a4a6-2cbd0b38c2fa
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "af902feb-5957-4d87-a4a6-2cbd0b38c2fa",
    "type": "financial_account_entry_credits",
    "attributes": {
      "amount": "9.99",
      "code": null,
      "created_at": "2022-01-12T17:18:55Z",
      "currency": "NZD",
      "description": "Intuitive actuating throughput",
      "entry_date": "2022-01-12",
      "remote_id": "1",
      "type": "FinancialAccount::Entry::Credit",
      "updated_at": "2022-01-12T17:18:55Z",
      "updated_in_db_at": "2022-01-12T17:18:55Z"
    },
    "relationships": {
      "financial_account": {
        "data": {
          "id": "95b038dd-302c-4903-b155-6554deb8b2f2",
          "type": "financial_accounts"
        }
      },
      "category": {
        "data": {
          "id": "29de9a27-21e7-4629-a202-b7fb8a38958e",
          "type": "financial_account_entry_categories"
        }
      }
    }
  }
}

Fields

Attributes

amount

Type number

Description The original amount

code

Type string

Description The entry code

created_at

Type date

Description The timestamp of when this resource was created

currency

Type string

Description The currency of the original amount

description

Type string

Description Additional notes in relation to this entry

entry_date

Type date

Description The date the entry was received

remote_id

Type ID string

Description The remote system id given by the origin system

type

Type string

Description Either FinancialAccount::Entry::Credit or FinancialAccount::Entry::Debit

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

category.data

Type Financial Account Entry Category

Description The category this entry fits into

financial_account.data

Type Financial Account

Description The financial account the entry belongs to