Skip to content

Check-Out booking, add a payment of type invoice to mark booking for invoicing

PUT
/v1/booking/checkout/bookings/CheckOut
curl --request PUT \
  --url https://rms.dev.caspeco.net/api/booking/v1/booking/checkout/bookings/CheckOut \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'system: example' \
  --data '{ "bookingRootId": 1, "cashierName": "example", "tableArticleIds": [ 1 ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
system
required
string

The system name / database to query

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
bookingRootId
integer format: int64
cashierName
string
nullable
tableArticleIds
Array<integer>
nullable
Examplegenerated
{
  "bookingRootId": 1,
  "cashierName": "example",
  "tableArticleIds": [
    1
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated checkout booking.

Media typeapplication/json
object
result
One of:
object
bookingNumber
string
nullable
start
string format: date-time
end
string format: date-time
guests
integer format: int32
guestsChildren
integer format: int32
message
string
nullable
messageInternal
string
nullable
status
integer format: byte
contactId
integer format: int64
contactFirstName
string
nullable
contactLastName
string
nullable
customerId
integer format: int64
customerName
string
nullable
bookingRootId
integer format: int64
checkoutPlaceId
string
nullable
id
integer format: int64
articleId
integer format: int64
tableArticles
Array<object>
nullable
object
start
string format: date-time
end
string format: date-time
articleId
integer format: int64
articleName
string
nullable
tableName
string
nullable
bookedArticleId
integer format: int64
nonTableArticles
Array<object>
nullable
object
start
string format: date-time
articleId
integer format: int64
bookedArticleId
integer format: int64
name
string
nullable
quantity
number format: decimal
outPriceIncVat
number format: decimal
vat
number format: decimal
mustBeInvoiced
boolean
validationResult
One of:
object
generalErrors
Array<object>
nullable
object
message
string
nullable
messageData
object
key
additional properties
string
generalWarnings
Array<object>
nullable
object
message
string
nullable
messageData
object
key
additional properties
string
propertyErrors
Array<object>
nullable
object
propertyName
string
nullable
message
string
nullable
messageData
object
key
additional properties
string
propertyWarnings
Array<object>
nullable
object
propertyName
string
nullable
message
string
nullable
messageData
object
key
additional properties
string
validationResults
object
key
additional properties
object
generalErrors
Array<object>
nullable
object
message
string
nullable
messageData
object
key
additional properties
string
generalWarnings
Array<object>
nullable
object
message
string
nullable
messageData
object
key
additional properties
string
propertyErrors
Array<object>
nullable
object
propertyName
string
nullable
message
string
nullable
messageData
object
key
additional properties
string
propertyWarnings
Array<object>
nullable
object
propertyName
string
nullable
message
string
nullable
messageData
object
key
additional properties
string
Example
{
  "application/json": {
    "bookingRootId": 12345,
    "cashierName": "Bella Roos",
    "tableArticleIds": [
      91926
    ]
  }
}