Merge · Schema

AccountRequest

# The Account Object ### Description An `Account` represents a category in a company’s ledger in which a financial transaction is recorded against. The aggregation of each `Account` object is often referred to as the **Chart of Accounts**. An `Account` can be classified into one of the following categories, determined through the `classification` field: * __Asset:__ Accounts Receivable and Bank Accounts * __Liability:__ Accounts Payable and Credit Card Accounts * __Equity:__ Treasury Accounts and Retained Earnings * __Revenue:__ Income and Other Income * __Expense:__ Cost of Goods Sold and Office Expenses ### Usage Example Fetch from the `LIST Accounts` endpoint and view a company's accounts.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
name	stringnull	The account's name.
description	stringnull	The account's description.
classification	object	The account's broadest grouping.
type	stringnull	The account's type is a narrower and more specific grouping within the account's classification.
account_type	object	Normalized account type- which is a narrower and more specific grouping within the account's classification.
status	object	The account's status.
current_balance	numbernull	The account's current balance.
currency	object	The account's currency. The currency code in ISO 4217 format.
account_number	stringnull	The account's number.
parent_account	stringnull	ID of the parent account.
company	stringnull	The company the account belongs to.
integration_params	objectnull
linked_account_params	objectnull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountRequest",
  "title": "AccountRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The account's name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The account's description."
    },
    "classification": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ClassificationEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The account's broadest grouping."
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "The account's type is a narrower and more specific grouping within the account's classification."
    },
    "account_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/AccountAccountTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "Normalized account type- which is a narrower and more specific grouping within the account's classification."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/AccountStatusEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The account's status."
    },
    "current_balance": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The account's current balance."
    },
    "currency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionCurrencyEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The account's currency. The currency code in ISO 4217 format."
    },
    "account_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The account's number."
    },
    "parent_account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "ID of the parent account."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the account belongs to."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    }
  },
  "description": "# The Account Object\n### Description\nAn `Account` represents a category in a company\u2019s ledger in which a financial transaction is recorded against. The aggregation of each `Account` object is often referred to as the **Chart of Accounts**.\n\nAn `Account` can be classified into one of the following categories, determined through the `classification` field:\n* __Asset:__ Accounts Receivable and Bank Accounts\n* __Liability:__ Accounts Payable and Credit Card Accounts\n* __Equity:__ Treasury Accounts and Retained Earnings\n* __Revenue:__ Income and Other Income\n* __Expense:__ Cost of Goods Sold and Office Expenses\n\n### Usage Example\nFetch from the `LIST Accounts` endpoint and view a company's accounts."
}