Balance Sheets

The BalanceSheet object shows a company’s assets, liabilities, and equity. Assets should be equal to liability and equity combined. This shows the company’s financial health at a specific point in time.

The BalanceSheet object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
remote_dataRemoteData[]
Optional
nameString
Optional
The balance sheet's name.
currencyEnum
Optional
The balance sheet's currency. Possible values include: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL, or - in cases where there is no clear mapping - the original value passed through.
companyString
Optional
The company the balance sheet belongs to.
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[]
Required

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.
JSON
{
  "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": []
    }
  ],
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"
}

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
Required
companyString
Optional
The company the report item belongs to.
liabilitiesReportItem[]
Required

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.
JSON
{
  "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": []
    }
  ],
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"
}

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
Required
companyString
Optional
The company the report item belongs to.
equityReportItem[]
Required

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.
JSON
{
  "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": []
    }
  ],
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"
}

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
Required
companyString
Optional
The company the report item belongs to.
remote_generated_atString
Optional
The time that balance sheet was generated by the accounting system.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
The BalanceSheet object
JSON
{
  "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "remote_id": "8937018",
  "remote_data": [
    {
      "path": "string",
      "data": {}
    }
  ],
  "name": "BalanceSheet",
  "currency": "USD",
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
  "date": "2021-09-31T00:00:00Z",
  "net_assets": 1000,
  "assets": [
    {
      "remote_id": "10010",
      "name": "Assets",
      "value": 1000,
      "sub_items": []
    }
  ],
  "liabilities": [
    {
      "remote_id": "10011",
      "name": "Liabilities",
      "value": 500,
      "sub_items": []
    }
  ],
  "equity": [
    {
      "remote_id": "10012",
      "name": "Equity",
      "value": 500,
      "sub_items": []
    }
  ],
  "remote_generated_at": "2021-10-01T00:00:00Z",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  }
}
GET

/balance-sheets

Returns a list of BalanceSheet objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

company_idString
Optional
If provided, will only return balance sheets for this company.
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_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
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
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
      "remote_id": "8937018",
      "remote_data": [
        {
          "path": "string",
          "data": {}
        }
      ],
      "name": "BalanceSheet",
      "currency": "USD",
      "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
      "date": "2021-09-31T00:00:00Z",
      "net_assets": 1000,
      "assets": [
        {
          "remote_id": "10010",
          "name": "Assets",
          "value": 1000,
          "sub_items": []
        }
      ],
      "liabilities": [
        {
          "remote_id": "10011",
          "name": "Liabilities",
          "value": 500,
          "sub_items": []
        }
      ],
      "equity": [
        {
          "remote_id": "10012",
          "name": "Equity",
          "value": 500,
          "sub_items": []
        }
      ],
      "remote_generated_at": "2021-10-01T00:00:00Z",
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      }
    }
  ]
}
Field support by platform

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
dateString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_generated_atString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

dateString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_generated_atString
FreshBooks

FreshBooks

Coming Soon
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/balance-sheets/{id}

Returns a BalanceSheet object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

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
JSON
{
  "id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
  "remote_id": "8937018",
  "remote_data": [
    {
      "path": "string",
      "data": {}
    }
  ],
  "name": "BalanceSheet",
  "currency": "USD",
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
  "date": "2021-09-31T00:00:00Z",
  "net_assets": 1000,
  "assets": [
    {
      "remote_id": "10010",
      "name": "Assets",
      "value": 1000,
      "sub_items": []
    }
  ],
  "liabilities": [
    {
      "remote_id": "10011",
      "name": "Liabilities",
      "value": 500,
      "sub_items": []
    }
  ],
  "equity": [
    {
      "remote_id": "10012",
      "name": "Equity",
      "value": 500,
      "sub_items": []
    }
  ],
  "remote_generated_at": "2021-10-01T00:00:00Z",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  }
}
Field support by platform

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
dateString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_generated_atString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

dateString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_generated_atString
FreshBooks

FreshBooks

Coming Soon
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Attachments

Next Up

Cash Flow Statements