Get Capacity

GET

Retrieve the capacity and availability for a ticket item number. Note that an item may have multiple admissions with different schedules and pricing.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

itemNumberstringRequired

An item or product number defined in the ticketing system

referenceDatedateOptional

A date to use as a reference for the capacity search. If not specified, the current date will be used.

quantityintegerOptional

The number of tickets to reserved

admissionCodestringOptional

A unique code that identifies a specific admission.

customerNumberstringOptional

The customer number of the user making the request. The customer number affects pricing.

Response

This endpoint returns a list of objects.
capacityControlenum
Allowed values: nonesalesadmittedfull

Indicates the type of capacity control for the admission. None implies that there is no capacity control. Sales implies that the capacity is controlled by the number of tickets sold. Admitted implies that the capacity is controlled by the number of tickets admitted. Full implies that the capacity is admitted and departed.

codestring

A unique code that identifies a specific admission.

defaultboolean

Indicates if this admission is the default admission when there are multiple admission defined.

discountPctdouble

The discount percentage for the admission based either on the customer or the quantity of tickets.

includedenum
Allowed values: mandatoryoptionaloptionalSelected

Indicates if the admission is mandatory or optional. Mandatory implies that the admission can not be deselected. Optional implies that you must opt-in to include the admission, while optionalSelected implies that the admission is optional but selected by default.

quantityinteger

The number of tickets to reserved

referenceDatedate

A date to use as a reference for the capacity search. If not specified, the current date will be used.

scheduleslist of objects
unitPricedouble

The unit price of the ticket.

unitPriceIncludesVatboolean

Indicates if the unit price includes VAT.

vatPctdouble

The VAT percentage for the admission.

customerNumberstringOptional

The customer number of the user making the request. The customer number affects pricing.

descriptionobjectOptional

Descriptive information about a ticket item. The source of these fields are configurable.