VRPlatformVRPlatform
Reports

/reports/trust-reconciliation/by-listing

Trust reconciliation grouped by listing

Required scope: reports:read

GET
/reports/trust-reconciliation/by-listing
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

endDate?string

Date boundary string. Accepted syntax: YYYY, YYYY-MM, or YYYY-MM-DD. Deprecated: use dateRange instead.

Formatvrp-date-boundary
dateRange?string

Date range string. Accepted syntax: YYYY, YYYY-MM, YYYY-MM-DD, or range YYYY-MM-DD...YYYY-MM-DD. Single values expand to the full year, month, or day.

Formatvrp-date-range
isDateRangeEndInclusive?boolean

Whether the end date in dateRange or paidAtRange is treated as inclusive (true) or exclusive (false).

Defaulttrue
listingDisplay?string

Controls grouped listing presentation. source returns flat source listing rows, nestedParent nests child rows below parent totals, and parentRollup returns only parent/group totals. Defaults to parentRollup.

Value in"source" | "nestedParent" | "parentRollup"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/reports/trust-reconciliation/by-listing"
{
  "trustReconciliationByListing": {
    "name": "Trust Reconciliation by Listing",
    "total": 0,
    "groups": [
      {
        "name": "Bank Accounts",
        "total": 0,
        "type": "accounts",
        "accounts": [
          {
            "id": "string",
            "name": "string",
            "categoryId": "string",
            "total": 0,
            "drilldown": {
              "type": "journalEntryReport",
              "filter": {
                "ids": "string",
                "txnCode": "string",
                "published": true,
                "status": "active",
                "ledger": "historical",
                "startAt": "string",
                "endAt": "string",
                "search": "string",
                "date": "string",
                "amount": "string",
                "isDateRangeEndInclusive": true,
                "reservationIds": "string",
                "transactionIds": "string",
                "ownerStatementIds": "string",
                "currency": "string",
                "excludeApAppendix": true,
                "listingIds": "string",
                "listingScope": "exact",
                "listingOwnershipPeriodIds": "string",
                "accountIds": "string",
                "accountReservationLineTypeIds": "string",
                "categoryIds": "string",
                "excludeCategoryIds": "string",
                "contactIds": "string",
                "classifications": "string",
                "accountType": "ledger",
                "types": "string",
                "excludeTypes": "string",
                "entityTypes": "string",
                "bookingChannels": "string",
                "triggerTypes": "string",
                "excludeTriggerTypes": "string",
                "parties": "string",
                "party": "owners",
                "accountAssignmentTypes": "string",
                "managerStatementSectionIds": "string",
                "recurringFee": true,
                "openingBalanceType": "taxPayable"
              },
              "measure": "periodActivity",
              "label": "string"
            }
          }
        ]
      }
    ]
  }
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}