---
title: "Retrieves the collection of CustomerOpeningBalance resources."
method: GET
path: "/customer_opening_balances"
tags: ["CustomerOpeningBalance"]
---

# Retrieves the collection of CustomerOpeningBalance resources.

`GET /customer_opening_balances`

Retrieves the collection of CustomerOpeningBalance resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

CustomerOpeningBalance collection

- CustomerOpeningBalance[]
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — The unique identifier of the source 3rd party integration
  - `created` string, date-time, nullable — The datetime when the item was created
  - `modified` string, date-time, nullable — The datetime when the item was last modified
  - `openingBalanceType` string, nullable — Unique identifier for the opening balance type
  - `customerId` string, nullable — Unique identifier for the customer
  - `openingDate` string, nullable — The date of the opening balance
  - `description` string, nullable — A description of the opening balance
  - `totalAmount` integer, nullable — The total amount of the opening balance
  - `currency` string, nullable — Currency of the account

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/revisions/d08a107895ad/schema)