v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
CustomerOpeningBalance

Retrieves the collection of CustomerOpeningBalance resources.

Retrieves the collection of CustomerOpeningBalance resources.

get/customer_opening_balances

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

CustomerOpeningBalance collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

The unique identifier of the source 3rd party integration

createdstring date-time nullable

The datetime when the item was created

modifiedstring date-time nullable

The datetime when the item was last modified

openingBalanceTypestring nullable

Unique identifier for the opening balance type

customerIdstring nullable

Unique identifier for the customer

openingDatestring nullable

The date of the opening balance

descriptionstring nullable

A description of the opening balance

totalAmountinteger nullable

The total amount of the opening balance

currencystring nullable

Currency of the account

Example response

[
  {
    "integration": "quickbooks"
  }
]