v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB

Balance Sheet

Get BalanceSheet

get/accounting/balance-sheet

Query parameters

example_downstream_propertystring

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

{
  "search": "San Francisco"
}

start_datestring

The start date of the period to include in the resource.

end_datestring

The end date of the period to include in the resource.

period_countinteger

The number of periods to include in the resource.

period_type'month' | 'quarter' | 'year'

The type of period to include in the resource: month, quarter, year.

location_idstring

The ID of the location to include in the resource.

accounting_method'cash' | 'accrual'

The accounting method used for the report: cash or accrual.

Apply filters

{
  "start_date": "2021-01-01",
  "end_date": "2021-12-31",
  "period_count": 3,
  "period_type": "month",
  "location_id": "123",
  "accounting_method": "accrual"
}

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Response

BalanceSheet

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "BalanceSheets",
  "operation": "one",
  "data": {
    "reports": [
      {
        "id": "12345",
        "report_name": "BalanceSheet",
        "start_date": "2017-01-01",
        "end_date": "2017-01-31",
        "currency": "USD",
        "assets": {
          "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": {
          "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": {
          "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": 1000,
        "updated_by": "12345",
        "created_by": "12345",
        "updated_at": "2020-09-30T07:43:32.000Z",
        "created_at": "2020-09-30T07:43:32.000Z",
        "uncategorized_items": {
          "account_id": "3",
          "code": "3000",
          "name": "Uncategorized Items",
          "value": 1000,
          "items": [
            {
              "account_id": "301",
              "code": "3100",
              "name": "not linked account",
              "value": 1000
            }
          ]
        }
      }
    ]
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  }
}