(v1.0) LS Central bookings API (1.0.0)

Download OpenAPI specification:

(v1.0) LS Central bookings API for Dynamics 365 Business Central. Published by the LS Central AL API pages at /api/lsRetail/bookings/v1.0.

Activity Location

An Activity Location is the physical site where activities (spa centers, ski schools, dining, etc.) are offered — it groups availability, pricing, currency, opening hours, and POS / retail-store mapping. Use this read-only API to enumerate the locations a booking integration may operate against. Replaces the legacy SOAP procedure UploadActivityLocations in codeunit 10015848 "LSC Activity WS".

Get activityLocations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "code" "description" "retailStore" "openingHours" "openFrom" "openTo" "workLocation" "diningArea" "eMail" "diningReservationDeskActivityProduct" "storesAllowedToCharge"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get activityLocations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityLocation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityLocation

query Parameters
$select
Array of strings unique
Items Enum: "id" "code" "description" "retailStore" "openingHours" "openFrom" "openTo" "workLocation" "diningArea" "eMail" "diningReservationDeskActivityProduct" "storesAllowedToCharge"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "description": null,
  • "retailStore": null,
  • "openingHours": null,
  • "openFrom": null,
  • "openTo": null,
  • "workLocation": null,
  • "diningArea": null,
  • "eMail": null,
  • "diningReservationDeskActivityProduct": null,
  • "storesAllowedToCharge": null
}

Activity Product

An Activity Product is a sellable, bookable offering (a yoga class, a hot-stone massage, a tee-time slot) that an integration can present to end users. The list is filtered to products with Available on Web > 0 so only web-visible offerings are returned. Use the bound actions getAvailability (available slots / resources for a date), getProductCharges (the default additional charges that come with the product) and preSell (reserve a slot to be confirmed later) to drive a booking flow. Replaces the legacy SOAP procedures UploadActivityProducts, GetAvailabilityV5, GetProductChargesV2, and PreSellActivityProduct in codeunit 10015848 "LSC Activity WS".

Get activityProducts from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "productNo" "description" "activityType" "retailItem" "productType" "status" "availableOnWeb" "defaultPrice" "priceMethod" "pricePerPerson" "defaultQuantity" "quantityDialog" "quantityConversion" "allowQuantityChange" "minQuantity" "maxQuantity" "allowNoOfPersons" "defaultNoOfPersons" "minNoOfPersons" "maxNoOfPersons" "noOfPersonsDialog" "duration" "durationType" "allowDurationChange" "intervalType" "allowPriceChange" "fixedLocation" "cancelPolicy" "cancelPolicyDescription" "securityDeposit" "securityDepositOptional" "requiredDeposit" "accessProfile" "admissionLabel" "expiryDateCalculation" "multipleAdmissionQty" "sellToSameTimes" "sellToSamePeriodCalc" "searchTags" "defaultEventCategory" "defaultGuestType" "guestTypeSelection" "maxRentalUnits" "overbooking" "requestWaiver" "waiverCode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get activityProducts from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityProduct-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityProduct

query Parameters
$select
Array of strings unique
Items Enum: "id" "productNo" "description" "activityType" "retailItem" "productType" "status" "availableOnWeb" "defaultPrice" "priceMethod" "pricePerPerson" "defaultQuantity" "quantityDialog" "quantityConversion" "allowQuantityChange" "minQuantity" "maxQuantity" "allowNoOfPersons" "defaultNoOfPersons" "minNoOfPersons" "maxNoOfPersons" "noOfPersonsDialog" "duration" "durationType" "allowDurationChange" "intervalType" "allowPriceChange" "fixedLocation" "cancelPolicy" "cancelPolicyDescription" "securityDeposit" "securityDepositOptional" "requiredDeposit" "accessProfile" "admissionLabel" "expiryDateCalculation" "multipleAdmissionQty" "sellToSameTimes" "sellToSamePeriodCalc" "searchTags" "defaultEventCategory" "defaultGuestType" "guestTypeSelection" "maxRentalUnits" "overbooking" "requestWaiver" "waiverCode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "retailItem": null,
  • "productType": null,
  • "status": null,
  • "availableOnWeb": null,
  • "defaultPrice": null,
  • "priceMethod": "Activity_x0020_Price",
  • "pricePerPerson": null,
  • "defaultQuantity": null,
  • "quantityDialog": null,
  • "quantityConversion": null,
  • "allowQuantityChange": null,
  • "minQuantity": null,
  • "maxQuantity": null,
  • "allowNoOfPersons": null,
  • "defaultNoOfPersons": null,
  • "minNoOfPersons": null,
  • "maxNoOfPersons": null,
  • "noOfPersonsDialog": null,
  • "duration": null,
  • "durationType": null,
  • "allowDurationChange": null,
  • "intervalType": null,
  • "allowPriceChange": null,
  • "fixedLocation": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "securityDeposit": null,
  • "securityDepositOptional": null,
  • "requiredDeposit": null,
  • "accessProfile": null,
  • "admissionLabel": null,
  • "expiryDateCalculation": null,
  • "multipleAdmissionQty": null,
  • "sellToSameTimes": null,
  • "sellToSamePeriodCalc": null,
  • "searchTags": null,
  • "defaultEventCategory": null,
  • "defaultGuestType": null,
  • "guestTypeSelection": null,
  • "maxRentalUnits": null,
  • "overbooking": "None",
  • "requestWaiver": null,
  • "waiverCode": null
}

Invoke action getAvailability

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityProduct-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityProduct

Request Body schema: application/json

Action parameters

locationNo
null or string
activityDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
clientNo
null or string
optionalResource
null or string
promoCode
null or string
activityNo
null or string
noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]
customerAccountNo
null or string
guestType
null or string

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "activityDate": null,
  • "clientNo": null,
  • "optionalResource": null,
  • "promoCode": null,
  • "activityNo": null,
  • "noOfPersons": null,
  • "customerAccountNo": null,
  • "guestType": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action getProductCharges

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityProduct-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityProduct

Request Body schema: application/json

Action parameters

locationNo
null or string
dateOfBooking
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "dateOfBooking": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action preSell

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityProduct-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityProduct

Request Body schema: application/json

Action parameters

locationNo
null or string
promoCode
null or string
clientNo
null or string
quantity
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "promoCode": null,
  • "clientNo": null,
  • "quantity": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get activityProduct from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

query Parameters
$select
Array of strings unique
Items Enum: "id" "productNo" "description" "activityType" "retailItem" "productType" "status" "availableOnWeb" "defaultPrice" "priceMethod" "pricePerPerson" "defaultQuantity" "quantityDialog" "quantityConversion" "allowQuantityChange" "minQuantity" "maxQuantity" "allowNoOfPersons" "defaultNoOfPersons" "minNoOfPersons" "maxNoOfPersons" "noOfPersonsDialog" "duration" "durationType" "allowDurationChange" "intervalType" "allowPriceChange" "fixedLocation" "cancelPolicy" "cancelPolicyDescription" "securityDeposit" "securityDepositOptional" "requiredDeposit" "accessProfile" "admissionLabel" "expiryDateCalculation" "multipleAdmissionQty" "sellToSameTimes" "sellToSamePeriodCalc" "searchTags" "defaultEventCategory" "defaultGuestType" "guestTypeSelection" "maxRentalUnits" "overbooking" "requestWaiver" "waiverCode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "retailItem": null,
  • "productType": null,
  • "status": null,
  • "availableOnWeb": null,
  • "defaultPrice": null,
  • "priceMethod": "Activity_x0020_Price",
  • "pricePerPerson": null,
  • "defaultQuantity": null,
  • "quantityDialog": null,
  • "quantityConversion": null,
  • "allowQuantityChange": null,
  • "minQuantity": null,
  • "maxQuantity": null,
  • "allowNoOfPersons": null,
  • "defaultNoOfPersons": null,
  • "minNoOfPersons": null,
  • "maxNoOfPersons": null,
  • "noOfPersonsDialog": null,
  • "duration": null,
  • "durationType": null,
  • "allowDurationChange": null,
  • "intervalType": null,
  • "allowPriceChange": null,
  • "fixedLocation": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "securityDeposit": null,
  • "securityDepositOptional": null,
  • "requiredDeposit": null,
  • "accessProfile": null,
  • "admissionLabel": null,
  • "expiryDateCalculation": null,
  • "multipleAdmissionQty": null,
  • "sellToSameTimes": null,
  • "sellToSamePeriodCalc": null,
  • "searchTags": null,
  • "defaultEventCategory": null,
  • "defaultGuestType": null,
  • "guestTypeSelection": null,
  • "maxRentalUnits": null,
  • "overbooking": "None",
  • "requestWaiver": null,
  • "waiverCode": null
}

Invoke action getAvailability

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

locationNo
null or string
activityDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
clientNo
null or string
optionalResource
null or string
promoCode
null or string
activityNo
null or string
noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]
customerAccountNo
null or string
guestType
null or string

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "activityDate": null,
  • "clientNo": null,
  • "optionalResource": null,
  • "promoCode": null,
  • "activityNo": null,
  • "noOfPersons": null,
  • "customerAccountNo": null,
  • "guestType": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action getProductCharges

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

locationNo
null or string
dateOfBooking
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "dateOfBooking": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action preSell

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

locationNo
null or string
promoCode
null or string
clientNo
null or string
quantity
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "promoCode": null,
  • "clientNo": null,
  • "quantity": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get activityProduct from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

query Parameters
$select
Array of strings unique
Items Enum: "id" "productNo" "description" "activityType" "retailItem" "productType" "status" "availableOnWeb" "defaultPrice" "priceMethod" "pricePerPerson" "defaultQuantity" "quantityDialog" "quantityConversion" "allowQuantityChange" "minQuantity" "maxQuantity" "allowNoOfPersons" "defaultNoOfPersons" "minNoOfPersons" "maxNoOfPersons" "noOfPersonsDialog" "duration" "durationType" "allowDurationChange" "intervalType" "allowPriceChange" "fixedLocation" "cancelPolicy" "cancelPolicyDescription" "securityDeposit" "securityDepositOptional" "requiredDeposit" "accessProfile" "admissionLabel" "expiryDateCalculation" "multipleAdmissionQty" "sellToSameTimes" "sellToSamePeriodCalc" "searchTags" "defaultEventCategory" "defaultGuestType" "guestTypeSelection" "maxRentalUnits" "overbooking" "requestWaiver" "waiverCode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "retailItem": null,
  • "productType": null,
  • "status": null,
  • "availableOnWeb": null,
  • "defaultPrice": null,
  • "priceMethod": "Activity_x0020_Price",
  • "pricePerPerson": null,
  • "defaultQuantity": null,
  • "quantityDialog": null,
  • "quantityConversion": null,
  • "allowQuantityChange": null,
  • "minQuantity": null,
  • "maxQuantity": null,
  • "allowNoOfPersons": null,
  • "defaultNoOfPersons": null,
  • "minNoOfPersons": null,
  • "maxNoOfPersons": null,
  • "noOfPersonsDialog": null,
  • "duration": null,
  • "durationType": null,
  • "allowDurationChange": null,
  • "intervalType": null,
  • "allowPriceChange": null,
  • "fixedLocation": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "securityDeposit": null,
  • "securityDepositOptional": null,
  • "requiredDeposit": null,
  • "accessProfile": null,
  • "admissionLabel": null,
  • "expiryDateCalculation": null,
  • "multipleAdmissionQty": null,
  • "sellToSameTimes": null,
  • "sellToSamePeriodCalc": null,
  • "searchTags": null,
  • "defaultEventCategory": null,
  • "defaultGuestType": null,
  • "guestTypeSelection": null,
  • "maxRentalUnits": null,
  • "overbooking": "None",
  • "requestWaiver": null,
  • "waiverCode": null
}

Invoke action getAvailability

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

locationNo
null or string
activityDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
clientNo
null or string
optionalResource
null or string
promoCode
null or string
activityNo
null or string
noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]
customerAccountNo
null or string
guestType
null or string

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "activityDate": null,
  • "clientNo": null,
  • "optionalResource": null,
  • "promoCode": null,
  • "activityNo": null,
  • "noOfPersons": null,
  • "customerAccountNo": null,
  • "guestType": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action getProductCharges

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

locationNo
null or string
dateOfBooking
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "dateOfBooking": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action preSell

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

locationNo
null or string
promoCode
null or string
clientNo
null or string
quantity
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "promoCode": null,
  • "clientNo": null,
  • "quantity": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Activity Promotion

An Activity Promotion is a time-bounded price override or percentage discount applied to one or more Activity Products. The list is filtered to promotions flagged Show on Web, Show on App, or Show Everywhere — i.e., only the promotions the system marks as customer-visible — and only those that have not yet expired (Date To is open or in the future). Read-only. Replaces the legacy SOAP procedure UploadPromotions in codeunit 10015848 "LSC Activity WS".

Get activityPromotions from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "productNo" "dateFrom" "dateTo" "timeFrom" "timeTo" "clubMembersOnly" "isPriceorDiscount" "priceOrDiscountValue" "daySetting" "priceDescription" "location" "productName" "sequence" "season" "memberScheme" "quantity" "noOfPersons" "promotionViewSetting"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get activityPromotions from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityPromotion-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityPromotion

query Parameters
$select
Array of strings unique
Items Enum: "id" "productNo" "dateFrom" "dateTo" "timeFrom" "timeTo" "clubMembersOnly" "isPriceorDiscount" "priceOrDiscountValue" "daySetting" "priceDescription" "location" "productName" "sequence" "season" "memberScheme" "quantity" "noOfPersons" "promotionViewSetting"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productNo": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "clubMembersOnly": null,
  • "isPriceorDiscount": null,
  • "priceOrDiscountValue": null,
  • "daySetting": null,
  • "priceDescription": null,
  • "location": null,
  • "productName": null,
  • "sequence": null,
  • "season": null,
  • "memberScheme": null,
  • "quantity": null,
  • "noOfPersons": null,
  • "promotionViewSetting": null
}

Activity Reservation

An Activity Reservation is a single bookable line (an Activity) on a parent Reservation — e.g., a 60-minute spa treatment, a ski lesson, a tee time. Each line points to one Activity Product, has its own date / time / quantity / pricing, and is the entity the lifecycle actions (confirmWithPayment, cancel, setStatus, changeProduct) operate on. Use this API to list activity lines (filter by reservationNo, clientNo, activityType, dateFrom, etc.), or to drive the booking flow via bound actions. Replaces the legacy SOAP procedures UploadReservationActivities, UploadClientBookingsV2, ConfirmActivityV7, CancelActivity, and UpdateActivityStatus in codeunit 10015848 "LSC Activity WS". Use $expand=reservationCharges to retrieve the additional charges attached to this specific activity line — it points at the same Reservation Charges endpoint used by the Reservations API; the SubPageLink scopes it to Reservation Line No. = the line''s own Line No. This release exposes the page as writable (POST / PATCH / DELETE); fields driven entirely by the product or by lifecycle actions remain read-only. Codeunit "LSC ACT Reservation API Mgt" adds the API-specific handling: line-number assignment on insert, mirroring of the comment into the LSC Comment list, and the editable-state gate that freezes structural fields once the line is past Draft / Waiting List. DELETE is only allowed while the parent reservation is Draft or Waiting List, is blocked for activities attached to a group reservation (managed through the group) and, in the table, for paid activities; it requires the row''s @odata.etag via the If-Match header.

Get activityReservations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "reservationNo" "lineNo" "activityNo" "productNo" "itemNo" "productType" "activityType" "eventCategory" "description" "dateFrom" "dateTo" "timeFrom" "timeTo" "quantity" "noOfUnits" "unit" "durationType" "unitPrice" "lineDiscountPercentage" "lineDiscountAmount" "totalAmount" "status" "paymentStatus" "location" "mainResource" "clientNo" "clientName" "noOfPersons" "guestType" "allowanceNo" "promoCode" "cancelPolicy" "cancelPolicyDescription" "cancelAmount" "comment" "waiverCode" "waiverStatus"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "reservationCharges"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to activityReservations for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this activity reservation line. Use this value as the entity key when calling bound actions (confirmWithPayment, cancel, setStatus, changeProduct) or building $expand links. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the line belongs to. Read-only; set when the line is created and used as the SubPageLink target from the Reservations API ($expand=activityReservations).

lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the line sequence within the parent reservation. Read-only; system-assigned in 10000 increments to allow line reordering.

activityNo
null or string <= 20 characters

Specifies the unique Activity number for the line, assigned from the activity number series of the related Activity Type. Read-only; used as the binding identifier for legacy SOAP calls that key by Activity No.

productNo
null or string <= 20 characters

Specifies the Activity Product booked on this line. The value must match a code in the LSC Activity Product table; changing it via the changeProduct action recalculates pricing, duration, and required resources.

itemNo
null or string <= 20 characters

Specifies the posting Item linked to the Activity Product. Read-only; used when the line is posted to the general ledger or to a sales document.

productType
null or string

Specifies the high-level classification of the Activity Product. Allowed values: Activity, Membership, Allowance, Charge. Read-only; defaulted from the product.

activityType
null or string <= 20 characters

Specifies the Activity Type the booked product belongs to. Read-only; drives default interval, duration, and resource selection.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category the activity line belongs to. Optional; used for banquet reporting and dimension defaulting.

description
null or string <= 100 characters

Specifies the display description of the activity line. Read-only on the API; defaulted from the Activity Product.

dateFrom
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the start date of the booked activity (ISO 8601 date). Combined with Time (From) it forms the scheduled start.

dateTo
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the end date of the booked activity. May equal Date From for single-day bookings; for multi-day rentals it forms the scheduled return date.

timeFrom
null or string

Specifies the start time of day for the booked activity. Combined with Date From it forms the inclusive lower bound of the booked slot.

timeTo
null or string

Specifies the end time of day for the booked activity. Combined with Date To it forms the exclusive upper bound of the booked slot; may be 00:00 when the duration is full-day.

quantity
null or number <decimal>

Specifies the quantity booked, in the unit of measure defined by the Activity Product (sessions, hours, etc.). Constraints: must be within the product''s Min/Max Quantity.

noOfUnits
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the number of resource units booked on this line (e.g., number of kayaks, number of treatment rooms). Used to drive resource allocation for multi-unit activities.

unit
null or string

Specifies the unit-of-measure code attached to the booked product. Read-only; defaulted from the product.

durationType
null or string

Specifies how duration is measured on this line. Allowed values: Minutes, Hours, Days, Nights, Open-ended. Read-only; defaulted from the product.

unitPrice
null or number <decimal>

Specifies the unit price applied to the booked quantity. When the caller overrides the default price the change is logged via ValidateUserChangedPrice so that pricing rules can react.

lineDiscountPercentage
null or number <decimal>

Specifies the percentage discount applied to the line. Allowed range: 0 - 100. Manual changes are logged via ValidateUserChangedDiscount to bypass automatic discount recalculation downstream.

lineDiscountAmount
null or number <decimal>

Specifies the absolute discount amount applied to the line. Alternative to Discount % — setting one recalculates the other.

totalAmount
null or number <decimal>

Specifies the calculated net amount for the line (Unit Price * Quantity, less discount). Read-only.

status
null or string <= 20 characters

Specifies the current status code of the activity line. Read-only on the API; use the setStatus / confirmWithPayment / cancel bound actions to transition status.

paymentStatus
null or string

Specifies the payment state of the activity line. Allowed values: None, Partial, Fully Paid, Refunded. Calculated from charges and POS postings; read-only.

location
null or string <= 20 characters

Specifies the Activity Location code where the activity takes place. Defaults from the parent reservation; may differ for multi-location reservations.

mainResource
null or string <= 20 characters

Specifies the primary Activity Resource assigned to the line (e.g., the instructor for a class, the table for a dining reservation). Optional.

clientNo
null or string <= 20 characters

Specifies the client (Contact No.) booked on the line. May differ from the parent Reservation''s client when a single reservation includes activities for multiple guests.

clientName
null or string <= 100 characters

Specifies the display name of the client on the line. When no client is assigned you may set a name (or an e-mail / phone to search for a member contact); once a Client No. is assigned the name follows the contact and cannot be changed.

noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the head count for the activity. Constraints: within the product''s Min/Max No. of Persons when those limits are configured.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing. Must match a configured Guest Type.

allowanceNo
null or string <= 20 characters

Specifies the Issued Allowance redeemed against this line. Read-only; set when the line is paid using a member allowance.

promoCode
null or string <= 20 characters

Specifies the promotion code applied to the line. Resolves to an entry in the Activity Promotions table; affects price.

cancelPolicy
null or string <= 20 characters

Specifies the cancellation policy code that governs cancellation fees for this line. Must match a code in the LSC ACT Cancellation Policy table.

cancelPolicyDescription
null or string

Specifies the human-readable description of the applied Cancellation Policy. Read-only; computed from Cancellation Policy.

cancelAmount
null or number <decimal>

Specifies the cancellation fee that would be charged if the line were cancelled at the current date/time, based on Cancellation Policy. Read-only; calculated on read.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the activity line. Shown on the activity matrix and printed confirmations.

waiverCode
null or string <= 20 characters

Specifies the Waiver code the participant must sign for this activity. Read-only on the API; defaulted from the Activity Product and managed through the waiver flow.

(lscWaiverStatus (null or string))

Specifies whether the required waiver has been signed. Allowed values: Not Required, Required, Signed, Expired. Read-only; resolved from Waiver Entries.

(memberDetail (null or object))
Array of objects (reservationCharge)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "lineNo": null,
  • "activityNo": null,
  • "productNo": null,
  • "itemNo": null,
  • "productType": null,
  • "activityType": null,
  • "eventCategory": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "noOfUnits": null,
  • "unit": null,
  • "durationType": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "lineDiscountAmount": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "mainResource": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "comment": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    },
  • "reservationCharges": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "lineNo": null,
  • "activityNo": null,
  • "productNo": null,
  • "itemNo": null,
  • "productType": null,
  • "activityType": null,
  • "eventCategory": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "noOfUnits": null,
  • "unit": null,
  • "durationType": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "lineDiscountAmount": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "mainResource": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "comment": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    },
  • "reservationCharges": [
    ]
}

Get activityReservations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

query Parameters
$select
Array of strings unique
Items Enum: "id" "reservationNo" "lineNo" "activityNo" "productNo" "itemNo" "productType" "activityType" "eventCategory" "description" "dateFrom" "dateTo" "timeFrom" "timeTo" "quantity" "noOfUnits" "unit" "durationType" "unitPrice" "lineDiscountPercentage" "lineDiscountAmount" "totalAmount" "status" "paymentStatus" "location" "mainResource" "clientNo" "clientName" "noOfPersons" "guestType" "allowanceNo" "promoCode" "cancelPolicy" "cancelPolicyDescription" "cancelAmount" "comment" "waiverCode" "waiverStatus"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "reservationCharges"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "lineNo": null,
  • "activityNo": null,
  • "productNo": null,
  • "itemNo": null,
  • "productType": null,
  • "activityType": null,
  • "eventCategory": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "noOfUnits": null,
  • "unit": null,
  • "durationType": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "lineDiscountAmount": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "mainResource": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "comment": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    },
  • "reservationCharges": [
    ]
}

Update the navigation property activityReservations in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this activity reservation line. Use this value as the entity key when calling bound actions (confirmWithPayment, cancel, setStatus, changeProduct) or building $expand links. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the line belongs to. Read-only; set when the line is created and used as the SubPageLink target from the Reservations API ($expand=activityReservations).

lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the line sequence within the parent reservation. Read-only; system-assigned in 10000 increments to allow line reordering.

activityNo
null or string <= 20 characters

Specifies the unique Activity number for the line, assigned from the activity number series of the related Activity Type. Read-only; used as the binding identifier for legacy SOAP calls that key by Activity No.

productNo
null or string <= 20 characters

Specifies the Activity Product booked on this line. The value must match a code in the LSC Activity Product table; changing it via the changeProduct action recalculates pricing, duration, and required resources.

itemNo
null or string <= 20 characters

Specifies the posting Item linked to the Activity Product. Read-only; used when the line is posted to the general ledger or to a sales document.

productType
null or string

Specifies the high-level classification of the Activity Product. Allowed values: Activity, Membership, Allowance, Charge. Read-only; defaulted from the product.

activityType
null or string <= 20 characters

Specifies the Activity Type the booked product belongs to. Read-only; drives default interval, duration, and resource selection.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category the activity line belongs to. Optional; used for banquet reporting and dimension defaulting.

description
null or string <= 100 characters

Specifies the display description of the activity line. Read-only on the API; defaulted from the Activity Product.

dateFrom
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the start date of the booked activity (ISO 8601 date). Combined with Time (From) it forms the scheduled start.

dateTo
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the end date of the booked activity. May equal Date From for single-day bookings; for multi-day rentals it forms the scheduled return date.

timeFrom
null or string

Specifies the start time of day for the booked activity. Combined with Date From it forms the inclusive lower bound of the booked slot.

timeTo
null or string

Specifies the end time of day for the booked activity. Combined with Date To it forms the exclusive upper bound of the booked slot; may be 00:00 when the duration is full-day.

quantity
null or number <decimal>

Specifies the quantity booked, in the unit of measure defined by the Activity Product (sessions, hours, etc.). Constraints: must be within the product''s Min/Max Quantity.

noOfUnits
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the number of resource units booked on this line (e.g., number of kayaks, number of treatment rooms). Used to drive resource allocation for multi-unit activities.

unit
null or string

Specifies the unit-of-measure code attached to the booked product. Read-only; defaulted from the product.

durationType
null or string

Specifies how duration is measured on this line. Allowed values: Minutes, Hours, Days, Nights, Open-ended. Read-only; defaulted from the product.

unitPrice
null or number <decimal>

Specifies the unit price applied to the booked quantity. When the caller overrides the default price the change is logged via ValidateUserChangedPrice so that pricing rules can react.

lineDiscountPercentage
null or number <decimal>

Specifies the percentage discount applied to the line. Allowed range: 0 - 100. Manual changes are logged via ValidateUserChangedDiscount to bypass automatic discount recalculation downstream.

lineDiscountAmount
null or number <decimal>

Specifies the absolute discount amount applied to the line. Alternative to Discount % — setting one recalculates the other.

totalAmount
null or number <decimal>

Specifies the calculated net amount for the line (Unit Price * Quantity, less discount). Read-only.

status
null or string <= 20 characters

Specifies the current status code of the activity line. Read-only on the API; use the setStatus / confirmWithPayment / cancel bound actions to transition status.

paymentStatus
null or string

Specifies the payment state of the activity line. Allowed values: None, Partial, Fully Paid, Refunded. Calculated from charges and POS postings; read-only.

location
null or string <= 20 characters

Specifies the Activity Location code where the activity takes place. Defaults from the parent reservation; may differ for multi-location reservations.

mainResource
null or string <= 20 characters

Specifies the primary Activity Resource assigned to the line (e.g., the instructor for a class, the table for a dining reservation). Optional.

clientNo
null or string <= 20 characters

Specifies the client (Contact No.) booked on the line. May differ from the parent Reservation''s client when a single reservation includes activities for multiple guests.

clientName
null or string <= 100 characters

Specifies the display name of the client on the line. When no client is assigned you may set a name (or an e-mail / phone to search for a member contact); once a Client No. is assigned the name follows the contact and cannot be changed.

noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the head count for the activity. Constraints: within the product''s Min/Max No. of Persons when those limits are configured.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing. Must match a configured Guest Type.

allowanceNo
null or string <= 20 characters

Specifies the Issued Allowance redeemed against this line. Read-only; set when the line is paid using a member allowance.

promoCode
null or string <= 20 characters

Specifies the promotion code applied to the line. Resolves to an entry in the Activity Promotions table; affects price.

cancelPolicy
null or string <= 20 characters

Specifies the cancellation policy code that governs cancellation fees for this line. Must match a code in the LSC ACT Cancellation Policy table.

cancelPolicyDescription
null or string

Specifies the human-readable description of the applied Cancellation Policy. Read-only; computed from Cancellation Policy.

cancelAmount
null or number <decimal>

Specifies the cancellation fee that would be charged if the line were cancelled at the current date/time, based on Cancellation Policy. Read-only; calculated on read.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the activity line. Shown on the activity matrix and printed confirmations.

waiverCode
null or string <= 20 characters

Specifies the Waiver code the participant must sign for this activity. Read-only on the API; defaulted from the Activity Product and managed through the waiver flow.

(lscWaiverStatus (null or string))

Specifies whether the required waiver has been signed. Allowed values: Not Required, Required, Signed, Expired. Read-only; resolved from Waiver Entries.

(memberDetail (null or object))
Array of objects (reservationCharge)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "lineNo": null,
  • "activityNo": null,
  • "productNo": null,
  • "itemNo": null,
  • "productType": null,
  • "activityType": null,
  • "eventCategory": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "noOfUnits": null,
  • "unit": null,
  • "durationType": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "lineDiscountAmount": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "mainResource": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "comment": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    },
  • "reservationCharges": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property activityReservations for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action cancel

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Responses

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action changeProduct

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

Action parameters

newProductNo
null or string

Responses

Request samples

Content type
application/json
{
  • "newProductNo": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action confirmWithPayment

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

Action parameters

optionalComment
null or string
setQuantity
null or number <decimal>
setNoOfPeople
null or number <decimal>
promoCode
null or string
email
null or string
customerAccountNo
null or string
token
null or string
guestType
null or string

Responses

Request samples

Content type
application/json
{
  • "optionalComment": null,
  • "setQuantity": null,
  • "setNoOfPeople": null,
  • "promoCode": null,
  • "email": null,
  • "customerAccountNo": null,
  • "token": null,
  • "guestType": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action getRequiredDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Responses

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action setStatus

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

Action parameters

newStatus
null or string

Responses

Request samples

Content type
application/json
{
  • "newStatus": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get activityReservations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "reservationNo" "lineNo" "activityNo" "productNo" "itemNo" "productType" "activityType" "eventCategory" "description" "dateFrom" "dateTo" "timeFrom" "timeTo" "quantity" "noOfUnits" "unit" "durationType" "unitPrice" "lineDiscountPercentage" "lineDiscountAmount" "totalAmount" "status" "paymentStatus" "location" "mainResource" "clientNo" "clientName" "noOfPersons" "guestType" "allowanceNo" "promoCode" "cancelPolicy" "cancelPolicyDescription" "cancelAmount" "comment" "waiverCode" "waiverStatus"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "reservationCharges"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to activityReservations for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this activity reservation line. Use this value as the entity key when calling bound actions (confirmWithPayment, cancel, setStatus, changeProduct) or building $expand links. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the line belongs to. Read-only; set when the line is created and used as the SubPageLink target from the Reservations API ($expand=activityReservations).

lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the line sequence within the parent reservation. Read-only; system-assigned in 10000 increments to allow line reordering.

activityNo
null or string <= 20 characters

Specifies the unique Activity number for the line, assigned from the activity number series of the related Activity Type. Read-only; used as the binding identifier for legacy SOAP calls that key by Activity No.

productNo
null or string <= 20 characters

Specifies the Activity Product booked on this line. The value must match a code in the LSC Activity Product table; changing it via the changeProduct action recalculates pricing, duration, and required resources.

itemNo
null or string <= 20 characters

Specifies the posting Item linked to the Activity Product. Read-only; used when the line is posted to the general ledger or to a sales document.

productType
null or string

Specifies the high-level classification of the Activity Product. Allowed values: Activity, Membership, Allowance, Charge. Read-only; defaulted from the product.

activityType
null or string <= 20 characters

Specifies the Activity Type the booked product belongs to. Read-only; drives default interval, duration, and resource selection.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category the activity line belongs to. Optional; used for banquet reporting and dimension defaulting.

description
null or string <= 100 characters

Specifies the display description of the activity line. Read-only on the API; defaulted from the Activity Product.

dateFrom
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the start date of the booked activity (ISO 8601 date). Combined with Time (From) it forms the scheduled start.

dateTo
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the end date of the booked activity. May equal Date From for single-day bookings; for multi-day rentals it forms the scheduled return date.

timeFrom
null or string

Specifies the start time of day for the booked activity. Combined with Date From it forms the inclusive lower bound of the booked slot.

timeTo
null or string

Specifies the end time of day for the booked activity. Combined with Date To it forms the exclusive upper bound of the booked slot; may be 00:00 when the duration is full-day.

quantity
null or number <decimal>

Specifies the quantity booked, in the unit of measure defined by the Activity Product (sessions, hours, etc.). Constraints: must be within the product''s Min/Max Quantity.

noOfUnits
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the number of resource units booked on this line (e.g., number of kayaks, number of treatment rooms). Used to drive resource allocation for multi-unit activities.

unit
null or string

Specifies the unit-of-measure code attached to the booked product. Read-only; defaulted from the product.

durationType
null or string

Specifies how duration is measured on this line. Allowed values: Minutes, Hours, Days, Nights, Open-ended. Read-only; defaulted from the product.

unitPrice
null or number <decimal>

Specifies the unit price applied to the booked quantity. When the caller overrides the default price the change is logged via ValidateUserChangedPrice so that pricing rules can react.

lineDiscountPercentage
null or number <decimal>

Specifies the percentage discount applied to the line. Allowed range: 0 - 100. Manual changes are logged via ValidateUserChangedDiscount to bypass automatic discount recalculation downstream.

lineDiscountAmount
null or number <decimal>

Specifies the absolute discount amount applied to the line. Alternative to Discount % — setting one recalculates the other.

totalAmount
null or number <decimal>

Specifies the calculated net amount for the line (Unit Price * Quantity, less discount). Read-only.

status
null or string <= 20 characters

Specifies the current status code of the activity line. Read-only on the API; use the setStatus / confirmWithPayment / cancel bound actions to transition status.

paymentStatus
null or string

Specifies the payment state of the activity line. Allowed values: None, Partial, Fully Paid, Refunded. Calculated from charges and POS postings; read-only.

location
null or string <= 20 characters

Specifies the Activity Location code where the activity takes place. Defaults from the parent reservation; may differ for multi-location reservations.

mainResource
null or string <= 20 characters

Specifies the primary Activity Resource assigned to the line (e.g., the instructor for a class, the table for a dining reservation). Optional.

clientNo
null or string <= 20 characters

Specifies the client (Contact No.) booked on the line. May differ from the parent Reservation''s client when a single reservation includes activities for multiple guests.

clientName
null or string <= 100 characters

Specifies the display name of the client on the line. When no client is assigned you may set a name (or an e-mail / phone to search for a member contact); once a Client No. is assigned the name follows the contact and cannot be changed.

noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the head count for the activity. Constraints: within the product''s Min/Max No. of Persons when those limits are configured.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing. Must match a configured Guest Type.

allowanceNo
null or string <= 20 characters

Specifies the Issued Allowance redeemed against this line. Read-only; set when the line is paid using a member allowance.

promoCode
null or string <= 20 characters

Specifies the promotion code applied to the line. Resolves to an entry in the Activity Promotions table; affects price.

cancelPolicy
null or string <= 20 characters

Specifies the cancellation policy code that governs cancellation fees for this line. Must match a code in the LSC ACT Cancellation Policy table.

cancelPolicyDescription
null or string

Specifies the human-readable description of the applied Cancellation Policy. Read-only; computed from Cancellation Policy.

cancelAmount
null or number <decimal>

Specifies the cancellation fee that would be charged if the line were cancelled at the current date/time, based on Cancellation Policy. Read-only; calculated on read.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the activity line. Shown on the activity matrix and printed confirmations.

waiverCode
null or string <= 20 characters

Specifies the Waiver code the participant must sign for this activity. Read-only on the API; defaulted from the Activity Product and managed through the waiver flow.

(lscWaiverStatus (null or string))

Specifies whether the required waiver has been signed. Allowed values: Not Required, Required, Signed, Expired. Read-only; resolved from Waiver Entries.

(memberDetail (null or object))
Array of objects (reservationCharge)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "lineNo": null,
  • "activityNo": null,
  • "productNo": null,
  • "itemNo": null,
  • "productType": null,
  • "activityType": null,
  • "eventCategory": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "noOfUnits": null,
  • "unit": null,
  • "durationType": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "lineDiscountAmount": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "mainResource": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "comment": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    },
  • "reservationCharges": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "lineNo": null,
  • "activityNo": null,
  • "productNo": null,
  • "itemNo": null,
  • "productType": null,
  • "activityType": null,
  • "eventCategory": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "noOfUnits": null,
  • "unit": null,
  • "durationType": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "lineDiscountAmount": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "mainResource": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "comment": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    },
  • "reservationCharges": [
    ]
}

Get activityReservations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

query Parameters
$select
Array of strings unique
Items Enum: "id" "reservationNo" "lineNo" "activityNo" "productNo" "itemNo" "productType" "activityType" "eventCategory" "description" "dateFrom" "dateTo" "timeFrom" "timeTo" "quantity" "noOfUnits" "unit" "durationType" "unitPrice" "lineDiscountPercentage" "lineDiscountAmount" "totalAmount" "status" "paymentStatus" "location" "mainResource" "clientNo" "clientName" "noOfPersons" "guestType" "allowanceNo" "promoCode" "cancelPolicy" "cancelPolicyDescription" "cancelAmount" "comment" "waiverCode" "waiverStatus"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "reservationCharges"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "lineNo": null,
  • "activityNo": null,
  • "productNo": null,
  • "itemNo": null,
  • "productType": null,
  • "activityType": null,
  • "eventCategory": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "noOfUnits": null,
  • "unit": null,
  • "durationType": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "lineDiscountAmount": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "mainResource": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "comment": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    },
  • "reservationCharges": [
    ]
}

Update the navigation property activityReservations in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this activity reservation line. Use this value as the entity key when calling bound actions (confirmWithPayment, cancel, setStatus, changeProduct) or building $expand links. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the line belongs to. Read-only; set when the line is created and used as the SubPageLink target from the Reservations API ($expand=activityReservations).

lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the line sequence within the parent reservation. Read-only; system-assigned in 10000 increments to allow line reordering.

activityNo
null or string <= 20 characters

Specifies the unique Activity number for the line, assigned from the activity number series of the related Activity Type. Read-only; used as the binding identifier for legacy SOAP calls that key by Activity No.

productNo
null or string <= 20 characters

Specifies the Activity Product booked on this line. The value must match a code in the LSC Activity Product table; changing it via the changeProduct action recalculates pricing, duration, and required resources.

itemNo
null or string <= 20 characters

Specifies the posting Item linked to the Activity Product. Read-only; used when the line is posted to the general ledger or to a sales document.

productType
null or string

Specifies the high-level classification of the Activity Product. Allowed values: Activity, Membership, Allowance, Charge. Read-only; defaulted from the product.

activityType
null or string <= 20 characters

Specifies the Activity Type the booked product belongs to. Read-only; drives default interval, duration, and resource selection.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category the activity line belongs to. Optional; used for banquet reporting and dimension defaulting.

description
null or string <= 100 characters

Specifies the display description of the activity line. Read-only on the API; defaulted from the Activity Product.

dateFrom
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the start date of the booked activity (ISO 8601 date). Combined with Time (From) it forms the scheduled start.

dateTo
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the end date of the booked activity. May equal Date From for single-day bookings; for multi-day rentals it forms the scheduled return date.

timeFrom
null or string

Specifies the start time of day for the booked activity. Combined with Date From it forms the inclusive lower bound of the booked slot.

timeTo
null or string

Specifies the end time of day for the booked activity. Combined with Date To it forms the exclusive upper bound of the booked slot; may be 00:00 when the duration is full-day.

quantity
null or number <decimal>

Specifies the quantity booked, in the unit of measure defined by the Activity Product (sessions, hours, etc.). Constraints: must be within the product''s Min/Max Quantity.

noOfUnits
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the number of resource units booked on this line (e.g., number of kayaks, number of treatment rooms). Used to drive resource allocation for multi-unit activities.

unit
null or string

Specifies the unit-of-measure code attached to the booked product. Read-only; defaulted from the product.

durationType
null or string

Specifies how duration is measured on this line. Allowed values: Minutes, Hours, Days, Nights, Open-ended. Read-only; defaulted from the product.

unitPrice
null or number <decimal>

Specifies the unit price applied to the booked quantity. When the caller overrides the default price the change is logged via ValidateUserChangedPrice so that pricing rules can react.

lineDiscountPercentage
null or number <decimal>

Specifies the percentage discount applied to the line. Allowed range: 0 - 100. Manual changes are logged via ValidateUserChangedDiscount to bypass automatic discount recalculation downstream.

lineDiscountAmount
null or number <decimal>

Specifies the absolute discount amount applied to the line. Alternative to Discount % — setting one recalculates the other.

totalAmount
null or number <decimal>

Specifies the calculated net amount for the line (Unit Price * Quantity, less discount). Read-only.

status
null or string <= 20 characters

Specifies the current status code of the activity line. Read-only on the API; use the setStatus / confirmWithPayment / cancel bound actions to transition status.

paymentStatus
null or string

Specifies the payment state of the activity line. Allowed values: None, Partial, Fully Paid, Refunded. Calculated from charges and POS postings; read-only.

location
null or string <= 20 characters

Specifies the Activity Location code where the activity takes place. Defaults from the parent reservation; may differ for multi-location reservations.

mainResource
null or string <= 20 characters

Specifies the primary Activity Resource assigned to the line (e.g., the instructor for a class, the table for a dining reservation). Optional.

clientNo
null or string <= 20 characters

Specifies the client (Contact No.) booked on the line. May differ from the parent Reservation''s client when a single reservation includes activities for multiple guests.

clientName
null or string <= 100 characters

Specifies the display name of the client on the line. When no client is assigned you may set a name (or an e-mail / phone to search for a member contact); once a Client No. is assigned the name follows the contact and cannot be changed.

noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the head count for the activity. Constraints: within the product''s Min/Max No. of Persons when those limits are configured.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing. Must match a configured Guest Type.

allowanceNo
null or string <= 20 characters

Specifies the Issued Allowance redeemed against this line. Read-only; set when the line is paid using a member allowance.

promoCode
null or string <= 20 characters

Specifies the promotion code applied to the line. Resolves to an entry in the Activity Promotions table; affects price.

cancelPolicy
null or string <= 20 characters

Specifies the cancellation policy code that governs cancellation fees for this line. Must match a code in the LSC ACT Cancellation Policy table.

cancelPolicyDescription
null or string

Specifies the human-readable description of the applied Cancellation Policy. Read-only; computed from Cancellation Policy.

cancelAmount
null or number <decimal>

Specifies the cancellation fee that would be charged if the line were cancelled at the current date/time, based on Cancellation Policy. Read-only; calculated on read.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the activity line. Shown on the activity matrix and printed confirmations.

waiverCode
null or string <= 20 characters

Specifies the Waiver code the participant must sign for this activity. Read-only on the API; defaulted from the Activity Product and managed through the waiver flow.

(lscWaiverStatus (null or string))

Specifies whether the required waiver has been signed. Allowed values: Not Required, Required, Signed, Expired. Read-only; resolved from Waiver Entries.

(memberDetail (null or object))
Array of objects (reservationCharge)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "lineNo": null,
  • "activityNo": null,
  • "productNo": null,
  • "itemNo": null,
  • "productType": null,
  • "activityType": null,
  • "eventCategory": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "noOfUnits": null,
  • "unit": null,
  • "durationType": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "lineDiscountAmount": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "mainResource": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "comment": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    },
  • "reservationCharges": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property activityReservations for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action cancel

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Responses

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action changeProduct

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

Action parameters

newProductNo
null or string

Responses

Request samples

Content type
application/json
{
  • "newProductNo": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action confirmWithPayment

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

Action parameters

optionalComment
null or string
setQuantity
null or number <decimal>
setNoOfPeople
null or number <decimal>
promoCode
null or string
email
null or string
customerAccountNo
null or string
token
null or string
guestType
null or string

Responses

Request samples

Content type
application/json
{
  • "optionalComment": null,
  • "setQuantity": null,
  • "setNoOfPeople": null,
  • "promoCode": null,
  • "email": null,
  • "customerAccountNo": null,
  • "token": null,
  • "guestType": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action getRequiredDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Responses

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action setStatus

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

Action parameters

newStatus
null or string

Responses

Request samples

Content type
application/json
{
  • "newStatus": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Member Detail

Member Details exposes the profile of a Member Contact — the person side of a Member Account. Use this API to look up a member by contact number, retrieve demographic and contact information, see the current points / account balance, and post a member-account deposit via the insertDeposit bound action. Replaces the legacy SOAP procedures UploadMemberDetails and InsertMemberDeposit in codeunit 10015848 "LSC Activity WS".

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

admissionEntry-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of admissionEntry

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

admissionEntry-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of admissionEntry

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetails from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get memberDetails from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

memberDetail-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of memberDetail

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

memberDetail-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of memberDetail

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

membershipEntry-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of membershipEntry

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

membershipEntry-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of membershipEntry

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

resourceActivity-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of resourceActivity

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

resourceActivity-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of resourceActivity

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Reservation Charge

A Reservation Charge is an additional posting line attached to a Reservation — i.e., something that gets paid for as part of the reservation but is not the activity booking itself (booking fees, equipment rental on a treatment, banquet service charge, security deposit, etc.). One endpoint covers both levels at which a charge can sit: header-level charges (attached to the reservation as a whole — Reservation Line No. = -1) and activity-line-level charges (attached to a specific Activity Reservation line — Reservation Line No. = that line''s Line No.). When accessed through $expand from the Reservations API the SubPageLink scopes the response to header-level only; when accessed through $expand from the Activity Reservations API it scopes the response to the specific line. At the top-level entitySet URL (no parent) both kinds are returned and the caller filters explicitly on reservationLineNo. POST/PATCH/DELETE are supported. Replaces the legacy SOAP procedures GetAdditionalCharges, GetReservationAdditionalCharges, and SetAdditionalChargesV4 in codeunit 10015848 "LSC Activity WS".

Get reservationCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "reservationNo" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "discountAmount" "totalAmount" "unitOfMeasureCode" "variantCode" "eventCategory" "allowance" "allowanceAmountType" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier" "barcode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to reservationCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this charge line. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the charge belongs to. Required on POST.

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the reservation the charge is attached to. Allowed values: -1 — the charge sits on the reservation header (not bound to any activity line); a positive integer — the charge sits on the Activity Reservation line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Reservations -> -1, Activity Reservations -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-line sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the reservation line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line. Resolves to the appropriate master table based on Product Type (Item, Deal, Item Category, Special Group, or Product Group).

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged, in the unit of measure defined by the product. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. Defaulted from the product; may be overridden when Price Handling permits. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

discountAmount
null or number <decimal>

Specifies the absolute discount amount applied. Alternative to Discount %; setting one recalculates the other. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Must match a UoM defined on the product. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

variantCode
null or string <= 10 characters

Specifies the item variant code when the product is an Item with variants. Optional.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category for the charge, used for dimension defaulting.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. When true, Allowance Amount Type controls the redemption value. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled). Defaulted on insert.

priceHandling
null or string

Specifies how the price is determined for the charge. Allowed values: Standard — use product price; Fixed — use Fixed Price; Manual — caller-supplied. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity from the parent (e.g., 1 charge per person on the activity).

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected, or mandatory (false).

selected
null or boolean

Specifies whether an optional charge is currently selected for posting. Ignored when Optional Item is false.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Used with Base Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

barcode
null or string <= 30 characters

Specifies the barcode used when the charge is added at the POS via barcode scan.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Get reservationCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "reservationNo" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "discountAmount" "totalAmount" "unitOfMeasureCode" "variantCode" "eventCategory" "allowance" "allowanceAmountType" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier" "barcode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Update the navigation property reservationCharges in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this charge line. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the charge belongs to. Required on POST.

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the reservation the charge is attached to. Allowed values: -1 — the charge sits on the reservation header (not bound to any activity line); a positive integer — the charge sits on the Activity Reservation line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Reservations -> -1, Activity Reservations -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-line sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the reservation line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line. Resolves to the appropriate master table based on Product Type (Item, Deal, Item Category, Special Group, or Product Group).

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged, in the unit of measure defined by the product. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. Defaulted from the product; may be overridden when Price Handling permits. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

discountAmount
null or number <decimal>

Specifies the absolute discount amount applied. Alternative to Discount %; setting one recalculates the other. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Must match a UoM defined on the product. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

variantCode
null or string <= 10 characters

Specifies the item variant code when the product is an Item with variants. Optional.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category for the charge, used for dimension defaulting.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. When true, Allowance Amount Type controls the redemption value. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled). Defaulted on insert.

priceHandling
null or string

Specifies how the price is determined for the charge. Allowed values: Standard — use product price; Fixed — use Fixed Price; Manual — caller-supplied. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity from the parent (e.g., 1 charge per person on the activity).

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected, or mandatory (false).

selected
null or boolean

Specifies whether an optional charge is currently selected for posting. Ignored when Optional Item is false.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Used with Base Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

barcode
null or string <= 30 characters

Specifies the barcode used when the charge is added at the POS via barcode scan.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property reservationCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get reservationCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "reservationNo" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "discountAmount" "totalAmount" "unitOfMeasureCode" "variantCode" "eventCategory" "allowance" "allowanceAmountType" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier" "barcode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to reservationCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this charge line. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the charge belongs to. Required on POST.

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the reservation the charge is attached to. Allowed values: -1 — the charge sits on the reservation header (not bound to any activity line); a positive integer — the charge sits on the Activity Reservation line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Reservations -> -1, Activity Reservations -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-line sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the reservation line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line. Resolves to the appropriate master table based on Product Type (Item, Deal, Item Category, Special Group, or Product Group).

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged, in the unit of measure defined by the product. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. Defaulted from the product; may be overridden when Price Handling permits. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

discountAmount
null or number <decimal>

Specifies the absolute discount amount applied. Alternative to Discount %; setting one recalculates the other. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Must match a UoM defined on the product. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

variantCode
null or string <= 10 characters

Specifies the item variant code when the product is an Item with variants. Optional.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category for the charge, used for dimension defaulting.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. When true, Allowance Amount Type controls the redemption value. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled). Defaulted on insert.

priceHandling
null or string

Specifies how the price is determined for the charge. Allowed values: Standard — use product price; Fixed — use Fixed Price; Manual — caller-supplied. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity from the parent (e.g., 1 charge per person on the activity).

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected, or mandatory (false).

selected
null or boolean

Specifies whether an optional charge is currently selected for posting. Ignored when Optional Item is false.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Used with Base Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

barcode
null or string <= 30 characters

Specifies the barcode used when the charge is added at the POS via barcode scan.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Get reservationCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "reservationNo" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "discountAmount" "totalAmount" "unitOfMeasureCode" "variantCode" "eventCategory" "allowance" "allowanceAmountType" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier" "barcode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Update the navigation property reservationCharges in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this charge line. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the charge belongs to. Required on POST.

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the reservation the charge is attached to. Allowed values: -1 — the charge sits on the reservation header (not bound to any activity line); a positive integer — the charge sits on the Activity Reservation line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Reservations -> -1, Activity Reservations -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-line sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the reservation line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line. Resolves to the appropriate master table based on Product Type (Item, Deal, Item Category, Special Group, or Product Group).

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged, in the unit of measure defined by the product. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. Defaulted from the product; may be overridden when Price Handling permits. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

discountAmount
null or number <decimal>

Specifies the absolute discount amount applied. Alternative to Discount %; setting one recalculates the other. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Must match a UoM defined on the product. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

variantCode
null or string <= 10 characters

Specifies the item variant code when the product is an Item with variants. Optional.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category for the charge, used for dimension defaulting.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. When true, Allowance Amount Type controls the redemption value. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled). Defaulted on insert.

priceHandling
null or string

Specifies how the price is determined for the charge. Allowed values: Standard — use product price; Fixed — use Fixed Price; Manual — caller-supplied. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity from the parent (e.g., 1 charge per person on the activity).

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected, or mandatory (false).

selected
null or boolean

Specifies whether an optional charge is currently selected for posting. Ignored when Optional Item is false.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Used with Base Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

barcode
null or string <= 30 characters

Specifies the barcode used when the charge is added at the POS via barcode scan.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property reservationCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get reservationCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "reservationNo" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "discountAmount" "totalAmount" "unitOfMeasureCode" "variantCode" "eventCategory" "allowance" "allowanceAmountType" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier" "barcode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to reservationCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this charge line. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the charge belongs to. Required on POST.

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the reservation the charge is attached to. Allowed values: -1 — the charge sits on the reservation header (not bound to any activity line); a positive integer — the charge sits on the Activity Reservation line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Reservations -> -1, Activity Reservations -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-line sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the reservation line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line. Resolves to the appropriate master table based on Product Type (Item, Deal, Item Category, Special Group, or Product Group).

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged, in the unit of measure defined by the product. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. Defaulted from the product; may be overridden when Price Handling permits. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

discountAmount
null or number <decimal>

Specifies the absolute discount amount applied. Alternative to Discount %; setting one recalculates the other. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Must match a UoM defined on the product. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

variantCode
null or string <= 10 characters

Specifies the item variant code when the product is an Item with variants. Optional.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category for the charge, used for dimension defaulting.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. When true, Allowance Amount Type controls the redemption value. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled). Defaulted on insert.

priceHandling
null or string

Specifies how the price is determined for the charge. Allowed values: Standard — use product price; Fixed — use Fixed Price; Manual — caller-supplied. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity from the parent (e.g., 1 charge per person on the activity).

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected, or mandatory (false).

selected
null or boolean

Specifies whether an optional charge is currently selected for posting. Ignored when Optional Item is false.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Used with Base Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

barcode
null or string <= 30 characters

Specifies the barcode used when the charge is added at the POS via barcode scan.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Get reservationCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "reservationNo" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "discountAmount" "totalAmount" "unitOfMeasureCode" "variantCode" "eventCategory" "allowance" "allowanceAmountType" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier" "barcode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Update the navigation property reservationCharges in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this charge line. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the charge belongs to. Required on POST.

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the reservation the charge is attached to. Allowed values: -1 — the charge sits on the reservation header (not bound to any activity line); a positive integer — the charge sits on the Activity Reservation line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Reservations -> -1, Activity Reservations -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-line sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the reservation line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line. Resolves to the appropriate master table based on Product Type (Item, Deal, Item Category, Special Group, or Product Group).

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged, in the unit of measure defined by the product. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. Defaulted from the product; may be overridden when Price Handling permits. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

discountAmount
null or number <decimal>

Specifies the absolute discount amount applied. Alternative to Discount %; setting one recalculates the other. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Must match a UoM defined on the product. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

variantCode
null or string <= 10 characters

Specifies the item variant code when the product is an Item with variants. Optional.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category for the charge, used for dimension defaulting.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. When true, Allowance Amount Type controls the redemption value. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled). Defaulted on insert.

priceHandling
null or string

Specifies how the price is determined for the charge. Allowed values: Standard — use product price; Fixed — use Fixed Price; Manual — caller-supplied. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity from the parent (e.g., 1 charge per person on the activity).

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected, or mandatory (false).

selected
null or boolean

Specifies whether an optional charge is currently selected for posting. Ignored when Optional Item is false.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Used with Base Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

barcode
null or string <= 30 characters

Specifies the barcode used when the charge is added at the POS via barcode scan.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property reservationCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

activityReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityReservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get reservationCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "reservationNo" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "discountAmount" "totalAmount" "unitOfMeasureCode" "variantCode" "eventCategory" "allowance" "allowanceAmountType" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier" "barcode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to reservationCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this charge line. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the charge belongs to. Required on POST.

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the reservation the charge is attached to. Allowed values: -1 — the charge sits on the reservation header (not bound to any activity line); a positive integer — the charge sits on the Activity Reservation line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Reservations -> -1, Activity Reservations -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-line sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the reservation line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line. Resolves to the appropriate master table based on Product Type (Item, Deal, Item Category, Special Group, or Product Group).

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged, in the unit of measure defined by the product. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. Defaulted from the product; may be overridden when Price Handling permits. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

discountAmount
null or number <decimal>

Specifies the absolute discount amount applied. Alternative to Discount %; setting one recalculates the other. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Must match a UoM defined on the product. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

variantCode
null or string <= 10 characters

Specifies the item variant code when the product is an Item with variants. Optional.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category for the charge, used for dimension defaulting.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. When true, Allowance Amount Type controls the redemption value. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled). Defaulted on insert.

priceHandling
null or string

Specifies how the price is determined for the charge. Allowed values: Standard — use product price; Fixed — use Fixed Price; Manual — caller-supplied. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity from the parent (e.g., 1 charge per person on the activity).

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected, or mandatory (false).

selected
null or boolean

Specifies whether an optional charge is currently selected for posting. Ignored when Optional Item is false.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Used with Base Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

barcode
null or string <= 30 characters

Specifies the barcode used when the charge is added at the POS via barcode scan.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Get reservationCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "reservationNo" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "discountAmount" "totalAmount" "unitOfMeasureCode" "variantCode" "eventCategory" "allowance" "allowanceAmountType" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier" "barcode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Update the navigation property reservationCharges in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this charge line. Read-only.

reservationNo
null or string <= 20 characters

Specifies the parent Reservation the charge belongs to. Required on POST.

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the reservation the charge is attached to. Allowed values: -1 — the charge sits on the reservation header (not bound to any activity line); a positive integer — the charge sits on the Activity Reservation line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Reservations -> -1, Activity Reservations -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-line sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the reservation line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line. Resolves to the appropriate master table based on Product Type (Item, Deal, Item Category, Special Group, or Product Group).

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged, in the unit of measure defined by the product. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. Defaulted from the product; may be overridden when Price Handling permits. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

discountAmount
null or number <decimal>

Specifies the absolute discount amount applied. Alternative to Discount %; setting one recalculates the other. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Must match a UoM defined on the product. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

variantCode
null or string <= 10 characters

Specifies the item variant code when the product is an Item with variants. Optional.

eventCategory
null or string <= 20 characters

Specifies the Event / Banquet Category for the charge, used for dimension defaulting.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. When true, Allowance Amount Type controls the redemption value. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled). Defaulted on insert.

priceHandling
null or string

Specifies how the price is determined for the charge. Allowed values: Standard — use product price; Fixed — use Fixed Price; Manual — caller-supplied. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity from the parent (e.g., 1 charge per person on the activity).

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected, or mandatory (false).

selected
null or boolean

Specifies whether an optional charge is currently selected for posting. Ignored when Optional Item is false.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Used with Base Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

barcode
null or string <= 30 characters

Specifies the barcode used when the charge is added at the POS via barcode scan.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reservationNo": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "discountAmount": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "variantCode": null,
  • "eventCategory": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null,
  • "barcode": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property reservationCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

reservationCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservationCharge

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Activity Resource Group

An Activity Resource Group bundles several Activity Resources that can substitute for one another for booking purposes — e.g., "any massage room", "any spin bike". The getAvailability bound action returns the aggregated bookable timetable across the resources in the group. Replaces the legacy SOAP procedure GetResourceGroupAvailability in codeunit 10015848 "LSC Activity WS".

Get activityResourceGroups from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "code" "description" "type" "capacityBasedOn" "noOfResources"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get activityResourceGroups from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityResourceGroup-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityResourceGroup

query Parameters
$select
Array of strings unique
Items Enum: "id" "code" "description" "type" "capacityBasedOn" "noOfResources"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "description": null,
  • "type": null,
  • "capacityBasedOn": null,
  • "noOfResources": null
}

Invoke action getAvailability

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityResourceGroup-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityResourceGroup

Request Body schema: application/json

Action parameters

locationNo
null or string
activityDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
intervalType
null or string
noOfDays
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "activityDate": null,
  • "intervalType": null,
  • "noOfDays": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Activity Resource

An Activity Resource is anything bookable that constrains capacity — an instructor, a treatment room, a piece of equipment, a kayak. The list is filtered to Status = Active. Use the getAvailability bound action to retrieve the bookable timetable for a resource on a given date. Replaces the legacy SOAP procedures UploadActivityResources, UploadResourceActivities (via the Resource Activities API), and GetResourceAvailability in codeunit 10015848 "LSC Activity WS".

Get activityResources from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "resourceNo" "description" "resourceGroup" "fixedLocation" "phone" "email" "status" "resourceType" "availableQuantity" "maxCapacity" "capacityBasedOn" "gender" "selectionPriority"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get activityResources from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityResource-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityResource

query Parameters
$select
Array of strings unique
Items Enum: "id" "resourceNo" "description" "resourceGroup" "fixedLocation" "phone" "email" "status" "resourceType" "availableQuantity" "maxCapacity" "capacityBasedOn" "gender" "selectionPriority"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "resourceNo": null,
  • "description": null,
  • "resourceGroup": null,
  • "fixedLocation": null,
  • "phone": null,
  • "email": null,
  • "status": null,
  • "resourceType": null,
  • "availableQuantity": null,
  • "maxCapacity": null,
  • "capacityBasedOn": null,
  • "gender": "_x0020_",
  • "selectionPriority": null
}

Invoke action getAvailability

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityResource-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityResource

Request Body schema: application/json

Action parameters

locationNo
null or string
activityDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
intervalType
null or string
noOfDays
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "locationNo": null,
  • "activityDate": null,
  • "intervalType": null,
  • "noOfDays": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Activity Setting

Activity Settings is the single-record setup table that governs Bookings web-service behavior — the default web currency, the timezone the API operates in, the status codes used by the SOAP confirm / cancel / set-status flows, payment handling, and the token TTL for resource holds. Read-only. Integrations typically read this first to discover the status codes they should pass to setStatus actions.

Get activitySettings from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "webCurrencyCode" "webServiceTimeZone" "webServiceOn" "webConfirmedStatus" "webDraftStatus" "webPaidStatus" "webCancelledStatus" "webGroupCancelledStatus" "webPaymentProcess" "webIncludeAdditionalCharges" "tokenExpiryTimeSeconds"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get activitySettings from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activitySetting-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activitySetting

query Parameters
$select
Array of strings unique
Items Enum: "id" "webCurrencyCode" "webServiceTimeZone" "webServiceOn" "webConfirmedStatus" "webDraftStatus" "webPaidStatus" "webCancelledStatus" "webGroupCancelledStatus" "webPaymentProcess" "webIncludeAdditionalCharges" "tokenExpiryTimeSeconds"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webCurrencyCode": null,
  • "webServiceTimeZone": null,
  • "webServiceOn": null,
  • "webConfirmedStatus": null,
  • "webDraftStatus": null,
  • "webPaidStatus": null,
  • "webCancelledStatus": null,
  • "webGroupCancelledStatus": null,
  • "webPaymentProcess": null,
  • "webIncludeAdditionalCharges": null,
  • "tokenExpiryTimeSeconds": null
}

Activity Type

An Activity Type is the top-level taxonomy used by Bookings — it groups Activity Products that share booking behavior, default availability windows, cancellation policy, and number series. Use this read-only API to enumerate the activity types an integration may operate against and to drive product pickers in front-end UI. Replaces the legacy SOAP procedure UploadActivityTypes in codeunit 10015848 "LSC Activity WS".

Get activityTypes from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "activityCode" "description" "intervalType" "dayDuration" "requireClientNo" "activityNoSeries" "noOfProducts" "advanceBookingLimitDays" "noOfDaysInAvailability" "newPostingItemTemplate" "sendRemindersDaysBefore" "reminderTemplate" "tasksEnabled" "preSellPostingItem" "preSellPostingType" "defaultMatrixView" "tableMgmtIntegration" "webBookingsAllowed" "cancellationPolicy" "defaultActivityCard" "lateReturnHandling" "lateReturnChargeAmount" "lateReturnFlexMinutes" "showNonAvailabilityPOS" "productTemplate" "posDaysInAvailability" "webDaysInAvailability" "performanceSetting" "defaultEventCategory" "allowancePostingType" "allowancePosting" "allowPastBookingsDays" "defaultPOSJournalScript" "waiverCode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get activityTypes from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

activityType-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of activityType

query Parameters
$select
Array of strings unique
Items Enum: "id" "activityCode" "description" "intervalType" "dayDuration" "requireClientNo" "activityNoSeries" "noOfProducts" "advanceBookingLimitDays" "noOfDaysInAvailability" "newPostingItemTemplate" "sendRemindersDaysBefore" "reminderTemplate" "tasksEnabled" "preSellPostingItem" "preSellPostingType" "defaultMatrixView" "tableMgmtIntegration" "webBookingsAllowed" "cancellationPolicy" "defaultActivityCard" "lateReturnHandling" "lateReturnChargeAmount" "lateReturnFlexMinutes" "showNonAvailabilityPOS" "productTemplate" "posDaysInAvailability" "webDaysInAvailability" "performanceSetting" "defaultEventCategory" "allowancePostingType" "allowancePosting" "allowPastBookingsDays" "defaultPOSJournalScript" "waiverCode"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityCode": "string",
  • "description": null,
  • "intervalType": null,
  • "dayDuration": null,
  • "requireClientNo": null,
  • "activityNoSeries": null,
  • "noOfProducts": null,
  • "advanceBookingLimitDays": null,
  • "noOfDaysInAvailability": null,
  • "newPostingItemTemplate": null,
  • "sendRemindersDaysBefore": null,
  • "reminderTemplate": null,
  • "tasksEnabled": null,
  • "preSellPostingItem": null,
  • "preSellPostingType": null,
  • "defaultMatrixView": null,
  • "tableMgmtIntegration": null,
  • "webBookingsAllowed": null,
  • "cancellationPolicy": null,
  • "defaultActivityCard": null,
  • "lateReturnHandling": null,
  • "lateReturnChargeAmount": null,
  • "lateReturnFlexMinutes": null,
  • "showNonAvailabilityPOS": null,
  • "productTemplate": null,
  • "posDaysInAvailability": null,
  • "webDaysInAvailability": null,
  • "performanceSetting": null,
  • "defaultEventCategory": null,
  • "allowancePostingType": null,
  • "allowancePosting": null,
  • "allowPastBookingsDays": null,
  • "defaultPOSJournalScript": null,
  • "waiverCode": null
}

Admission Entry

An Admission Entry is the audit trail of a gate scan / membership swipe — one row per access event captured at a location''s entry point. Use this read-only API to enumerate access history for a client, location, or gate. Replaces the legacy SOAP procedure UploadAdmissionEntries in codeunit 10015848 "LSC Activity WS".

Get admissionEntries from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "locationNo" "gateNo" "memberNo" "lineNo" "date" "time" "memberType" "productName" "type" "name" "membershipNo" "accessId" "accountNo" "dateTimeEntry" "year" "month"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get admissionEntries from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

admissionEntry-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of admissionEntry

query Parameters
$select
Array of strings unique
Items Enum: "id" "locationNo" "gateNo" "memberNo" "lineNo" "date" "time" "memberType" "productName" "type" "name" "membershipNo" "accessId" "accountNo" "dateTimeEntry" "year" "month"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "locationNo": null,
  • "gateNo": null,
  • "memberNo": null,
  • "lineNo": null,
  • "date": null,
  • "time": null,
  • "memberType": null,
  • "productName": null,
  • "type": null,
  • "name": null,
  • "membershipNo": null,
  • "accessId": null,
  • "accountNo": null,
  • "dateTimeEntry": null,
  • "year": null,
  • "month": null,
  • "memberDetail": {
    }
}

Attribute

An Attribute Value is a typed key/value pair attached to any of several Bookings entities — Reservation, Activity Reservation, Activity Product, Activity Resource, Rental Unit, etc. This API is a merged surface: the caller supplies linkType (entity kind) + linkNo (entity identifier) on every read filter and on every write. POST/PATCH/DELETE are supported. Replaces the legacy SOAP procedures GetAttributes and SetAttribute (and all their entity-specific overloads) in codeunit 10015848 "LSC Activity WS" — instead of one call per link type, integrators now point at one endpoint and use $filter=linkType eq ''…'' and linkNo eq ''…''.

Get attributes from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "linkType" "linkNo" "linkField2" "linkField3" "attributeCode" "attributeValue" "numericValue" "sequence" "description" "attributeValueType" "valueCalculated"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to attributes for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this attribute value. Read-only.

linkType
null or string

Specifies the kind of entity the attribute is linked to. Allowed values: Reservation, Activity, Product, Resource, Unit, Group, Membership — drives how Link No. / Link Field 2 / Link Field 3 are interpreted.

linkNo
null or string <= 20 characters

Specifies the primary identifier of the linked entity (e.g., Reservation No., Activity No., Product No.). Required.

linkField2
null or string <= 20 characters

Specifies the secondary identifier of the linked entity, when its key has more than one part (e.g., Line No. on a reservation activity).

linkField3
null or string <= 20 characters

Specifies the tertiary identifier of the linked entity, used by Link Types whose key has three parts.

attributeCode
null or string <= 20 characters

Specifies the code of the attribute being set. Must match an attribute defined for the relevant Link Type.

attributeValue
null or string <= 250 characters

Specifies the text value of the attribute. For numeric attributes the value is also stored in Numeric Value.

numericValue
null or number <decimal>

Specifies the numeric value of the attribute, populated when Attribute Value Type is Number.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the ordinal of the attribute when several attribute values share the same Link + Attribute Code. Used for multi-valued attributes.

description
null or string <= 50 characters

Specifies the human-readable description of the attribute. Read-only; auto-loaded from the attribute master.

attributeValueType
null or string

Specifies the declared data type of the attribute. Allowed values: Text, Number, Option, Boolean, Date. Read-only; defined on the attribute master.

valueCalculated
null or string

Specifies whether the value was computed by a rule rather than set by a user (true). Read-only.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "linkType": null,
  • "linkNo": null,
  • "linkField2": null,
  • "linkField3": null,
  • "attributeCode": null,
  • "attributeValue": null,
  • "numericValue": null,
  • "sequence": null,
  • "description": null,
  • "attributeValueType": null,
  • "valueCalculated": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "linkType": null,
  • "linkNo": null,
  • "linkField2": null,
  • "linkField3": null,
  • "attributeCode": null,
  • "attributeValue": null,
  • "numericValue": null,
  • "sequence": null,
  • "description": null,
  • "attributeValueType": null,
  • "valueCalculated": null
}

Get attributes from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

attribute-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of attribute

query Parameters
$select
Array of strings unique
Items Enum: "id" "linkType" "linkNo" "linkField2" "linkField3" "attributeCode" "attributeValue" "numericValue" "sequence" "description" "attributeValueType" "valueCalculated"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "linkType": null,
  • "linkNo": null,
  • "linkField2": null,
  • "linkField3": null,
  • "attributeCode": null,
  • "attributeValue": null,
  • "numericValue": null,
  • "sequence": null,
  • "description": null,
  • "attributeValueType": null,
  • "valueCalculated": null
}

Update the navigation property attributes in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

attribute-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of attribute

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this attribute value. Read-only.

linkType
null or string

Specifies the kind of entity the attribute is linked to. Allowed values: Reservation, Activity, Product, Resource, Unit, Group, Membership — drives how Link No. / Link Field 2 / Link Field 3 are interpreted.

linkNo
null or string <= 20 characters

Specifies the primary identifier of the linked entity (e.g., Reservation No., Activity No., Product No.). Required.

linkField2
null or string <= 20 characters

Specifies the secondary identifier of the linked entity, when its key has more than one part (e.g., Line No. on a reservation activity).

linkField3
null or string <= 20 characters

Specifies the tertiary identifier of the linked entity, used by Link Types whose key has three parts.

attributeCode
null or string <= 20 characters

Specifies the code of the attribute being set. Must match an attribute defined for the relevant Link Type.

attributeValue
null or string <= 250 characters

Specifies the text value of the attribute. For numeric attributes the value is also stored in Numeric Value.

numericValue
null or number <decimal>

Specifies the numeric value of the attribute, populated when Attribute Value Type is Number.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the ordinal of the attribute when several attribute values share the same Link + Attribute Code. Used for multi-valued attributes.

description
null or string <= 50 characters

Specifies the human-readable description of the attribute. Read-only; auto-loaded from the attribute master.

attributeValueType
null or string

Specifies the declared data type of the attribute. Allowed values: Text, Number, Option, Boolean, Date. Read-only; defined on the attribute master.

valueCalculated
null or string

Specifies whether the value was computed by a rule rather than set by a user (true). Read-only.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "linkType": null,
  • "linkNo": null,
  • "linkField2": null,
  • "linkField3": null,
  • "attributeCode": null,
  • "attributeValue": null,
  • "numericValue": null,
  • "sequence": null,
  • "description": null,
  • "attributeValueType": null,
  • "valueCalculated": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property attributes for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

attribute-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of attribute

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Customer Entry

A Customer Entry is a single BC Customer Ledger Entry — the financial trail of invoices, payments, credit memos, etc. posted against a Customer. This API projects the standard Cust. Ledger Entry table for use by Bookings front-ends that need to show a customer''s open balance, pending invoices, and payment history (filter by customerNo and / or memberNo). Read-only. Replaces the legacy SOAP procedure UploadCustomerEntries in codeunit 10015848 "LSC Activity WS".

Get customerEntries from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "entryNo" "customerNo" "memberNo" "customerName" "postingDate" "documentDate" "dueDate" "documentType" "documentNo" "externalDocumentNo" "description" "currencyCode" "amount" "remainingAmount" "amountLcy" "remainingAmountLcy" "open" "closedAtDate" "closedByEntryNo" "salesPersonCode" "paymentMethodCode" "globalDimension1Code" "globalDimension2Code"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get customerEntries from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

customerEntry-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of customerEntry

query Parameters
$select
Array of strings unique
Items Enum: "id" "entryNo" "customerNo" "memberNo" "customerName" "postingDate" "documentDate" "dueDate" "documentType" "documentNo" "externalDocumentNo" "description" "currencyCode" "amount" "remainingAmount" "amountLcy" "remainingAmountLcy" "open" "closedAtDate" "closedByEntryNo" "salesPersonCode" "paymentMethodCode" "globalDimension1Code" "globalDimension2Code"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entryNo": null,
  • "customerNo": null,
  • "memberNo": null,
  • "customerName": null,
  • "postingDate": null,
  • "documentDate": null,
  • "dueDate": null,
  • "documentType": "_x0020_",
  • "documentNo": null,
  • "externalDocumentNo": null,
  • "description": null,
  • "currencyCode": null,
  • "amount": null,
  • "remainingAmount": null,
  • "amountLcy": null,
  • "remainingAmountLcy": null,
  • "open": null,
  • "closedAtDate": null,
  • "closedByEntryNo": null,
  • "salesPersonCode": null,
  • "paymentMethodCode": null,
  • "globalDimension1Code": null,
  • "globalDimension2Code": null
}

Group Charge

A Group Charge is an additional posting line attached to a Group Reservation — i.e., something paid as part of the group reservation but distinct from the activity lines themselves (banquet service fee, per-guest welcome drink, coach-hire surcharge). One endpoint covers both levels at which a charge can sit: group-header charges (attached to the group as a whole — Reservation Line No. = -1) and group-line charges (attached to a specific Group Reservation Line — Reservation Line No. = that line''s Line No.). When accessed through $expand from the Group Reservations API the SubPageLink scopes the response to header-level only; when accessed through $expand from the Group Reservation Lines API it scopes the response to the specific line. At the top-level entitySet URL (no parent) both kinds are returned and the caller filters explicitly on reservationLineNo. The optional groupMember field further attributes a charge to a specific group member. POST/PATCH/DELETE are supported. Replaces the legacy SOAP procedures GetGroupReservationAdditionalCharges and SetGroupAdditionalCharges in codeunit 10015848 "LSC Activity WS".

Get groupCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "activityGroup" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "totalAmount" "unitOfMeasureCode" "allowance" "allowanceAmountType" "groupMember" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group charge line. Read-only.

activityGroup
null or string <= 20 characters

Specifies the parent Group Reservation the charge belongs to. Required on POST; used as the SubPageLink target from the Group Reservations API ($expand=groupCharges).

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the group reservation the charge is attached to. Allowed values: -1 — the charge sits on the group header (not bound to any group line); a positive integer — the charge sits on the Group Reservation Line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Group Reservations -> -1, Group Reservation Lines -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-group sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line.

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

groupMember
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the optional Group Member sequence the charge is attributed to. Zero means the charge is borne by the group rather than a specific member.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled).

priceHandling
null or string

Specifies how the price is determined. Allowed values: Standard, Fixed, Manual. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity.

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected.

selected
null or boolean

Specifies whether an optional charge is currently selected for posting.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Get groupCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "activityGroup" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "totalAmount" "unitOfMeasureCode" "allowance" "allowanceAmountType" "groupMember" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Update the navigation property groupCharges in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group charge line. Read-only.

activityGroup
null or string <= 20 characters

Specifies the parent Group Reservation the charge belongs to. Required on POST; used as the SubPageLink target from the Group Reservations API ($expand=groupCharges).

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the group reservation the charge is attached to. Allowed values: -1 — the charge sits on the group header (not bound to any group line); a positive integer — the charge sits on the Group Reservation Line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Group Reservations -> -1, Group Reservation Lines -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-group sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line.

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

groupMember
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the optional Group Member sequence the charge is attributed to. Zero means the charge is borne by the group rather than a specific member.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled).

priceHandling
null or string

Specifies how the price is determined. Allowed values: Standard, Fixed, Manual. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity.

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected.

selected
null or boolean

Specifies whether an optional charge is currently selected for posting.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get groupCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "activityGroup" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "totalAmount" "unitOfMeasureCode" "allowance" "allowanceAmountType" "groupMember" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group charge line. Read-only.

activityGroup
null or string <= 20 characters

Specifies the parent Group Reservation the charge belongs to. Required on POST; used as the SubPageLink target from the Group Reservations API ($expand=groupCharges).

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the group reservation the charge is attached to. Allowed values: -1 — the charge sits on the group header (not bound to any group line); a positive integer — the charge sits on the Group Reservation Line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Group Reservations -> -1, Group Reservation Lines -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-group sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line.

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

groupMember
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the optional Group Member sequence the charge is attributed to. Zero means the charge is borne by the group rather than a specific member.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled).

priceHandling
null or string

Specifies how the price is determined. Allowed values: Standard, Fixed, Manual. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity.

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected.

selected
null or boolean

Specifies whether an optional charge is currently selected for posting.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Get groupCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "activityGroup" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "totalAmount" "unitOfMeasureCode" "allowance" "allowanceAmountType" "groupMember" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Update the navigation property groupCharges in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group charge line. Read-only.

activityGroup
null or string <= 20 characters

Specifies the parent Group Reservation the charge belongs to. Required on POST; used as the SubPageLink target from the Group Reservations API ($expand=groupCharges).

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the group reservation the charge is attached to. Allowed values: -1 — the charge sits on the group header (not bound to any group line); a positive integer — the charge sits on the Group Reservation Line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Group Reservations -> -1, Group Reservation Lines -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-group sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line.

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

groupMember
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the optional Group Member sequence the charge is attributed to. Zero means the charge is borne by the group rather than a specific member.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled).

priceHandling
null or string

Specifies how the price is determined. Allowed values: Standard, Fixed, Manual. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity.

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected.

selected
null or boolean

Specifies whether an optional charge is currently selected for posting.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get groupCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "activityGroup" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "totalAmount" "unitOfMeasureCode" "allowance" "allowanceAmountType" "groupMember" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group charge line. Read-only.

activityGroup
null or string <= 20 characters

Specifies the parent Group Reservation the charge belongs to. Required on POST; used as the SubPageLink target from the Group Reservations API ($expand=groupCharges).

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the group reservation the charge is attached to. Allowed values: -1 — the charge sits on the group header (not bound to any group line); a positive integer — the charge sits on the Group Reservation Line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Group Reservations -> -1, Group Reservation Lines -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-group sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line.

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

groupMember
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the optional Group Member sequence the charge is attributed to. Zero means the charge is borne by the group rather than a specific member.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled).

priceHandling
null or string

Specifies how the price is determined. Allowed values: Standard, Fixed, Manual. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity.

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected.

selected
null or boolean

Specifies whether an optional charge is currently selected for posting.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Get groupCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "activityGroup" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "totalAmount" "unitOfMeasureCode" "allowance" "allowanceAmountType" "groupMember" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Update the navigation property groupCharges in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group charge line. Read-only.

activityGroup
null or string <= 20 characters

Specifies the parent Group Reservation the charge belongs to. Required on POST; used as the SubPageLink target from the Group Reservations API ($expand=groupCharges).

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the group reservation the charge is attached to. Allowed values: -1 — the charge sits on the group header (not bound to any group line); a positive integer — the charge sits on the Group Reservation Line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Group Reservations -> -1, Group Reservation Lines -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-group sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line.

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

groupMember
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the optional Group Member sequence the charge is attributed to. Zero means the charge is borne by the group rather than a specific member.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled).

priceHandling
null or string

Specifies how the price is determined. Allowed values: Standard, Fixed, Manual. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity.

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected.

selected
null or boolean

Specifies whether an optional charge is currently selected for posting.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get groupCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "activityGroup" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "totalAmount" "unitOfMeasureCode" "allowance" "allowanceAmountType" "groupMember" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group charge line. Read-only.

activityGroup
null or string <= 20 characters

Specifies the parent Group Reservation the charge belongs to. Required on POST; used as the SubPageLink target from the Group Reservations API ($expand=groupCharges).

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the group reservation the charge is attached to. Allowed values: -1 — the charge sits on the group header (not bound to any group line); a positive integer — the charge sits on the Group Reservation Line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Group Reservations -> -1, Group Reservation Lines -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-group sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line.

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

groupMember
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the optional Group Member sequence the charge is attributed to. Zero means the charge is borne by the group rather than a specific member.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled).

priceHandling
null or string

Specifies how the price is determined. Allowed values: Standard, Fixed, Manual. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity.

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected.

selected
null or boolean

Specifies whether an optional charge is currently selected for posting.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Get groupCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "activityGroup" "reservationLineNo" "sequenceNo" "productType" "productNo" "description" "quantity" "price" "discountPercentage" "totalAmount" "unitOfMeasureCode" "allowance" "allowanceAmountType" "groupMember" "status" "priceHandling" "fixedPrice" "baseQuantity" "optionalItem" "selected" "quantityMultiplier"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Update the navigation property groupCharges in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group charge line. Read-only.

activityGroup
null or string <= 20 characters

Specifies the parent Group Reservation the charge belongs to. Required on POST; used as the SubPageLink target from the Group Reservations API ($expand=groupCharges).

reservationLineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies which level of the group reservation the charge is attached to. Allowed values: -1 — the charge sits on the group header (not bound to any group line); a positive integer — the charge sits on the Group Reservation Line whose Line No. equals this value. Required on POST; the value 0 (or omitting the field) is rejected. When the entity is reached through $expand from a parent page this field is implicitly filtered by the SubPageLink (Group Reservations -> -1, Group Reservation Lines -> the parent line''s Line No.).

sequenceNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-group sequence of the charge entry. System-assigned: leave it unset on POST and the next free sequence for the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

(lscactAddtlItemProdType (null or string))

Specifies the kind of charged product. Allowed values: Item, Deal, Amount — drives downstream posting logic and the resolution of Product No.

productNo
null or string <= 20 characters

Specifies the product number on the charge line.

description
null or string <= 100 characters

Specifies the display description of the charge. Defaulted from the product master.

quantity
null or number <decimal>

Specifies the quantity charged. For Amount-type charges this is system-controlled (fixed at 1) and any value sent is ignored.

price
null or number <decimal>

Specifies the unit price of the charge. For Amount-type charges the value you supply is retained as the fixed unit price even when Allowance Amount Type or Product No. are sent in the same request.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied. Allowed range: 0 - 100. Not applicable to Amount-type charges, where it is system-controlled (forced to 0) and any value sent is ignored.

totalAmount
null or number <decimal>

Specifies the net amount of the charge (Quantity * Price, less discount). Read-only.

unitOfMeasureCode
null or string <= 10 characters

Specifies the unit-of-measure code for the quantity. Not applicable to Amount-type charges, where it is system-controlled (cleared) and any value sent is ignored.

allowance
null or boolean

Specifies whether the charge is paid by redeeming an issued allowance. For Amount-type charges this is always true — the API forces it and ignores a false value sent on the request.

(lscactAllowanceAmountType (null or string))

Specifies, for an Amount-type allowance charge, which master table the Product No. resolves against. Allowed values: None, Item Category, Special Group, Product Group.

groupMember
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the optional Group Member sequence the charge is attributed to. Zero means the charge is borne by the group rather than a specific member.

status
null or string

Specifies the lifecycle state of the charge line (e.g., Pending, Posted, Cancelled).

priceHandling
null or string

Specifies how the price is determined. Allowed values: Standard, Fixed, Manual. For Amount-type charges this is always Use Fixed Price and cannot be changed.

fixedPrice
null or number <decimal>

Specifies the override price used when Price Handling is Fixed.

baseQuantity
null or number <decimal>

Specifies the quantity scale factor used together with Quantity Multiplier to derive Quantity.

optionalItem
null or string

Specifies whether the charge is optional (true) and may be deselected.

selected
null or boolean

Specifies whether an optional charge is currently selected for posting.

quantityMultiplier
null or string

Specifies the factor applied to a parent quantity (e.g., No. of Persons) to derive Quantity. Not applicable to Amount-type charges, where it is system-controlled (forced to None) and any value sent is ignored.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityGroup": null,
  • "reservationLineNo": null,
  • "sequenceNo": null,
  • "productType": "Item",
  • "productNo": null,
  • "description": null,
  • "quantity": null,
  • "price": null,
  • "discountPercentage": null,
  • "totalAmount": null,
  • "unitOfMeasureCode": null,
  • "allowance": null,
  • "allowanceAmountType": "None",
  • "groupMember": null,
  • "status": null,
  • "priceHandling": null,
  • "fixedPrice": null,
  • "baseQuantity": null,
  • "optionalItem": null,
  • "selected": null,
  • "quantityMultiplier": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupCharges for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupCharge

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Group Reservation Line

A Group Reservation Line is a single bookable line on a parent Group Reservation — typically one activity slot (e.g., 30 ski-school passes at 09:00, a banquet dinner at 19:00). Use this API to list group lines (filter by groupNo, activityType, reservationDate, etc.) and to drive the line-level lifecycle via bound actions confirmActivity (set the line status to Confirmed and create the underlying activity reservations), assign (link a group member to a slot), and remove (release a member from a slot). Replaces the legacy SOAP procedures AssignGroupMember, RemoveGroupMember, and DeleteGroupActivity in codeunit 10015848 "LSC Activity WS". Available expands: $expand=groupCharges (additional charges scoped to this line — same Group Charges endpoint as on the parent, here filtered to Reservation Line No. = this line''s Line No.), $expand=groupReservationMembers (the members assigned to this specific line — same Group Reservation Members endpoint as on the parent, here filtered to Group Line = this line''s Line No.; header-level members with Group Line = 0 are not returned, fetch them via the parent Group Reservations API). HTTP DELETE on the entity is the modern replacement for the SOAP DeleteGroupActivity call. This release exposes the page as writable (POST / PATCH / DELETE); fields driven by the product or by lifecycle actions (Line No., Activity Type, Amount, Payment Status) stay read-only, and Group No. is read-only once the line exists - a line cannot be moved to another group reservation. Structural fields can only be changed while the parent group is Draft or Waiting List; Comment and Description stay editable in any status. DELETE is only allowed while the parent group is Draft or Waiting List; it removes the line and its dependents (activity reservations, group members, comments and additional charges), blocks a fully-paid line, and requires the row''s @odata.etag via the If-Match header.

Get groupReservationLines from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "groupNo" "lineNo" "type" "productNo" "description" "activityType" "reservationDate" "reservationTime" "activityQuantity" "quantity" "unitPrice" "discountPercentage" "amount" "chargeType" "guestType" "allowanceNo" "promoCode" "location" "comment" "paymentStatus" "sharedActivity" "endTime"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "activityProduct" "groupCharges" "groupReservationMembers"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupReservationLines for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group line. Use this value as the entity key when calling bound actions (confirmActivity, assign, remove). Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the line belongs to. Read-only; set when the line is created and used as the SubPageLink target from the Group Reservations API ($expand=groupReservationLines). A line cannot be moved to another group reservation.

lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the line sequence within the parent group reservation. Read-only; system-assigned in 10000 increments.

type
null or string

Specifies the kind of product on the line. Allowed values: Activity Product — a bookable activity slot; Retail Item — a retail item charge.

productNo
null or string <= 20 characters

Specifies the product number on the line. Resolves to a LSC Activity Product, BC Item, or similar based on Type.

description
null or string <= 100 characters

Specifies the display description of the group line. Defaulted from the product and editable.

activityType
null or string <= 20 characters

Specifies the Activity Type for the line. Read-only; defaulted from the product.

reservationDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the scheduled date of the group activity (ISO 8601 date). Must fall within the parent Group Reservation window.

reservationTime
null or string

Specifies the scheduled start time of the group activity.

activityQuantity
null or number <decimal>

Specifies the number of activity slots booked on this line (e.g., 30 ski passes). Drives resource allocation.

quantity
null or number <decimal>

Specifies the priced quantity for the line. Often equal to Activity Quantity, but may differ when one slot covers multiple participants.

unitPrice
null or number <decimal>

Specifies the unit price applied to the line. Defaulted from the product / price group; may be overridden when Allow Price Change is enabled.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied to the line. Allowed range: 0 - 100.

amount
null or number <decimal>

Specifies the calculated net amount for the line (Unit Price * Quantity, less discount). Read-only.

chargeType
null or string

Specifies who is charged for this line. Allowed values: Group — posts to the group customer; Individual — posts to the assigned member.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child) used for differential pricing on the line.

allowanceNo
null or string <= 20 characters

Specifies the Issued Allowance redeemed against this line. Set when the line is paid using a member allowance.

promoCode
null or string <= 20 characters

Specifies the promotion code applied to the line. Affects price resolution.

location
null or string <= 20 characters

Specifies the Activity Location where the activity takes place. Defaults from the parent group reservation.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the line. Shown on the activity matrix and printed confirmations.

paymentStatus
null or string

Specifies the payment state of the line. Allowed values: No Payment, Partially Paid, Fully Paid. Calculated; read-only.

sharedActivity
null or boolean

Specifies whether several group members share a single Activity Reservation (true) or each member gets a dedicated reservation (false). Drives how confirmActivity expands into individual Activity Reservations.

endTime
null or string

Specifies the scheduled end time of the group activity. Optional; defaults from the product duration.

(activityProduct (null or object))
Array of objects (groupCharge)
Array of objects (groupReservationMember)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "lineNo": null,
  • "type": null,
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "reservationDate": null,
  • "reservationTime": null,
  • "activityQuantity": null,
  • "quantity": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "chargeType": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "location": null,
  • "comment": null,
  • "paymentStatus": null,
  • "sharedActivity": null,
  • "endTime": null,
  • "activityProduct": {
    },
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "lineNo": null,
  • "type": null,
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "reservationDate": null,
  • "reservationTime": null,
  • "activityQuantity": null,
  • "quantity": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "chargeType": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "location": null,
  • "comment": null,
  • "paymentStatus": null,
  • "sharedActivity": null,
  • "endTime": null,
  • "activityProduct": {
    },
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ]
}

Get groupReservationLines from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

query Parameters
$select
Array of strings unique
Items Enum: "id" "groupNo" "lineNo" "type" "productNo" "description" "activityType" "reservationDate" "reservationTime" "activityQuantity" "quantity" "unitPrice" "discountPercentage" "amount" "chargeType" "guestType" "allowanceNo" "promoCode" "location" "comment" "paymentStatus" "sharedActivity" "endTime"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "activityProduct" "groupCharges" "groupReservationMembers"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "lineNo": null,
  • "type": null,
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "reservationDate": null,
  • "reservationTime": null,
  • "activityQuantity": null,
  • "quantity": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "chargeType": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "location": null,
  • "comment": null,
  • "paymentStatus": null,
  • "sharedActivity": null,
  • "endTime": null,
  • "activityProduct": {
    },
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ]
}

Update the navigation property groupReservationLines in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group line. Use this value as the entity key when calling bound actions (confirmActivity, assign, remove). Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the line belongs to. Read-only; set when the line is created and used as the SubPageLink target from the Group Reservations API ($expand=groupReservationLines). A line cannot be moved to another group reservation.

lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the line sequence within the parent group reservation. Read-only; system-assigned in 10000 increments.

type
null or string

Specifies the kind of product on the line. Allowed values: Activity Product — a bookable activity slot; Retail Item — a retail item charge.

productNo
null or string <= 20 characters

Specifies the product number on the line. Resolves to a LSC Activity Product, BC Item, or similar based on Type.

description
null or string <= 100 characters

Specifies the display description of the group line. Defaulted from the product and editable.

activityType
null or string <= 20 characters

Specifies the Activity Type for the line. Read-only; defaulted from the product.

reservationDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the scheduled date of the group activity (ISO 8601 date). Must fall within the parent Group Reservation window.

reservationTime
null or string

Specifies the scheduled start time of the group activity.

activityQuantity
null or number <decimal>

Specifies the number of activity slots booked on this line (e.g., 30 ski passes). Drives resource allocation.

quantity
null or number <decimal>

Specifies the priced quantity for the line. Often equal to Activity Quantity, but may differ when one slot covers multiple participants.

unitPrice
null or number <decimal>

Specifies the unit price applied to the line. Defaulted from the product / price group; may be overridden when Allow Price Change is enabled.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied to the line. Allowed range: 0 - 100.

amount
null or number <decimal>

Specifies the calculated net amount for the line (Unit Price * Quantity, less discount). Read-only.

chargeType
null or string

Specifies who is charged for this line. Allowed values: Group — posts to the group customer; Individual — posts to the assigned member.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child) used for differential pricing on the line.

allowanceNo
null or string <= 20 characters

Specifies the Issued Allowance redeemed against this line. Set when the line is paid using a member allowance.

promoCode
null or string <= 20 characters

Specifies the promotion code applied to the line. Affects price resolution.

location
null or string <= 20 characters

Specifies the Activity Location where the activity takes place. Defaults from the parent group reservation.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the line. Shown on the activity matrix and printed confirmations.

paymentStatus
null or string

Specifies the payment state of the line. Allowed values: No Payment, Partially Paid, Fully Paid. Calculated; read-only.

sharedActivity
null or boolean

Specifies whether several group members share a single Activity Reservation (true) or each member gets a dedicated reservation (false). Drives how confirmActivity expands into individual Activity Reservations.

endTime
null or string

Specifies the scheduled end time of the group activity. Optional; defaults from the product duration.

(activityProduct (null or object))
Array of objects (groupCharge)
Array of objects (groupReservationMember)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "lineNo": null,
  • "type": null,
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "reservationDate": null,
  • "reservationTime": null,
  • "activityQuantity": null,
  • "quantity": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "chargeType": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "location": null,
  • "comment": null,
  • "paymentStatus": null,
  • "sharedActivity": null,
  • "endTime": null,
  • "activityProduct": {
    },
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupReservationLines for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action assign

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

memberSequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "memberSequence": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action confirmActivity

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Responses

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action remove

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

memberSequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "memberSequence": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get groupReservationLines from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "groupNo" "lineNo" "type" "productNo" "description" "activityType" "reservationDate" "reservationTime" "activityQuantity" "quantity" "unitPrice" "discountPercentage" "amount" "chargeType" "guestType" "allowanceNo" "promoCode" "location" "comment" "paymentStatus" "sharedActivity" "endTime"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "activityProduct" "groupCharges" "groupReservationMembers"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupReservationLines for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group line. Use this value as the entity key when calling bound actions (confirmActivity, assign, remove). Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the line belongs to. Read-only; set when the line is created and used as the SubPageLink target from the Group Reservations API ($expand=groupReservationLines). A line cannot be moved to another group reservation.

lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the line sequence within the parent group reservation. Read-only; system-assigned in 10000 increments.

type
null or string

Specifies the kind of product on the line. Allowed values: Activity Product — a bookable activity slot; Retail Item — a retail item charge.

productNo
null or string <= 20 characters

Specifies the product number on the line. Resolves to a LSC Activity Product, BC Item, or similar based on Type.

description
null or string <= 100 characters

Specifies the display description of the group line. Defaulted from the product and editable.

activityType
null or string <= 20 characters

Specifies the Activity Type for the line. Read-only; defaulted from the product.

reservationDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the scheduled date of the group activity (ISO 8601 date). Must fall within the parent Group Reservation window.

reservationTime
null or string

Specifies the scheduled start time of the group activity.

activityQuantity
null or number <decimal>

Specifies the number of activity slots booked on this line (e.g., 30 ski passes). Drives resource allocation.

quantity
null or number <decimal>

Specifies the priced quantity for the line. Often equal to Activity Quantity, but may differ when one slot covers multiple participants.

unitPrice
null or number <decimal>

Specifies the unit price applied to the line. Defaulted from the product / price group; may be overridden when Allow Price Change is enabled.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied to the line. Allowed range: 0 - 100.

amount
null or number <decimal>

Specifies the calculated net amount for the line (Unit Price * Quantity, less discount). Read-only.

chargeType
null or string

Specifies who is charged for this line. Allowed values: Group — posts to the group customer; Individual — posts to the assigned member.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child) used for differential pricing on the line.

allowanceNo
null or string <= 20 characters

Specifies the Issued Allowance redeemed against this line. Set when the line is paid using a member allowance.

promoCode
null or string <= 20 characters

Specifies the promotion code applied to the line. Affects price resolution.

location
null or string <= 20 characters

Specifies the Activity Location where the activity takes place. Defaults from the parent group reservation.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the line. Shown on the activity matrix and printed confirmations.

paymentStatus
null or string

Specifies the payment state of the line. Allowed values: No Payment, Partially Paid, Fully Paid. Calculated; read-only.

sharedActivity
null or boolean

Specifies whether several group members share a single Activity Reservation (true) or each member gets a dedicated reservation (false). Drives how confirmActivity expands into individual Activity Reservations.

endTime
null or string

Specifies the scheduled end time of the group activity. Optional; defaults from the product duration.

(activityProduct (null or object))
Array of objects (groupCharge)
Array of objects (groupReservationMember)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "lineNo": null,
  • "type": null,
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "reservationDate": null,
  • "reservationTime": null,
  • "activityQuantity": null,
  • "quantity": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "chargeType": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "location": null,
  • "comment": null,
  • "paymentStatus": null,
  • "sharedActivity": null,
  • "endTime": null,
  • "activityProduct": {
    },
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "lineNo": null,
  • "type": null,
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "reservationDate": null,
  • "reservationTime": null,
  • "activityQuantity": null,
  • "quantity": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "chargeType": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "location": null,
  • "comment": null,
  • "paymentStatus": null,
  • "sharedActivity": null,
  • "endTime": null,
  • "activityProduct": {
    },
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ]
}

Get groupReservationLines from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

query Parameters
$select
Array of strings unique
Items Enum: "id" "groupNo" "lineNo" "type" "productNo" "description" "activityType" "reservationDate" "reservationTime" "activityQuantity" "quantity" "unitPrice" "discountPercentage" "amount" "chargeType" "guestType" "allowanceNo" "promoCode" "location" "comment" "paymentStatus" "sharedActivity" "endTime"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "activityProduct" "groupCharges" "groupReservationMembers"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "lineNo": null,
  • "type": null,
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "reservationDate": null,
  • "reservationTime": null,
  • "activityQuantity": null,
  • "quantity": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "chargeType": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "location": null,
  • "comment": null,
  • "paymentStatus": null,
  • "sharedActivity": null,
  • "endTime": null,
  • "activityProduct": {
    },
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ]
}

Update the navigation property groupReservationLines in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group line. Use this value as the entity key when calling bound actions (confirmActivity, assign, remove). Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the line belongs to. Read-only; set when the line is created and used as the SubPageLink target from the Group Reservations API ($expand=groupReservationLines). A line cannot be moved to another group reservation.

lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the line sequence within the parent group reservation. Read-only; system-assigned in 10000 increments.

type
null or string

Specifies the kind of product on the line. Allowed values: Activity Product — a bookable activity slot; Retail Item — a retail item charge.

productNo
null or string <= 20 characters

Specifies the product number on the line. Resolves to a LSC Activity Product, BC Item, or similar based on Type.

description
null or string <= 100 characters

Specifies the display description of the group line. Defaulted from the product and editable.

activityType
null or string <= 20 characters

Specifies the Activity Type for the line. Read-only; defaulted from the product.

reservationDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the scheduled date of the group activity (ISO 8601 date). Must fall within the parent Group Reservation window.

reservationTime
null or string

Specifies the scheduled start time of the group activity.

activityQuantity
null or number <decimal>

Specifies the number of activity slots booked on this line (e.g., 30 ski passes). Drives resource allocation.

quantity
null or number <decimal>

Specifies the priced quantity for the line. Often equal to Activity Quantity, but may differ when one slot covers multiple participants.

unitPrice
null or number <decimal>

Specifies the unit price applied to the line. Defaulted from the product / price group; may be overridden when Allow Price Change is enabled.

discountPercentage
null or number <decimal>

Specifies the percentage discount applied to the line. Allowed range: 0 - 100.

amount
null or number <decimal>

Specifies the calculated net amount for the line (Unit Price * Quantity, less discount). Read-only.

chargeType
null or string

Specifies who is charged for this line. Allowed values: Group — posts to the group customer; Individual — posts to the assigned member.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child) used for differential pricing on the line.

allowanceNo
null or string <= 20 characters

Specifies the Issued Allowance redeemed against this line. Set when the line is paid using a member allowance.

promoCode
null or string <= 20 characters

Specifies the promotion code applied to the line. Affects price resolution.

location
null or string <= 20 characters

Specifies the Activity Location where the activity takes place. Defaults from the parent group reservation.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the line. Shown on the activity matrix and printed confirmations.

paymentStatus
null or string

Specifies the payment state of the line. Allowed values: No Payment, Partially Paid, Fully Paid. Calculated; read-only.

sharedActivity
null or boolean

Specifies whether several group members share a single Activity Reservation (true) or each member gets a dedicated reservation (false). Drives how confirmActivity expands into individual Activity Reservations.

endTime
null or string

Specifies the scheduled end time of the group activity. Optional; defaults from the product duration.

(activityProduct (null or object))
Array of objects (groupCharge)
Array of objects (groupReservationMember)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "lineNo": null,
  • "type": null,
  • "productNo": null,
  • "description": null,
  • "activityType": null,
  • "reservationDate": null,
  • "reservationTime": null,
  • "activityQuantity": null,
  • "quantity": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "chargeType": null,
  • "guestType": null,
  • "allowanceNo": null,
  • "promoCode": null,
  • "location": null,
  • "comment": null,
  • "paymentStatus": null,
  • "sharedActivity": null,
  • "endTime": null,
  • "activityProduct": {
    },
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupReservationLines for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action assign

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

memberSequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "memberSequence": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action confirmActivity

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Responses

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action remove

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json

Action parameters

memberSequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "memberSequence": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Group Reservation Member

A Group Reservation Member is a single participant attached to a Group Reservation (or a specific Group Line via the Group Line field). Use this API to list, create (POST), update (PATCH), or delete (DELETE) the people that make up a group — tour participants, banquet guests, school-trip attendees — and to mark one of them as the main contact. This page is writable and replaces the legacy SOAP procedure SetGroupMembers in codeunit 10015848 "LSC Activity WS". Together with the assign / remove bound actions on Group Reservation Lines it covers the full member-to-slot allocation lifecycle. The number of members is capped to mirror the activity group pages: a POST is rejected once the group already has its No. of Persons members (group-level) or the group line is full (Quantity x No. of Persons).

Get groupReservationMembers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "groupNo" "groupLine" "sequence" "contact" "name" "email" "phone" "memberAccountNo" "guestType" "comment"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupReservationMembers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group member record. Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the member belongs to. Used as the SubPageLink target when reached via $expand from a Group Reservation Line.

groupLine
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the Group Reservation Line the member is bound to. Zero means the member is attached to the group as a whole rather than to a specific line. A non-zero value must reference an existing group line; a non-existent line is rejected.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-(group, line) ordinal of the member used by the assign / remove bound actions on Group Reservation Lines (memberSequence parameter). System-assigned: leave it unset on POST and the next free sequence within the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

contact
null or string <= 20 characters

Specifies the Contact No. of the member when they are a known client in the standard BC Contact table. Optional; leave blank for walk-in or anonymous participants.

name
null or string <= 100 characters

Specifies the display name of the group member. Free text; required when no Contact is supplied.

email
null or string <= 200 characters

Specifies the email address used to send confirmations and reminders to the member.

phone
null or string <= 50 characters

Specifies the phone number of the member. Free text; format not validated by the API.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account linked to the group member. Optional; enables member-level pricing and allowance tracking for the participant.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing on activities assigned to this member.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the member (e.g., dietary requirements, accessibility notes). On POST/PATCH the comment is also written to the member''s comment list so it surfaces on the Activity Group Member page.

(memberDetail (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Get groupReservationMembers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

query Parameters
$select
Array of strings unique
Items Enum: "id" "groupNo" "groupLine" "sequence" "contact" "name" "email" "phone" "memberAccountNo" "guestType" "comment"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Update the navigation property groupReservationMembers in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group member record. Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the member belongs to. Used as the SubPageLink target when reached via $expand from a Group Reservation Line.

groupLine
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the Group Reservation Line the member is bound to. Zero means the member is attached to the group as a whole rather than to a specific line. A non-zero value must reference an existing group line; a non-existent line is rejected.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-(group, line) ordinal of the member used by the assign / remove bound actions on Group Reservation Lines (memberSequence parameter). System-assigned: leave it unset on POST and the next free sequence within the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

contact
null or string <= 20 characters

Specifies the Contact No. of the member when they are a known client in the standard BC Contact table. Optional; leave blank for walk-in or anonymous participants.

name
null or string <= 100 characters

Specifies the display name of the group member. Free text; required when no Contact is supplied.

email
null or string <= 200 characters

Specifies the email address used to send confirmations and reminders to the member.

phone
null or string <= 50 characters

Specifies the phone number of the member. Free text; format not validated by the API.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account linked to the group member. Optional; enables member-level pricing and allowance tracking for the participant.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing on activities assigned to this member.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the member (e.g., dietary requirements, accessibility notes). On POST/PATCH the comment is also written to the member''s comment list so it surfaces on the Activity Group Member page.

(memberDetail (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupReservationMembers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get groupReservationMembers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "groupNo" "groupLine" "sequence" "contact" "name" "email" "phone" "memberAccountNo" "guestType" "comment"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupReservationMembers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group member record. Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the member belongs to. Used as the SubPageLink target when reached via $expand from a Group Reservation Line.

groupLine
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the Group Reservation Line the member is bound to. Zero means the member is attached to the group as a whole rather than to a specific line. A non-zero value must reference an existing group line; a non-existent line is rejected.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-(group, line) ordinal of the member used by the assign / remove bound actions on Group Reservation Lines (memberSequence parameter). System-assigned: leave it unset on POST and the next free sequence within the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

contact
null or string <= 20 characters

Specifies the Contact No. of the member when they are a known client in the standard BC Contact table. Optional; leave blank for walk-in or anonymous participants.

name
null or string <= 100 characters

Specifies the display name of the group member. Free text; required when no Contact is supplied.

email
null or string <= 200 characters

Specifies the email address used to send confirmations and reminders to the member.

phone
null or string <= 50 characters

Specifies the phone number of the member. Free text; format not validated by the API.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account linked to the group member. Optional; enables member-level pricing and allowance tracking for the participant.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing on activities assigned to this member.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the member (e.g., dietary requirements, accessibility notes). On POST/PATCH the comment is also written to the member''s comment list so it surfaces on the Activity Group Member page.

(memberDetail (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Get groupReservationMembers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

query Parameters
$select
Array of strings unique
Items Enum: "id" "groupNo" "groupLine" "sequence" "contact" "name" "email" "phone" "memberAccountNo" "guestType" "comment"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Update the navigation property groupReservationMembers in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group member record. Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the member belongs to. Used as the SubPageLink target when reached via $expand from a Group Reservation Line.

groupLine
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the Group Reservation Line the member is bound to. Zero means the member is attached to the group as a whole rather than to a specific line. A non-zero value must reference an existing group line; a non-existent line is rejected.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-(group, line) ordinal of the member used by the assign / remove bound actions on Group Reservation Lines (memberSequence parameter). System-assigned: leave it unset on POST and the next free sequence within the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

contact
null or string <= 20 characters

Specifies the Contact No. of the member when they are a known client in the standard BC Contact table. Optional; leave blank for walk-in or anonymous participants.

name
null or string <= 100 characters

Specifies the display name of the group member. Free text; required when no Contact is supplied.

email
null or string <= 200 characters

Specifies the email address used to send confirmations and reminders to the member.

phone
null or string <= 50 characters

Specifies the phone number of the member. Free text; format not validated by the API.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account linked to the group member. Optional; enables member-level pricing and allowance tracking for the participant.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing on activities assigned to this member.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the member (e.g., dietary requirements, accessibility notes). On POST/PATCH the comment is also written to the member''s comment list so it surfaces on the Activity Group Member page.

(memberDetail (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupReservationMembers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get groupReservationMembers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "groupNo" "groupLine" "sequence" "contact" "name" "email" "phone" "memberAccountNo" "guestType" "comment"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupReservationMembers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group member record. Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the member belongs to. Used as the SubPageLink target when reached via $expand from a Group Reservation Line.

groupLine
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the Group Reservation Line the member is bound to. Zero means the member is attached to the group as a whole rather than to a specific line. A non-zero value must reference an existing group line; a non-existent line is rejected.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-(group, line) ordinal of the member used by the assign / remove bound actions on Group Reservation Lines (memberSequence parameter). System-assigned: leave it unset on POST and the next free sequence within the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

contact
null or string <= 20 characters

Specifies the Contact No. of the member when they are a known client in the standard BC Contact table. Optional; leave blank for walk-in or anonymous participants.

name
null or string <= 100 characters

Specifies the display name of the group member. Free text; required when no Contact is supplied.

email
null or string <= 200 characters

Specifies the email address used to send confirmations and reminders to the member.

phone
null or string <= 50 characters

Specifies the phone number of the member. Free text; format not validated by the API.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account linked to the group member. Optional; enables member-level pricing and allowance tracking for the participant.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing on activities assigned to this member.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the member (e.g., dietary requirements, accessibility notes). On POST/PATCH the comment is also written to the member''s comment list so it surfaces on the Activity Group Member page.

(memberDetail (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Get groupReservationMembers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

query Parameters
$select
Array of strings unique
Items Enum: "id" "groupNo" "groupLine" "sequence" "contact" "name" "email" "phone" "memberAccountNo" "guestType" "comment"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Update the navigation property groupReservationMembers in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group member record. Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the member belongs to. Used as the SubPageLink target when reached via $expand from a Group Reservation Line.

groupLine
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the Group Reservation Line the member is bound to. Zero means the member is attached to the group as a whole rather than to a specific line. A non-zero value must reference an existing group line; a non-existent line is rejected.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-(group, line) ordinal of the member used by the assign / remove bound actions on Group Reservation Lines (memberSequence parameter). System-assigned: leave it unset on POST and the next free sequence within the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

contact
null or string <= 20 characters

Specifies the Contact No. of the member when they are a known client in the standard BC Contact table. Optional; leave blank for walk-in or anonymous participants.

name
null or string <= 100 characters

Specifies the display name of the group member. Free text; required when no Contact is supplied.

email
null or string <= 200 characters

Specifies the email address used to send confirmations and reminders to the member.

phone
null or string <= 50 characters

Specifies the phone number of the member. Free text; format not validated by the API.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account linked to the group member. Optional; enables member-level pricing and allowance tracking for the participant.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing on activities assigned to this member.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the member (e.g., dietary requirements, accessibility notes). On POST/PATCH the comment is also written to the member''s comment list so it surfaces on the Activity Group Member page.

(memberDetail (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupReservationMembers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationLine

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Get groupReservationMembers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "groupNo" "groupLine" "sequence" "contact" "name" "email" "phone" "memberAccountNo" "guestType" "comment"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupReservationMembers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group member record. Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the member belongs to. Used as the SubPageLink target when reached via $expand from a Group Reservation Line.

groupLine
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the Group Reservation Line the member is bound to. Zero means the member is attached to the group as a whole rather than to a specific line. A non-zero value must reference an existing group line; a non-existent line is rejected.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-(group, line) ordinal of the member used by the assign / remove bound actions on Group Reservation Lines (memberSequence parameter). System-assigned: leave it unset on POST and the next free sequence within the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

contact
null or string <= 20 characters

Specifies the Contact No. of the member when they are a known client in the standard BC Contact table. Optional; leave blank for walk-in or anonymous participants.

name
null or string <= 100 characters

Specifies the display name of the group member. Free text; required when no Contact is supplied.

email
null or string <= 200 characters

Specifies the email address used to send confirmations and reminders to the member.

phone
null or string <= 50 characters

Specifies the phone number of the member. Free text; format not validated by the API.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account linked to the group member. Optional; enables member-level pricing and allowance tracking for the participant.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing on activities assigned to this member.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the member (e.g., dietary requirements, accessibility notes). On POST/PATCH the comment is also written to the member''s comment list so it surfaces on the Activity Group Member page.

(memberDetail (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Get groupReservationMembers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

query Parameters
$select
Array of strings unique
Items Enum: "id" "groupNo" "groupLine" "sequence" "contact" "name" "email" "phone" "memberAccountNo" "guestType" "comment"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Update the navigation property groupReservationMembers in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group member record. Read-only.

groupNo
null or string <= 20 characters

Specifies the parent Group Reservation the member belongs to. Used as the SubPageLink target when reached via $expand from a Group Reservation Line.

groupLine
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the Group Reservation Line the member is bound to. Zero means the member is attached to the group as a whole rather than to a specific line. A non-zero value must reference an existing group line; a non-existent line is rejected.

sequence
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the per-(group, line) ordinal of the member used by the assign / remove bound actions on Group Reservation Lines (memberSequence parameter). System-assigned: leave it unset on POST and the next free sequence within the group line is assigned automatically. A value is only used if you supply a non-zero one explicitly.

contact
null or string <= 20 characters

Specifies the Contact No. of the member when they are a known client in the standard BC Contact table. Optional; leave blank for walk-in or anonymous participants.

name
null or string <= 100 characters

Specifies the display name of the group member. Free text; required when no Contact is supplied.

email
null or string <= 200 characters

Specifies the email address used to send confirmations and reminders to the member.

phone
null or string <= 50 characters

Specifies the phone number of the member. Free text; format not validated by the API.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account linked to the group member. Optional; enables member-level pricing and allowance tracking for the participant.

guestType
null or string <= 20 characters

Specifies the Guest Type code (e.g., Adult, Child, Senior) used for differential pricing on activities assigned to this member.

comment
null or string <= 100 characters

Specifies a free-text comment attached to the member (e.g., dietary requirements, accessibility notes). On POST/PATCH the comment is also written to the member''s comment list so it surfaces on the Activity Group Member page.

(memberDetail (null or object))

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupNo": null,
  • "groupLine": null,
  • "sequence": null,
  • "contact": null,
  • "name": null,
  • "email": null,
  • "phone": null,
  • "memberAccountNo": null,
  • "guestType": null,
  • "comment": null,
  • "memberDetail": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete navigation property groupReservationMembers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

groupReservationMember-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservationMember

header Parameters
If-Match
string

ETag

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Group Reservation

A Group Reservation is the header that bundles many activities and members into one bookable unit — used for tour operators, school groups, weddings, and other multi-participant scenarios where pricing, billing, and lifecycle must be managed centrally. Use this API to read group reservation headers, drive the header lifecycle action setStatus, and (via $expand) reach the related child entities. Replaces the legacy SOAP procedures InsertGroupReservationV3, UpdateGroupReservationV3, UpdateGroupHeaderStatus, and the group-level read paths in codeunit 10015848 "LSC Activity WS". Available expands: $expand=groupReservationLines (the bookable activity lines on the group), $expand=groupReservationMembers (the people attached to the group — members live at header level; the optional groupLine field on each member points to a specific line when relevant), and $expand=groupCharges (additional group-header charges only — the SubPageLink scopes Reservation Line No. to -1; the same endpoint serves line-level charges when reached through Group Reservation Lines). This release exposes the page as writable (POST / PATCH); calculated financial flow-fields and system fields (No., Customer Account Name, Discount Group, Created, Created By) plus the lifecycle status fields (Status, Internal Status, Payment Status) stay read-only - use the setStatus action to transition status. Structural fields can only be changed while the group is Draft or Waiting List; once confirmed a small whitelist (E-Mail, Mobile Phone No., Reference, Description, Sales Person) stays editable. Header deletion is not allowed.

Get groupReservations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "no" "reservationType" "description" "groupReservationFrom" "groupReservationTo" "location" "status" "internalStatus" "paymentStatus" "currencyCode" "eventNo" "mainGroupMember" "noOfPersons" "customerAccountNo" "customerAccountName" "memberAccountNo" "email" "mobilePhoneNo" "contactNo" "salesPerson" "reference" "priceGroup" "discountGroup" "reservationChargeLimit" "chargeType" "totalActivityCharges" "activitiesPaid" "totalGroupAmount" "totalIndividualAmount" "totalFees" "totalFeesPaid" "depositsBalance" "quote" "created" "createdBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "groupReservationLines" "groupReservationMembers" "groupCharges"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to groupReservations for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group reservation. Use this value as the entity key when calling bound actions or building $expand links. Read-only.

no
null or string <= 20 characters

Specifies the business identifier of the group reservation, assigned from the group reservation number series. Read-only; used as the foreign key from Group Reservation Lines and Group Reservation Members.

reservationType
null or string <= 20 characters

Specifies the group reservation type that drives default behavior such as number series, allowed activity types, and pricing. The value must match a code in the LSC Reservation Type table.

description
null or string <= 100 characters

Specifies the free-text description of the group reservation, used on customer-facing documents and the activity matrix.

groupReservationFrom
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the start date of the group reservation window (ISO 8601 date). Group lines must fall on or after this date.

groupReservationTo
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the end date of the group reservation window (ISO 8601 date). Group lines must fall on or before this date.

location
null or string <= 20 characters

Specifies the Activity Location code that owns the group reservation. The value must match a code in the LSC Activity Location table; scopes POS posting, currency, and resource availability.

status
null or string <= 20 characters

Specifies the user-visible status code of the group reservation. Read-only on the API; use the setStatus bound action to transition between states defined in the configured workflow.

internalStatus
null or string

Specifies the system-derived internal lifecycle state of the group reservation. Allowed values: Open, Confirmed, Cancelled, Closed. Read-only; driven by the workflow attached to Status.

paymentStatus
null or string

Specifies the aggregate payment state across all activity lines on the group reservation. Allowed values: None, Partial, Fully Paid, Refunded. Calculated; read-only.

currencyCode
null or string <= 10 characters

Specifies the ISO 4217 currency code in which amounts on the group reservation are denominated.

eventNo
null or string <= 20 characters

Specifies the Event the group reservation belongs to. Optional; when set, lines inherit event-level pricing and dimensions.

mainGroupMember
null or string <= 20 characters

Specifies the sequence number of the Group Reservation Member designated as the primary contact / group leader. Resolves into the Group Reservation Members child collection.

noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the head count for the group. Used for capacity planning and price tier resolution.

customerAccountNo
null or string <= 20 characters

Specifies the BC customer (debtor) the group reservation invoices to. Optional; when blank, charges remain on the group balance until settled.

customerAccountName
null or string <= 100 characters

Specifies the display name of the linked Customer. Read-only; auto-calculated from Customer Account No.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account charged on the group reservation. Optional; enables member pricing and allowance redemption.

email
null or string <= 200 characters

Specifies the email address used for group confirmation messages and reminders.

mobilePhoneNo
null or string <= 30 characters

Specifies the mobile phone number used for SMS confirmation and reminders.

contactNo
null or string <= 20 characters

Specifies the primary Contact (group leader) on the group reservation. Must match a Contact No. from the standard BC Contact table.

salesPerson
null or string <= 20 characters

Specifies the Salesperson code attributed to the group reservation. Used for commission reporting.

reference
null or string <= 35 characters

Specifies a free-text external reference (e.g., tour operator booking number). Use this field to correlate the BC group reservation with the origin system.

priceGroup
null or string <= 10 characters

Specifies the Activity Price Group used to resolve unit prices for all lines on the group reservation.

discountGroup
null or string <= 20 characters

Specifies the Activity Discount Group applied to all lines. Read-only; resolved from client and price group.

reservationChargeLimit
null or number <decimal>

Specifies the maximum amount of POS charges that may be posted to the group reservation. Zero means no limit.

chargeType
null or string

Specifies how charges are split between the group and its members. Allowed values: Group — everything posts to the group customer; Individual — each member pays their own line; Mixed — per-line choice.

totalActivityCharges
null or number <decimal>

Specifies the sum of all activity-line amounts on the group reservation. Calculated; read-only.

activitiesPaid
null or number <decimal>

Specifies the total amount already paid against the group activity lines. Calculated; read-only.

totalGroupAmount
null or number <decimal>

Specifies the sum of amounts charged at the group level (Charge Type = Group). Calculated; read-only.

totalIndividualAmount
null or number <decimal>

Specifies the sum of amounts charged at the individual member level. Calculated; read-only.

totalFees
null or number <decimal>

Specifies the sum of cancellation and other fees accrued on the group reservation. Calculated; read-only.

totalFeesPaid
null or number <decimal>

Specifies the portion of Total Fees already paid. Calculated; read-only.

depositsBalance
null or number <decimal>

Specifies the net deposit balance held on the group reservation (deposits minus refunds). Positive means the group has prepaid. Calculated; read-only.

quote
null or string <= 20 characters

Specifies whether the group reservation is a non-binding quote (true) rather than a confirmed booking (false). Quotes do not reserve resource capacity.

created
null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the date the group reservation was created. Read-only; system-set on insert.

createdBy
null or string <= 100 characters

Specifies the user ID that created the group reservation. Read-only; system-set on insert.

(memberDetail (null or object))
Array of objects (groupReservationLine)
Array of objects (groupReservationMember)
Array of objects (groupCharge)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "reservationType": null,
  • "description": null,
  • "groupReservationFrom": null,
  • "groupReservationTo": null,
  • "location": null,
  • "status": null,
  • "internalStatus": null,
  • "paymentStatus": null,
  • "currencyCode": null,
  • "eventNo": null,
  • "mainGroupMember": null,
  • "noOfPersons": null,
  • "customerAccountNo": null,
  • "customerAccountName": null,
  • "memberAccountNo": null,
  • "email": null,
  • "mobilePhoneNo": null,
  • "contactNo": null,
  • "salesPerson": null,
  • "reference": null,
  • "priceGroup": null,
  • "discountGroup": null,
  • "reservationChargeLimit": null,
  • "chargeType": null,
  • "totalActivityCharges": null,
  • "activitiesPaid": null,
  • "totalGroupAmount": null,
  • "totalIndividualAmount": null,
  • "totalFees": null,
  • "totalFeesPaid": null,
  • "depositsBalance": null,
  • "quote": null,
  • "created": null,
  • "createdBy": null,
  • "memberDetail": {
    },
  • "groupReservationLines": [
    ],
  • "groupReservationMembers": [
    ],
  • "groupCharges": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "reservationType": null,
  • "description": null,
  • "groupReservationFrom": null,
  • "groupReservationTo": null,
  • "location": null,
  • "status": null,
  • "internalStatus": null,
  • "paymentStatus": null,
  • "currencyCode": null,
  • "eventNo": null,
  • "mainGroupMember": null,
  • "noOfPersons": null,
  • "customerAccountNo": null,
  • "customerAccountName": null,
  • "memberAccountNo": null,
  • "email": null,
  • "mobilePhoneNo": null,
  • "contactNo": null,
  • "salesPerson": null,
  • "reference": null,
  • "priceGroup": null,
  • "discountGroup": null,
  • "reservationChargeLimit": null,
  • "chargeType": null,
  • "totalActivityCharges": null,
  • "activitiesPaid": null,
  • "totalGroupAmount": null,
  • "totalIndividualAmount": null,
  • "totalFees": null,
  • "totalFeesPaid": null,
  • "depositsBalance": null,
  • "quote": null,
  • "created": null,
  • "createdBy": null,
  • "memberDetail": {
    },
  • "groupReservationLines": [
    ],
  • "groupReservationMembers": [
    ],
  • "groupCharges": [
    ]
}

Get groupReservations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

query Parameters
$select
Array of strings unique
Items Enum: "id" "no" "reservationType" "description" "groupReservationFrom" "groupReservationTo" "location" "status" "internalStatus" "paymentStatus" "currencyCode" "eventNo" "mainGroupMember" "noOfPersons" "customerAccountNo" "customerAccountName" "memberAccountNo" "email" "mobilePhoneNo" "contactNo" "salesPerson" "reference" "priceGroup" "discountGroup" "reservationChargeLimit" "chargeType" "totalActivityCharges" "activitiesPaid" "totalGroupAmount" "totalIndividualAmount" "totalFees" "totalFeesPaid" "depositsBalance" "quote" "created" "createdBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "groupReservationLines" "groupReservationMembers" "groupCharges"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "reservationType": null,
  • "description": null,
  • "groupReservationFrom": null,
  • "groupReservationTo": null,
  • "location": null,
  • "status": null,
  • "internalStatus": null,
  • "paymentStatus": null,
  • "currencyCode": null,
  • "eventNo": null,
  • "mainGroupMember": null,
  • "noOfPersons": null,
  • "customerAccountNo": null,
  • "customerAccountName": null,
  • "memberAccountNo": null,
  • "email": null,
  • "mobilePhoneNo": null,
  • "contactNo": null,
  • "salesPerson": null,
  • "reference": null,
  • "priceGroup": null,
  • "discountGroup": null,
  • "reservationChargeLimit": null,
  • "chargeType": null,
  • "totalActivityCharges": null,
  • "activitiesPaid": null,
  • "totalGroupAmount": null,
  • "totalIndividualAmount": null,
  • "totalFees": null,
  • "totalFeesPaid": null,
  • "depositsBalance": null,
  • "quote": null,
  • "created": null,
  • "createdBy": null,
  • "memberDetail": {
    },
  • "groupReservationLines": [
    ],
  • "groupReservationMembers": [
    ],
  • "groupCharges": [
    ]
}

Update the navigation property groupReservations in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this group reservation. Use this value as the entity key when calling bound actions or building $expand links. Read-only.

no
null or string <= 20 characters

Specifies the business identifier of the group reservation, assigned from the group reservation number series. Read-only; used as the foreign key from Group Reservation Lines and Group Reservation Members.

reservationType
null or string <= 20 characters

Specifies the group reservation type that drives default behavior such as number series, allowed activity types, and pricing. The value must match a code in the LSC Reservation Type table.

description
null or string <= 100 characters

Specifies the free-text description of the group reservation, used on customer-facing documents and the activity matrix.

groupReservationFrom
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the start date of the group reservation window (ISO 8601 date). Group lines must fall on or after this date.

groupReservationTo
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the end date of the group reservation window (ISO 8601 date). Group lines must fall on or before this date.

location
null or string <= 20 characters

Specifies the Activity Location code that owns the group reservation. The value must match a code in the LSC Activity Location table; scopes POS posting, currency, and resource availability.

status
null or string <= 20 characters

Specifies the user-visible status code of the group reservation. Read-only on the API; use the setStatus bound action to transition between states defined in the configured workflow.

internalStatus
null or string

Specifies the system-derived internal lifecycle state of the group reservation. Allowed values: Open, Confirmed, Cancelled, Closed. Read-only; driven by the workflow attached to Status.

paymentStatus
null or string

Specifies the aggregate payment state across all activity lines on the group reservation. Allowed values: None, Partial, Fully Paid, Refunded. Calculated; read-only.

currencyCode
null or string <= 10 characters

Specifies the ISO 4217 currency code in which amounts on the group reservation are denominated.

eventNo
null or string <= 20 characters

Specifies the Event the group reservation belongs to. Optional; when set, lines inherit event-level pricing and dimensions.

mainGroupMember
null or string <= 20 characters

Specifies the sequence number of the Group Reservation Member designated as the primary contact / group leader. Resolves into the Group Reservation Members child collection.

noOfPersons
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the head count for the group. Used for capacity planning and price tier resolution.

customerAccountNo
null or string <= 20 characters

Specifies the BC customer (debtor) the group reservation invoices to. Optional; when blank, charges remain on the group balance until settled.

customerAccountName
null or string <= 100 characters

Specifies the display name of the linked Customer. Read-only; auto-calculated from Customer Account No.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account charged on the group reservation. Optional; enables member pricing and allowance redemption.

email
null or string <= 200 characters

Specifies the email address used for group confirmation messages and reminders.

mobilePhoneNo
null or string <= 30 characters

Specifies the mobile phone number used for SMS confirmation and reminders.

contactNo
null or string <= 20 characters

Specifies the primary Contact (group leader) on the group reservation. Must match a Contact No. from the standard BC Contact table.

salesPerson
null or string <= 20 characters

Specifies the Salesperson code attributed to the group reservation. Used for commission reporting.

reference
null or string <= 35 characters

Specifies a free-text external reference (e.g., tour operator booking number). Use this field to correlate the BC group reservation with the origin system.

priceGroup
null or string <= 10 characters

Specifies the Activity Price Group used to resolve unit prices for all lines on the group reservation.

discountGroup
null or string <= 20 characters

Specifies the Activity Discount Group applied to all lines. Read-only; resolved from client and price group.

reservationChargeLimit
null or number <decimal>

Specifies the maximum amount of POS charges that may be posted to the group reservation. Zero means no limit.

chargeType
null or string

Specifies how charges are split between the group and its members. Allowed values: Group — everything posts to the group customer; Individual — each member pays their own line; Mixed — per-line choice.

totalActivityCharges
null or number <decimal>

Specifies the sum of all activity-line amounts on the group reservation. Calculated; read-only.

activitiesPaid
null or number <decimal>

Specifies the total amount already paid against the group activity lines. Calculated; read-only.

totalGroupAmount
null or number <decimal>

Specifies the sum of amounts charged at the group level (Charge Type = Group). Calculated; read-only.

totalIndividualAmount
null or number <decimal>

Specifies the sum of amounts charged at the individual member level. Calculated; read-only.

totalFees
null or number <decimal>

Specifies the sum of cancellation and other fees accrued on the group reservation. Calculated; read-only.

totalFeesPaid
null or number <decimal>

Specifies the portion of Total Fees already paid. Calculated; read-only.

depositsBalance
null or number <decimal>

Specifies the net deposit balance held on the group reservation (deposits minus refunds). Positive means the group has prepaid. Calculated; read-only.

quote
null or string <= 20 characters

Specifies whether the group reservation is a non-binding quote (true) rather than a confirmed booking (false). Quotes do not reserve resource capacity.

created
null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the date the group reservation was created. Read-only; system-set on insert.

createdBy
null or string <= 100 characters

Specifies the user ID that created the group reservation. Read-only; system-set on insert.

(memberDetail (null or object))
Array of objects (groupReservationLine)
Array of objects (groupReservationMember)
Array of objects (groupCharge)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "reservationType": null,
  • "description": null,
  • "groupReservationFrom": null,
  • "groupReservationTo": null,
  • "location": null,
  • "status": null,
  • "internalStatus": null,
  • "paymentStatus": null,
  • "currencyCode": null,
  • "eventNo": null,
  • "mainGroupMember": null,
  • "noOfPersons": null,
  • "customerAccountNo": null,
  • "customerAccountName": null,
  • "memberAccountNo": null,
  • "email": null,
  • "mobilePhoneNo": null,
  • "contactNo": null,
  • "salesPerson": null,
  • "reference": null,
  • "priceGroup": null,
  • "discountGroup": null,
  • "reservationChargeLimit": null,
  • "chargeType": null,
  • "totalActivityCharges": null,
  • "activitiesPaid": null,
  • "totalGroupAmount": null,
  • "totalIndividualAmount": null,
  • "totalFees": null,
  • "totalFeesPaid": null,
  • "depositsBalance": null,
  • "quote": null,
  • "created": null,
  • "createdBy": null,
  • "memberDetail": {
    },
  • "groupReservationLines": [
    ],
  • "groupReservationMembers": [
    ],
  • "groupCharges": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action setStatus

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

groupReservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of groupReservation

Request Body schema: application/json

Action parameters

newStatus
null or string

Responses

Request samples

Content type
application/json
{
  • "newStatus": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Issued Allowance

An Issued Allowance is a prepaid quota of consumable units (sessions, dollars, F&B credit) granted to a member or client — issued by a transaction, redeemable up to the expiry date. Use this read-only API to enumerate a client''s issued allowances and their consumption status (filter by clientNo, allowanceType, location). Replaces the legacy SOAP procedure UploadPurchasedAllowances in codeunit 10015848 "LSC Activity WS".

Get issuedAllowances from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "allowanceNo" "productNo" "validLocation" "description" "qtyIssued" "dateIssued" "unitPrice" "clientNo" "clientName" "expiryDate" "quantityConsumed" "issuedTotalAmount" "transaction" "transactionType" "allowanceType" "membershipNo" "unitOfMeasure" "transactionLineNo" "status" "referenceNo" "amountConsumed"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "membershipEntry"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get issuedAllowances from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

query Parameters
$select
Array of strings unique
Items Enum: "id" "allowanceNo" "productNo" "validLocation" "description" "qtyIssued" "dateIssued" "unitPrice" "clientNo" "clientName" "expiryDate" "quantityConsumed" "issuedTotalAmount" "transaction" "transactionType" "allowanceType" "membershipNo" "unitOfMeasure" "transactionLineNo" "status" "referenceNo" "amountConsumed"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "membershipEntry"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "allowanceNo": null,
  • "productNo": null,
  • "validLocation": null,
  • "description": null,
  • "qtyIssued": null,
  • "dateIssued": null,
  • "unitPrice": null,
  • "clientNo": null,
  • "clientName": null,
  • "expiryDate": null,
  • "quantityConsumed": null,
  • "issuedTotalAmount": null,
  • "transaction": null,
  • "transactionType": null,
  • "allowanceType": "Pre_x002D_Paid_x0020_Allowance",
  • "membershipNo": null,
  • "unitOfMeasure": null,
  • "transactionLineNo": null,
  • "status": null,
  • "referenceNo": null,
  • "amountConsumed": null,
  • "memberDetail": {
    },
  • "membershipEntry": {
    }
}

Get issuedAllowances from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "allowanceNo" "productNo" "validLocation" "description" "qtyIssued" "dateIssued" "unitPrice" "clientNo" "clientName" "expiryDate" "quantityConsumed" "issuedTotalAmount" "transaction" "transactionType" "allowanceType" "membershipNo" "unitOfMeasure" "transactionLineNo" "status" "referenceNo" "amountConsumed"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "membershipEntry"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get issuedAllowances from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

query Parameters
$select
Array of strings unique
Items Enum: "id" "allowanceNo" "productNo" "validLocation" "description" "qtyIssued" "dateIssued" "unitPrice" "clientNo" "clientName" "expiryDate" "quantityConsumed" "issuedTotalAmount" "transaction" "transactionType" "allowanceType" "membershipNo" "unitOfMeasure" "transactionLineNo" "status" "referenceNo" "amountConsumed"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "membershipEntry"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "allowanceNo": null,
  • "productNo": null,
  • "validLocation": null,
  • "description": null,
  • "qtyIssued": null,
  • "dateIssued": null,
  • "unitPrice": null,
  • "clientNo": null,
  • "clientName": null,
  • "expiryDate": null,
  • "quantityConsumed": null,
  • "issuedTotalAmount": null,
  • "transaction": null,
  • "transactionType": null,
  • "allowanceType": "Pre_x002D_Paid_x0020_Allowance",
  • "membershipNo": null,
  • "unitOfMeasure": null,
  • "transactionLineNo": null,
  • "status": null,
  • "referenceNo": null,
  • "amountConsumed": null,
  • "memberDetail": {
    },
  • "membershipEntry": {
    }
}

Membership Entry

A Membership Entry is the per-member instance of a Membership Product — it holds dates, status, pricing, payment method, and access ID for an active or on-hold membership. The list is filtered to Status = Active or On Hold so cancelled / expired memberships are not returned (use $filter overrides for historical queries). Use the cancel bound action to cancel a membership with a recorded comment. Replaces the legacy SOAP procedures UploadMembershipEntries and CancelMembership in codeunit 10015848 "LSC Activity WS".

Get membershipEntry from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

query Parameters
$select
Array of strings unique
Items Enum: "id" "membershipNo" "memberNo" "memberName" "memberAccountNo" "membershipType" "membershipDescription" "dateIssued" "dateCreated" "dateExpires" "commitmentDate" "status" "statusCode" "statusDate" "onHoldUntil" "unitPrice" "discountPercentage" "amount" "location" "entryType" "accessId" "accessUntil" "noOfVisits" "chargeToCustomer" "chargeToName" "paymentMethodCode" "priceCommitmentExpires" "totalProcessedCharges" "totalProcessedEntries" "transaction" "transactionLine" "transactionType" "salesPersonCode" "waiverCode" "waiverStatus" "customerBalanceLcy"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "membershipNo": "string",
  • "memberNo": null,
  • "memberName": null,
  • "memberAccountNo": null,
  • "membershipType": null,
  • "membershipDescription": null,
  • "dateIssued": null,
  • "dateCreated": null,
  • "dateExpires": null,
  • "commitmentDate": null,
  • "status": null,
  • "statusCode": null,
  • "statusDate": null,
  • "onHoldUntil": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "location": null,
  • "entryType": null,
  • "accessId": null,
  • "accessUntil": null,
  • "noOfVisits": null,
  • "chargeToCustomer": null,
  • "chargeToName": null,
  • "paymentMethodCode": null,
  • "priceCommitmentExpires": null,
  • "totalProcessedCharges": null,
  • "totalProcessedEntries": null,
  • "transaction": null,
  • "transactionLine": null,
  • "transactionType": null,
  • "salesPersonCode": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "customerBalanceLcy": null,
  • "memberDetail": {
    }
}

Invoke action cancel

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

Request Body schema: application/json

Action parameters

comment
null or string

Responses

Request samples

Content type
application/json
{
  • "comment": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get membershipEntries from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "membershipNo" "memberNo" "memberName" "memberAccountNo" "membershipType" "membershipDescription" "dateIssued" "dateCreated" "dateExpires" "commitmentDate" "status" "statusCode" "statusDate" "onHoldUntil" "unitPrice" "discountPercentage" "amount" "location" "entryType" "accessId" "accessUntil" "noOfVisits" "chargeToCustomer" "chargeToName" "paymentMethodCode" "priceCommitmentExpires" "totalProcessedCharges" "totalProcessedEntries" "transaction" "transactionLine" "transactionType" "salesPersonCode" "waiverCode" "waiverStatus" "customerBalanceLcy"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get membershipEntries from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

membershipEntry-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of membershipEntry

query Parameters
$select
Array of strings unique
Items Enum: "id" "membershipNo" "memberNo" "memberName" "memberAccountNo" "membershipType" "membershipDescription" "dateIssued" "dateCreated" "dateExpires" "commitmentDate" "status" "statusCode" "statusDate" "onHoldUntil" "unitPrice" "discountPercentage" "amount" "location" "entryType" "accessId" "accessUntil" "noOfVisits" "chargeToCustomer" "chargeToName" "paymentMethodCode" "priceCommitmentExpires" "totalProcessedCharges" "totalProcessedEntries" "transaction" "transactionLine" "transactionType" "salesPersonCode" "waiverCode" "waiverStatus" "customerBalanceLcy"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "membershipNo": "string",
  • "memberNo": null,
  • "memberName": null,
  • "memberAccountNo": null,
  • "membershipType": null,
  • "membershipDescription": null,
  • "dateIssued": null,
  • "dateCreated": null,
  • "dateExpires": null,
  • "commitmentDate": null,
  • "status": null,
  • "statusCode": null,
  • "statusDate": null,
  • "onHoldUntil": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "location": null,
  • "entryType": null,
  • "accessId": null,
  • "accessUntil": null,
  • "noOfVisits": null,
  • "chargeToCustomer": null,
  • "chargeToName": null,
  • "paymentMethodCode": null,
  • "priceCommitmentExpires": null,
  • "totalProcessedCharges": null,
  • "totalProcessedEntries": null,
  • "transaction": null,
  • "transactionLine": null,
  • "transactionType": null,
  • "salesPersonCode": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "customerBalanceLcy": null,
  • "memberDetail": {
    }
}

Invoke action cancel

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

membershipEntry-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of membershipEntry

Request Body schema: application/json

Action parameters

comment
null or string

Responses

Request samples

Content type
application/json
{
  • "comment": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get membershipEntry from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

query Parameters
$select
Array of strings unique
Items Enum: "id" "membershipNo" "memberNo" "memberName" "memberAccountNo" "membershipType" "membershipDescription" "dateIssued" "dateCreated" "dateExpires" "commitmentDate" "status" "statusCode" "statusDate" "onHoldUntil" "unitPrice" "discountPercentage" "amount" "location" "entryType" "accessId" "accessUntil" "noOfVisits" "chargeToCustomer" "chargeToName" "paymentMethodCode" "priceCommitmentExpires" "totalProcessedCharges" "totalProcessedEntries" "transaction" "transactionLine" "transactionType" "salesPersonCode" "waiverCode" "waiverStatus" "customerBalanceLcy"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "membershipNo": "string",
  • "memberNo": null,
  • "memberName": null,
  • "memberAccountNo": null,
  • "membershipType": null,
  • "membershipDescription": null,
  • "dateIssued": null,
  • "dateCreated": null,
  • "dateExpires": null,
  • "commitmentDate": null,
  • "status": null,
  • "statusCode": null,
  • "statusDate": null,
  • "onHoldUntil": null,
  • "unitPrice": null,
  • "discountPercentage": null,
  • "amount": null,
  • "location": null,
  • "entryType": null,
  • "accessId": null,
  • "accessUntil": null,
  • "noOfVisits": null,
  • "chargeToCustomer": null,
  • "chargeToName": null,
  • "paymentMethodCode": null,
  • "priceCommitmentExpires": null,
  • "totalProcessedCharges": null,
  • "totalProcessedEntries": null,
  • "transaction": null,
  • "transactionLine": null,
  • "transactionType": null,
  • "salesPersonCode": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "customerBalanceLcy": null,
  • "memberDetail": {
    }
}

Get memberDetail from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "clubCode" "name" "name2" "address" "address2" "city" "postCode" "email" "mobile" "phone" "country" "gender" "dateofBirth" "accountBalance" "accountNo" "schemeCode" "mainContact" "searchName" "houseApartmentNo" "homePage"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "clubCode": null,
  • "name": null,
  • "name2": null,
  • "address": null,
  • "address2": null,
  • "city": null,
  • "postCode": null,
  • "email": null,
  • "mobile": null,
  • "phone": null,
  • "country": null,
  • "gender": "_x0020_",
  • "dateofBirth": null,
  • "accountBalance": null,
  • "accountNo": "string",
  • "schemeCode": null,
  • "mainContact": null,
  • "searchName": null,
  • "houseApartmentNo": null,
  • "homePage": null
}

Invoke action insertDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

Request Body schema: application/json

Action parameters

amount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "amount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action cancel

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

issuedAllowance-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of issuedAllowance

Request Body schema: application/json

Action parameters

comment
null or string

Responses

Request samples

Content type
application/json
{
  • "comment": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Membership Product

A Membership Product (Membership Type) is the sellable definition of a membership — its duration, price, access profile, commitment period, and access type. The list is filtered to Status = Active and Selling Options in {All, WEB Only}, so only web-sellable memberships are returned. Use the sell bound action to issue a membership for a given client. Replaces the legacy SOAP procedures UploadMembershipProducts and SellMembershipV2 in codeunit 10015848 "LSC Activity WS".

Get membershipProducts from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "code" "description" "chargeType" "accessType" "status" "expirationCalculation" "commitmentPeriod" "noOfTimes" "retailItem" "price" "minAge" "fixedEndDate" "requiresMemberShip" "sellingOption" "maxAge" "entryType" "subscriptionType" "memberClub" "pricingUpdate" "fixedIssueDate" "priceCommitmentPeriod" "membershipNoSeries" "contractReportNo" "priceMethod" "sellToSameTimes" "paymentMethodCode" "accessProfile"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get membershipProducts from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

membershipProduct-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of membershipProduct

query Parameters
$select
Array of strings unique
Items Enum: "id" "code" "description" "chargeType" "accessType" "status" "expirationCalculation" "commitmentPeriod" "noOfTimes" "retailItem" "price" "minAge" "fixedEndDate" "requiresMemberShip" "sellingOption" "maxAge" "entryType" "subscriptionType" "memberClub" "pricingUpdate" "fixedIssueDate" "priceCommitmentPeriod" "membershipNoSeries" "contractReportNo" "priceMethod" "sellToSameTimes" "paymentMethodCode" "accessProfile"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "description": null,
  • "chargeType": null,
  • "accessType": null,
  • "status": null,
  • "expirationCalculation": null,
  • "commitmentPeriod": null,
  • "noOfTimes": null,
  • "retailItem": null,
  • "price": null,
  • "minAge": null,
  • "fixedEndDate": null,
  • "requiresMemberShip": null,
  • "sellingOption": null,
  • "maxAge": null,
  • "entryType": null,
  • "subscriptionType": null,
  • "memberClub": null,
  • "pricingUpdate": null,
  • "fixedIssueDate": null,
  • "priceCommitmentPeriod": null,
  • "membershipNoSeries": null,
  • "contractReportNo": null,
  • "priceMethod": "Default",
  • "sellToSameTimes": null,
  • "paymentMethodCode": null,
  • "accessProfile": null
}

Invoke action sell

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

membershipProduct-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of membershipProduct

Request Body schema: application/json

Action parameters

clientNo
null or string

Responses

Request samples

Content type
application/json
{
  • "clientNo": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Membership Subscription Charge

A Membership Subscription Charge is one posted line of a recurring membership-billing batch — what was charged, for whom, and for which billing period. The list is filtered to Entry Status = Posted so only billable / billed charges are returned. Read-only. Replaces the legacy SOAP procedure UploadMembershipSubscriptionCharges in codeunit 10015848 "LSC Activity WS".

Get membershipSubscriptionCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "memberNo" "price" "discount" "qty" "amount" "productType" "productNo" "description" "comment" "invoiceNo" "membershipNo" "postingDate" "additionalCharges" "membershipType" "periodFrom" "periodTo" "batchNo" "lineNo" "subscriptionType" "memberName" "invoicedTo" "invoicePosted" "modifiedBy" "manuallyModified"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get membershipSubscriptionCharges from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

membershipSubscriptionCharge-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of membershipSubscriptionCharge

query Parameters
$select
Array of strings unique
Items Enum: "id" "memberNo" "price" "discount" "qty" "amount" "productType" "productNo" "description" "comment" "invoiceNo" "membershipNo" "postingDate" "additionalCharges" "membershipType" "periodFrom" "periodTo" "batchNo" "lineNo" "subscriptionType" "memberName" "invoicedTo" "invoicePosted" "modifiedBy" "manuallyModified"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "memberNo": null,
  • "price": null,
  • "discount": null,
  • "qty": null,
  • "amount": null,
  • "productType": null,
  • "productNo": null,
  • "description": null,
  • "comment": null,
  • "invoiceNo": null,
  • "membershipNo": "string",
  • "postingDate": null,
  • "additionalCharges": null,
  • "membershipType": null,
  • "periodFrom": null,
  • "periodTo": null,
  • "batchNo": null,
  • "lineNo": null,
  • "subscriptionType": null,
  • "memberName": null,
  • "invoicedTo": null,
  • "invoicePosted": null,
  • "modifiedBy": null,
  • "manuallyModified": null
}

Reservation

A Reservation is the header that groups one or more Activity Reservations (lines) made for a single Client at a Location. Use this API to read reservations and their financial totals, to trigger header-level lifecycle actions (confirm, cancel, setStatus), to take or refund deposits (paymentDeposit / paymentRefund), and to drive charge-to-room style POS posting (chargeToInitialize / chargeItem / chargeFinalPosting). Replaces the legacy SOAP procedures GetActReservations, ChargeToReservationList, InsertReservationV2, UpdateReservationV2, ConfirmReservation, CancelReservation, UpdateReservationStatus, PaymentDeposit, PaymentRefund, and the ChargeToReservation* trio in codeunit 10015848 "LSC Activity WS". Available expands: $expand=activityReservations (the booking lines), $expand=reservationCharges (header-level additional charges — same Reservation Charges endpoint as on Activity Reservations, here filtered to Reservation Line No. = -1), and $expand=reservationAllowances (the issued allowances tied to this reservation — same Issued Allowances endpoint, here filtered to Transaction Type = "Activity Reservation" and Transaction = this reservation''s No.; matches the "Reservation Allowances" action on the Reservation Card). This release exposes the page as writable (POST / PATCH); calculated financial flow-fields and system fields (No., Customer Account Name, Discount Group, Created, Created By, Name) stay read-only.

Get reservations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "no" "reservationType" "clientNo" "clientName" "description" "reservationFrom" "reservationTo" "timeFrom" "timeTo" "location" "status" "internalStatus" "paymentStatus" "currencyCode" "customerAccountNo" "customerAccountName" "memberAccountNo" "email" "mobilePhoneNo" "salesPerson" "reference" "eventNo" "priceGroup" "discountGroup" "reservationChargeLimit" "defaultProductNo" "quote" "totalActivityCharges" "activitiesPaid" "totalAdditionalCharges" "additionalChargesPaid" "totalFees" "totalFeesPaid" "depositsBalance" "posSalesBalance" "resourcesReserved" "assignedRentalUnits" "depositPolicy" "created" "createdBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "activityReservations" "reservationCharges" "issuedAllowances"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to reservations for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this reservation. Use this value as the entity key when calling bound actions or building $expand / navigation links. Read-only.

no
null or string <= 20 characters

Specifies the business identifier of the reservation, assigned from the reservation number series. Read-only; the value is stable across the reservation lifecycle and is used as the foreign key from Activity Reservation lines, Reservation Charges, and POS receipts.

reservationType
null or string <= 20 characters

Specifies the reservation type that drives default behavior such as number series, allowed activity types, and POS posting rules. The value must match a code in the LSC Reservation Type table.

clientNo
null or string <= 20 characters

Specifies the contact (client / guest) the reservation is made for. The value is a Contact No. from the standard BC Contact table; for member clients it also resolves to a Member Contact. Drives club-member pricing, allowance availability, and customer-account suggestions.

clientName
null or string <= 100 characters

Specifies the display name of the client on the reservation. When no client is assigned you may set a name (or an e-mail / phone to search for a member contact); once a Client No. is assigned the name follows the contact and cannot be changed.

description
null or string <= 100 characters

Specifies the free-text description of the reservation shown on customer-facing documents and the activity matrix.

reservationFrom
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the start date of the reservation window (ISO 8601 date). Activity Reservation lines must fall on or after this date.

reservationTo
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the end date of the reservation window (ISO 8601 date). Activity Reservation lines must fall on or before this date.

timeFrom
null or string

Specifies the earliest time of day for activities on the reservation. Combined with Reservation From it forms the inclusive lower bound of the reservation window.

timeTo
null or string

Specifies the latest time of day for activities on the reservation. Combined with Reservation To it forms the inclusive upper bound of the reservation window.

location
null or string <= 20 characters

Specifies the Activity Location code that owns the reservation. The value must match a code in the LSC Activity Location table and is used to scope POS posting, currency, and resource availability.

status
null or string <= 20 characters

Specifies the user-visible status code of the reservation (e.g., Draft, Confirmed, Cancelled). Read-only on the API; use the setStatus / confirm / cancel bound actions to transition status so the configured workflow and payment calculations run.

internalStatus
null or string

Specifies the system-derived internal lifecycle state of the reservation. Allowed values: Draft — still being edited; Confirmed — committed; Cancelled — voided; Closed — completed and posted; Waiting List; No Show. Read-only; driven by the workflow configured on the Status code.

paymentStatus
null or string

Specifies the aggregate payment state across all charges on the reservation. Allowed values: None — nothing paid; Partial — deposits taken but balance remains; Fully Paid — balance zero; Refunded — net negative. Read-only; updated by paymentDeposit / paymentRefund and POS posting.

currencyCode
null or string <= 10 characters

Specifies the ISO 4217 currency code in which amounts on the reservation are denominated. Defaults from the Activity Location.

customerAccountNo
null or string <= 20 characters

Specifies the BC customer (debtor) the reservation invoices and POS charges post to. Optional; when blank, charges remain on the reservation balance until settled at the POS.

customerAccountName
null or string <= 100 characters

Specifies the display name of the linked Customer. Read-only; auto-calculated from Customer Account No.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account (club account) charged on the reservation. Optional; enables member pricing and allowance redemption when set.

email
null or string <= 200 characters

Specifies the email address used for confirmation messages and reminders. Free text; format is not validated by the API.

mobilePhoneNo
null or string <= 30 characters

Specifies the mobile phone number used for SMS confirmation and reminders.

salesPerson
null or string <= 20 characters

Specifies the Salesperson code attributed to the reservation. The value must match a code in the standard BC Salesperson/Purchaser table; used for commission reporting.

reference
null or string <= 35 characters

Specifies a free-text external reference (e.g., booking number from a third-party channel). Use this field to correlate the BC reservation with the origin system.

eventNo
null or string <= 20 characters

Specifies the Event the reservation belongs to. Optional; when set, reservation lines inherit event-level pricing and dimensions.

priceGroup
null or string <= 10 characters

Specifies the Activity Price Group used to resolve unit prices for activity reservation lines on this reservation.

discountGroup
null or string <= 20 characters

Specifies the Activity Discount Group applied to all lines on the reservation. Read-only on the API; resolved from the client and price group.

reservationChargeLimit
null or number <decimal>

Specifies the maximum amount of POS charges that may be posted to the reservation via charge-to-room. Zero means no limit. The chargeItem action errors when adding a line would exceed this limit.

defaultProductNo
null or string <= 20 characters

Specifies the Activity Product proposed when a new activity reservation line is added without an explicit product. Optional.

quote
null or string <= 20 characters

Specifies whether the reservation is a non-binding quote (true) rather than a confirmed booking (false). Quotes do not reserve resource capacity.

totalActivityCharges
null or number <decimal>

Specifies the sum of all activity-line amounts on the reservation. Calculated (FlowField); auto-loaded on read.

activitiesPaid
null or number <decimal>

Specifies the total amount already paid against the activity lines. Calculated (FlowField); auto-loaded on read.

totalAdditionalCharges
null or number <decimal>

Specifies the sum of all additional reservation-level charges (reservationCharges + activityCharges). Calculated; read-only.

additionalChargesPaid
null or number <decimal>

Specifies the total amount paid against additional charges. Calculated; read-only.

totalFees
null or number <decimal>

Specifies the sum of cancellation and other fees accrued on the reservation. Calculated; read-only.

totalFeesPaid
null or number <decimal>

Specifies the portion of Total Fees that has already been paid. Calculated; read-only.

depositsBalance
null or number <decimal>

Specifies the net deposit balance held on the reservation (deposits taken minus refunds). Positive means the customer has prepaid; calculated; read-only.

posSalesBalance
null or number <decimal>

Specifies the net balance of POS charge-to-reservation postings against the reservation. Calculated; read-only.

resourcesReserved
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the count of resources (instructors, equipment, rooms) currently allocated to lines on the reservation. Calculated; read-only.

assignedRentalUnits
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the count of rental units assigned to lines on the reservation. Calculated; read-only.

depositPolicy
null or string <= 20 characters

Specifies the Activity Deposit Policy code that controls whether and how much deposit is required to confirm the reservation. Must match a code in the LSC Activity Deposit Policy table.

created
null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the date the reservation record was first created. Read-only; system-set on insert.

createdBy
null or string <= 100 characters

Specifies the user ID that created the reservation. Read-only; system-set on insert.

(memberDetail (null or object))
Array of objects (activityReservation)
Array of objects (reservationCharge)
Array of objects (issuedAllowance)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "reservationType": null,
  • "clientNo": null,
  • "clientName": null,
  • "description": null,
  • "reservationFrom": null,
  • "reservationTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "location": null,
  • "status": null,
  • "internalStatus": null,
  • "paymentStatus": null,
  • "currencyCode": null,
  • "customerAccountNo": null,
  • "customerAccountName": null,
  • "memberAccountNo": null,
  • "email": null,
  • "mobilePhoneNo": null,
  • "salesPerson": null,
  • "reference": null,
  • "eventNo": null,
  • "priceGroup": null,
  • "discountGroup": null,
  • "reservationChargeLimit": null,
  • "defaultProductNo": null,
  • "quote": null,
  • "totalActivityCharges": null,
  • "activitiesPaid": null,
  • "totalAdditionalCharges": null,
  • "additionalChargesPaid": null,
  • "totalFees": null,
  • "totalFeesPaid": null,
  • "depositsBalance": null,
  • "posSalesBalance": null,
  • "resourcesReserved": null,
  • "assignedRentalUnits": null,
  • "depositPolicy": null,
  • "created": null,
  • "createdBy": null,
  • "memberDetail": {
    },
  • "activityReservations": [
    ],
  • "reservationCharges": [
    ],
  • "issuedAllowances": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "reservationType": null,
  • "clientNo": null,
  • "clientName": null,
  • "description": null,
  • "reservationFrom": null,
  • "reservationTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "location": null,
  • "status": null,
  • "internalStatus": null,
  • "paymentStatus": null,
  • "currencyCode": null,
  • "customerAccountNo": null,
  • "customerAccountName": null,
  • "memberAccountNo": null,
  • "email": null,
  • "mobilePhoneNo": null,
  • "salesPerson": null,
  • "reference": null,
  • "eventNo": null,
  • "priceGroup": null,
  • "discountGroup": null,
  • "reservationChargeLimit": null,
  • "defaultProductNo": null,
  • "quote": null,
  • "totalActivityCharges": null,
  • "activitiesPaid": null,
  • "totalAdditionalCharges": null,
  • "additionalChargesPaid": null,
  • "totalFees": null,
  • "totalFeesPaid": null,
  • "depositsBalance": null,
  • "posSalesBalance": null,
  • "resourcesReserved": null,
  • "assignedRentalUnits": null,
  • "depositPolicy": null,
  • "created": null,
  • "createdBy": null,
  • "memberDetail": {
    },
  • "activityReservations": [
    ],
  • "reservationCharges": [
    ],
  • "issuedAllowances": [
    ]
}

Get reservations from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

query Parameters
$select
Array of strings unique
Items Enum: "id" "no" "reservationType" "clientNo" "clientName" "description" "reservationFrom" "reservationTo" "timeFrom" "timeTo" "location" "status" "internalStatus" "paymentStatus" "currencyCode" "customerAccountNo" "customerAccountName" "memberAccountNo" "email" "mobilePhoneNo" "salesPerson" "reference" "eventNo" "priceGroup" "discountGroup" "reservationChargeLimit" "defaultProductNo" "quote" "totalActivityCharges" "activitiesPaid" "totalAdditionalCharges" "additionalChargesPaid" "totalFees" "totalFeesPaid" "depositsBalance" "posSalesBalance" "resourcesReserved" "assignedRentalUnits" "depositPolicy" "created" "createdBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "memberDetail" "activityReservations" "reservationCharges" "issuedAllowances"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "reservationType": null,
  • "clientNo": null,
  • "clientName": null,
  • "description": null,
  • "reservationFrom": null,
  • "reservationTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "location": null,
  • "status": null,
  • "internalStatus": null,
  • "paymentStatus": null,
  • "currencyCode": null,
  • "customerAccountNo": null,
  • "customerAccountName": null,
  • "memberAccountNo": null,
  • "email": null,
  • "mobilePhoneNo": null,
  • "salesPerson": null,
  • "reference": null,
  • "eventNo": null,
  • "priceGroup": null,
  • "discountGroup": null,
  • "reservationChargeLimit": null,
  • "defaultProductNo": null,
  • "quote": null,
  • "totalActivityCharges": null,
  • "activitiesPaid": null,
  • "totalAdditionalCharges": null,
  • "additionalChargesPaid": null,
  • "totalFees": null,
  • "totalFeesPaid": null,
  • "depositsBalance": null,
  • "posSalesBalance": null,
  • "resourcesReserved": null,
  • "assignedRentalUnits": null,
  • "depositPolicy": null,
  • "created": null,
  • "createdBy": null,
  • "memberDetail": {
    },
  • "activityReservations": [
    ],
  • "reservationCharges": [
    ],
  • "issuedAllowances": [
    ]
}

Update the navigation property reservations in companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json

New navigation property values

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this reservation. Use this value as the entity key when calling bound actions or building $expand / navigation links. Read-only.

no
null or string <= 20 characters

Specifies the business identifier of the reservation, assigned from the reservation number series. Read-only; the value is stable across the reservation lifecycle and is used as the foreign key from Activity Reservation lines, Reservation Charges, and POS receipts.

reservationType
null or string <= 20 characters

Specifies the reservation type that drives default behavior such as number series, allowed activity types, and POS posting rules. The value must match a code in the LSC Reservation Type table.

clientNo
null or string <= 20 characters

Specifies the contact (client / guest) the reservation is made for. The value is a Contact No. from the standard BC Contact table; for member clients it also resolves to a Member Contact. Drives club-member pricing, allowance availability, and customer-account suggestions.

clientName
null or string <= 100 characters

Specifies the display name of the client on the reservation. When no client is assigned you may set a name (or an e-mail / phone to search for a member contact); once a Client No. is assigned the name follows the contact and cannot be changed.

description
null or string <= 100 characters

Specifies the free-text description of the reservation shown on customer-facing documents and the activity matrix.

reservationFrom
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the start date of the reservation window (ISO 8601 date). Activity Reservation lines must fall on or after this date.

reservationTo
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the end date of the reservation window (ISO 8601 date). Activity Reservation lines must fall on or before this date.

timeFrom
null or string

Specifies the earliest time of day for activities on the reservation. Combined with Reservation From it forms the inclusive lower bound of the reservation window.

timeTo
null or string

Specifies the latest time of day for activities on the reservation. Combined with Reservation To it forms the inclusive upper bound of the reservation window.

location
null or string <= 20 characters

Specifies the Activity Location code that owns the reservation. The value must match a code in the LSC Activity Location table and is used to scope POS posting, currency, and resource availability.

status
null or string <= 20 characters

Specifies the user-visible status code of the reservation (e.g., Draft, Confirmed, Cancelled). Read-only on the API; use the setStatus / confirm / cancel bound actions to transition status so the configured workflow and payment calculations run.

internalStatus
null or string

Specifies the system-derived internal lifecycle state of the reservation. Allowed values: Draft — still being edited; Confirmed — committed; Cancelled — voided; Closed — completed and posted; Waiting List; No Show. Read-only; driven by the workflow configured on the Status code.

paymentStatus
null or string

Specifies the aggregate payment state across all charges on the reservation. Allowed values: None — nothing paid; Partial — deposits taken but balance remains; Fully Paid — balance zero; Refunded — net negative. Read-only; updated by paymentDeposit / paymentRefund and POS posting.

currencyCode
null or string <= 10 characters

Specifies the ISO 4217 currency code in which amounts on the reservation are denominated. Defaults from the Activity Location.

customerAccountNo
null or string <= 20 characters

Specifies the BC customer (debtor) the reservation invoices and POS charges post to. Optional; when blank, charges remain on the reservation balance until settled at the POS.

customerAccountName
null or string <= 100 characters

Specifies the display name of the linked Customer. Read-only; auto-calculated from Customer Account No.

memberAccountNo
null or string <= 20 characters

Specifies the Member Account (club account) charged on the reservation. Optional; enables member pricing and allowance redemption when set.

email
null or string <= 200 characters

Specifies the email address used for confirmation messages and reminders. Free text; format is not validated by the API.

mobilePhoneNo
null or string <= 30 characters

Specifies the mobile phone number used for SMS confirmation and reminders.

salesPerson
null or string <= 20 characters

Specifies the Salesperson code attributed to the reservation. The value must match a code in the standard BC Salesperson/Purchaser table; used for commission reporting.

reference
null or string <= 35 characters

Specifies a free-text external reference (e.g., booking number from a third-party channel). Use this field to correlate the BC reservation with the origin system.

eventNo
null or string <= 20 characters

Specifies the Event the reservation belongs to. Optional; when set, reservation lines inherit event-level pricing and dimensions.

priceGroup
null or string <= 10 characters

Specifies the Activity Price Group used to resolve unit prices for activity reservation lines on this reservation.

discountGroup
null or string <= 20 characters

Specifies the Activity Discount Group applied to all lines on the reservation. Read-only on the API; resolved from the client and price group.

reservationChargeLimit
null or number <decimal>

Specifies the maximum amount of POS charges that may be posted to the reservation via charge-to-room. Zero means no limit. The chargeItem action errors when adding a line would exceed this limit.

defaultProductNo
null or string <= 20 characters

Specifies the Activity Product proposed when a new activity reservation line is added without an explicit product. Optional.

quote
null or string <= 20 characters

Specifies whether the reservation is a non-binding quote (true) rather than a confirmed booking (false). Quotes do not reserve resource capacity.

totalActivityCharges
null or number <decimal>

Specifies the sum of all activity-line amounts on the reservation. Calculated (FlowField); auto-loaded on read.

activitiesPaid
null or number <decimal>

Specifies the total amount already paid against the activity lines. Calculated (FlowField); auto-loaded on read.

totalAdditionalCharges
null or number <decimal>

Specifies the sum of all additional reservation-level charges (reservationCharges + activityCharges). Calculated; read-only.

additionalChargesPaid
null or number <decimal>

Specifies the total amount paid against additional charges. Calculated; read-only.

totalFees
null or number <decimal>

Specifies the sum of cancellation and other fees accrued on the reservation. Calculated; read-only.

totalFeesPaid
null or number <decimal>

Specifies the portion of Total Fees that has already been paid. Calculated; read-only.

depositsBalance
null or number <decimal>

Specifies the net deposit balance held on the reservation (deposits taken minus refunds). Positive means the customer has prepaid; calculated; read-only.

posSalesBalance
null or number <decimal>

Specifies the net balance of POS charge-to-reservation postings against the reservation. Calculated; read-only.

resourcesReserved
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the count of resources (instructors, equipment, rooms) currently allocated to lines on the reservation. Calculated; read-only.

assignedRentalUnits
null or number <int32> [ -2147483648 .. 2147483647 ]

Specifies the count of rental units assigned to lines on the reservation. Calculated; read-only.

depositPolicy
null or string <= 20 characters

Specifies the Activity Deposit Policy code that controls whether and how much deposit is required to confirm the reservation. Must match a code in the LSC Activity Deposit Policy table.

created
null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the date the reservation record was first created. Read-only; system-set on insert.

createdBy
null or string <= 100 characters

Specifies the user ID that created the reservation. Read-only; system-set on insert.

(memberDetail (null or object))
Array of objects (activityReservation)
Array of objects (reservationCharge)
Array of objects (issuedAllowance)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "reservationType": null,
  • "clientNo": null,
  • "clientName": null,
  • "description": null,
  • "reservationFrom": null,
  • "reservationTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "location": null,
  • "status": null,
  • "internalStatus": null,
  • "paymentStatus": null,
  • "currencyCode": null,
  • "customerAccountNo": null,
  • "customerAccountName": null,
  • "memberAccountNo": null,
  • "email": null,
  • "mobilePhoneNo": null,
  • "salesPerson": null,
  • "reference": null,
  • "eventNo": null,
  • "priceGroup": null,
  • "discountGroup": null,
  • "reservationChargeLimit": null,
  • "defaultProductNo": null,
  • "quote": null,
  • "totalActivityCharges": null,
  • "activitiesPaid": null,
  • "totalAdditionalCharges": null,
  • "additionalChargesPaid": null,
  • "totalFees": null,
  • "totalFeesPaid": null,
  • "depositsBalance": null,
  • "posSalesBalance": null,
  • "resourcesReserved": null,
  • "assignedRentalUnits": null,
  • "depositPolicy": null,
  • "created": null,
  • "createdBy": null,
  • "memberDetail": {
    },
  • "activityReservations": [
    ],
  • "reservationCharges": [
    ],
  • "issuedAllowances": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action cancel

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action chargeFinalPosting

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json

Action parameters

storeNo
null or string
receiptNo
null or string
totalQty
null or number <decimal>
totalAmount
null or number <decimal>

Responses

Request samples

Content type
application/json
{
  • "storeNo": null,
  • "receiptNo": null,
  • "totalQty": null,
  • "totalAmount": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action chargeItem

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json

Action parameters

storeNo
null or string
receiptNo
null or string
lineNo
null or number <int32> [ -2147483648 .. 2147483647 ]
entryType
null or number <int32> [ -2147483648 .. 2147483647 ]
itemNo
null or string
variantNo
null or string
uom
null or string
description
null or string
qty
null or number <decimal>
discount
null or number <decimal>
unitPrice
null or number <decimal>
totalAmount
null or number <decimal>
netPrice
null or number <decimal>
vatAmount
null or number <decimal>
discountAmount
null or number <decimal>
barcode
null or string
cashierID
null or string

Responses

Request samples

Content type
application/json
{
  • "storeNo": null,
  • "receiptNo": null,
  • "lineNo": null,
  • "entryType": null,
  • "itemNo": null,
  • "variantNo": null,
  • "uom": null,
  • "description": null,
  • "qty": null,
  • "discount": null,
  • "unitPrice": null,
  • "totalAmount": null,
  • "netPrice": null,
  • "vatAmount": null,
  • "discountAmount": null,
  • "barcode": null,
  • "cashierID": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action chargeToInitialize

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json

Action parameters

storeNo
null or string
receiptNo
null or string

Responses

Request samples

Content type
application/json
{
  • "storeNo": null,
  • "receiptNo": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action confirm

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action paymentDeposit

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json

Action parameters

scheduleDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
paymentType
null or string
tenderTypeCode
null or string
currency
null or string
currencyFactor
null or number <decimal>
cardType
null or string
cardTransType
null or string
cardTransDate
null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
cardAuthCode
null or string
cardAuthId
null or string
cardHolderName
null or string
cardMaskedNumber
null or string
tokenNo
null or string

Responses

Request samples

Content type
application/json
{
  • "scheduleDate": null,
  • "paymentType": null,
  • "tenderTypeCode": null,
  • "currency": null,
  • "currencyFactor": null,
  • "cardType": null,
  • "cardTransType": null,
  • "cardTransDate": null,
  • "cardAuthCode": null,
  • "cardAuthId": null,
  • "cardHolderName": null,
  • "cardMaskedNumber": null,
  • "tokenNo": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action paymentRefund

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json

Action parameters

scheduleDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
paymentType
null or string
tenderTypeCode
null or string
currency
null or string
currencyFactor
null or number <decimal>
cardType
null or string
cardTransType
null or string
cardTransDate
null or string <date-time> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
cardAuthCode
null or string
cardAuthId
null or string
cardHolderName
null or string
cardMaskedNumber
null or string
tokenNo
null or string

Responses

Request samples

Content type
application/json
{
  • "scheduleDate": null,
  • "paymentType": null,
  • "tenderTypeCode": null,
  • "currency": null,
  • "currencyFactor": null,
  • "cardType": null,
  • "cardTransType": null,
  • "cardTransDate": null,
  • "cardAuthCode": null,
  • "cardAuthId": null,
  • "cardHolderName": null,
  • "cardMaskedNumber": null,
  • "tokenNo": null
}

Response samples

Content type
application/json
{
  • "value": null
}

Invoke action setStatus

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

reservation-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of reservation

Request Body schema: application/json

Action parameters

newStatus
null or string

Responses

Request samples

Content type
application/json
{
  • "newStatus": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Resource Activity

A Resource Activity is the timetable view of Activity Reservation lines filtered by a Resource — what is booked on a given instructor, room, or piece of equipment, when, and for whom. This API projects the LSC Activity Reservation table; use it to drive resource-centric scheduling UIs (instructor day plans, room utilization). Filter by mainResource, location, dateFrom, etc. Replaces the legacy SOAP procedure UploadResourceActivities in codeunit 10015848 "LSC Activity WS". For the booking-centric view of the same lines use the Activity Reservations API.

Get resourceActivities from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "activityNo" "productNo" "description" "dateFrom" "dateTo" "timeFrom" "timeTo" "quantity" "unitPrice" "lineDiscountPercentage" "totalAmount" "status" "paymentStatus" "location" "clientNo" "clientName" "noOfPersons" "lineDiscountAmount" "allowanceNo" "cancelPolicy" "cancelPolicyDescription" "cancelAmount" "reservationNo" "lineNo" "itemNo" "activityType" "eventCategory" "guestType" "productType" "durationType" "noOfUnits" "unit" "mainResource" "promoCode" "waiverCode" "waiverStatus"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get resourceActivities from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

resourceActivity-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of resourceActivity

query Parameters
$select
Array of strings unique
Items Enum: "id" "activityNo" "productNo" "description" "dateFrom" "dateTo" "timeFrom" "timeTo" "quantity" "unitPrice" "lineDiscountPercentage" "totalAmount" "status" "paymentStatus" "location" "clientNo" "clientName" "noOfPersons" "lineDiscountAmount" "allowanceNo" "cancelPolicy" "cancelPolicyDescription" "cancelAmount" "reservationNo" "lineNo" "itemNo" "activityType" "eventCategory" "guestType" "productType" "durationType" "noOfUnits" "unit" "mainResource" "promoCode" "waiverCode" "waiverStatus"

Select properties to be returned

$expand
Array of strings unique
Items Value: "memberDetail"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityNo": null,
  • "productNo": null,
  • "description": null,
  • "dateFrom": null,
  • "dateTo": null,
  • "timeFrom": null,
  • "timeTo": null,
  • "quantity": null,
  • "unitPrice": null,
  • "lineDiscountPercentage": null,
  • "totalAmount": null,
  • "status": null,
  • "paymentStatus": null,
  • "location": null,
  • "clientNo": null,
  • "clientName": null,
  • "noOfPersons": null,
  • "lineDiscountAmount": null,
  • "allowanceNo": null,
  • "cancelPolicy": null,
  • "cancelPolicyDescription": null,
  • "cancelAmount": null,
  • "reservationNo": null,
  • "lineNo": null,
  • "itemNo": null,
  • "activityType": null,
  • "eventCategory": null,
  • "guestType": null,
  • "productType": null,
  • "durationType": null,
  • "noOfUnits": null,
  • "unit": null,
  • "mainResource": null,
  • "promoCode": null,
  • "waiverCode": null,
  • "waiverStatus": "Not_x0020_Required",
  • "memberDetail": {
    }
}

Waiver

A Waiver is a liability-release / consent document associated with a Client, a Reservation, or a Membership. Use this API to list waiver entries (filter by referenceType + referenceNo to isolate Client, Reservation, or Membership waivers in one call) and to apply a signature via the sign bound action or void it via the cancel bound action. The merged surface replaces five legacy SOAP procedures (GetReservationWaivers, GetClientWaivers, GetWaiverStatus, InsertReservationWaiver, InsertClientWaiver, SetWaiverStatus) by routing them through a single linkType / linkNo discriminator. Create a waiver with POST (referenceType Client, Reservation, or Membership); use the sign bound action to capture a signature, or the cancel bound action to void it. The page is create-only — waiver entries cannot be modified or deleted through this API.

Get waivers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "no" "referenceType" "referenceNo" "waiverCode" "description" "clientNo" "clientName" "accountNo" "status" "dateSigned" "timeSigned" "expiryDate" "identificationReference"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Create new navigation property to waivers for companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

Request Body schema: application/json
required

New navigation property

id
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Specifies the immutable system-assigned GUID that uniquely identifies this waiver entry. Use this value as the entity key when calling the sign bound action. Read-only.

no
null or string <= 20 characters

Specifies the business identifier of the waiver entry, assigned from a number series on creation. Read-only.

(lscActivityWaiverRefType (null or string))

Specifies the kind of object the waiver is bound to. Allowed values: Client — waiver signed by a person and re-usable; Reservation — waiver for a single reservation; Membership — waiver tied to a membership.

referenceNo
null or string <= 20 characters

Specifies the identifier of the linked object (Contact No., Reservation No., or Membership No.) based on Reference Type.

waiverCode
string <= 20 characters

Specifies the Waiver template code that defines the legal text and validity period. Must match a code in the Waiver master table.

description
null or string <= 100 characters

Specifies the description of the waiver template. Read-only; auto-loaded from the Waiver master.

clientNo
null or string <= 20 characters

Specifies the Contact No. of the signer. Required when Reference Type is Client; informational for Reservation / Membership waivers.

clientName
null or string <= 100 characters

Specifies the display name of the signer. Free text; typically copied from the contact.

accountNo
null or string <= 20 characters

Specifies the Member Account linked to the signer when applicable. Read-only.

(lscWaiverStatus (null or string))

Specifies the signature state of the waiver. Allowed values: Pending — waiver issued, not signed; Signed — signature captured; Expired — signed but past the expiry date; Cancelled — voided. Read-only; transitions only via the sign bound action.

dateSigned
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the date the waiver was signed (ISO 8601). Read-only; set by the sign action.

timeSigned
null or string

Specifies the time of day the waiver was signed. Read-only; set by the sign action.

expiryDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...

Specifies the date on which the signed waiver ceases to be valid. Read-only; calculated from Date Signed plus the validity period defined on the Waiver master.

identificationReference
null or string <= 50 characters

Specifies a free-text reference to the identification document presented by the signer (e.g., driver license number, passport last digits).

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "referenceType": "Client",
  • "referenceNo": null,
  • "waiverCode": "string",
  • "description": null,
  • "clientNo": null,
  • "clientName": null,
  • "accountNo": null,
  • "status": "Not_x0020_Required",
  • "dateSigned": null,
  • "timeSigned": null,
  • "expiryDate": null,
  • "identificationReference": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "referenceType": "Client",
  • "referenceNo": null,
  • "waiverCode": "string",
  • "description": null,
  • "clientNo": null,
  • "clientName": null,
  • "accountNo": null,
  • "status": "Not_x0020_Required",
  • "dateSigned": null,
  • "timeSigned": null,
  • "expiryDate": null,
  • "identificationReference": null
}

Get waivers from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

waiver-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of waiver

query Parameters
$select
Array of strings unique
Items Enum: "id" "no" "referenceType" "referenceNo" "waiverCode" "description" "clientNo" "clientName" "accountNo" "status" "dateSigned" "timeSigned" "expiryDate" "identificationReference"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "no": null,
  • "referenceType": "Client",
  • "referenceNo": null,
  • "waiverCode": "string",
  • "description": null,
  • "clientNo": null,
  • "clientName": null,
  • "accountNo": null,
  • "status": "Not_x0020_Required",
  • "dateSigned": null,
  • "timeSigned": null,
  • "expiryDate": null,
  • "identificationReference": null
}

Invoke action cancel

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

waiver-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of waiver

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invoke action sign

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

waiver-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of waiver

Request Body schema: application/json

Action parameters

isSigned
null or boolean
Default: false
signatureDate
null or string <date> ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|...
signatureTime
null or string

Responses

Request samples

Content type
application/json
{
  • "isSigned": false,
  • "signatureDate": null,
  • "signatureTime": null
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Company

Get entities from companies

Authorizations:
oAuth2basicAuth
query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "systemVersion" "timestamp" "name" "displayName" "businessProfileId" "systemCreatedAt" "systemCreatedBy" "systemModifiedAt" "systemModifiedBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "activityTypes" "activityLocations" "activityProducts" "activityPromotions" "activityResources" "memberDetails" "membershipProducts" "admissionEntries" "issuedAllowances" "resourceActivities" "activitySettings" "reservations" "activityReservations" "reservationCharges" "membershipEntries" "customerEntries" "groupReservations" "groupReservationLines" "groupCharges" "groupReservationMembers" "membershipSubscriptionCharges" "attributes" "waivers" "activityResourceGroups"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from companies by key

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$select
Array of strings unique
Items Enum: "id" "systemVersion" "timestamp" "name" "displayName" "businessProfileId" "systemCreatedAt" "systemCreatedBy" "systemModifiedAt" "systemModifiedBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "activityTypes" "activityLocations" "activityProducts" "activityPromotions" "activityResources" "memberDetails" "membershipProducts" "admissionEntries" "issuedAllowances" "resourceActivities" "activitySettings" "reservations" "activityReservations" "reservationCharges" "membershipEntries" "customerEntries" "groupReservations" "groupReservationLines" "groupCharges" "groupReservationMembers" "membershipSubscriptionCharges" "attributes" "waivers" "activityResourceGroups"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "systemVersion": null,
  • "timestamp": null,
  • "name": null,
  • "displayName": null,
  • "businessProfileId": null,
  • "systemCreatedAt": null,
  • "systemCreatedBy": null,
  • "systemModifiedAt": null,
  • "systemModifiedBy": null,
  • "activityTypes": [
    ],
  • "activityLocations": [
    ],
  • "activityProducts": [
    ],
  • "activityPromotions": [
    ],
  • "activityResources": [
    ],
  • "memberDetails": [
    ],
  • "membershipProducts": [
    ],
  • "admissionEntries": [
    ],
  • "issuedAllowances": [
    ],
  • "resourceActivities": [
    ],
  • "activitySettings": [
    ],
  • "reservations": [
    ],
  • "activityReservations": [
    ],
  • "reservationCharges": [
    ],
  • "membershipEntries": [
    ],
  • "customerEntries": [
    ],
  • "groupReservations": [
    ],
  • "groupReservationLines": [
    ],
  • "groupCharges": [
    ],
  • "groupReservationMembers": [
    ],
  • "membershipSubscriptionCharges": [
    ],
  • "attributes": [
    ],
  • "waivers": [
    ],
  • "activityResourceGroups": [
    ]
}