Skip to content

Unit_Get

GET
/v1/booking/units/{id}
curl --request GET \
  --url https://rms.dev.caspeco.net/api/booking/v1/booking/units/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'system: example'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer format: int64

Header Parameters

Section titled “Header Parameters”
system
required
string

The system name / database to query

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
name
string
nullable
number
string
nullable
hidden
boolean
articleGroupsId
string
nullable
dayBreak
number format: decimal
caspecoStationId
integer format: int64
locationId
string
nullable
brandId
string
nullable
areaId
string
nullable
usePRIM
boolean
isDefault
boolean
sections
Array<object>
nullable
object
name
string
nullable
unitId
integer format: int64
hidden
boolean
id
integer format: int64
sortOrder
integer format: int64
image
string
nullable
description
string
nullable
uploadImage
One of:
object
tags
Array<string>
nullable
cropRatios
Array<object>
nullable
object
id
integer format: int64
nullable
imageId
integer format: int64
nullable
left
number format: double
top
number format: double
width
number format: double
height
number format: double
aspectRatio
string
image
string
imageUrl
string
imageFilename
string
imageUploadData
string
changeStatus
integer
Allowed values: 0 1 2 3
articleGroups
Array<object>
nullable
object
name
string
nullable
sortOrder
integer format: int32
hidden
boolean
isRestaurants
boolean
onePerGuest
boolean
notRelevantForCheckout
boolean
id
integer format: int64
accountNumber
integer format: int32
accountVat25
string
nullable
accountVat12
string
nullable
accountVat06
string
nullable
accountVat00
string
nullable
accountCostOfGoods
string
nullable
colorIndex
integer format: int32
color
string
nullable
type
integer
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
centralKey
string
nullable
changeDate
string format: date-time
nullable
unitSetting
One of:
object
currentDBHash
integer format: int32
webBookingPayMethods
Array<integer>
nullable
Allowed values: 0 1 6 7 999
id
integer format: int64
tableBooking
One of:
object
timePeriods
Array<object>
nullable
object
name
string
nullable
startTime
string
nullable
endTime
string
nullable
selectableMinutesResolution
integer format: int32
bookingWindow
integer format: int32
maxArrivingGuests
integer format: int32
showArrivingGuestAboveTimeAxis
boolean
advancedTimeBooking
boolean
advancedBookingDetailsDialog
boolean
shareBetweenUnits
boolean
cancelBookingTemplate
string
nullable
confirmTemplate
string
nullable
timeplanTablebooking
boolean
defaultTableStatus
integer format: int32
standardSitLengths
Array<object>
nullable
object
id
integer format: int64
unitId
integer format: int64
doRemove
boolean
isRestRule
boolean
weekDays
Array<string>
nullable
articleGroupIds
string
nullable
sitLength
number format: double
startTime
string
nullable
endTime
string
nullable
recoupLength
integer format: int32
minGroupSize
integer format: int32
nullable
maxGroupSize
integer format: int32
nullable
statusColorMappings
Array<object>
nullable
object
statusCode
integer format: int32
colorCode
integer format: int32
noteTemplates
Array<object>
nullable
object
name
string
nullable
template
string
nullable
type
integer
Allowed values: 0 2 3 7 10 11
dayOpenTimeTable
number format: decimal
dayCloseTimeTable
number format: decimal
nameStyle
integer
Allowed values: 0 1 2 3
confirmEmail
boolean
confirmSms
boolean
confirmExternal
boolean
emailPolicyLink
boolean
emailCancelDisabled
boolean
smsBookingLinkEnabled
boolean
cancelDisabledHoursBefore
integer format: int32
selectableMinutesResolution
integer format: int32
hoverInformationTags
string
nullable
messageCompletedBooking
string
nullable
showHoverInformationTags
boolean
showHoverInformationTagsInBook
boolean
activateChildrenField
boolean
activateAutomaticCancel
boolean
activateBookingMarkings
boolean
activateInvoiceMarking
boolean
activateBookingEventTag
boolean
activateNoteTemplates
boolean
standardSurveyId
string
nullable
bookingPrinters
Array<object>
nullable
object
id
string
nullable
description
string
nullable
paperWidth
integer format: int32
printBeforeMinutes
integer format: int32
jobExpireMinutes
integer format: int32
header
integer
Allowed values: 0 1 2 3
includeBookingNumber
boolean
includePrinterName
boolean
includeStartTime
boolean
includeEndTime
boolean
includeGuests
boolean
includeGuestsChildren
boolean
includeStatus
boolean
includeMessage
boolean
includeContactName
boolean
includeContactMobile
boolean
includeTableArticles
boolean
includeNonTableArticles
boolean
includeArticleName
boolean
includeArticleNumber
boolean
includeArticleQuantity
boolean
includeArticleRetailPrice
boolean
includeArticleMessage
boolean
includeBarcode
boolean
includePrinterId
boolean
includeTotalPriceInclVat
boolean
includePayedAmount
boolean
nrCopies
integer format: int32
nrEmptyRowsAtTop
integer format: int32
largeArticleTextSize
boolean
inactive
boolean
bowlingScoreSheetIncludeSummaryPage
boolean
bowlingScoreSheetColumnCount
integer format: int32
bowlingMinutesToWaitWhenStartingNow
integer format: int32
bowlingMinutesToReduceFromReservationDuration
integer format: int32
bowlingMaxTimeOnHold
integer format: int32
bowlingEndGameOnTime
boolean
notifyCheckout
integer
Allowed values: 0 1 2
showContactCheckInInformation
boolean
contactSettings
One of:
object
replyEmail
string
nullable
signatur
string
nullable
signaturSMS
string
nullable
signaturEmail
string
nullable
smSsender
string
nullable
emailSender
string
nullable
phone
string
nullable
cancellationSMS
string
nullable
address
string
nullable
webpage
string
nullable
backupEmail
string
nullable
notificationSettings
One of:
object
email
string
nullable
sms
string
nullable
paymentSettings
One of:
object
captureMessageNoShow
string
nullable
captureMessagePrePayment
string
nullable
creditMessage
string
nullable
reminderMessage
string
nullable
paymentLinkMessage
string
nullable
reservationOfCardMessage
string
nullable
paymentLinkDurationHours
number format: double
paymentLinkDurationDays
number format: double
noShowLinkMessage
string
nullable
noShowBookingMessage
string
nullable
webBooking
One of:
object
introductionMessageHeader
string
introductionMessage
string
checkFakeBookings
boolean
allowEditBooking
boolean
collapseConditions
boolean
inquiryInfo
string
maxWebGuests
integer format: int32
defaultAmountGuests
integer format: int32
confirmEmail
boolean
confirmSms
boolean
waitListWebEnabled
boolean
emailPolicyLink
boolean
emailCancelDisabled
boolean
smsBookingLinkEnabled
boolean
cancelDisabledHoursBefore
integer format: int32
enableInvoicing
boolean
activateWebChildren
boolean
activateInquiry
boolean
bookingWindow
integer format: int32
bookingWindowUnit
integer
Allowed values: 0 1 2
bookingWindowAsMonth
integer format: int32
enableOnlineBooking40
boolean
settingsAfterBugUpdated
boolean
messageDescription
string
nullable
deliveryInfoDescription
string
nullable
displayMessageBox
boolean
menuMessageDescription
string
nullable
displayMenuMessageBox
boolean
messagePUL
string
nullable
defaultExpandedSectionIds
Array<integer>
nullable
messageBookingClosed
string
nullable
webConditions
string
nullable
menuHeader
string
nullable
menuMessage
string
nullable
lastGrab
boolean
unitCategoryIds
string
nullable
unitSubCategoryIds
string
nullable
city
string
nullable
postalCode
string
nullable
countryCode
string
nullable
inactivateNewsletter
boolean
gaTrackingId
string
nullable
takeAwaySetting
boolean
pling
boolean
showWaitingTime
boolean
colorTheme
string
nullable
whiteLabelConfig
One of:
object
colors
object
background
string
onBackground
string
onBackgroundSubdued
string
onBackgroundBorder
string
backgroundDisabled
string
onBackgroundHeader
string
surface
string
onSurface
string
onSurfaceSubdued
string
onSurfaceBorder
string
surfaceDisabled
string
onSurfaceHeader
string
primary
string
primaryHover
string
primaryActive
string
onPrimary
string
primaryContainer
string
onPrimaryContainer
string
secondary
string
secondaryHover
string
secondaryActive
string
onSecondary
string
secondaryContainer
string
onSecondaryContainer
string
accent
string
accentHover
string
accentActive
string
accentHoverAlpha
string
accentActiveAlpha
string
onAccent
string
accentContainer
string
onAccentContainer
string
info
string
infoHover
string
infoActive
string
onInfo
string
infoContainer
string
onInfoContainer
string
success
string
successHover
string
successActive
string
onSuccess
string
successContainer
string
onSuccessContainer
string
warning
string
warningHover
string
warningActive
string
onWarning
string
warningContainer
string
onWarningContainer
string
error
string
errorHover
string
errorActive
string
onError
string
errorContainer
string
onErrorContainer
string
neutral
string
neutralHover
string
neutralActive
string
onNeutral
string
neutralContainer
string
onNeutralContainer
string
logo
object
tags
Array<string>
nullable
cropRatios
Array<object>
nullable
object
id
integer format: int64
nullable
imageId
integer format: int64
nullable
left
number format: double
top
number format: double
width
number format: double
height
number format: double
aspectRatio
string
image
string
imageUrl
string
imageFilename
string
imageUploadData
string
coverImageThirtyTwoByNine
object
tags
Array<string>
nullable
cropRatios
Array<object>
nullable
object
id
integer format: int64
nullable
imageId
integer format: int64
nullable
left
number format: double
top
number format: double
width
number format: double
height
number format: double
aspectRatio
string
image
string
imageUrl
string
imageFilename
string
imageUploadData
string
coverImageOneByOne
object
tags
Array<string>
nullable
cropRatios
Array<object>
nullable
object
id
integer format: int64
nullable
imageId
integer format: int64
nullable
left
number format: double
top
number format: double
width
number format: double
height
number format: double
aspectRatio
string
image
string
imageUrl
string
imageFilename
string
imageUploadData
string
showTimeFilter
boolean
waitListSetting
One of:
object
automaticWaitListOffersEnabled
boolean
smsDispatchInterval
integer format: int32
smsDispatchIntervalTimeUnit
integer
Allowed values: 0 1
lastDispatchBeforeSeating
integer format: int32
lastDispatchBeforeSeatingTimeUnit
integer
Allowed values: 0 1
showSpecialDiets
boolean
showValidUntil
boolean
showFeedbackDate
boolean
unitMetaData
One of:
object
currentDBHash
integer format: int32
id
integer format: int64
unitId
integer format: int64
messageExceededGuests
string
nullable
messageCompleted
string
nullable
cssurl
string
nullable
logo
string
nullable
takeAwayWaitTimeMinutes
integer format: int32
name
string
nullable
binaryFlags
integer
Allowed values: 0 1
maxWebGuests
integer format: int32
defaultAmountGuests
integer format: int32
confirmEmail
boolean
confirmSMS
boolean
activateWebChildren
boolean
bookingWindow
integer format: int32
contact
One of:
object
replyEmail
string
nullable
signatur
string
nullable
signaturSMS
string
nullable
signaturEmail
string
nullable
smSsender
string
nullable
emailSender
string
nullable
phone
string
nullable
cancellationSMS
string
nullable
address
string
nullable
webpage
string
nullable
backupEmail
string
nullable
colorTheme
string
nullable
showTimeFilter
boolean
payMethods
Array<object>
nullable
object
id
integer format: int64
name
string
nullable
hidden
boolean
changeStatus
integer
Allowed values: 0 1 2 3
invoiceSetting
One of:
object
paymentTerms
integer format: int32
invoicingFee
integer format: int32
payEventPayMethods
Array<integer>
nullable
useCaspecoPayInvoice
boolean
useCostOfGoods
boolean
fileExport
integer
Allowed values: 0 1
usePayrollLockPeriod
boolean
bookAndSend
boolean
lastLockDate
string
nullable
ourReference
string
nullable
markingTags
string
nullable
bookingTags
string
nullable
invoicingSystem
integer
Allowed values: 0 1 2 3 4 5 6
bookingMarkings
Array<object>
nullable
object
id
integer format: int64
text
string
nullable
prefix
string
nullable
colorIndex
integer format: int32
hidden
boolean
changeStatus
integer
Allowed values: 0 1 2 3
mandatoryContactFields
One of:
object
customerNumber
boolean
streetaddress
boolean
zipcode
boolean
city
boolean
mobile
boolean
email
boolean
phone
boolean
fax
boolean
invoiceReference
boolean
information
boolean
contactFilter
boolean
mandatoryCustomerFields
One of:
object
customerNumber
boolean
orgNr
boolean
streetaddress
boolean
zipcode
boolean
city
boolean
phone
boolean
email
boolean
fax
boolean
webAddress
boolean
information
boolean
marking
boolean
invoiceStreetaddress
boolean
customerFilter
boolean
timeZone
string
nullable
id
integer format: int64
Example
{
  "sections": [
    {
      "changeStatus": 0
    }
  ],
  "articleGroups": [
    {
      "type": 0
    }
  ],
  "unitSetting": {
    "webBookingPayMethods": [
      0
    ],
    "tableBooking": {
      "noteTemplates": [
        {
          "type": 0
        }
      ],
      "nameStyle": 0,
      "bookingPrinters": [
        {
          "header": 0
        }
      ],
      "notifyCheckout": 0
    },
    "bookingWindowUnit": 0,
    "waitListSetting": {
      "smsDispatchIntervalTimeUnit": 0,
      "lastDispatchBeforeSeatingTimeUnit": 0
    }
  },
  "unitMetaData": {
    "binaryFlags": 0
  },
  "payMethods": [
    {
      "changeStatus": 0
    }
  ],
  "invoiceSetting": {
    "fileExport": 0,
    "invoicingSystem": 0
  },
  "bookingMarkings": [
    {
      "changeStatus": 0
    }
  ]
}