Apideck · Schema

BalanceSheet

IntegrationsUnified API

Properties

Name Type Description
reports array
View JSON Schema on GitHub

JSON Schema

apideck-balancesheet-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BalanceSheet",
  "title": "BalanceSheet",
  "type": "object",
  "x-apideck-schema-id": "BalanceSheet",
  "x-apideck-circular-ref": true,
  "x-apideck-weights": {
    "reports": "critical"
  },
  "additionalProperties": false,
  "required": [
    "reports"
  ],
  "properties": {
    "reports": {
      "type": "array",
      "x-apideck-schema-id": "BalanceSheetReports",
      "items": {
        "type": "object",
        "x-apideck-schema-id": "BalanceSheetReport",
        "x-apideck-weights": {
          "id": "medium",
          "report_name": "medium",
          "start_date": "medium",
          "end_date": "critical",
          "currency": "medium",
          "assets": "critical",
          "liabilities": "critical",
          "equity": "critical",
          "net_assets": "high",
          "custom_mappings": "edge-case",
          "updated_by": "edge-case",
          "created_by": "edge-case",
          "updated_at": "low",
          "created_at": "edge-case",
          "uncategorized_items": "edge-case"
        },
        "additionalProperties": false,
        "required": [
          "end_date",
          "assets",
          "liabilities",
          "equity"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Id"
          },
          "report_name": {
            "type": "string",
            "description": "The name of the report",
            "title": "Report Name",
            "example": "BalanceSheet"
          },
          "start_date": {
            "type": "string",
            "description": "The start date of the report",
            "title": "Start Date",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "example": "2017-01-01"
          },
          "end_date": {
            "type": "string",
            "description": "The start date of the report",
            "title": "Start Date",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "example": "2017-01-31"
          },
          "currency": {
            "$ref": "#/components/schemas/Currency"
          },
          "assets": {
            "type": "object",
            "x-apideck-schema-id": "BalanceSheetAssetsAccount",
            "x-apideck-weights": {
              "account_id": "high",
              "name": "high",
              "value": "critical",
              "items": "medium"
            },
            "title": "Balance Sheet Assets Account",
            "description": "A balance sheet assets account represents the financial position of a company at a specific point in time.",
            "additionalProperties": false,
            "properties": {
              "account_id": {
                "$ref": "#/components/schemas/AccountId"
              },
              "code": {
                "$ref": "#/components/schemas/AccountCode"
              },
              "name": {
                "$ref": "#/components/schemas/AccountName"
              },
              "value": {
                "$ref": "#/components/schemas/Amount"
              },
              "items": {
                "$ref": "#/components/schemas/BalanceSheetAccounts"
              }
            },
            "example": {
              "account_id": "1",
              "code": "1000",
              "name": "Assets",
              "value": 50000,
              "items": [
                {
                  "account_id": "101",
                  "code": "1100",
                  "name": "Current Assets",
                  "value": 20000,
                  "items": [
                    {
                      "account_id": "1011",
                      "code": "1101",
                      "name": "Cash and Cash Equivalents",
                      "value": 10000
                    },
                    {
                      "account_id": "1012",
                      "code": "1102",
                      "name": "Accounts Receivable",
                      "value": 5000
                    },
                    {
                      "account_id": "1013",
                      "code": "1103",
                      "name": "Inventory",
                      "value": 3000
                    },
                    {
                      "account_id": "1014",
                      "code": "1104",
                      "name": "Prepaid Expenses",
                      "value": 2000
                    }
                  ]
                },
                {
                  "account_id": "102",
                  "code": "1200",
                  "name": "Non-Current Assets",
                  "value": 30000,
                  "items": [
                    {
                      "account_id": "1021",
                      "code": "1201",
                      "name": "Property, Plant, and Equipment (PPE)",
                      "value": 25000
                    },
                    {
                      "account_id": "1022",
                      "code": "1202",
                      "name": "Intangible Assets",
                      "value": 5000,
                      "items": [
                        {
                          "account_id": "10221",
                          "code": "1203",
                          "name": "Goodwill",
                          "value": 3000
                        },
                        {
                          "account_id": "10222",
                          "code": "1204",
                          "name": "Patents",
                          "value": 2000
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          },
          "liabilities": {
            "type": "object",
            "x-apideck-schema-id": "BalanceSheetLiabilitiesAccount",
            "x-apideck-weights": {
              "account_id": "high",
              "name": "high",
              "value": "critical",
              "items": "medium"
            },
            "title": "Balance Sheet Liabilities Account",
            "description": "A balance sheet liabilities account represents the financial position of a company at a specific point in time.",
            "additionalProperties": false,
            "properties": {
              "account_id": {
                "$ref": "#/components/schemas/AccountId"
              },
              "code": {
                "$ref": "#/components/schemas/AccountCode"
              },
              "name": {
                "$ref": "#/components/schemas/AccountName"
              },
              "value": {
                "$ref": "#/components/schemas/Amount"
              },
              "items": {
                "$ref": "#/components/schemas/BalanceSheetAccounts"
              }
            },
            "example": {
              "account_id": "2",
              "code": "2000",
              "name": "Liabilities",
              "value": 30000,
              "items": [
                {
                  "account_id": "201",
                  "code": "2100",
                  "name": "Current Liabilities",
                  "value": 10000,
                  "items": [
                    {
                      "account_id": "2011",
                      "code": "2101",
                      "name": "Accounts Payable",
                      "value": 4000
                    },
                    {
                      "account_id": "2012",
                      "code": "2102",
                      "name": "Short-Term Debt",
                      "value": 2000
                    },
                    {
                      "account_id": "2013",
                      "code": "2103",
                      "name": "Accrued Expenses",
                      "value": 1000
                    },
                    {
                      "account_id": "2014",
                      "code": "2104",
                      "name": "Current Portion of Long-Term Debt",
                      "value": 3000
                    }
                  ]
                },
                {
                  "account_id": "202",
                  "code": "2200",
                  "name": "Non-Current Liabilities",
                  "value": 20000,
                  "items": [
                    {
                      "account_id": "2021",
                      "code": "2201",
                      "name": "Long-Term Debt",
                      "value": 15000
                    },
                    {
                      "account_id": "2022",
                      "code": "2202",
                      "name": "Deferred Tax Liabilities",
                      "value": 3000
                    },
                    {
                      "account_id": "2023",
                      "code": "2203",
                      "name": "Pension Liabilities",
                      "value": 2000
                    }
                  ]
                }
              ]
            }
          },
          "equity": {
            "type": "object",
            "x-apideck-schema-id": "BalanceSheetEquityAccount",
            "x-apideck-weights": {
              "account_id": "high",
              "name": "high",
              "value": "critical",
              "items": "medium"
            },
            "title": "Balance Sheet Equity Account",
            "description": "A balance sheet equity account represents the financial position of a company at a specific point in time.",
            "additionalProperties": false,
            "properties": {
              "account_id": {
                "$ref": "#/components/schemas/AccountId"
              },
              "code": {
                "$ref": "#/components/schemas/AccountCode"
              },
              "name": {
                "$ref": "#/components/schemas/AccountName"
              },
              "value": {
                "$ref": "#/components/schemas/Amount"
              },
              "items": {
                "$ref": "#/components/schemas/BalanceSheetAccounts"
              }
            },
            "example": {
              "account_id": "3",
              "code": "3000",
              "name": "Equity",
              "value": 20000,
              "items": [
                {
                  "account_id": "301",
                  "code": "3100",
                  "name": "Common Stock",
                  "value": 5000
                },
                {
                  "account_id": "302",
                  "code": "3200",
                  "name": "Retained Earnings",
                  "value": 10000
                },
                {
                  "account_id": "303",
                  "code": "3300",
                  "name": "Additional Paid-In Capital",
                  "value": 3000
                },
                {
                  "account_id": "304",
                  "code": "3400",
                  "name": "Treasury Stock",
                  "value": -1000
                },
                {
                  "account_id": "305",
                  "code": "3500",
                  "name": "Other Comprehensive Income",
                  "value": 3000
                }
              ]
            }
          },
          "net_assets": {
            "type": "number",
            "description": "The net assets of the balance sheet",
            "title": "Net Assets",
            "example": 1000
          },
          "custom_mappings": {
            "$ref": "#/components/schemas/CustomMappings"
          },
          "updated_by": {
            "$ref": "#/components/schemas/UpdatedBy"
          },
          "created_by": {
            "$ref": "#/components/schemas/CreatedBy"
          },
          "updated_at": {
            "$ref": "#/components/schemas/UpdatedAt"
          },
          "created_at": {
            "$ref": "#/components/schemas/CreatedAt"
          },
          "uncategorized_items": {
            "type": "object",
            "x-apideck-schema-id": "BalanceSheetUncategorizedItemsAccount",
            "x-apideck-weights": {
              "account_id": "high",
              "name": "high",
              "value": "critical",
              "items": "medium"
            },
            "title": "Balance Sheet Uncategorized Items Account",
            "description": "A balance sheet uncategorized items account represents the financial position of a company at a specific point in time.",
            "additionalProperties": false,
            "properties": {
              "account_id": {
                "$ref": "#/components/schemas/AccountId"
              },
              "code": {
                "$ref": "#/components/schemas/AccountCode"
              },
              "name": {
                "$ref": "#/components/schemas/AccountName"
              },
              "value": {
                "$ref": "#/components/schemas/Amount"
              },
              "items": {
                "$ref": "#/components/schemas/BalanceSheetAccounts"
              }
            },
            "example": {
              "account_id": "3",
              "code": "3000",
              "name": "Uncategorized Items",
              "value": 1000,
              "items": [
                {
                  "account_id": "301",
                  "code": "3100",
                  "name": "not linked account",
                  "value": 1000
                }
              ]
            }
          }
        }
      }
    }
  }
}