BokaMera.API.Host

<back to all web services

GroupedServiceQuery

The following routes are available for this service:

GET	/services/grouped

GroupedServiceQuery Parameters:

Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	Company to show services for
Active	query	boolean	No	Service status
IncludeResources	query	bool	No	If you want to include the connected resource types and resources
IncludeSchedules	query	boolean	No	If you want to include the connected schedules
IncludeCustomFields	query	boolean	No	If you want to include the connected custom fields
IncludeCustomFieldValues	query	boolean	No	If you want to include the connected resource types and resources
IncludeBookingCustomFields	query	boolean	No	If you want to include the connected custom fields needs to be entered when booking a new time on the service
IncludeCustomerCustomFields	query	boolean	No	If you want to include the connected custom fields for the customers
IncludePrices	query	boolean	No	If you want to include the service prices
PriceDate	query	dateTime	No	If you have selected to include the prices, here you can set the date to show the prices for
PriceTime	query	timeSpan	No	If you have selected to include the prices, here you can set the datetime to show the exact price

QueryBase Parameters:

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

Service Parameters:

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

ResourceType Parameters:

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

Resource Parameters:

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
Email	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

ISchedule Parameters:

Name	Parameter	Data Type	Required	Description
Resources	form	IList<Resource>	No
Type	form	ScheduleType	No
Active	form	bool	No
IsResourceSpecific	form	bool	No

ScheduleType Enum:

NotDefined
RecurringSchedule
DateSchedule

ITimeException Parameters:

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

IBookedTime Parameters:

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

BookingStatusEnum Enum:

Name	Value
Booked	1
Unbooked	2
Reserved	3
Canceled	4
AwaitingPayment	5
AwaitingPaymentNoTimeLimit	6
Payed	7
AwaitingPaymentRequestFromAdmin	8
AwaitingPaymentFromProvider	9
Invoiced	10

BookedCustomer Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	Guid	No
Firstname	form	string	No
Lastname	form	string	No
Email	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

CustomFieldConfig Parameters:

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

CustomFieldValue Parameters:

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

CustomField Parameters:

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

RegEx Parameters:

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

CustomFieldServiceRelation Parameters:

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

CustomFieldDataResponse Parameters:

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'

TotalPriceInformation Parameters:

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

AppliedRebateCodes Parameters:

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

RebateCodeType Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
Description	form	string	No
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

ServicePrice Parameters:

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

Currency Parameters:

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

PriceMapping Parameters:

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

ServicePriceDayOfWeekRelation Parameters:

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

BokaMeraDayOfWeek Enum:

Name	Value
Monday	1
Tuesday	2
Wednesday	3
Thursday	4
Friday	5
Saturday	6
Sunday	7

RebateCode Parameters:

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

PayableEntity Parameters:

Name	Parameter	Data Type	Required	Description
DbFactory	form	IDbConnectionFactory	No
QvicklyPaymentManager	form	IBokameraPaymentManager<InitCheckoutRequestBody, QvicklyCheckoutResponse, QvicklyPaymentResponse>	No
Payson2PaymentManager	form	IBokameraPaymentManager<Payson2CheckoutResponse, Payson2CheckoutResponse, Payson2CheckoutResponse>	No
StripePaymentManager	form	IBokameraPaymentManager<SessionCreateOptions, CustomSessionData, CustomSessionData>	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

InitCheckoutRequestBody Parameters:

Name	Parameter	Data Type	Required	Description
credentials	form	Credentials	No
data	form	InitCheckoutData	No
function	form	string	No

Credentials Parameters:

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

ServerData Parameters:

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

InitCheckoutData Parameters:

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

CheckoutData Parameters:

Name	Parameter	Data Type	Required	Description
terms	form	Uri	No
privacyPolicy	form	Uri	No
redirectOnSuccess	form	string	No

CheckoutPaymentData Parameters:

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

PaymentInfo Parameters:

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

QvicklyArticle Parameters:

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

Cart Parameters:

Name	Parameter	Data Type	Required	Description
Handling	form	CartHandling	No
Total	form	CartTotal	No
Shipping	form	Shipping	No

CartHandling Parameters:

Name	Parameter	Data Type	Required	Description
withouttax	form	string	No
taxrate	form	string	No

CartTotal Parameters:

Name	Parameter	Data Type	Required	Description
rounding	form	string	No
withouttax	form	string	No
tax	form	string	No
withtax	form	string	No

Shipping Parameters:

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

QvicklyCustomer Parameters:

Name	Parameter	Data Type	Required	Description
nr	form	string	No
pno	form	string	No
Billing	form	CustomerBilling	No

CustomerBilling Parameters:

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
email	form	string	No

QvicklyCheckoutResponse Parameters:

Name	Parameter	Data Type	Required	Description
Number	form	int	No
Status	form	string	No
OrderId	form	string	No
Url	form	string	No

QvicklyPaymentResponse Parameters:

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

QvikclyPaymentData Parameters:

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

Card Parameters:

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

Settlement Parameters:

Name	Parameter	Data Type	Required	Description
number	form	string	No
date	form	string	No

Payson2CheckoutResponse Parameters:

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

Payson2CheckoutStatus Enum:

None
Created
FormsFilled
ReadyToPay
ProcessingPayment
ReadyToShip
Shipped
PaidToAccount
Canceled
Credited
Expired
Denied

Customer Parameters:

Name	Parameter	Data Type	Required	Description
City	form	string	No
CountryCode	form	string	No
IdentityNumber	form	string	No
Email	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

CustomerType Enum:

Person
Business

Order Parameters:

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

Currency Enum:

Name	Value
SEK	1
EUR	2

Item Parameters:

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

ItemType Enum:

Physical
Service
Fee
Discount

Merchant Parameters:

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

Gui Parameters:

Name	Parameter	Data Type	Required	Description
ColorScheme	form	ColorScheme	No
Locale	form	string	No
RequestPhone	form	bool	No
PhoneOptional	form	bool	No

ColorScheme Enum:

White
Blue
Gray
GrayTextLogos
BlueTextLogos
WhiteTextLogos
WhiteNoFooter
GrayNoFooter
BlueNoFooter

History Parameters:

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

SessionCreateOptions Parameters:

Name	Parameter	Data Type	Required	Description
AfterExpiration	form	SessionAfterExpirationOptions	No
AllowPromotionCodes	form	bool?	No
AutomaticTax	form	SessionAutomaticTaxOptions	No
BillingAddressCollection	form	string	No
CancelUrl	form	string	No
ClientReferenceId	form	string	No
ConsentCollection	form	SessionConsentCollectionOptions	No
Currency	form	string	No
CustomFields	form	List<SessionCustomFieldOptions>	No
CustomText	form	SessionCustomTextOptions	No
Customer	form	string	No
CustomerCreation	form	string	No
CustomerEmail	form	string	No
CustomerUpdate	form	SessionCustomerUpdateOptions	No
Discounts	form	List<SessionDiscountOptions>	No
ExpiresAt	form	DateTime?	No
InvoiceCreation	form	SessionInvoiceCreationOptions	No
LineItems	form	List<SessionLineItemOptions>	No
Locale	form	string	No
Metadata	form	Dictionary<string, string>	No
Mode	form	string	No
PaymentIntentData	form	SessionPaymentIntentDataOptions	No
PaymentMethodCollection	form	string	No
PaymentMethodConfiguration	form	string	No
PaymentMethodData	form	SessionPaymentMethodDataOptions	No
PaymentMethodOptions	form	SessionPaymentMethodOptionsOptions	No
PaymentMethodTypes	form	List<string>	No
PhoneNumberCollection	form	SessionPhoneNumberCollectionOptions	No
RedirectOnCompletion	form	string	No
ReturnUrl	form	string	No
SavedPaymentMethodOptions	form	SessionSavedPaymentMethodOptionsOptions	No
SetupIntentData	form	SessionSetupIntentDataOptions	No
ShippingAddressCollection	form	SessionShippingAddressCollectionOptions	No
ShippingOptions	form	List<SessionShippingOptionOptions>	No
SubmitType	form	string	No
SubscriptionData	form	SessionSubscriptionDataOptions	No
SuccessUrl	form	string	No
TaxIdCollection	form	SessionTaxIdCollectionOptions	No
UiMode	form	string	No

BaseOptions Parameters:

Name	Parameter	Data Type	Required	Description
Expand	form	List<string>	No
ExtraParams	form	IDictionary<string, Object>	No

SessionAfterExpirationOptions Parameters:

Name	Parameter	Data Type	Required	Description
Recovery	form	SessionAfterExpirationRecoveryOptions	No

SessionAfterExpirationRecoveryOptions Parameters:

Name	Parameter	Data Type	Required	Description
AllowPromotionCodes	form	bool?	No
Enabled	form	bool?	No

SessionAutomaticTaxOptions Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool?	No
Liability	form	SessionAutomaticTaxLiabilityOptions	No

SessionAutomaticTaxLiabilityOptions Parameters:

Name	Parameter	Data Type	Required	Description
Account	form	string	No
Type	form	string	No

SessionConsentCollectionOptions Parameters:

Name	Parameter	Data Type	Required	Description
PaymentMethodReuseAgreement	form	SessionConsentCollectionPaymentMethodReuseAgreementOptions	No
Promotions	form	string	No
TermsOfService	form	string	No

SessionConsentCollectionPaymentMethodReuseAgreementOptions Parameters:

Name	Parameter	Data Type	Required	Description
Position	form	string	No

SessionCustomFieldOptions Parameters:

Name	Parameter	Data Type	Required	Description
Dropdown	form	SessionCustomFieldDropdownOptions	No
Key	form	string	No
Label	form	SessionCustomFieldLabelOptions	No
Numeric	form	SessionCustomFieldNumericOptions	No
Optional	form	bool?	No
Text	form	SessionCustomFieldTextOptions	No
Type	form	string	No

SessionCustomFieldDropdownOptions Parameters:

Name	Parameter	Data Type	Required	Description
DefaultValue	form	string	No
Options	form	List<SessionCustomFieldDropdownOptionOptions>	No

SessionCustomFieldDropdownOptionOptions Parameters:

Name	Parameter	Data Type	Required	Description
Label	form	string	No
Value	form	string	No

SessionCustomFieldLabelOptions Parameters:

Name	Parameter	Data Type	Required	Description
Custom	form	string	No
Type	form	string	No

SessionCustomFieldNumericOptions Parameters:

Name	Parameter	Data Type	Required	Description
DefaultValue	form	string	No
MaximumLength	form	long?	No
MinimumLength	form	long?	No

SessionCustomFieldTextOptions Parameters:

Name	Parameter	Data Type	Required	Description
DefaultValue	form	string	No
MaximumLength	form	long?	No
MinimumLength	form	long?	No

SessionCustomTextOptions Parameters:

Name	Parameter	Data Type	Required	Description
AfterSubmit	form	SessionCustomTextAfterSubmitOptions	No
ShippingAddress	form	SessionCustomTextShippingAddressOptions	No
Submit	form	SessionCustomTextSubmitOptions	No
TermsOfServiceAcceptance	form	SessionCustomTextTermsOfServiceAcceptanceOptions	No

SessionCustomTextAfterSubmitOptions Parameters:

Name	Parameter	Data Type	Required	Description
Message	form	string	No

SessionCustomTextShippingAddressOptions Parameters:

Name	Parameter	Data Type	Required	Description
Message	form	string	No

SessionCustomTextSubmitOptions Parameters:

Name	Parameter	Data Type	Required	Description
Message	form	string	No

SessionCustomTextTermsOfServiceAcceptanceOptions Parameters:

Name	Parameter	Data Type	Required	Description
Message	form	string	No

SessionCustomerUpdateOptions Parameters:

Name	Parameter	Data Type	Required	Description
Address	form	string	No
Name	form	string	No
Shipping	form	string	No

SessionDiscountOptions Parameters:

Name	Parameter	Data Type	Required	Description
Coupon	form	string	No
PromotionCode	form	string	No

SessionInvoiceCreationOptions Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool?	No
InvoiceData	form	SessionInvoiceCreationInvoiceDataOptions	No

SessionInvoiceCreationInvoiceDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
AccountTaxIds	form	List<string>	No
CustomFields	form	List<SessionInvoiceCreationInvoiceDataCustomFieldOptions>	No
Description	form	string	No
Footer	form	string	No
Issuer	form	SessionInvoiceCreationInvoiceDataIssuerOptions	No
Metadata	form	Dictionary<string, string>	No
RenderingOptions	form	SessionInvoiceCreationInvoiceDataRenderingOptionsOptions	No

SessionInvoiceCreationInvoiceDataCustomFieldOptions Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

SessionInvoiceCreationInvoiceDataIssuerOptions Parameters:

Name	Parameter	Data Type	Required	Description
Account	form	string	No
Type	form	string	No

SessionInvoiceCreationInvoiceDataRenderingOptionsOptions Parameters:

Name	Parameter	Data Type	Required	Description
AmountTaxDisplay	form	string	No

SessionLineItemOptions Parameters:

Name	Parameter	Data Type	Required	Description
AdjustableQuantity	form	SessionLineItemAdjustableQuantityOptions	No
DynamicTaxRates	form	List<string>	No
Price	form	string	No
PriceData	form	SessionLineItemPriceDataOptions	No
Quantity	form	long?	No
TaxRates	form	List<string>	No

SessionLineItemAdjustableQuantityOptions Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool?	No
Maximum	form	long?	No
Minimum	form	long?	No

SessionLineItemPriceDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
Currency	form	string	No
Product	form	string	No
ProductData	form	SessionLineItemPriceDataProductDataOptions	No
Recurring	form	SessionLineItemPriceDataRecurringOptions	No
TaxBehavior	form	string	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No

SessionLineItemPriceDataProductDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
Description	form	string	No
Images	form	List<string>	No
Metadata	form	Dictionary<string, string>	No
Name	form	string	No
TaxCode	form	string	No

SessionLineItemPriceDataRecurringOptions Parameters:

Name	Parameter	Data Type	Required	Description
Interval	form	string	No
IntervalCount	form	long?	No

SessionPaymentIntentDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
ApplicationFeeAmount	form	long?	No
CaptureMethod	form	string	No
Description	form	string	No
Metadata	form	Dictionary<string, string>	No
OnBehalfOf	form	string	No
ReceiptEmail	form	string	No
SetupFutureUsage	form	string	No
Shipping	form	ChargeShippingOptions	No
StatementDescriptor	form	string	No
StatementDescriptorSuffix	form	string	No
TransferData	form	SessionPaymentIntentDataTransferDataOptions	No
TransferGroup	form	string	No

ChargeShippingOptions Parameters:

Name	Parameter	Data Type	Required	Description
Address	form	AddressOptions	No
Carrier	form	string	No
Name	form	string	No
Phone	form	string	No
TrackingNumber	form	string	No

AddressOptions Parameters:

Name	Parameter	Data Type	Required	Description
City	form	string	No
Country	form	string	No
Line1	form	string	No
Line2	form	string	No
PostalCode	form	string	No
State	form	string	No

SessionPaymentIntentDataTransferDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
Amount	form	long?	No
Destination	form	string	No

SessionPaymentMethodDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
AllowRedisplay	form	string	No

SessionPaymentMethodOptionsOptions Parameters:

Name	Parameter	Data Type	Required	Description
AcssDebit	form	SessionPaymentMethodOptionsAcssDebitOptions	No
Affirm	form	SessionPaymentMethodOptionsAffirmOptions	No
AfterpayClearpay	form	SessionPaymentMethodOptionsAfterpayClearpayOptions	No
Alipay	form	SessionPaymentMethodOptionsAlipayOptions	No
AmazonPay	form	SessionPaymentMethodOptionsAmazonPayOptions	No
AuBecsDebit	form	SessionPaymentMethodOptionsAuBecsDebitOptions	No
BacsDebit	form	SessionPaymentMethodOptionsBacsDebitOptions	No
Bancontact	form	SessionPaymentMethodOptionsBancontactOptions	No
Boleto	form	SessionPaymentMethodOptionsBoletoOptions	No
Card	form	SessionPaymentMethodOptionsCardOptions	No
Cashapp	form	SessionPaymentMethodOptionsCashappOptions	No
CustomerBalance	form	SessionPaymentMethodOptionsCustomerBalanceOptions	No
Eps	form	SessionPaymentMethodOptionsEpsOptions	No
Fpx	form	SessionPaymentMethodOptionsFpxOptions	No
Giropay	form	SessionPaymentMethodOptionsGiropayOptions	No
Grabpay	form	SessionPaymentMethodOptionsGrabpayOptions	No
Ideal	form	SessionPaymentMethodOptionsIdealOptions	No
Klarna	form	SessionPaymentMethodOptionsKlarnaOptions	No
Konbini	form	SessionPaymentMethodOptionsKonbiniOptions	No
Link	form	SessionPaymentMethodOptionsLinkOptions	No
Mobilepay	form	SessionPaymentMethodOptionsMobilepayOptions	No
Multibanco	form	SessionPaymentMethodOptionsMultibancoOptions	No
Oxxo	form	SessionPaymentMethodOptionsOxxoOptions	No
P24	form	SessionPaymentMethodOptionsP24Options	No
Paynow	form	SessionPaymentMethodOptionsPaynowOptions	No
Paypal	form	SessionPaymentMethodOptionsPaypalOptions	No
Pix	form	SessionPaymentMethodOptionsPixOptions	No
RevolutPay	form	SessionPaymentMethodOptionsRevolutPayOptions	No
SepaDebit	form	SessionPaymentMethodOptionsSepaDebitOptions	No
Sofort	form	SessionPaymentMethodOptionsSofortOptions	No
Swish	form	SessionPaymentMethodOptionsSwishOptions	No
UsBankAccount	form	SessionPaymentMethodOptionsUsBankAccountOptions	No
WechatPay	form	SessionPaymentMethodOptionsWechatPayOptions	No

SessionPaymentMethodOptionsAcssDebitOptions Parameters:

Name	Parameter	Data Type	Required	Description
Currency	form	string	No
MandateOptions	form	SessionPaymentMethodOptionsAcssDebitMandateOptionsOptions	No
SetupFutureUsage	form	string	No
VerificationMethod	form	string	No

SessionPaymentMethodOptionsAcssDebitMandateOptionsOptions Parameters:

Name	Parameter	Data Type	Required	Description
CustomMandateUrl	form	string	No
DefaultFor	form	List<string>	No
IntervalDescription	form	string	No
PaymentSchedule	form	string	No
TransactionType	form	string	No

SessionPaymentMethodOptionsAffirmOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsAfterpayClearpayOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsAlipayOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsAmazonPayOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsAuBecsDebitOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsBacsDebitOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsBancontactOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsBoletoOptions Parameters:

Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long?	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsCardOptions Parameters:

Name	Parameter	Data Type	Required	Description
Installments	form	SessionPaymentMethodOptionsCardInstallmentsOptions	No
RequestThreeDSecure	form	string	No
SetupFutureUsage	form	string	No
StatementDescriptorSuffixKana	form	string	No
StatementDescriptorSuffixKanji	form	string	No

SessionPaymentMethodOptionsCardInstallmentsOptions Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool?	No

SessionPaymentMethodOptionsCashappOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsCustomerBalanceOptions Parameters:

Name	Parameter	Data Type	Required	Description
BankTransfer	form	SessionPaymentMethodOptionsCustomerBalanceBankTransferOptions	No
FundingType	form	string	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsCustomerBalanceBankTransferOptions Parameters:

Name	Parameter	Data Type	Required	Description
EuBankTransfer	form	SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferOptions	No
RequestedAddressTypes	form	List<string>	No
Type	form	string	No

SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferOptions Parameters:

Name	Parameter	Data Type	Required	Description
Country	form	string	No

SessionPaymentMethodOptionsEpsOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsFpxOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsGiropayOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsGrabpayOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsIdealOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsKlarnaOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsKonbiniOptions Parameters:

Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long?	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsLinkOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsMobilepayOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsMultibancoOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsOxxoOptions Parameters:

Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long?	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsP24Options Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No
TosShownAndAccepted	form	bool?	No

SessionPaymentMethodOptionsPaynowOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsPaypalOptions Parameters:

Name	Parameter	Data Type	Required	Description
CaptureMethod	form	string	No
PreferredLocale	form	string	No
Reference	form	string	No
RiskCorrelationId	form	string	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsPixOptions Parameters:

Name	Parameter	Data Type	Required	Description
ExpiresAfterSeconds	form	long?	No

SessionPaymentMethodOptionsRevolutPayOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsSepaDebitOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsSofortOptions Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsSwishOptions Parameters:

Name	Parameter	Data Type	Required	Description
Reference	form	string	No

SessionPaymentMethodOptionsUsBankAccountOptions Parameters:

Name	Parameter	Data Type	Required	Description
FinancialConnections	form	SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions	No
SetupFutureUsage	form	string	No
VerificationMethod	form	string	No

SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions Parameters:

Name	Parameter	Data Type	Required	Description
Permissions	form	List<string>	No
Prefetch	form	List<string>	No

SessionPaymentMethodOptionsWechatPayOptions Parameters:

Name	Parameter	Data Type	Required	Description
AppId	form	string	No
Client	form	string	No
SetupFutureUsage	form	string	No

SessionPhoneNumberCollectionOptions Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool?	No

SessionSavedPaymentMethodOptionsOptions Parameters:

Name	Parameter	Data Type	Required	Description
AllowRedisplayFilters	form	List<string>	No
PaymentMethodSave	form	string	No

SessionSetupIntentDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
Description	form	string	No
Metadata	form	Dictionary<string, string>	No
OnBehalfOf	form	string	No

SessionShippingAddressCollectionOptions Parameters:

Name	Parameter	Data Type	Required	Description
AllowedCountries	form	List<string>	No

SessionShippingOptionOptions Parameters:

Name	Parameter	Data Type	Required	Description
ShippingRate	form	string	No
ShippingRateData	form	SessionShippingOptionShippingRateDataOptions	No

SessionShippingOptionShippingRateDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
DeliveryEstimate	form	SessionShippingOptionShippingRateDataDeliveryEstimateOptions	No
DisplayName	form	string	No
FixedAmount	form	SessionShippingOptionShippingRateDataFixedAmountOptions	No
Metadata	form	Dictionary<string, string>	No
TaxBehavior	form	string	No
TaxCode	form	string	No
Type	form	string	No

SessionShippingOptionShippingRateDataDeliveryEstimateOptions Parameters:

Name	Parameter	Data Type	Required	Description
Maximum	form	SessionShippingOptionShippingRateDataDeliveryEstimateMaximumOptions	No
Minimum	form	SessionShippingOptionShippingRateDataDeliveryEstimateMinimumOptions	No

SessionShippingOptionShippingRateDataDeliveryEstimateMaximumOptions Parameters:

Name	Parameter	Data Type	Required	Description
Unit	form	string	No
Value	form	long?	No

SessionShippingOptionShippingRateDataDeliveryEstimateMinimumOptions Parameters:

Name	Parameter	Data Type	Required	Description
Unit	form	string	No
Value	form	long?	No

SessionShippingOptionShippingRateDataFixedAmountOptions Parameters:

Name	Parameter	Data Type	Required	Description
Amount	form	long?	No
Currency	form	string	No
CurrencyOptions	form	Dictionary<string, SessionShippingOptionShippingRateDataFixedAmountCurrencyOptionsOptions>	No

SessionShippingOptionShippingRateDataFixedAmountCurrencyOptionsOptions Parameters:

Name	Parameter	Data Type	Required	Description
Amount	form	long?	No
TaxBehavior	form	string	No

SessionSubscriptionDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
ApplicationFeePercent	form	decimal?	No
BillingCycleAnchor	form	DateTime?	No
DefaultTaxRates	form	List<string>	No
Description	form	string	No
InvoiceSettings	form	SessionSubscriptionDataInvoiceSettingsOptions	No
Metadata	form	Dictionary<string, string>	No
OnBehalfOf	form	string	No
ProrationBehavior	form	string	No
TransferData	form	SessionSubscriptionDataTransferDataOptions	No
TrialEnd	form	DateTime?	No
TrialPeriodDays	form	long?	No
TrialSettings	form	SessionSubscriptionDataTrialSettingsOptions	No

SessionSubscriptionDataInvoiceSettingsOptions Parameters:

Name	Parameter	Data Type	Required	Description
Issuer	form	SessionSubscriptionDataInvoiceSettingsIssuerOptions	No

SessionSubscriptionDataInvoiceSettingsIssuerOptions Parameters:

Name	Parameter	Data Type	Required	Description
Account	form	string	No
Type	form	string	No

SessionSubscriptionDataTransferDataOptions Parameters:

Name	Parameter	Data Type	Required	Description
AmountPercent	form	decimal?	No
Destination	form	string	No

SessionSubscriptionDataTrialSettingsOptions Parameters:

Name	Parameter	Data Type	Required	Description
EndBehavior	form	SessionSubscriptionDataTrialSettingsEndBehaviorOptions	No

SessionSubscriptionDataTrialSettingsEndBehaviorOptions Parameters:

Name	Parameter	Data Type	Required	Description
MissingPaymentMethod	form	string	No

SessionTaxIdCollectionOptions Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool?	No
Required	form	string	No

CustomSessionData Parameters:

Name	Parameter	Data Type	Required	Description
Session	form	Session	No
LineItems	form	List<LineItem>	No

Session Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	string	No
Object	form	string	No
AfterExpiration	form	SessionAfterExpiration	No
AllowPromotionCodes	form	bool?	No
AmountSubtotal	form	long?	No
AmountTotal	form	long?	No
AutomaticTax	form	SessionAutomaticTax	No
BillingAddressCollection	form	string	No
CancelUrl	form	string	No
ClientReferenceId	form	string	No
ClientSecret	form	string	No
Consent	form	SessionConsent	No
ConsentCollection	form	SessionConsentCollection	No
Created	form	DateTime	No
Currency	form	string	No
CurrencyConversion	form	SessionCurrencyConversion	No
CustomFields	form	List<SessionCustomField>	No
CustomText	form	SessionCustomText	No
CustomerCreation	form	string	No
CustomerDetails	form	SessionCustomerDetails	No
CustomerEmail	form	string	No
ExpiresAt	form	DateTime	No
InvoiceCreation	form	SessionInvoiceCreation	No
LineItems	form	StripeList<LineItem>	No
Livemode	form	bool	No
Locale	form	string	No
Metadata	form	Dictionary<string, string>	No
Mode	form	string	No
PaymentMethodCollection	form	string	No
PaymentMethodConfigurationDetails	form	SessionPaymentMethodConfigurationDetails	No
PaymentMethodOptions	form	SessionPaymentMethodOptions	No
PaymentMethodTypes	form	List<string>	No
PaymentStatus	form	string	No
PhoneNumberCollection	form	SessionPhoneNumberCollection	No
RecoveredFrom	form	string	No
RedirectOnCompletion	form	string	No
ReturnUrl	form	string	No
SavedPaymentMethodOptions	form	SessionSavedPaymentMethodOptions	No
ShippingAddressCollection	form	SessionShippingAddressCollection	No
ShippingCost	form	SessionShippingCost	No
ShippingDetails	form	SessionShippingDetails	No
ShippingOptions	form	List<SessionShippingOption>	No
Status	form	string	No
SubmitType	form	string	No
SuccessUrl	form	string	No
TaxIdCollection	form	SessionTaxIdCollection	No
TotalDetails	form	SessionTotalDetails	No
UiMode	form	string	No
Url	form	string	No

SessionAfterExpiration Parameters:

Name	Parameter	Data Type	Required	Description
Recovery	form	SessionAfterExpirationRecovery	No

SessionAfterExpirationRecovery Parameters:

Name	Parameter	Data Type	Required	Description
AllowPromotionCodes	form	bool	No
Enabled	form	bool	No
ExpiresAt	form	DateTime?	No
Url	form	string	No

SessionAutomaticTax Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No
Liability	form	SessionAutomaticTaxLiability	No
Status	form	string	No

SessionAutomaticTaxLiability Parameters:

Name	Parameter	Data Type	Required	Description
Type	form	string	No

SessionConsent Parameters:

Name	Parameter	Data Type	Required	Description
Promotions	form	string	No
TermsOfService	form	string	No

SessionConsentCollection Parameters:

Name	Parameter	Data Type	Required	Description
PaymentMethodReuseAgreement	form	SessionConsentCollectionPaymentMethodReuseAgreement	No
Promotions	form	string	No
TermsOfService	form	string	No

SessionConsentCollectionPaymentMethodReuseAgreement Parameters:

Name	Parameter	Data Type	Required	Description
Position	form	string	No

SessionCurrencyConversion Parameters:

Name	Parameter	Data Type	Required	Description
AmountSubtotal	form	long	No
AmountTotal	form	long	No
FxRate	form	decimal	No
SourceCurrency	form	string	No

SessionCustomField Parameters:

Name	Parameter	Data Type	Required	Description
Dropdown	form	SessionCustomFieldDropdown	No
Key	form	string	No
Label	form	SessionCustomFieldLabel	No
Numeric	form	SessionCustomFieldNumeric	No
Optional	form	bool	No
Text	form	SessionCustomFieldText	No
Type	form	string	No

SessionCustomFieldDropdown Parameters:

Name	Parameter	Data Type	Required	Description
DefaultValue	form	string	No
Options	form	List<SessionCustomFieldDropdownOption>	No
Value	form	string	No

SessionCustomFieldDropdownOption Parameters:

Name	Parameter	Data Type	Required	Description
Label	form	string	No
Value	form	string	No

SessionCustomFieldLabel Parameters:

Name	Parameter	Data Type	Required	Description
Custom	form	string	No
Type	form	string	No

SessionCustomFieldNumeric Parameters:

Name	Parameter	Data Type	Required	Description
DefaultValue	form	string	No
MaximumLength	form	long?	No
MinimumLength	form	long?	No
Value	form	string	No

SessionCustomFieldText Parameters:

Name	Parameter	Data Type	Required	Description
DefaultValue	form	string	No
MaximumLength	form	long?	No
MinimumLength	form	long?	No
Value	form	string	No

SessionCustomText Parameters:

Name	Parameter	Data Type	Required	Description
AfterSubmit	form	SessionCustomTextAfterSubmit	No
ShippingAddress	form	SessionCustomTextShippingAddress	No
Submit	form	SessionCustomTextSubmit	No
TermsOfServiceAcceptance	form	SessionCustomTextTermsOfServiceAcceptance	No

SessionCustomTextAfterSubmit Parameters:

Name	Parameter	Data Type	Required	Description
Message	form	string	No

SessionCustomTextShippingAddress Parameters:

Name	Parameter	Data Type	Required	Description
Message	form	string	No

SessionCustomTextSubmit Parameters:

Name	Parameter	Data Type	Required	Description
Message	form	string	No

SessionCustomTextTermsOfServiceAcceptance Parameters:

Name	Parameter	Data Type	Required	Description
Message	form	string	No

SessionCustomerDetails Parameters:

Name	Parameter	Data Type	Required	Description
Address	form	Address	No
Email	form	string	No
Name	form	string	No
Phone	form	string	No
TaxExempt	form	string	No
TaxIds	form	List<SessionCustomerDetailsTaxId>	No

Address Parameters:

Name	Parameter	Data Type	Required	Description
City	form	string	No
Country	form	string	No
Line1	form	string	No
Line2	form	string	No
PostalCode	form	string	No
State	form	string	No

SessionCustomerDetailsTaxId Parameters:

Name	Parameter	Data Type	Required	Description
Type	form	string	No
Value	form	string	No

SessionInvoiceCreation Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No
InvoiceData	form	SessionInvoiceCreationInvoiceData	No

SessionInvoiceCreationInvoiceData Parameters:

Name	Parameter	Data Type	Required	Description
CustomFields	form	List<SessionInvoiceCreationInvoiceDataCustomField>	No
Description	form	string	No
Footer	form	string	No
Issuer	form	SessionInvoiceCreationInvoiceDataIssuer	No
Metadata	form	Dictionary<string, string>	No
RenderingOptions	form	SessionInvoiceCreationInvoiceDataRenderingOptions	No

SessionInvoiceCreationInvoiceDataCustomField Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

SessionInvoiceCreationInvoiceDataIssuer Parameters:

Name	Parameter	Data Type	Required	Description
Type	form	string	No

SessionInvoiceCreationInvoiceDataRenderingOptions Parameters:

Name	Parameter	Data Type	Required	Description
AmountTaxDisplay	form	string	No

LineItem Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	string	No
Object	form	string	No
AmountDiscount	form	long	No
AmountSubtotal	form	long	No
AmountTax	form	long	No
AmountTotal	form	long	No
Currency	form	string	No
Deleted	form	bool?	No
Description	form	string	No
Discounts	form	List<LineItemDiscount>	No
Price	form	Price	No
Quantity	form	long?	No
Taxes	form	List<LineItemTax>	No

LineItemDiscount Parameters:

Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Discount	form	Discount	No

Discount Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	string	No
Object	form	string	No
CheckoutSession	form	string	No
Coupon	form	Coupon	No
Deleted	form	bool?	No
End	form	DateTime?	No
Invoice	form	string	No
InvoiceItem	form	string	No
Start	form	DateTime	No
Subscription	form	string	No
SubscriptionItem	form	string	No

Coupon Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	string	No
Object	form	string	No
AmountOff	form	long?	No
AppliesTo	form	CouponAppliesTo	No
Created	form	DateTime	No
Currency	form	string	No
CurrencyOptions	form	Dictionary<string, CouponCurrencyOptions>	No
Deleted	form	bool?	No
Duration	form	string	No
DurationInMonths	form	long?	No
Livemode	form	bool	No
MaxRedemptions	form	long?	No
Metadata	form	Dictionary<string, string>	No
Name	form	string	No
PercentOff	form	decimal?	No
RedeemBy	form	DateTime?	No
TimesRedeemed	form	long	No
Valid	form	bool	No

CouponAppliesTo Parameters:

Name	Parameter	Data Type	Required	Description
Products	form	List<string>	No

CouponCurrencyOptions Parameters:

Name	Parameter	Data Type	Required	Description
AmountOff	form	long	No

Price Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	string	No
Object	form	string	No
Active	form	bool	No
BillingScheme	form	string	No
Created	form	DateTime	No
Currency	form	string	No
CurrencyOptions	form	Dictionary<string, PriceCurrencyOptions>	No
CustomUnitAmount	form	PriceCustomUnitAmount	No
Deleted	form	bool?	No
Livemode	form	bool	No
LookupKey	form	string	No
Metadata	form	Dictionary<string, string>	No
Nickname	form	string	No
Recurring	form	PriceRecurring	No
TaxBehavior	form	string	No
Tiers	form	List<PriceTier>	No
TiersMode	form	string	No
TransformQuantity	form	PriceTransformQuantity	No
Type	form	string	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No

PriceCurrencyOptions Parameters:

Name	Parameter	Data Type	Required	Description
CustomUnitAmount	form	PriceCurrencyOptionsCustomUnitAmount	No
TaxBehavior	form	string	No
Tiers	form	List<PriceCurrencyOptionsTier>	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No

PriceCurrencyOptionsCustomUnitAmount Parameters:

Name	Parameter	Data Type	Required	Description
Maximum	form	long?	No
Minimum	form	long?	No
Preset	form	long?	No

PriceCurrencyOptionsTier Parameters:

Name	Parameter	Data Type	Required	Description
FlatAmount	form	long?	No
FlatAmountDecimal	form	decimal?	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No
UpTo	form	long?	No

PriceCustomUnitAmount Parameters:

Name	Parameter	Data Type	Required	Description
Maximum	form	long?	No
Minimum	form	long?	No
Preset	form	long?	No

PriceRecurring Parameters:

Name	Parameter	Data Type	Required	Description
AggregateUsage	form	string	No
Interval	form	string	No
IntervalCount	form	long	No
Meter	form	string	No
TrialPeriodDays	form	long?	No
UsageType	form	string	No

PriceTier Parameters:

Name	Parameter	Data Type	Required	Description
FlatAmount	form	long?	No
FlatAmountDecimal	form	decimal?	No
UnitAmount	form	long?	No
UnitAmountDecimal	form	decimal?	No
UpTo	form	long?	No

PriceTransformQuantity Parameters:

Name	Parameter	Data Type	Required	Description
DivideBy	form	long	No
Round	form	string	No

LineItemTax Parameters:

Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Rate	form	TaxRate	No
TaxabilityReason	form	string	No
TaxableAmount	form	long?	No

TaxRate Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	string	No
Object	form	string	No
Active	form	bool	No
Country	form	string	No
Created	form	DateTime	No
Description	form	string	No
DisplayName	form	string	No
EffectivePercentage	form	decimal?	No
Inclusive	form	bool	No
Jurisdiction	form	string	No
JurisdictionLevel	form	string	No
Livemode	form	bool	No
Metadata	form	Dictionary<string, string>	No
Percentage	form	decimal	No
State	form	string	No
TaxType	form	string	No

SessionPaymentMethodConfigurationDetails Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	string	No
Parent	form	string	No

SessionPaymentMethodOptions Parameters:

Name	Parameter	Data Type	Required	Description
AcssDebit	form	SessionPaymentMethodOptionsAcssDebit	No
Affirm	form	SessionPaymentMethodOptionsAffirm	No
AfterpayClearpay	form	SessionPaymentMethodOptionsAfterpayClearpay	No
Alipay	form	SessionPaymentMethodOptionsAlipay	No
AmazonPay	form	SessionPaymentMethodOptionsAmazonPay	No
AuBecsDebit	form	SessionPaymentMethodOptionsAuBecsDebit	No
BacsDebit	form	SessionPaymentMethodOptionsBacsDebit	No
Bancontact	form	SessionPaymentMethodOptionsBancontact	No
Boleto	form	SessionPaymentMethodOptionsBoleto	No
Card	form	SessionPaymentMethodOptionsCard	No
Cashapp	form	SessionPaymentMethodOptionsCashapp	No
CustomerBalance	form	SessionPaymentMethodOptionsCustomerBalance	No
Eps	form	SessionPaymentMethodOptionsEps	No
Fpx	form	SessionPaymentMethodOptionsFpx	No
Giropay	form	SessionPaymentMethodOptionsGiropay	No
Grabpay	form	SessionPaymentMethodOptionsGrabpay	No
Ideal	form	SessionPaymentMethodOptionsIdeal	No
Klarna	form	SessionPaymentMethodOptionsKlarna	No
Konbini	form	SessionPaymentMethodOptionsKonbini	No
Link	form	SessionPaymentMethodOptionsLink	No
Mobilepay	form	SessionPaymentMethodOptionsMobilepay	No
Multibanco	form	SessionPaymentMethodOptionsMultibanco	No
Oxxo	form	SessionPaymentMethodOptionsOxxo	No
P24	form	SessionPaymentMethodOptionsP24	No
Paynow	form	SessionPaymentMethodOptionsPaynow	No
Paypal	form	SessionPaymentMethodOptionsPaypal	No
Pix	form	SessionPaymentMethodOptionsPix	No
RevolutPay	form	SessionPaymentMethodOptionsRevolutPay	No
SepaDebit	form	SessionPaymentMethodOptionsSepaDebit	No
Sofort	form	SessionPaymentMethodOptionsSofort	No
Swish	form	SessionPaymentMethodOptionsSwish	No
UsBankAccount	form	SessionPaymentMethodOptionsUsBankAccount	No

SessionPaymentMethodOptionsAcssDebit Parameters:

Name	Parameter	Data Type	Required	Description
Currency	form	string	No
MandateOptions	form	SessionPaymentMethodOptionsAcssDebitMandateOptions	No
SetupFutureUsage	form	string	No
VerificationMethod	form	string	No

SessionPaymentMethodOptionsAcssDebitMandateOptions Parameters:

Name	Parameter	Data Type	Required	Description
CustomMandateUrl	form	string	No
DefaultFor	form	List<string>	No
IntervalDescription	form	string	No
PaymentSchedule	form	string	No
TransactionType	form	string	No

SessionPaymentMethodOptionsAffirm Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsAfterpayClearpay Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsAlipay Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsAmazonPay Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsAuBecsDebit Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsBacsDebit Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsBancontact Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsBoleto Parameters:

Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsCard Parameters:

Name	Parameter	Data Type	Required	Description
Installments	form	SessionPaymentMethodOptionsCardInstallments	No
RequestThreeDSecure	form	string	No
SetupFutureUsage	form	string	No
StatementDescriptorSuffixKana	form	string	No
StatementDescriptorSuffixKanji	form	string	No

SessionPaymentMethodOptionsCardInstallments Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No

SessionPaymentMethodOptionsCashapp Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsCustomerBalance Parameters:

Name	Parameter	Data Type	Required	Description
BankTransfer	form	SessionPaymentMethodOptionsCustomerBalanceBankTransfer	No
FundingType	form	string	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsCustomerBalanceBankTransfer Parameters:

Name	Parameter	Data Type	Required	Description
EuBankTransfer	form	SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer	No
RequestedAddressTypes	form	List<string>	No
Type	form	string	No

SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer Parameters:

Name	Parameter	Data Type	Required	Description
Country	form	string	No

SessionPaymentMethodOptionsEps Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsFpx Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsGiropay Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsGrabpay Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsIdeal Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsKlarna Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsKonbini Parameters:

Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long?	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsLink Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsMobilepay Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsMultibanco Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsOxxo Parameters:

Name	Parameter	Data Type	Required	Description
ExpiresAfterDays	form	long	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsP24 Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsPaynow Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsPaypal Parameters:

Name	Parameter	Data Type	Required	Description
CaptureMethod	form	string	No
PreferredLocale	form	string	No
Reference	form	string	No
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsPix Parameters:

Name	Parameter	Data Type	Required	Description
ExpiresAfterSeconds	form	long?	No

SessionPaymentMethodOptionsRevolutPay Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsSepaDebit Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsSofort Parameters:

Name	Parameter	Data Type	Required	Description
SetupFutureUsage	form	string	No

SessionPaymentMethodOptionsSwish Parameters:

Name	Parameter	Data Type	Required	Description
Reference	form	string	No

SessionPaymentMethodOptionsUsBankAccount Parameters:

Name	Parameter	Data Type	Required	Description
FinancialConnections	form	SessionPaymentMethodOptionsUsBankAccountFinancialConnections	No
SetupFutureUsage	form	string	No
VerificationMethod	form	string	No

SessionPaymentMethodOptionsUsBankAccountFinancialConnections Parameters:

Name	Parameter	Data Type	Required	Description
Filters	form	SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters	No
Permissions	form	List<string>	No
Prefetch	form	List<string>	No
ReturnUrl	form	string	No

SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters Parameters:

Name	Parameter	Data Type	Required	Description
AccountSubcategories	form	List<string>	No

SessionPhoneNumberCollection Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No

SessionSavedPaymentMethodOptions Parameters:

Name	Parameter	Data Type	Required	Description
AllowRedisplayFilters	form	List<string>	No
PaymentMethodRemove	form	string	No
PaymentMethodSave	form	string	No

SessionShippingAddressCollection Parameters:

Name	Parameter	Data Type	Required	Description
AllowedCountries	form	List<string>	No

SessionShippingCost Parameters:

Name	Parameter	Data Type	Required	Description
AmountSubtotal	form	long	No
AmountTax	form	long	No
AmountTotal	form	long	No
Taxes	form	List<SessionShippingCostTax>	No

SessionShippingCostTax Parameters:

Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Rate	form	TaxRate	No
TaxabilityReason	form	string	No
TaxableAmount	form	long?	No

SessionShippingDetails Parameters:

Name	Parameter	Data Type	Required	Description
Address	form	Address	No
Carrier	form	string	No
Name	form	string	No
Phone	form	string	No
TrackingNumber	form	string	No

SessionShippingOption Parameters:

Name	Parameter	Data Type	Required	Description
ShippingAmount	form	long	No

SessionTaxIdCollection Parameters:

Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No
Required	form	string	No

SessionTotalDetails Parameters:

Name	Parameter	Data Type	Required	Description
AmountDiscount	form	long	No
AmountShipping	form	long?	No
AmountTax	form	long	No
Breakdown	form	SessionTotalDetailsBreakdown	No

SessionTotalDetailsBreakdown Parameters:

Name	Parameter	Data Type	Required	Description
Discounts	form	List<SessionTotalDetailsBreakdownDiscount>	No
Taxes	form	List<SessionTotalDetailsBreakdownTax>	No

SessionTotalDetailsBreakdownDiscount Parameters:

Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Discount	form	Discount	No

SessionTotalDetailsBreakdownTax Parameters:

Name	Parameter	Data Type	Required	Description
Amount	form	long	No
Rate	form	TaxRate	No
TaxabilityReason	form	string	No
TaxableAmount	form	long?	No

PaymentLog Parameters:

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

Customer Parameters:

Name	Parameter	Data Type	Required	Description
IdentityId	form	int	No
Id	form	Guid	No
CustomerId	form	Guid	No
AccessKeys	form	IList<UserAccessKeys>	No
Email	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
FullName	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

UserAccessKeys Parameters:

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

ExternalReference Parameters:

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

Company Parameters:

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
Email	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

CompanyStatus Enum:

Name	Value
Registered	1
AwaitingApproval	2
Approved	3
Inactive	4
ClosedDown	5
NotApproved	6

BookingSettings Parameters:

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

ScheduleView Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

WeekNumberSetting Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
Description	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	Yes

BookingTemplate Parameters:

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

CalendarType Parameters:

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

FreeSpotTexts Parameters:

Name	Parameter	Data Type	Required	Description
TextSingular	form	string	Yes
TextPlural	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	Yes

BookingStatusOptions Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	No
Description	form	string	No

CompanyType Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
Description	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	Yes

CodeLockSetting Parameters:

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

CodeLockSystem Parameters:

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

PaymentSetting Parameters:

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

AdminPaymentOptions Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
Description	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	Yes

PaymentProviders Parameters:

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

CompanySetting Parameters:

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

LanguageResponse Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	string	No
Name	form	string	No

HomepageWidgetSetting Parameters:

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

WidgetServiceLayouts Parameters:

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

WidgetTimeLayouts Parameters:

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

WidgetBookingLayouts Parameters:

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

WidgetBookingMethods Parameters:

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

HomepageSetting Parameters:

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

HomepageTemplate Parameters:

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

HeroSectionStyle Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
Description	form	string	No
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	Yes

AverageRatingScore Parameters:

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

Rating Parameters:

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

Review Parameters:

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

License Parameters:

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

LicenseType Parameters:

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

LicenseTypeItem Parameters:

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

LicensePrice Parameters:

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

Country Parameters:

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

CompanyCategory Parameters:

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

CustomerComment Parameters:

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

RebateCodeStatus Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
Description	form	string	No
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

Article Parameters:

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

ArticleServiceRelation Parameters:

Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	Yes
Id	form	int	No
ServiceId	form	int	Yes
ArticleId	form	int	Yes

ArticleTypeEnum Enum:

Name	Value
ServiceArticle	1
StandAloneArticle	2
RebateCodePunchTicketArticle	3
RebateCodeGiftCardArticle	4
RebateCodeValueCardArticle	5

RebateCodeDayOfWeekRelation Parameters:

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

RebateCodeServiceRelation Parameters:

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

RebateCodeBookingPriceRelation Parameters:

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

RebateCodeCustomerRelation Parameters:

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

DaysOfWeek Parameters:

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

RebateCodeTransaction Parameters:

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

Booking Parameters:

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

CalendarExport Parameters:

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

BookingLog Parameters:

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

BookingLogEventType Parameters:

Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
Description	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	Yes

PaymentDetails Parameters:

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

BookingPrice Parameters:

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

BookingStatus Parameters:

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

BookedResourceType Parameters:

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

BookedResource Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	No
Color	form	string	No
ImageUrl	form	Uri	No
Email	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

GroupedServiceQueryResponse Parameters:

Name	Parameter	Data Type	Required	Description
Group	form	string	No
SortOrder	form	int	No
Items	form	List<ServiceQueryResponse>	No
ResponseStatus	form	ResponseStatus	No

ServiceQueryResponse Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	No
Description	form	string	No
ImageUrl	form	Uri	No
TotalSpots	form	int	No
LockSpotsToBooking	form	bool?	No	If this setting is turned on the remaining spots (if Totalspots > 1) is locked from be booked by another customer.
MinNumberOfSpotsPerBooking	form	int	No
MaxNumberOfSpotsPerBooking	form	int	No
MinNumberOfResourcesToBook	form	int	No
MaxNumberOfResourcesToBook	form	int	No
UnbookBeforeDays	form	int	No
UnbookBeforeHours	form	int	No
UnbookBeforeMinutes	form	int	No
ScheduleType	form	ScheduleType	No	What type of schedule is connected to the service. RecurringSchedule = 1, DateSchedule = 2
ScheduleTypeId	form	int	No	What type of schedule is connected to the service. RecurringSchedule = 1, DateSchedule = 2
BookBeforeDays	form	int	No
BookBeforeHours	form	int	No
BookBeforeMinutes	form	int	No
Group	form	string	No
EnableBookingQueue	form	bool	No
EnableCodeLockSync	form	bool	No
EnableCustomerManualPayment	form	bool	No
SortOrder	form	int	No
Active	form	bool	No
IsGroupBooking	form	bool	No
GroupBooking	form	GroupBookingSettings	No
MultipleResource	form	MultipleResourceSettings	No
IsPaymentEnabled	form	bool	No
MaxPaymentTime	form	int	No	Maximum numbers of minutes the booking payment must be completed before automatically unbooked
BookingStatusId	form	int	No	If the booking should be either 1 = Booked) or 3 = Reserved. Default is 1 = Booked.
OnlyVisibleByAdmin	form	bool	No
LengthInMinutes	form	int?	No
DurationTypeId	form	int	No
Duration	form	int?	No
MinDuration	form	int?	No
MaxDuration	form	int?	No
DurationInterval	form	int?	No
PauseAfterBooking	form	int	No
CustomFields	form	List<CustomFieldConfigData>	No
CustomFieldValues	form	List<CustomFieldDataResponse>	No
BookingCustomFields	form	List<CustomFieldConfigData>	No
CustomerCustomFields	form	List<CustomFieldConfigData>	No
BookingStatusOptions	form	List<BookingStatusOptionsResponse>	No	The booking status options to choose from
Prices	form	List<ServicePriceResponse>	No
Schedules	form	ServiceSchedules	No
RatingSummary	form	CompanyRatingSummary	No
Reviews	form	List<RatingReviewResponse>	No
ResourceTypes	form	List<ServiceResourceTypeResponse>	No
ResponseStatus	form	ResponseStatus	No
PriceViewTypeId	form	int?	No

GroupBookingSettings Parameters:

Name	Parameter	Data Type	Required	Description
Active	form	bool	No
Min	form	int	No
Max	form	int	No

MultipleResourceSettings Parameters:

Name	Parameter	Data Type	Required	Description
Active	form	bool	No
Min	form	int	No
Max	form	int	No

CustomFieldConfigData Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No	Custom field id
Name	form	string	No	Configuration name. Example: 'Number of persons'.
Description	form	string	No	Custom field description. Example: 'For how many persons is this booking?'
Width	form	int?	No	Field width. Example: 20 for 20px
DataType	form	string	No	Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
DefaultValue	form	string	No	Default value of the field. Example: '3'
IsMandatory	form	bool	No	Determines if the field is required to have a value or not
MandatoryErrorMessage	form	string	No	Error message shown to the user if the field data is required but not entered
MaxLength	form	int	No	Max lenght of the field
MultipleLineText	form	bool	No	If the field should have multiple lines
RegEx	form	string	No	Regular expression used for validation of the field
RegExErrorMessage	form	string	No	Error message shown if the regular expression validation failed
Values	form	List<CustomFieldValueResponse>	No	The values to select from if Datatype is DropDown for this custom field

CustomFieldValueResponse Parameters:

Name	Parameter	Data Type	Required	Description
Value	form	string	No

BookingStatusOptionsResponse Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	No
Description	form	string	No

ServicePriceResponse Parameters:

Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company id
Id	form	int	No	The price id
ServiceId	form	int	No	The service id
Price	form	double	No	The price
CalculationTypeId	form	int	No	The price calculation type id, 1 = Normal, price is for the service total duration, 2 = Price is per minute, 3 = Price is per hour, 4= Price is per day
CurrencyId	form	string	No	The price currency
PriceSign	form	string	No	The price sign
VAT	form	decimal	No	The price VAT in percent
Category	form	string	No	The price category if price has a category
PriceText	form	string	No	The price text to display
From	form	DateTime	No	The valid from date for the price.
To	form	DateTime	No	The valid to date for the price.
DaysOfWeek	form	List<DayOfWeekDto>	No	If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
FromTime	form	TimeSpan?	No	If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
ToTime	form	TimeSpan?	No	If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
Service	form	ServiceInfoResponse	No
IsTimeSpecific	form	bool	No	If the price is only valid for a specific time span
IsDaysOfWeekSpecific	form	bool	No	If the price is only valid for specific days of week

DayOfWeekDto Parameters:

Name	Parameter	Data Type	Required	Description
DayOfWeekId	form	int	No
DotNetDayOfWeekId	form	int	No
DayOfWeek	form	string	No

ServiceInfoResponse Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	No
Description	form	string	No
ImageUrl	form	Uri	No
LengthInMinutes	form	int?	No
MaxNumberOfSpotsPerBooking	form	int	No
MinNumberOfSpotsPerBooking	form	int	No
GroupBooking	form	GroupBookingSettings	No
MultipleResource	form	MultipleResourceSettings	No
IsGroupBooking	form	bool	No
IsPaymentEnabled	form	bool	No

ServiceSchedules Parameters:

Name	Parameter	Data Type	Required	Description
ScheduleType	form	ScheduleType	No
RecurringSchedules	form	List<ISchedule>	No
DateSchedules	form	List<ISchedule>	No

CompanyRatingSummary Parameters:

Name	Parameter	Data Type	Required	Description
AverageScore	form	double	No	The average rating score
RatingScore1Count	form	int	No	The number of ratings of score 1
RatingScore2Count	form	int	No	The number of ratings of score 2
RatingScore3Count	form	int	No	The number of ratings of score 3
RaingScore4Count	form	int	No	The number of ratings of score 4
RatingScore5Count	form	int	No	The number of ratings of score 5
Count	form	int	No	The number of ratings

RatingReviewResponse Parameters:

Name	Parameter	Data Type	Required	Description
Title	form	string	No	The title for the review
Description	form	string	No	The description for the review
RatingScore	form	int	No	The rating score
Author	form	string	No	The review author
Created	form	DateTime	No	The created date
ReviewAnswer	form	string	No	The review answer from the company

ServiceResourceTypeResponse Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No	The resourcetype id
SelectableByUser	form	bool	No	The resourcetype is selectable by customer
Name	form	string	No	The resourcetype name
Description	form	string	No	The resourcetype description
Resources	form	List<ServiceResourceTypeResource>	No	The resources in the resourcetype. Only shows active resources if not admin.

ServiceResourceTypeResource Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No	The resource id
Name	form	string	No	The resource name
Description	form	string	No	The resource description
Email	form	string	No	The resource email
Phone	form	string	No	The resource phone
Color	form	string	No	The resource color
ImageUrl	form	Uri	No	The resource image
Priority	form	int	No	The priority of the resource
EmailNotification	form	bool	No	If the resource want to receive email notifications
SMSNotification	form	bool	No	If the resource want to receive sms notifications
EmailReminder	form	bool	No	If the resource want to receive email reminders
SMSReminder	form	bool	No	If the resource want to receive sms reminders

QueryResponse<AccessKeyTypeResponse> Parameters:

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

AccessKeyTypeResponse Parameters:

Name	Parameter	Data Type	Required	Description
Id	form	int	No
KeyType	form	string	No
Description	form	string	No