Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
GET | /schedules/recurring | Find recurring schedules for a company |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | path | Guid? | No | Enter the company you want to see news for, if blank and you are an admin, your company id will be used |
ValidFrom | query | dateTime | No | Enter the From Date you want to see news from, only allowed if admin |
ValidTo | query | dateTime | No | Enter the To Date you want to see news to, only allowed if admin |
IncludeRecurringDays | query | bool | No | If you want to include the connected days for the schedule |
IncludeConnectedResources | query | bool | No | If you want to include the connected resources for the schedule |
IncludeConnectedServices | query | bool | No | If you want to include the connected services for the schedule |
IncludeExceptions | query | bool | No | If you want to include the exceptions for the schedule |
Active | query | boolean | No | Use this parameter if you want to only show active news |
IncludeScheduleDates | query | bool | No | If you want to include the connected dates for the schedule. This is used when the schedule having setting, different opening hours per week (not rolling schedule using days of week). |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | query | int | No | Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: ?skip=10&orderBy=Id |
Take | query | int | No | Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: ?take=20 |
OrderBy | query | string | No | Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: ?orderBy=Id,-Age,FirstName |
OrderByDesc | query | string | No | Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: ?orderByDesc=Id,-Age,FirstName |
Include | query | string | No | Include any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.Example: ?include=COUNT(*) as Total or multiple fields with ?include=Count(*) Total, Min(Age), AVG(Age) AverageAge or unique with ?include=COUNT(DISTINCT LivingStatus) as UniqueStatus |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | ScheduleType | No | |
Dates | form | IList<RecurringScheduleDate> | No | |
Resources | form | IList<Resource> | No | |
Services | form | IList<Service> | No | |
RecurringScheduleResourceRelation | form | List<RecurringScheduleResourceRelation> | No | |
RecurringScheduleDates | form | List<RecurringScheduleDate> | No | |
RecurringScheduleDayOfWeekRelation | form | List<RecurringScheduleDayOfWeekRelation> | No | |
ServiceRecurringScheduleRelation | form | List<ServiceRecurringScheduleRelation> | No | |
RecurringScheduleExceptions | form | List<RecurringScheduleException> | No | |
Exceptions | form | IList<IScheduleException> | No | |
IsRecurringByDayOfWeek | form | bool | No | |
IsRecurringByDates | form | bool | No | |
IsResourceSpecific | form | bool | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
Name | form | string | Yes | |
Description | form | string | Yes | |
TimeInterval | form | int | Yes | |
StartTime | form | TimeSpan | Yes | |
EndTime | form | TimeSpan | Yes | |
NumberOfScheduleDays | form | int | Yes | |
UpdatedDate | form | DateTime | Yes | |
CreatedDate | form | DateTime | Yes | |
EnableBookingUntilClosingTime | form | bool | Yes | |
ValidFrom | form | DateTime | Yes | |
ValidTo | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Active | form | bool | Yes |
NotDefined | |
RecurringSchedule | |
DateSchedule |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
From | form | DateTime | No | |
To | form | DateTime | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
RecurringScheduleId | form | int | Yes | |
Date | form | DateTime | Yes | |
StartTime | form | TimeSpan | Yes | |
EndTime | form | TimeSpan | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Priority | form | int | No | |
Schedules | form | IList<ISchedule> | No | |
Exceptions | form | IList<ITimeException> | No | |
Bookings | form | IList<IBookedTime> | No | |
CustomFieldsConfig | form | IList<CustomFieldConfig> | No | |
CustomFieldsData | form | IList<CustomFieldDataResponse> | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
Name | form | string | Yes | |
Active | form | bool | Yes | |
Description | form | string | No | |
ImageUrl | form | string | No | |
UpdatedDate | form | DateTime | Yes | |
CreatedDate | form | DateTime | Yes | |
Color | form | string | Yes | |
form | string | No | ||
MobilePhone | form | string | No | |
EmailNotification | form | bool? | No | |
SMSNotification | form | bool? | No | |
SendSMSReminder | form | bool | Yes | |
SendEmailReminder | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
AccessGroup | form | string | No | |
TextField1 | form | string | No | |
TextField2 | form | string | No | |
TextField3 | form | string | No | |
TextField4 | form | string | No | |
TextField5 | form | string | No | |
TextField6 | form | string | No | |
TextField7 | form | string | No | |
TextField8 | form | string | No | |
TextField9 | form | string | No | |
TextField10 | form | string | No | |
TextField11 | form | string | No | |
TextField12 | form | string | No | |
TextField13 | form | string | No | |
TextField14 | form | string | No | |
TextField15 | form | string | No | |
TextField16 | form | string | No | |
TextField17 | form | string | No | |
TextField18 | form | string | No | |
TextField19 | form | string | No | |
TextField20 | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Resources | form | IList<Resource> | No | |
Type | form | ScheduleType | No | |
Active | form | bool | No | |
IsResourceSpecific | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
ReasonText | form | string | No | |
IsBlock | form | bool | No | |
ReasonTextPublic | form | string | No | |
IsRecurring | form | bool | No | |
ResourceIds | form | int[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
ServiceId | form | int | No | |
BookedSpots | form | int | No | |
TotalSpots | form | int | No | |
PauseAfterInMinutes | form | int | No | |
Status | form | BookingStatusEnum | No | |
StatusId | form | int | No | |
Customer | form | BookedCustomer | No |
Name | Value | |
---|---|---|
Booked | 1 | |
Unbooked | 2 | |
Reserved | 3 | |
Canceled | 4 | |
AwaitingPayment | 5 | |
AwaitingPaymentNoTimeLimit | 6 | |
Payed | 7 | |
AwaitingPaymentRequestFromAdmin | 8 | |
AwaitingPaymentFromProvider | 9 | |
Invoiced | 10 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
Firstname | form | string | No | |
Lastname | form | string | No | |
form | string | No | ||
Phone | form | string | No | |
FacebookUserName | form | string | No | |
ImageUrl | form | string | No | |
CorporateIdentityNumber | form | string | No | |
InvoiceAddress1 | form | string | No | |
InvoiceAddress2 | form | string | No | |
InvoiceCity | form | string | No | |
InvoicePostalCode | form | string | No | |
InvoiceCountryCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Values | form | List<CustomFieldValue> | No | |
CustomField | form | CustomField | No | |
RegEx | form | RegEx | No | |
Services | form | List<Service> | No | |
CustomFieldServiceRelation | form | List<CustomFieldServiceRelation> | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
GroupId | form | int? | No | |
FieldId | form | int | Yes | |
IconId | form | int | Yes | |
RegExId | form | int? | No | |
Name | form | string | Yes | |
Description | form | string | Yes | |
Datatype | form | string | Yes | |
MaxLength | form | int | Yes | |
IsPublic | form | bool | Yes | |
IsHidden | form | bool | Yes | |
IsMandatory | form | bool | Yes | |
DefaultValue | form | string | No | |
RegExErrorMessage | form | string | No | |
MandatoryErrorMessage | form | string | No | |
Width | form | int? | No | |
MultipleLineText | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
Value | form | string | Yes | |
Active | form | bool | Yes | |
SortOrder | form | short? | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Table | form | string | Yes | |
Column | form | string | Yes | |
DataType | form | string | Yes | |
Description | form | string | Yes | |
Active | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
RegExCode | form | string | Yes | |
ErrorMessage | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceTypes | form | List<ResourceType> | No | |
Resources | form | IEnumerable<Resource> | No | |
TotalPrice | form | TotalPriceInformation | No | |
Prices | form | List<ServicePrice> | No | |
BookingStatusOptions | form | List<BookingStatusOptions> | No | |
IsGroupBooking | form | bool | No | |
IsMultipleResource | form | bool | No | |
Settings | form | BookingSettings | No | |
PaymentSetting | form | PaymentSetting | No | |
BookingCustomFieldsConfig | form | IList<CustomFieldConfig> | No | |
CustomerCustomFieldsConfig | form | IList<CustomFieldConfig> | No | |
CustomFieldsConfig | form | IList<CustomFieldConfig> | No | |
CustomFieldsData | form | IList<CustomFieldDataResponse> | No | |
Schedules | form | IList<ISchedule> | No | |
CustomerActiveBookings | form | IList<Booking> | No | |
ScheduleType | form | ScheduleType | No | |
LastTimeToUnbookThreshold | form | TimeSpan | No | |
LastTimeToBookThreshold | form | TimeSpan | No | |
RatingScore | form | AverageRatingScore | No | |
Ratings | form | List<Rating> | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
Name | form | string | Yes | |
Description | form | string | Yes | |
Group | form | string | No | |
Active | form | bool | Yes | |
SortOrder | form | int | Yes | |
PauseAfterBooking | form | int | Yes | |
UnbookBeforeDays | form | int | Yes | |
UnbookBeforeHours | form | int | Yes | |
UnbookBeforeMinutes | form | int | Yes | |
BookBeforeDays | form | int | Yes | |
BookBeforeHours | form | int | Yes | |
BookBeforeMinutes | form | int | Yes | |
Duration | form | int? | No | |
DurationTypeId | form | int | No | |
MinDuration | form | int? | No | |
MaxDuration | form | int? | No | |
DurationInterval | form | int? | No | |
TotalSpots | form | int? | No | |
ImageUrl | form | string | No | |
ScheduleTypeId | form | int | Yes | |
UpdatedDate | form | DateTime | Yes | |
CreatedDate | form | DateTime | Yes | |
OnlyVisibleByAdmin | form | bool | Yes | |
MinNumberOfSpotsPerBooking | form | int | Yes | |
MaxNumberOfSpotsPerBooking | form | int | Yes | |
MinNumberOfResourcesToBook | form | int | Yes | |
MaxNumberOfResourcesToBook | form | int | Yes | |
IsPaymentEnabled | form | bool | Yes | |
MaxPaymentTime | form | int | Yes | |
LockSpotsToBooking | form | bool | Yes | |
EnableBookingQueue | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
BookingStatusId | form | int | Yes | |
EnableCodeLockSync | form | bool | Yes | |
EnableCustomerManualPayment | form | bool | Yes | |
PriceViewTypeId | form | int? | No | |
TextField1 | form | string | No | |
TextField2 | form | string | No | |
TextField3 | form | string | No | |
TextField4 | form | string | No | |
TextField5 | form | string | No | |
TextField6 | form | string | No | |
TextField7 | form | string | No | |
TextField8 | form | string | No | |
TextField9 | form | string | No | |
TextField10 | form | string | No | |
TextField11 | form | string | No | |
TextField12 | form | string | No | |
TextField13 | form | string | No | |
TextField14 | form | string | No | |
TextField15 | form | string | No | |
TextField16 | form | string | No | |
TextField17 | form | string | No | |
TextField18 | form | string | No | |
TextField19 | form | string | No | |
TextField20 | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SelectableByUser | form | bool | No | |
Resources | form | List<Resource> | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
Name | form | string | Yes | |
Description | form | string | No | |
Active | form | bool | Yes | |
UpdatedDate | form | DateTime | Yes | |
CreatedDate | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalPrice | form | double | No | |
TotalVATAmount | form | double | No | |
TotalRebate | form | double | No | |
TotalPriceBeforeRebate | form | double | No | |
AppliedCodes | form | List<AppliedRebateCodes> | No | |
PriceSign | form | string | No | |
CurrencyId | form | string | No | |
VAT | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RebateCodeId | form | int | No | |
RebateCodeSign | form | string | No | |
RebateCodeValue | form | int | No | |
RebateAmount | form | double | No | |
RebateCodeType | form | RebateCodeType | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CurrencyId | form | string | No | |
CurrencyInfo | form | Currency | No | |
Service | form | Service | No | |
PriceMappings | form | List<PriceMapping> | No | |
isTimeSpecific | form | bool | No | |
isDaysOfWeekSpecific | form | bool | No | |
DayOfWeeks | form | List<ServicePriceDayOfWeekRelation> | No | |
PriceBeforeRebate | form | double? | No | |
RebateCodesApplied | form | List<RebateCode> | No | |
PriceText | form | string | No | |
OverlappingPrices | form | List<ServicePrice> | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
ServiceId | form | int | Yes | |
Price | form | double? | No | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
FromTime | form | TimeSpan | Yes | |
ToTime | form | TimeSpan | Yes | |
VAT | form | decimal | Yes | |
Category | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
From | form | DateTime | Yes | |
To | form | DateTime | Yes | |
CalculationTypeId | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
CurrencySign | form | string | Yes | |
Active | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
Id | form | Guid | Yes | |
PriceId | form | int | Yes | |
ReferenceType | form | string | No | |
ExternalReference | form | string | No | |
UpdatedDate | form | DateTime | Yes | |
CreatedDate | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DayOfWeek | form | BokaMeraDayOfWeek | No | |
CompanyId | form | Guid | Yes | |
ServicePriceId | form | int | Yes | |
DayOfWeekId | form | int | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Value | |
---|---|---|
Monday | 1 | |
Tuesday | 2 | |
Wednesday | 3 | |
Thursday | 4 | |
Friday | 5 | |
Saturday | 6 | |
Sunday | 7 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RebateCodeTypeId | form | int | No | |
RebateCodeTypeInfo | form | RebateCodeType | No | |
RebateCodeStatusId | form | int | No | |
RebateCodeStatusInfo | form | RebateCodeStatus | No | |
Article | form | Article | No | |
Services | form | List<Service> | No | |
RebateCodeDayOfWeekRelation | form | List<RebateCodeDayOfWeekRelation> | No | |
RebateCodeServiceRelation | form | List<RebateCodeServiceRelation> | No | |
RebateCodeBookingPriceRelation | form | List<RebateCodeBookingPriceRelation> | No | |
RebateCodeCustomerRelation | form | List<RebateCodeCustomerRelation> | No | |
ServicesNames | form | string | No | |
DaysOfWeek | form | List<DaysOfWeek> | No | |
RebateCodeStatus | form | RebateCodeStatus | No | |
RebateCodeType | form | RebateCodeType | No | |
Transactions | form | List<RebateCodeTransaction> | No | |
RemainingAmount | form | double? | No | |
RemainingUsage | form | int? | No | |
CurrentNumberOfUsesPerCustomer | form | int | No | |
IsSpecificByDayOfWeek | form | bool | No | |
Active | form | bool | No | |
ActiveByStatus | form | bool | No | |
RebateCodeCurrencySign | form | string | No | |
CurrencyInfo | form | Currency | No | |
PaymentReceived | form | bool | No | |
InternalReferenceId | form | string | No | |
ValidFrom | form | DateTime | Yes | |
ValidTo | form | DateTime | Yes | |
RebateCodeSign | form | string | Yes | |
RebateCodeValue | form | int | Yes | |
MaxNumberOfUses | form | int | Yes | |
MaxNumberOfUsesPerCustomer | form | int | Yes | |
NumberOfUsesUsed | form | int | Yes | |
PersonalNote | form | string | No | |
CreatedBy | form | string | Yes | |
Created | form | DateTime | Yes | |
UpdatedBy | form | string | Yes | |
UpdatedDate | form | DateTime | Yes | |
FromTime | form | TimeSpan | Yes | |
ToTime | form | TimeSpan | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No | |
ArticleId | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DbFactory | form | IDbConnectionFactory | No | |
QvicklyPaymentManager | form | IBokameraPaymentManager<InitCheckoutRequestBody, QvicklyCheckoutResponse, QvicklyPaymentResponse> | No | |
Payson2PaymentManager | form | IBokameraPaymentManager<Payson2CheckoutResponse, Payson2CheckoutResponse, Payson2CheckoutResponse> | No | |
PaysonPaymentCheckout1 | form | IPaysonPaymentCheckout1 | No | |
Logger | form | ILogger<PayableEntity> | No | |
InternalReferenceId | form | string | No | |
PaymentLog | form | List<PaymentLog> | No | |
CompanyId | form | Guid | No | |
PriceVat | form | decimal? | No | |
CurrencyId | form | string | No | |
Customer | form | Customer | No | |
Customers | form | List<Customer> | No | |
Company | form | Company | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
credentials | form | Credentials | No | |
data | form | InitCheckoutData | No | |
function | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
hash | form | string | No | |
id | form | string | No | |
version | form | string | No | |
client | form | string | No | |
serverdata | form | ServerData | No | |
time | form | string | No | |
test | form | string | No | |
language | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HTTP_HOST | form | string | No | |
HTTP_CONNECTION | form | string | No | |
HTTP_CACHE_CONTROL | form | string | No | |
HTTP_ACCEPT | form | string | No | |
HTTP_USER_AGENT | form | string | No | |
HTTP_ACCEPT_ENCODING | form | string | No | |
HTTP_ACCEPT_LANGUAGE | form | string | No | |
PATH | form | string | No | |
SERVER_SOFTWARE | form | string | No | |
SERVER_NAME | form | string | No | |
SERVER_ADDR | form | string | No | |
SERVER_PORT | form | string | No | |
REMOTE_ADDR | form | string | No | |
REMOTE_PORT | form | string | No | |
GATEWAY_INTERFACE | form | string | No | |
SERVER_PROTOCOL | form | string | No | |
REQUEST_METHOD | form | string | No | |
QUERY_STRING | form | string | No | |
REQUEST_TIME | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CheckoutData | form | CheckoutData | No | |
PaymentData | form | CheckoutPaymentData | No | |
PaymentInfo | form | PaymentInfo | No | |
Articles | form | QvicklyArticle[] | No | |
Cart | form | Cart | No | |
QvicklyCustomer | form | QvicklyCustomer | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
terms | form | Uri | No | |
privacyPolicy | form | Uri | No | |
redirectOnSuccess | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
currency | form | string | No | |
language | form | string | No | |
country | form | string | No | |
autoactivate | form | string | No | |
orderid | form | string | No | |
returnmethod | form | string | No | |
accepturl | form | Uri | No | |
cancelurl | form | Uri | No | |
callbackurl | form | Uri | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
paymentdate | form | string | No | |
paymentterms | form | string | No | |
yourreference | form | string | No | |
ourreference | form | string | No | |
projectname | form | string | No | |
deliverymethod | form | string | No | |
deliveryterms | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
artnr | form | string | No | |
title | form | string | No | |
quantity | form | int | No | |
aprice | form | int | No | |
tax | form | int | No | |
discount | form | int | No | |
withouttax | form | int | No | |
taxrate | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Handling | form | CartHandling | No | |
Total | form | CartTotal | No | |
Shipping | form | Shipping | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
withouttax | form | string | No | |
taxrate | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
rounding | form | string | No | |
withouttax | form | string | No | |
tax | form | string | No | |
withtax | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
firstname | form | string | No | |
lastname | form | string | No | |
company | form | string | No | |
street | form | string | No | |
street2 | form | string | No | |
zip | form | string | No | |
city | form | string | No | |
country | form | string | No | |
phone | form | string | No | |
withouttax | form | string | No | |
taxrate | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
nr | form | string | No | |
pno | form | string | No | |
Billing | form | CustomerBilling | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
firstname | form | string | No | |
lastname | form | string | No | |
company | form | string | No | |
street | form | string | No | |
street2 | form | string | No | |
zip | form | string | No | |
city | form | string | No | |
country | form | string | No | |
phone | form | string | No | |
form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Number | form | int | No | |
Status | form | string | No | |
OrderId | form | string | No | |
Url | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PaymentData | form | QvikclyPaymentData | No | |
PaymentInfo | form | PaymentInfo | No | |
Card | form | Card | No | |
Settlement | form | Settlement | No | |
QvicklyCustomer | form | QvicklyCustomer | No | |
Articles | form | QvicklyArticle[] | No | |
Cart | form | Cart | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
method | form | string | No | |
paymentplanid | form | string | No | |
currency | form | string | No | |
country | form | string | No | |
language | form | string | No | |
autoactivate | form | string | No | |
orderid | form | string | No | |
status | form | string | No | |
paymentid_related | form | string | No | |
url | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
promptname | form | string | No | |
recurring | form | string | No | |
recurringnr | form | string | No | |
accepturl | form | string | No | |
cancelurl | form | string | No | |
callbackurl | form | string | No | |
returnmethod | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
number | form | string | No | |
date | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
ExpirationTime | form | DateTime? | No | |
Snippet | form | string | No | |
Status | form | Payson2CheckoutStatus | No | |
Customer | form | Customer | No | |
Order | form | Order | No | |
Merchant | form | Merchant | No | |
Gui | form | Gui | No | |
History | form | History | No | |
PurchaseId | form | int? | No |
None | |
Created | |
FormsFilled | |
ReadyToPay | |
ProcessingPayment | |
ReadyToShip | |
Shipped | |
PaidToAccount | |
Canceled | |
Credited | |
Expired | |
Denied |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
City | form | string | No | |
CountryCode | form | string | No | |
IdentityNumber | form | string | No | |
form | string | No | ||
FirstName | form | string | No | |
LastName | form | string | No | |
Phone | form | string | No | |
PostalCode | form | string | No | |
Street | form | string | No | |
Reference | form | string | No | |
Type | form | CustomerType | No |
Person | |
Business |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Currency | form | Currency | No | |
TotalFeeExcludingTax | form | decimal | No | |
TotalFeeIncludingTax | form | decimal | No | |
TotalPriceExcludingTax | form | decimal | No | |
TotalPriceIncludingTax | form | decimal | No | |
TotalTaxAmount | form | decimal | No | |
TotalCreditedAmount | form | decimal | No | |
Items | form | IList<Item> | No |
Name | Value | |
---|---|---|
SEK | 1 | |
EUR | 2 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ItemId | form | Guid | No | |
DiscountRate | form | decimal | No | |
Ean | form | string | No | |
ImageUri | form | Uri | No | |
Name | form | string | No | |
Quantity | form | decimal | No | |
Reference | form | string | No | |
TaxRate | form | decimal | No | |
TotalPriceExcludingTax | form | decimal | No | |
TotalPriceIncludingTax | form | decimal | No | |
TotalTaxAmount | form | decimal | No | |
CreditedAmount | form | decimal | No | |
Type | form | ItemType | No | |
UnitPrice | form | decimal | No | |
Uri | form | Uri | No |
Physical | |
Service | |
Fee | |
Discount |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CheckoutUri | form | Uri | No | |
ConfirmationUri | form | Uri | No | |
NotificationUri | form | Uri | No | |
ValidationUri | form | Uri | No | |
TermsUri | form | Uri | No | |
Reference | form | string | No | |
PartnerId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ColorScheme | form | ColorScheme | No | |
Locale | form | string | No | |
RequestPhone | form | bool | No | |
PhoneOptional | form | bool | No |
White | |
Blue | |
Gray | |
GrayTextLogos | |
BlueTextLogos | |
WhiteTextLogos | |
WhiteNoFooter | |
GrayNoFooter | |
BlueNoFooter |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Created | form | DateTime? | No | |
ReadyToPay | form | DateTime? | No | |
ReadyToShip | form | DateTime? | No | |
Shipped | form | DateTime? | No | |
PaidToAccount | form | DateTime? | No | |
Canceled | form | DateTime? | No | |
Expired | form | DateTime? | No | |
Denied | form | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CurrencyId | form | string | No | |
CurrencyInfo | form | Currency | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
InternalReferenceId | form | string | Yes | |
ArticleTypeId | form | int | Yes | |
PaymentReferenceId | form | string | No | |
PaymentProviderId | form | int? | No | |
OrderItemReferenceId | form | string | No | |
Amount | form | double? | No | |
VAT | form | decimal? | No | |
AmountCredited | form | double? | No | |
Comments | form | string | No | |
Created | form | DateTime | Yes | |
Updated | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IdentityId | form | int | No | |
Id | form | Guid | No | |
CustomerId | form | Guid | No | |
AccessKeys | form | IList<UserAccessKeys> | No | |
form | string | No | ||
ExternalReferences | form | IList<ExternalReference> | No | |
Company | form | Company | No | |
CustomFieldsConfig | form | IList<CustomFieldConfig> | No | |
CustomFieldsData | form | IList<CustomFieldDataResponse> | No | |
Comments | form | IList<CustomerComment> | No | |
RebateCodes | form | IList<RebateCode> | No | |
Firstname | form | string | No | |
ImageUrl | form | string | No | |
Active | form | bool | Yes | |
FacebookUsername | form | string | No | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
IpAddress | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
TextField1 | form | string | No | |
TextField2 | form | string | No | |
TextField3 | form | string | No | |
TextField4 | form | string | No | |
TextField5 | form | string | No | |
TextField6 | form | string | No | |
TextField7 | form | string | No | |
TextField8 | form | string | No | |
TextField9 | form | string | No | |
TextField10 | form | string | No | |
TextField11 | form | string | No | |
TextField12 | form | string | No | |
TextField13 | form | string | No | |
TextField14 | form | string | No | |
TextField15 | form | string | No | |
TextField16 | form | string | No | |
TextField17 | form | string | No | |
TextField18 | form | string | No | |
TextField19 | form | string | No | |
TextField20 | form | string | No | |
UserId | form | Guid | No | |
Lastname | form | string | No | |
Phone | form | string | No | |
CorporateIdentityNumber | form | string | No | |
InvoiceAddress1 | form | string | No | |
InvoiceAddress2 | form | string | No | |
InvoiceCity | form | string | No | |
InvoicePostalCode | form | string | No | |
InvoiceCountryCode | form | string | No | |
CompanyId | form | Guid | Yes | |
SubscribedToNewsletter | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
AccessKeyTypeId | form | int | Yes | |
Value | form | string | Yes | |
CustomerId | form | Guid | Yes | |
Description | form | string | No | |
Id | form | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
Id | form | Guid | Yes | |
OwnerId | form | Guid | Yes | |
ReferenceType | form | string | Yes | |
ExternalData | form | string | No | |
CreatedBy | form | string | No | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | CompanyStatus | No | |
Active | form | bool | No | |
CustomerCustomFieldsConfig | form | IList<CustomFieldConfig> | No | |
BookingAgreements | form | string | No | |
BookingSettings | form | BookingSettings | No | |
CompanyType | form | CompanyType | No | |
CodeLockSettings | form | CodeLockSetting | No | |
PaymentSettings | form | PaymentSetting | No | |
Settings | form | CompanySetting | No | |
WidgetSettings | form | HomepageWidgetSetting | No | |
HomepageSettings | form | HomepageSetting | No | |
RatingScore | form | AverageRatingScore | No | |
Ratings | form | List<Rating> | No | |
Distance | form | double? | No | |
Licenses | form | List<License> | No | |
ActiveLicenses | form | List<License> | No | |
CurrentLicense | form | License | No | |
IsFreeAccount | form | bool | No | |
DefaultLanguage | form | CultureInfo | No | |
Category | form | CompanyCategory | No | |
Lat | form | double | No | |
Lon | form | double | No | |
IsFavorite | form | bool | No | |
ExternalReferences | form | IList<ExternalReference> | No | |
OrganisationNumber | form | string | Yes | |
StatusId | form | int | Yes | |
CategoryId | form | int | Yes | |
SitePath | form | string | Yes | |
Name | form | string | Yes | |
Street1 | form | string | No | |
Street2 | form | string | No | |
ZipCode | form | string | No | |
City | form | string | No | |
OpeningHours | form | string | No | |
FaxNumber | form | string | No | |
form | string | Yes | ||
Phone | form | string | No | |
Details | form | string | No | |
LogoType | form | string | No | |
ApprovedByAdmin | form | bool | Yes | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
IpAddress | form | string | No | |
Homepage | form | string | No | |
DomainName | form | string | No | |
CountryId | form | string | Yes | |
CompanyOwnerId | form | int | Yes | |
TypeId | form | int? | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | Guid | Yes |
Name | Value | |
---|---|---|
Registered | 1 | |
AwaitingApproval | 2 | |
Approved | 3 | |
Inactive | 4 | |
ClosedDown | 5 | |
NotApproved | 6 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FreeSpotTextsId | form | int | No | |
SendEmailConfirmation | form | bool | No | |
ScheduleViewOptions | form | List<ScheduleView> | No | |
WeekNumberSettingOptions | form | List<WeekNumberSetting> | No | |
BookingTemplateOptions | form | List<BookingTemplate> | No | |
CalendarTypeOptions | form | List<CalendarType> | No | |
FreeSpotTextOptions | form | List<FreeSpotTexts> | No | |
BookingStatusOptions | form | List<BookingStatusOptions> | No | |
FreeSpotTextsInfo | form | FreeSpotTexts | No | |
FreeSpotsTextSingular | form | string | No | |
FreeSpotsTextPlural | form | string | No | |
BookingStatusId | form | int | Yes | |
ScheduleViewId | form | int | Yes | |
BookingTemplateId | form | int | Yes | |
CalendarTypeId | form | int | Yes | |
AllowBookingOnUnbookedTimes | form | bool | Yes | |
SendEmailReminder | form | bool | Yes | |
SendSmsReminder | form | bool | Yes | |
SendSmsConfirmation | form | bool | Yes | |
EmailReminderTime | form | int | Yes | |
SmsReminderTime | form | int | Yes | |
MaxActiveBookings | form | int | Yes | |
SendNotifications | form | bool | Yes | |
SendNotificationsEmail | form | string | No | |
EnableMobileApp | form | bool | Yes | |
ScheduleStartTime | form | TimeSpan? | No | |
ScheduleEndTime | form | TimeSpan? | No | |
ReceiptTemplate | form | string | No | |
ScheduleTimeSlotMinutes | form | int | Yes | |
ShowFreeTimesLeft | form | bool | Yes | |
EnableICalGroupBookings | form | bool | Yes | |
AgreementTemplate | form | string | No | |
ScheduleShowTimeExeptions | form | bool | Yes | |
EnableBookingsOnSameTime | form | bool | Yes | |
ShowWeekNumberSettingId | form | int | Yes | |
EnableShowBookedTimes | form | bool | Yes | |
EnableSendFollowUpMessage | form | bool | Yes | |
FollowUpMessageTime | form | int | Yes | |
MessageText | form | string | No | |
ScheduleGroupResources | form | bool | Yes | |
BookSpotUserResponseMinutes | form | int | Yes | |
IsBookSpotDirectly | form | bool | Yes | |
BookSpotDirectlyTimeLeftMinutes | form | int | Yes | |
SendEmailNotificationQueue | form | bool | Yes | |
SendSMSNotificationQueue | form | bool | Yes | |
SchedulerDisableHorizontalScrolling | form | bool | Yes | |
BookOnlyOnExistingCustomers | form | bool | Yes | |
AutoGenerateUniquePinCode | form | bool | Yes | |
WeightedPrices | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
AutoCreateUserProfile | form | bool | Yes | |
ShowMultipleResourcesAsOne | form | bool | No | |
ShowMultiDayAsTime | form | bool | No | |
Id | form | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
UsedByApplication | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
Active | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TextSingular | form | string | Yes | |
TextPlural | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CodeLockSystemOptions | form | List<CodeLockSystem> | No | |
Active | form | bool | Yes | |
CodeLockSystemsId | form | int | Yes | |
ValidBeforeMinutes | form | int | Yes | |
ValidAfterMinutes | form | int | Yes | |
DeleteOldBySchedule | form | bool | Yes | |
Created | form | DateTime | Yes | |
Updated | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
SendEmailNotification | form | bool | Yes | |
SendSMSNotification | form | bool | Yes | |
EmailNotificationTime | form | short | Yes | |
SMSNotificationTime | form | short | Yes | |
Id | form | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Supplier | form | string | Yes | |
LogoType | form | string | No | |
Description | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AdminPaymentOption | form | AdminPaymentOptions | No | |
AdminPaymentOptions | form | List<AdminPaymentOptions> | No | |
PaymentProviderOptions | form | List<PaymentProviders> | No | |
Enabled | form | bool | Yes | |
InvoiceFee | form | int | Yes | |
AllowCreditCardPayment | form | bool | Yes | |
AllowInvoicePayment | form | bool | Yes | |
AllowBankPayment | form | bool | Yes | |
GuaranteeOffered | form | bool | Yes | |
RefundOnCancelBooking | form | bool | Yes | |
DefaultPaymentOptionId | form | int? | No | |
PaymentProviderId | form | int | Yes | |
SendPaymentRequestDirectly | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
Category | form | string | Yes | |
Url | form | string | No | |
Active | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Languages | form | List<LanguageResponse> | No | |
Active | form | bool | Yes | |
InactiveMessage | form | string | No | |
Searchable | form | bool | Yes | |
GATrackingId | form | string | No | |
FacebookPixelId | form | string | No | |
MultiLanguage | form | bool | Yes | |
EnableAPITranslation | form | bool | Yes | |
DefaultLanguage | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
GTMTrackingId | form | string | No | |
ShowOnMarketPlace | form | bool | Yes | |
GoogleAdsConversionId | form | string | No | |
LinkedinTagId | form | string | No | |
GoogleAdsConversionLabel | form | string | No | |
SendCustomerInformationToExternalProviders | form | bool | No | |
Id | form | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
WidgetServiceLayoutOptions | form | List<WidgetServiceLayouts> | No | |
WidgetTimeLayoutOptions | form | List<WidgetTimeLayouts> | No | |
WidgetBookingLayoutOptions | form | List<WidgetBookingLayouts> | No | |
WidgetBookingMethodOptions | form | List<WidgetBookingMethods> | No | |
ServiceLayoutId | form | int | Yes | |
TimeLayoutId | form | int | Yes | |
BookingLayoutId | form | int | Yes | |
PrimaryColor | form | string | Yes | |
ShowServiceImage | form | bool | Yes | |
ShowNextAvailableTime | form | bool | Yes | |
ShowEndTime | form | bool | Yes | |
BookedTimeSlotText | form | string | No | |
DarkTheme | form | bool | Yes | |
ShowRebateCodeField | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
EnableCreateAccount | form | bool | Yes | |
EnableLogin | form | bool | Yes | |
EnableDirectBooking | form | bool | Yes | |
EnableFacebookLogin | form | bool | Yes | |
ShowSubscribeToNewsletter | form | bool | Yes | |
Id | form | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
Code | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
Code | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
Code | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
Code | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HomepageTemplateOptions | form | List<HomepageTemplate> | No | |
HomepageHeroSectionStyleOptions | form | List<HeroSectionStyle> | No | |
CompanyId | form | Guid? | No | |
WelcomePageHeading | form | string | No | |
WelcomePageBody | form | string | No | |
AboutUsPageHeading | form | string | No | |
AboutUsPageBody | form | string | No | |
HomePageTemplateId | form | int | Yes | |
ImageUrl | form | string | No | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
HomepageHeading | form | string | No | |
HeroSectionStyleId | form | int | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
ShowRating | form | bool | Yes | |
EnableHomepage | form | bool | Yes | |
Id | form | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
ImageUrl | form | Uri | No | |
Premium | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AverageScore | form | double | No | |
Score1Count | form | int | No | |
Score2Count | form | int | No | |
Score3Count | form | int | No | |
Score4Count | form | int | No | |
Score5Count | form | int | No | |
Count | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReviewId | form | Guid? | No | |
Review | form | Review | No | |
CompanyId | form | Guid | Yes | |
BookingId | form | int | Yes | |
RatingScore | form | int | Yes | |
Status | form | int | Yes | |
Created | form | DateTime | Yes | |
Updated | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReviewId | form | Guid | No | |
CompanyId | form | Guid | Yes | |
Title | form | string | Yes | |
Description | form | string | Yes | |
Author | form | string | Yes | |
Status | form | int | Yes | |
Created | form | DateTime | Yes | |
Updated | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
ReviewAnswer | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | LicenseType | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
TypeId | form | int | Yes | |
ValidFrom | form | DateTime | Yes | |
ValidTo | form | DateTime | Yes | |
Active | form | bool | Yes | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
MetaData | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LicenseItems | form | IList<LicenseTypeItem> | No | |
Prices | form | IList<LicensePrice> | No | |
PeriodOfNoticeDays | form | int | No | |
NextLicenseOption | form | LicenseType | No | |
Name | form | string | Yes | |
Description | form | string | Yes | |
ExtraLicenseOption | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Active | form | bool | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
LicenseType | form | LicenseType | No | |
LicenseTypesId | form | int | Yes | |
LicenseItemsId | form | int | Yes | |
NumberOfItems | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Country | form | Country | No | |
MonthlyPayment | form | bool | No | |
LicenseTypeId | form | int | Yes | |
CountryId | form | string | Yes | |
Price | form | int | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CurrencyId | form | string | No | |
CurrencyInfo | form | Currency | No | |
Name | form | string | Yes | |
Culture | form | string | No | |
TimeZone | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Header | form | string | Yes | |
Description | form | string | Yes | |
ImageUrl | form | Uri | No | |
Active | form | bool | Yes | |
SortOrder | form | int? | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Column | form | string | No | |
Name | form | string | No | |
Description | form | string | No | |
Value | form | string | No | |
DataType | form | string | No | Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
CustomerId | form | Guid | Yes | |
Comments | form | string | Yes | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
ImageUrl | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Company | form | Company | No | |
CurrencyInfo | form | Currency | No | |
ArticleServiceRelations | form | List<ArticleServiceRelation> | No | |
ServiceIds | form | List<int> | No | |
ArticleType | form | ArticleTypeEnum | No | |
ArticleTypeName | form | string | No | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
Name | form | string | Yes | |
ArticleTypeId | form | int | Yes | |
Description | form | string | No | |
ImageUrl | form | string | No | |
Active | form | bool | Yes | |
Amount | form | int | Yes | |
Price | form | double | Yes | |
CurrencyId | form | string | Yes | |
UpdatedDate | form | DateTime | Yes | |
CreatedDate | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
ServiceId | form | int | Yes | |
ArticleId | form | int | Yes |
Name | Value | |
---|---|---|
ServiceArticle | 1 | |
StandAloneArticle | 2 | |
RebateCodePunchTicketArticle | 3 | |
RebateCodeGiftCardArticle | 4 | |
RebateCodeValueCardArticle | 5 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DayOfWeek | form | BokaMeraDayOfWeek | No | |
DayOfWeekId | form | int | Yes | |
RebateCodeId | form | int | Yes | |
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
ServiceId | form | int | Yes | |
RebateCodeId | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
PriceId | form | int | Yes | |
RebateCodeId | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
CustomerId | form | Guid | Yes | |
RebateCodeId | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No | |
RebateCodeEmailSentToCustomer | form | bool | No | |
MessageToReceiver | form | string | No | |
Buyer | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DayOfWeek | form | string | Yes | |
DayOfWeekTranslation | form | string | Yes | |
DayOfWeekActive | form | bool? | No | |
DayOfWeekSortOrder | form | short? | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Booking | form | Booking | No | |
RebateCode | form | RebateCode | No | |
Customer | form | Customer | No | |
Id | form | int | No | |
CompanyId | form | Guid | No | |
Note | form | string | No | |
RebateCodeId | form | int | Yes | |
Amount | form | double | Yes | |
Usage | form | int | Yes | |
BookingId | form | int? | No | |
UpdatedDate | form | DateTime | Yes | |
CreatedDate | form | DateTime | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Service | form | Service | No | |
CalendarExport | form | CalendarExport | No | |
Log | form | List<BookingLog> | No | |
CheckoutLogs | form | List<PaymentDetails> | No | |
Prices | form | List<BookingPrice> | No | |
Status | form | BookingStatusEnum | No | |
IsReserved | form | bool | No | |
StatusName | form | string | No | |
CurrencyInfo | form | Currency | No | |
BookingStatus | form | BookingStatus | No | |
TotalPrice | form | double? | No | |
TotalSpots | form | int? | No | |
Resources | form | IList<Resource> | No | |
ExternalReferences | form | IList<ExternalReference> | No | |
BookedResources | form | IList<BookedResourceType> | No | |
CustomFieldsConfig | form | IList<CustomFieldConfig> | No | |
CustomFieldsData | form | IList<CustomFieldDataResponse> | No | |
DeterministicId | form | Guid | No | |
Active | form | bool | No | |
LastTimeToUnBook | form | DateTime? | No | |
PriceMappings | form | List<PriceMapping> | No | |
InternalReferenceId | form | string | No | |
UpdatedDate | form | DateTime | Yes | |
CreatedDate | form | DateTime | Yes | |
Id | form | int | No | |
CustomerId | form | Guid | Yes | |
ServiceId | form | int | Yes | |
StatusId | form | int | Yes | |
UnbookedOn | form | DateTime? | No | |
UnbookedComments | form | string | No | |
BookedComments | form | string | No | |
BookedBy | form | string | Yes | |
UnBookedBy | form | string | No | |
SendSmsReminder | form | bool | Yes | |
SendEmailReminder | form | bool | Yes | |
SendSmsConfirmation | form | bool | Yes | |
RebateCode | form | string | No | |
Comments | form | string | No | |
IpAddress | form | string | No | |
NumberOfBookedSpots | form | int | Yes | |
CommentsToCustomer | form | string | No | |
PaymentExpiration | form | DateTime? | No | |
SendEmailConfirmation | form | bool | Yes | |
CancellationCode | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
RatingCode | form | string | No | |
TextField1 | form | string | No | |
TextField2 | form | string | No | |
TextField3 | form | string | No | |
TextField4 | form | string | No | |
TextField5 | form | string | No | |
TextField6 | form | string | No | |
TextField7 | form | string | No | |
TextField8 | form | string | No | |
TextField9 | form | string | No | |
TextField10 | form | string | No | |
TextField11 | form | string | No | |
TextField12 | form | string | No | |
TextField13 | form | string | No | |
TextField14 | form | string | No | |
TextField15 | form | string | No | |
TextField16 | form | string | No | |
TextField17 | form | string | No | |
TextField18 | form | string | No | |
TextField19 | form | string | No | |
TextField20 | form | string | No | |
From | form | DateTime | Yes | |
To | form | DateTime | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
BookingId | form | int | Yes | |
ExceptionId | form | int | Yes | |
CalendarSync | form | bool? | No | |
CalendarId | form | string | No | |
IsExceptionDeleted | form | bool? | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EventTypeId | form | int | No | |
EventType | form | BookingLogEventType | No | |
CompanyId | form | Guid | Yes | |
BookingId | form | int | Yes | |
Id | form | int | No | |
Comments | form | string | No | |
UserId | form | string | No | |
Created | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
QvicklyCheckoutSerialized | form | QvicklyCheckoutResponse | No | |
Payson2CheckoutSerialized | form | Payson2CheckoutResponse | No | |
CompanyId | form | Guid | Yes | |
InternalReferenceId | form | string | Yes | |
ArticleTypeId | form | int | Yes | |
ExternalResponseData | form | string | Yes | |
ExternalResponseReference | form | string | Yes | |
PaymentProviderId | form | int | Yes | |
CreatedDate | form | DateTime | Yes | |
UpdatedDate | form | DateTime | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CurrencyId | form | string | No | |
PriceId | form | int? | No | |
CurrencyInfo | form | Currency | No | |
PriceText | form | string | No | |
AppliedCodes | form | List<AppliedRebateCodes> | No | |
IsRebate | form | bool | No | |
CompanyId | form | Guid | Yes | |
BookingId | form | int | Yes | |
Quantity | form | int | Yes | |
Price | form | double? | No | |
VAT | form | decimal? | No | |
Category | form | string | No | |
Updated | form | DateTime | Yes | |
Created | form | DateTime | Yes | |
Invoiced | form | bool | Yes | |
OccupiesSpot | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Description | form | string | Yes | |
Color | form | string | Yes | |
Icon | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The resource type id |
Name | form | string | No | The resource type name |
Resources | form | List<BookedResource> | No | The resources inside resource type |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
Color | form | string | No | |
ImageUrl | form | Uri | No | |
form | string | No | ||
MobilePhone | form | string | No | |
AccessGroup | form | string | No | |
EmailNotification | form | bool | No | |
SMSNotification | form | bool | No | |
EmailReminder | form | bool | No | |
SMSReminder | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
CustomFieldConfigId | form | int | Yes | |
ServiceId | form | int | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
RecurringScheduleId | form | int | Yes | |
ResourceId | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DayOfWeek | form | BokaMeraDayOfWeek | No | |
DayOfWeekId | form | int | Yes | |
CompanyId | form | Guid | Yes | |
RecurringScheduleId | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
ServiceId | form | int | Yes | |
RecurringScheduleId | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
RecurringScheduleId | form | int | Yes | |
Id | form | int | No | |
ModifiedDate | form | DateTimeOffset? | No | |
StartTime | form | TimeSpan | Yes | |
EndTime | form | TimeSpan | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StartTime | form | TimeSpan | No | |
EndTime | form | TimeSpan | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The schedule id |
Name | form | string | No | Name of the schedule |
Description | form | string | No | Description of the schedule |
Active | form | bool | No | If the schedule is active or not |
TimeInterval | form | int | Yes | Time interval for available times Here you set the interval at which times should appear. For example, if you select the range 15minutes, and your service has an duration of 1 hour and opening hours are 9AM to 6PM you will see the following suggested times: 09AM-10PM 09:15AM-10:15PM, 09:30AM-10:30PM , ..... 04:45PM-05:45, 05:00PM-06:00PM |
ValidFrom | form | DateTime | Yes | The timestamp to which the schedule is valid from |
ValidTo | form | DateTime | Yes | The timestamp to which the schedule is valid to |
StartTime | form | TimeSpan | Yes | The time for the schedule opening hours (starttime) |
EndTime | form | TimeSpan | Yes | The time for the schedule opening hours (endtime) |
NumberOfScheduleDays | form | int | Yes | The number of days the schedule is valid from todays date |
IsResourceSpecific | form | bool? | Yes | If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this. |
UpdatedDate | form | DateTime | Yes | The timestamp when the schedule was updated |
CreatedDate | form | DateTime | Yes | The timestamp when the schedule was created |
EnableBookingUntilClosingTime | form | bool | Yes | Allow bookings end time exceeds the opening hours Here you can choose whether it should be possible to make a reservation exceeding the opening hours. This should be ticked when a service duration is longer than 24 hours (possible to book over midnight). |
DaysOfWeek | form | List<DayOfWeekDto> | No | If recurring, an array indicating which days of the week the exception recures on where 1 = Monday .. 7 = Sunday. When recurring then the time portion of the Fields From and To indicates the time of day the recurrence occurs |
Resources | form | List<ScheduleResources> | No | The resources that is connected to the schedule |
Services | form | List<ScheduleServices> | No | The services that is connected to the schedule |
Exceptions | form | List<RecurringScheduleExceptionResponse> | No | The exceptions that is added to the schedule |
ScheduleDates | form | List<RecurringScheduleDateResponse> | No | Schedule dates, used when the schedule is not a rolling schedule using days of week |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DayOfWeekId | form | int | No | |
DotNetDayOfWeekId | form | int | No | |
DayOfWeek | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | Name of the resource |
ImageUrl | form | Uri | No | The image url of the resource |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | Name of the service |
ImageUrl | form | Uri | No | The image url of the service |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StartTime | form | TimeSpan | No | Start time of the schedule exception. |
EndTime | form | TimeSpan | No | End time of the schedule exception. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Date | form | DateTime | No | |
StartTime | form | TimeSpan | No | |
EndTime | form | TimeSpan | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<AccessKeyTypeResponse> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
KeyType | form | string | No | |
Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /schedules/recurring HTTP/1.1 Host: api.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","Active":false,"TimeInterval":0,"StartTime":"00:00:00","EndTime":"00:00:00","NumberOfScheduleDays":0,"IsResourceSpecific":false,"EnableBookingUntilClosingTime":false,"DaysOfWeek":[{"DayOfWeekId":0,"DotNetDayOfWeekId":0,"DayOfWeek":"String"}],"Resources":[{"Id":0,"Name":"String"}],"Services":[{"Id":0,"Name":"String"}],"Exceptions":[{"StartTime":"00:00:00","EndTime":"00:00:00"}],"ScheduleDates":[{"Id":0,"StartTime":"00:00:00","EndTime":"00:00:00","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}