/listings/opening-balance
Get opening balances for listings
Authorization
apiKey API key provided in dashboard
In: header
Query Parameters
"active" | "inactive"Filter by parent listing id. Use parent=null to return only parent/root listings.
Comma-separated listing ids.
vrp-csvFilter listings by ownership period ID.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidComma-separated listing short refs.
vrp-csvFilter listings by whether they currently have an active ownership period.
Include child listing links on each listing.
Filter by active recurring fee coverage. Use active or inactive for any recurring fee type, prefix a fee type with ! to exclude it, or pass a recurring fee UUID for one specific fee.
Filter listings that have (true) or lack (false) opening balances
Filter listings by setup issue code, "all" (all setup issues), or "any" (at least one setup issue)
"all" | "any" | "missingOwnershipOrDeactivation" | "missingFeesAndCommission" | "missingOpeningBalance"1001 <= value <= 25011 <= valueResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/listings/opening-balance"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"address": {
"full": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"stateCode": "string",
"countryCode": "string"
},
"openingBalance": {
"amount": -9007199254740991,
"currency": "string",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
}
}
],
"pagination": {
"limit": 100,
"page": 1,
"total": 0,
"totalPage": 0,
"nextPage": 0
}
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}