VRPlatformVRPlatform
Reports

/reports/sales-tax-liability

Sales Tax Liability Report. Taxable income excludes synthetic A/R adjustment mirrors. Collectable taxes include reservation postings and reservation-attributed revenue reclassifications; tax remittances are excluded.

Required scope: reports:read

GET
/reports/sales-tax-liability

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

startDate?string

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

Formatvrp-date-boundary
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 (legacy comma separator also accepted). 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
taxableLineIds*string

Comma-separated reservation line mapping UUIDs.

channels?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://staging.api.vrplatform.app/reports/sales-tax-liability?taxableLineIds=string"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "taxableIncomeTotal": 0,
      "collectableTaxesTotal": 0,
      "channels": [
        {
          "name": "string",
          "taxableIncomeTotal": 0,
          "collectableTaxesTotal": 0,
          "reservations": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "taxableIncome": 0,
              "collectableTaxes": 0,
              "checkIn": "string",
              "checkOut": "string",
              "bookedAt": "string",
              "guestName": "string",
              "confirmationCode": "string",
              "nights": 0,
              "taxableIncomeDrilldown": {
                "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"
              },
              "collectableTaxesDrilldown": {
                "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"
              }
            }
          ]
        }
      ]
    }
  ],
  "taxesIncomeTotal": 0,
  "collectableTaxesTotal": 0
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/reports/sales-tax-liability/csv GET

Previous Page

/reports/trial-balance/csv GET

Next Page