Raw schema
{
"type": "object",
"properties": {
"apartment_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The property id."
},
"arrival_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Arrival date (yyyy-mm-dd)."
},
"departure_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Departure date (yyyy-mm-dd)."
},
"channel_id": {
"description": "Channel id (defaults to 70). Must be a channel the account has, e.g. 13 = Direct booking, 11 = Blocked channel.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"arrival_time": {
"type": "string",
"pattern": "^\\d{2}:\\d{2}$",
"description": "Arrival time (HH:mm, 24h)."
},
"departure_time": {
"type": "string",
"pattern": "^\\d{2}:\\d{2}$",
"description": "Departure time (HH:mm, 24h)."
},
"first_name": {
"description": "Guest first name.",
"type": "string"
},
"last_name": {
"description": "Guest last name.",
"type": "string"
},
"email": {
"description": "Guest email.",
"type": "string"
},
"phone": {
"description": "Guest phone.",
"type": "string"
},
"address": {
"description": "Guest address.",
"type": "object",
"properties": {
"street": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"location": {
"description": "City / town.",
"type": "string"
}
}
},
"country": {
"description": "Guest country.",
"type": "string"
},
"notice": {
"description": "Free-text notes on the booking.",
"type": "string"
},
"adults": {
"description": "Number of adults.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"children": {
"description": "Number of children.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"price": {
"description": "Total price of the booking.",
"type": "number"
},
"price_status": {
"description": "Price status: 0 = open / not paid, 1 = paid in full.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
]
},
"prepayment": {
"description": "Prepayment amount.",
"type": "number"
},
"prepayment_status": {
"description": "Prepayment status: 0 = open / not paid, 1 = paid in full.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
]
},
"deposit": {
"description": "Deposit amount.",
"type": "number"
},
"deposit_status": {
"description": "Deposit status: 0 = open / not paid, 1 = paid in full.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
]
},
"language": {
"description": "Guest language, e.g. en, de, es.",
"type": "string"
},
"price_elements": {
"description": "Optional price breakdown (base price, cleaning fee, ...).",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"description": "Price element type.",
"type": "string",
"enum": [
"basePrice",
"cleaningFee",
"addon",
"longStayDiscount",
"coupon"
]
},
"name": {
"type": "string",
"description": "Display name, e.g. 'Cleaning fee'."
},
"amount": {
"type": "number",
"description": "Amount."
},
"quantity": {
"description": "Quantity, if applicable.",
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"tax": {
"description": "Tax, if applicable.",
"type": [
"number",
"null"
]
},
"currencyCode": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 currency code, e.g. EUR."
},
"sortOrder": {
"description": "Display order (ascending).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"name",
"amount",
"currencyCode"
]
}
}
},
"required": [
"apartment_id",
"arrival_date",
"departure_date"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}