Balance Sheets

The BalanceSheet object is used to represent a company's balance sheet.

The BalanceSheet object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

nameString
Optional
The balance sheet's name.

dateString
Optional
The balance sheet's date. The balance sheet data will reflect the company's financial position this point in time.

net_assetsNumber
Optional
The balance sheet's net assets.

assetsReportItem[]
Optional

The ReportItem object

The ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.
{
  "remote_id": "10299",
  "name": "Revenue",
  "value": 1000,
  "sub_items": [
    {
      "remote_id": "10300",
      "name": "Revenue - San Francisco",
      "value": 500,
      "sub_items": []
    },
    {
      "remote_id": "10301",
      "name": "Revenue - New York",
      "value": 500,
      "sub_items": []
    }
  ]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Optional

liabilitiesReportItem[]
Optional

The ReportItem object

The ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.
{
  "remote_id": "10299",
  "name": "Revenue",
  "value": 1000,
  "sub_items": [
    {
      "remote_id": "10300",
      "name": "Revenue - San Francisco",
      "value": 500,
      "sub_items": []
    },
    {
      "remote_id": "10301",
      "name": "Revenue - New York",
      "value": 500,
      "sub_items": []
    }
  ]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Optional

equityReportItem[]
Optional

The ReportItem object

The ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.
{
  "remote_id": "10299",
  "name": "Revenue",
  "value": 1000,
  "sub_items": [
    {
      "remote_id": "10300",
      "name": "Revenue - San Francisco",
      "value": 500,
      "sub_items": []
    },
    {
      "remote_id": "10301",
      "name": "Revenue - New York",
      "value": 500,
      "sub_items": []
    }
  ]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Optional

remote_generated_atString
Optional
The time that balance sheet was generated by the accounting system.

The BalanceSheet object

{
  "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "remote_id": "8937018",
  "remote_data": [
    {
      "path": "string",
      "data": {}
    }
  ],
  "name": "BalanceSheet",
  "date": "2021-09-31T00:00:00Z",
  "net_assets": 1000,
  "assets": [
    {
      "remote_id": "10010",
      "name": "Assets",
      "value": 1000,
      "sub_items": null
    }
  ],
  "liabilities": [
    {
      "remote_id": "10011",
      "name": "Liabilities",
      "value": 500,
      "sub_items": null
    }
  ],
  "equity": [
    {
      "remote_id": "10012",
      "name": "Equity",
      "value": 500,
      "sub_items": null
    }
  ],
  "remote_generated_at": "2021-10-01T00:00:00Z"
}

GET

/balance-sheets

Returns a list of BalanceSheet objects.


Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
      "remote_id": "8937018",
      "remote_data": [
        {
          "path": "string",
          "data": {}
        }
      ],
      "name": "BalanceSheet",
      "date": "2021-09-31T00:00:00Z",
      "net_assets": 1000,
      "assets": [
        {
          "remote_id": "10010",
          "name": "Assets",
          "value": 1000,
          "sub_items": null
        }
      ],
      "liabilities": [
        {
          "remote_id": "10011",
          "name": "Liabilities",
          "value": 500,
          "sub_items": null
        }
      ],
      "equity": [
        {
          "remote_id": "10012",
          "name": "Equity",
          "value": 500,
          "sub_items": null
        }
      ],
      "remote_generated_at": "2021-10-01T00:00:00Z"
    }
  ]
}
GET

/balance-sheets/{id}

Returns a BalanceSheet object with the given id.


Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

Response

{
  "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "remote_id": "8937018",
  "remote_data": [
    {
      "path": "string",
      "data": {}
    }
  ],
  "name": "BalanceSheet",
  "date": "2021-09-31T00:00:00Z",
  "net_assets": 1000,
  "assets": [
    {
      "remote_id": "10010",
      "name": "Assets",
      "value": 1000,
      "sub_items": null
    }
  ],
  "liabilities": [
    {
      "remote_id": "10011",
      "name": "Liabilities",
      "value": 500,
      "sub_items": null
    }
  ],
  "equity": [
    {
      "remote_id": "10012",
      "name": "Equity",
      "value": 500,
      "sub_items": null
    }
  ],
  "remote_generated_at": "2021-10-01T00:00:00Z"
}