VRPlatformVRPlatform
Reports

/reports/trial-balance

Trial balance report

GET
/reports/trial-balance
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

startDate*string
endDate*string
classification?string
ledger?string
Value in"trust" | "operating"
type?string
Value in"ledger" | "bank" | "recurringFee" | "nonPosting"
party?string
Value in"owners" | "manager"
accountIds?string
search?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/reports/trial-balance?startDate=string&endDate=string"
{
  "unassignedBalanceStart": 0,
  "unassignedDebit": 0,
  "unassignedCredit": 0,
  "unassignedBalanceEnd": 0,
  "unassignedDrilldowns": {
    "balanceStart": {
      "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",
        "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"
    },
    "debit": {
      "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",
        "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"
    },
    "credit": {
      "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",
        "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"
    },
    "balanceEnd": {
      "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",
        "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"
    }
  },
  "accounts": [
    {
      "id": "string",
      "title": "string",
      "classification": "string",
      "balanceStart": 0,
      "debit": 0,
      "credit": 0,
      "balanceEnd": 0,
      "drilldowns": {
        "balanceStart": {
          "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",
            "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"
        },
        "debit": {
          "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",
            "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"
        },
        "credit": {
          "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",
            "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"
        },
        "balanceEnd": {
          "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",
            "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",
  "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
}