VRPlatformVRPlatform
Api

Audit Catalog

Generated audit subjects, field paths, value types, and reference targets

Audit Catalog

Last Updated: 2026-09-03 Version: 2.0.0

Every field that can appear in an audit event's entityChanges, attemptedEntityChanges, or redactedFields is listed here; no other field is ever published. Any listed field can appear in redactedFields when its value was withheld. The changedPath filter accepts exactly these paths for the selected changedEntityType. See Audit Events for the event model and synchronization rules.

Action codes join the root entity type with the past tense of the operation: reservation.updated, ownerStatement.created, bankRecord.deleted. Operations are create, update, delete, archive, restore, execute, and recalculate.

Event Attribution And Outcomes

  • actor.type: user, api_key, sync, automation, or system.
  • actor.organization.type: vrplatform, partner, team, or system; the organization is nullable when retained evidence cannot prove the event-time affiliation.
  • source.type: portal, api, integration, sync, automation, embedded, or system.
  • entityChanges contains committed reviewed changes.
  • attemptedEntityChanges contains reviewed changes that were attempted but blocked.
  • accountingImpact.blockedBy[].code: booksClosed, statementPeriod, or statementAttachment.
  • accountingImpact.recovery[].action: createReservationAdjustment when that recovery path is supported.

account

Root entity type. Events with this root match entityType=account.

Field filters match changedEntityType=account with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountConnectionIdsstring_listValue returned
assignmentsstring_listValue returned
bankingCategoryenumValue returned
bankingCurrencyenumValue returned
bankingLast4stringValue returned
bankingTypeenumValue returned
categoryIdentity_referenceaccountCategoryValue returned
statusenumValue returned
titlestringValue returned
typeenumValue returned
uniqueRefstringValue returned

accountConnection

Root entity type. Events with this root match entityType=accountConnection.

Field filters match changedEntityType=accountConnection with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
accountIdentity_referenceaccountValue returned
categoryenumValue returned
currencyenumValue returned
lastDigitsstringValue returned
namestringValue returned
startDatedateValue returned
statusenumValue returned
typeenumValue returned

apiToken

Root entity type. Events with this root match entityType=apiToken.

Field filters match changedEntityType=apiToken with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
allowedEmbedParentOriginsstring_listAlways redacted
allowedIpCidrsstring_listAlways redacted
bundlesstring_listValue returned
hintstringValue returned
roleenumValue returned
scopestringValue returned
scopesstring_listValue returned

bankRecord

Root entity type. Events with this root match entityType=bankRecord.

Field filters match changedEntityType=bankRecord with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountConnectionIdentity_referenceaccountConnectionValue returned
accountIdentity_referenceaccountValue returned
centBalancemoneyValue returned
centTotalmoneyValue returned
datedateValue returned
isBalanceAdjustmentbooleanValue returned
reconcileStatusenumValue returned
statusenumValue returned

bankRule

Root entity type. Events with this root match entityType=bankRule.

Field filters match changedEntityType=bankRule with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountIdsstring_listValue returned
conditionsstringAlways redacted
descriptionOverridestringAlways redacted
linesstringAlways redacted
matchModeenumValue returned
modeenumValue returned
namestringValue returned
priorityintegerValue returned
statusenumValue returned
transactionTypeenumValue returned
usePriorMonthEndbooleanValue returned
vendorContactIdentity_referencecontactValue returned

connection

Root entity type. Events with this root match entityType=connection.

Field filters match changedEntityType=connection with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountingEndAtdateValue returned
accountingStartAtdateValue returned
appIdentity_referenceappValue returned
credentialsstringAlways redacted
disabledbooleanValue returned
namestringValue returned
statusenumValue returned
typeenumValue returned

contact

Root entity type. Events with this root match entityType=contact.

Field filters match changedEntityType=contact with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
emailstringValue returned
firstNamestringValue returned
namestringValue returned
payoutAccountIdentity_referenceaccountValue returned
statusenumValue returned
typeenumValue returned

emailTemplate

Root entity type. Events with this root match entityType=emailTemplate.

Field filters match changedEntityType=emailTemplate with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
datastringAlways redacted
typeenumValue returned

flowMapping

Root entity type. Events with this root match entityType=flowMapping.

Field filters match changedEntityType=flowMapping with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountIdentity_referenceaccountValue returned
bookingChannelIdentity_referencebookingChannelValue returned
connectionIdentity_referenceconnectionValue returned
contactIdentity_referencecontactValue returned
flowIdentity_referenceflowValue returned
listingIdentity_referencelistingValue returned
mappingKeystringValue returned
rateIdentity_referencetaxRateValue returned
sourceIdstringAlways redacted
valuestringAlways redacted

flowSetting

Root entity type. Events with this root match entityType=flowSetting.

Field filters match changedEntityType=flowSetting with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountIdentity_referenceaccountValue returned
bookingChannelIdentity_referencebookingChannelValue returned
connectionIdentity_referenceconnectionValue returned
contactIdentity_referencecontactValue returned
flowIdentity_referenceflowValue returned
listingIdentity_referencelistingValue returned
rateIdentity_referencetaxRateValue returned
settingKeystringValue returned
valuestringAlways redacted

listing

Root entity type. Events with this root match entityType=listing.

Field filters match changedEntityType=listing with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
collectionIdentity_referencelistingCollectionValue returned
customCodestringValue returned
defaultCurrencyenumValue returned
namestringValue returned
parentIdentity_referencelistingValue returned
statusenumValue returned
titlestringValue returned
uniqueRefstringValue returned

listingOwnershipPeriod

Root entity type. Events with this root match entityType=listingOwnershipPeriod.

Field filters match changedEntityType=listingOwnershipPeriod with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
businessModelenumValue returned
endAtdateValue returned
listingIdentity_referencelistingValue returned
reserveCentTotalmoneyValue returned
setListingInactivebooleanValue returned
startAtdateValue returned

ownerStatement

Root entity type. Events with this root match entityType=ownerStatement.

Field filters match changedEntityType=ownerStatement with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
centBalanceEndmoneyValue returned
centBalanceStartmoneyValue returned
centExpensesmoneyValue returned
centNetRevenuemoneyValue returned
centPayedOutmoneyValue returned
centRentalRevenuemoneyValue returned
centTotalmoneyValue returned
centTransfermoneyValue returned
currencyenumValue returned
endAtdateValue returned
listingIdentity_referencelistingValue returned
listingOwnershipPeriodIdentity_referencelistingOwnershipPeriodValue returned
startAtdateValue returned
statusenumValue returned
uniqueRefstringValue returned

ownerStatementLayout

Root entity type. Events with this root match entityType=ownerStatementLayout.

Field filters match changedEntityType=ownerStatementLayout with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
activeListingIdsstring_listValue returned
isDefaultbooleanValue returned
linkedAccountIdsstring_listValue returned
namestringValue returned
netRevenueSectionsstringAlways redacted
otherSectionsstringAlways redacted
showTeamEmailbooleanValue returned
summaryTypeenumValue returned
versionintegerValue returned

ownerStatementLayoutListing

Root entity type. Events with this root match entityType=ownerStatementLayoutListing.

Field filters match changedEntityType=ownerStatementLayoutListing with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
layoutIdentity_referenceownerStatementLayoutValue returned
listingIdentity_referencelistingValue returned

ownerUserAccess

Root entity type. Events with this root match entityType=ownerUserAccess.

Field filters match changedEntityType=ownerUserAccess with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
contactIdentity_referencecontactValue returned
roleenumValue returned
userIdstringAlways redacted

recurringFee

Root entity type. Events with this root match entityType=recurringFee.

Field filters match changedEntityType=recurringFee with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountTotalConditionsstringAlways redacted
bookingChannelsFilterstring_listValue returned
creditAccountIdentity_referenceaccountValue returned
creditPartyenumValue returned
debitAccountIdentity_referenceaccountValue returned
debitPartyenumValue returned
defaultRateintegerValue returned
formulastringAlways redacted
linkedAccountIdsstring_listValue returned
rateTypeenumValue returned
revenueRecognitionenumValue returned
statusenumValue returned
statusFilterenumValue returned
taxBehaviorenumValue returned
taxRateIdentity_referencetaxRateValue returned
titlestringValue returned
typeenumValue returned
uniqueRefstringValue returned

recurringFeeListingSubscription

Root entity type. Events with this root match entityType=recurringFeeListingSubscription.

Field filters match changedEntityType=recurringFeeListingSubscription with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
endAtdateValue returned
listingIdentity_referencelistingValue returned
rateintegerValue returned
rateTypeenumValue returned
recurringFeeIdentity_referencerecurringFeeValue returned
startAtdateValue returned
statusenumValue returned

recurringTransactionTemplate

Root entity type. Events with this root match entityType=recurringTransactionTemplate.

Field filters match changedEntityType=recurringTransactionTemplate with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountIdentity_referenceaccountValue returned
centTotalmoneyValue returned
contactIdentity_referencecontactValue returned
currencyenumValue returned
datedateValue returned
descriptionstringAlways redacted
linesstringAlways redacted
paidStatusenumValue returned
patternstringAlways redacted
statusenumValue returned
uniqueRefstringValue returned

reservation

Root entity type. Events with this root match entityType=reservation.

Field filters match changedEntityType=reservation with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
adultsintegerValue returned
bookingPlatformenumValue returned
centAccommodationmoneyValue returned
centCleaningmoneyValue returned
centTotalmoneyValue returned
checkIndateValue returned
checkOutdateValue returned
childrenintegerValue returned
confirmationCodestringValue returned
currencyenumValue returned
editedCheckIndateValue returned
editedCheckOutdateValue returned
generalLedgerPostingAtdateValue returned
generalLedgerStatusenumValue returned
guestsintegerValue returned
listingIdentity_referencelistingValue returned
managerCentTotalmoneyValue returned
ownersCentTotalmoneyValue returned
paidStatusenumValue returned
pmsReferenceCodestringValue returned
statusenumValue returned
taxCentTotalmoneyValue returned
uniqueRefstringValue returned

reservationLineMapping

Root entity type. Events with this root match entityType=reservationLineMapping.

Field filters match changedEntityType=reservationLineMapping with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountIdentity_referenceaccountValue returned
bookingChannelstringValue returned
descriptionstringAlways redacted
lineTypestringValue returned
revenueRecognitionenumValue returned
statusenumValue returned

taxRate

Root entity type. Events with this root match entityType=taxRate.

Field filters match changedEntityType=taxRate with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountIdentity_referenceaccountValue returned
basisPointsintegerValue returned
behaviorenumValue returned
countryCodestringValue returned
currencyenumValue returned
debitAccountIdentity_referenceaccountValue returned
descriptionstringValue returned
namestringValue returned
statusenumValue returned
typeenumValue returned
uniqueRefstringValue returned

team

Root entity type. Events with this root match entityType=team.

Field filters match changedEntityType=team with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
booksClosedAtdateValue returned
colorPrimarystringValue returned
defaultCurrencyenumValue returned
defaultRevenueRecognitionenumValue returned
logostringAlways redacted
namestringValue returned
ownerPortalShowDraftStatementsbooleanValue returned
partnerDeniedPermissionsstring_listValue returned
slugstringValue returned
settings.showCancelledReservationsbooleanValue returned
settings.showOwnerCalendarBlockingbooleanValue returned
settings.showReservationTotalbooleanValue returned
settings.showReservationsbooleanValue returned
settings.showTaxStatementsbooleanValue returned
settings.showTwoFactorAuthbooleanValue returned
settings.showVRPilotGuidebooleanValue returned
statementStartAtdateValue returned

teamMember

Root entity type. Events with this root match entityType=teamMember.

Field filters match changedEntityType=teamMember with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
managedTeamAccessenumValue returned
permissionBundlesstring_listValue returned
roleenumValue returned
statusenumValue returned

transaction

Root entity type. Events with this root match entityType=transaction.

Field filters match changedEntityType=transaction with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountIdentity_referenceaccountValue returned
centTotalmoneyValue returned
contactIdentity_referencecontactValue returned
currencyenumValue returned
datedateValue returned
descriptionstringValue returned
dueAtdateValue returned
paidAtdateValue returned
paidStatusenumValue returned
recurringFeeIdentity_referencerecurringFeeValue returned
returnedFromTransactionIdentity_referencetransactionValue returned
returnEffectiveAttimestampValue returned
statusenumValue returned
typeenumValue returned
uniqueRefstringValue returned

webhookSubscription

Root entity type. Events with this root match entityType=webhookSubscription.

Field filters match changedEntityType=webhookSubscription with one changedPath from this table.

Can affect accounting

No

Fields

PathValue typeReferencesVisibility
apiVersionenumValue returned
descriptionstringAlways redacted
eventTypesstring_listValue returned
scopeenumValue returned
secretstringAlways redacted
statusenumValue returned
urlstringAlways redacted

paymentLine

Child subject only. It never forms its own event and appears inside its root event's entityChanges.

Field filters match changedEntityType=paymentLine with one changedPath from this table.

Can affect accounting

Yes

Fields

PathValue typeReferencesVisibility
accountIdentity_referenceaccountValue returned
amountmoneyValue returned
descriptionstringValue returned
generalLedgerPostingAtdateValue returned
partyenumValue returned
recurringFeeIdentity_referencerecurringFeeValue returned
typeenumValue returned
uniqueRefstringValue returned

On this page