---
title: "Retrieves a CustomerOpeningBalance resource."
method: GET
path: "/customer_opening_balances/{id}"
tags: ["CustomerOpeningBalance"]
---

# Retrieves a CustomerOpeningBalance resource.

`GET /customer_opening_balances/{id}`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/customer_opening_balances/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/customer_opening_balances/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a CustomerOpeningBalance resource.

## Path parameters

- `id` string, required

## Response `200`

CustomerOpeningBalance resource

- 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

## Other responses

- `404`: Resource not found

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)