Recurring fees
/recurring-fees/{id}
Get a recurring fee and whether its affected reservation journals are current.
Required scope: recurring-fees:read
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Path Parameters
id*string
Match
^([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)$Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/recurring-fees/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"name": "string",
"formula": "string",
"defaultRate": -9007199254740991,
"icon": "string",
"type": "managementFee",
"taxBehavior": "excluded",
"revenueRecognition": "checkIn",
"status": "active",
"rateType": "flat",
"creditParty": "manager",
"debitParty": "manager",
"bookingChannelsFilter": [
"string"
],
"statusFilter": "canceled",
"accountTotalConditions": [
{
"accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
"operator": ">",
"centValue": -9007199254740991
}
],
"id": "string",
"uniqueRef": "string",
"lock": {
"status": "locked",
"booksClosed": {
"date": "string"
},
"ownerStatement": {
"ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
},
"reconciled": {
"bankRecordIds": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
},
"statementPeriod": {
"hits": [
{
"listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
"txnAt": "string",
"openFrom": "string"
}
]
}
},
"creditAccount": {
"id": "string",
"name": "string",
"uniqueRef": "string",
"status": "active"
},
"debitAccount": {
"id": "string",
"name": "string",
"uniqueRef": "string",
"status": "active"
},
"linkedAccounts": [
{
"id": "string",
"name": "string",
"uniqueRef": "string",
"status": "active"
}
],
"includedFinancials": [
{
"accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
"lineType": "string",
"name": "string",
"app": {
"id": "string",
"name": "string"
}
}
],
"taxRate": {
"id": "string",
"name": "string",
"basisPoints": 100000
},
"activeListings": 9007199254740991,
"journalStatus": {
"state": "current",
"reason": "journalLocked",
"staleSince": "2024-01-15T12:30:00.000+00:00",
"calculatedAt": "2024-01-15T12:30:00.000+00:00"
},
"operations": {
"counts": {
"total": 9007199254740991,
"queued": 9007199254740991,
"running": 9007199254740991,
"completed": 9007199254740991,
"failed": 9007199254740991
},
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "ach-verification",
"status": "queued",
"resource": {
"type": "bank-rule",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role": "source",
"url": "http://example.com"
},
"failure": {
"code": "csvBlankHeader",
"message": "CSV contains a blank header"
},
"initiator": {
"type": "user",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
},
"createdAt": "2024-01-15T12:30:00.000+00:00",
"startedAt": "2024-01-15T12:30:00.000+00:00",
"finishedAt": "2024-01-15T12:30:00.000+00:00"
}
]
}
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "MISDIRECTED_REQUEST",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
"dataRegion": "ap",
"apiBaseUrl": "http://example.com"
}
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}