Reservations
/reservations/{id}
Update a reservation by ID. Financial changes refresh the reservation journal inline; a reservation locked by closed books, a finalized statement period, or entries attached to an owner statement rejects them unless the change posts via a generalLedgerPostingAt date after the locked range. Owner API keys cannot update reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#editability.
Required scope: reservations:write
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
uuidQuery Parameters
dryRun?boolean
Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode.
Request Body
application/json
currency?string|null
uniqueRef?string|null
connectionId?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
uuidguestName?string|null
bookerName?string|null
checkIn?string|null
checkOut?string|null
generalLedgerPostingAt?string|null
listingId?string|null
status?string|null
bookedAt?string|null
cancelledAt?string|null
bookingPlatform?string|null
confirmationCode?string|null
pmsReferenceCode?string|null
guests?number|null
userdata?|null
metadata?|null
sourceId?string|null
source?|null
lines?|null
lines_create?|null
Lines to be added (can not be combined with "lines" in the same request)
lines_update?|null
Lines to be updated (can not be combined with "lines" in the same request)
lines_delete?|null
Lines to be deleted (can not be combined with "lines" in the same request)
adjustments_create?|null
Adjustments to be created
adjustments_update?|null
Adjustments to be updated
adjustments_delete?|null
Adjustments to be deleted
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://api.vrplatform.app/reservations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{
"currency": "string",
"uniqueRef": "string",
"guestName": "string",
"bookerName": "string",
"checkIn": "string",
"checkOut": "string",
"generalLedgerPostingAt": "string",
"bookedAt": "string",
"cancelledAt": "string",
"bookingPlatform": "string",
"confirmationCode": "string",
"pmsReferenceCode": "string",
"guests": 0,
"userdata": {
"property1": null,
"property2": null
},
"metadata": {
"property1": null,
"property2": null
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"shortRef": "string",
"generalLedgerStatus": "active",
"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"
}
]
}
},
"issues": [
{
"code": "lineNotFound",
"severity": "error",
"context": {
"lineIds": [
"string"
]
},
"message": "string"
}
],
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "active",
"uniqueRef": "string",
"appId": "string"
},
"nights": 0,
"status": "booked",
"bookingPlatformLabel": "string",
"financials": {
"totals": {
"tax": 0,
"manager": 0,
"owner": 0,
"reservation": 0,
"expense": 0,
"deposit": 0,
"guest": 0
},
"lines": [
{
"name": "string",
"type": "reservation",
"party": "owners",
"status": "active",
"amount": 0,
"inactiveReason": "reservationCancelled",
"currency": "string",
"account": {
"id": "string",
"name": "string",
"uniqueRef": "string",
"status": "active",
"type": "ledger"
},
"recurringFee": {
"id": "string",
"uniqueRef": "string",
"name": "string",
"type": "managementFee"
},
"transaction": {
"id": "string",
"status": "active",
"amount": -9007199254740991,
"account": {
"id": "string",
"name": "string",
"uniqueRef": "string",
"status": "active"
},
"date": "string",
"description": "string",
"currency": "string",
"type": "deposit",
"isOpeningBalance": true,
"contact": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"firstName": "string",
"uniqueRef": "string",
"shortRef": "string",
"email": "user@example.com",
"type": "owner"
},
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "active",
"uniqueRef": "string",
"appId": "string"
},
"uniqueRef": "string",
"shortRef": "string",
"recurringTemplate": {
"id": "string"
}
},
"line": {
"id": "string",
"type": "string",
"description": "string"
},
"postingDatePreview": {
"hasMore": true,
"entries": [
{
"postingDate": "string",
"amount": 0
}
]
},
"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"
}
]
}
}
}
]
},
"listing": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"uniqueRef": "string",
"shortRef": "string"
},
"listingConnection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"uniqueRef": "string",
"shortRef": "string"
},
"payment": {
"expected": 0,
"received": 0,
"status": "unpaid"
},
"source": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"status": "active",
"appId": "string",
"appIcon": "string"
},
"lines": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"uniqueRef": "string",
"type": "string",
"description": "string",
"amount": -9007199254740991,
"connectionId": "string",
"metadata": {
"property1": null,
"property2": null
},
"generalLedgerPostingAt": "string",
"account": {
"id": "string",
"name": "string",
"uniqueRef": "string",
"status": "active"
},
"isExcluded": true
}
],
"adjustments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"description": "string",
"amount": -9007199254740991,
"metadata": {
"property1": null,
"property2": null
},
"generalLedgerPostingAt": "string",
"type": "string",
"party": "owners",
"account": {
"id": "string",
"name": "string",
"uniqueRef": "string",
"status": "active"
},
"recurringFee": {
"id": "string",
"uniqueRef": "string",
"name": "string",
"type": "managementFee"
},
"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"
}
]
}
}
}
]
}{
"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
}