BokaMera.API.Host

<back to all web services

SupportCaseQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/support/casesGet company support casesGet company support cases.
SupportCaseQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ActivequerybooleanNoIf you want to search on active support cases
IdqueryintNoSupport Case Id
IncludeCommentsquerybooleanNoIf you want to include the support case comments
IncludeCaseStatusInformationquerybooleanNoIf you want to include the support case status information
IncludeCaseTypeInformationquerybooleanNoIf you want to include the support case type information
IncludeCaseAreaInformationquerybooleanNoIf you want to include the support case area information
IncludeCaseCommentsquerybooleanNoIf you want to include the support case comments
IncludeCaseAttachmentsquerybooleanNoIf you want to include the support case attachments
IncludeCaseStatusOptionsquerybooleanNoIf you want to include the support case status options to select from
IncludeCaseTypeOptionsquerybooleanNoIf you want to include the support case type options to select from
IncludeCaseAreaOptionsquerybooleanNoIf you want to include the support case area options to select from
ResponseStatusqueryResponseStatusNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip 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
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma 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
OrderByDescquerystringNoComma 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
IncludequerystringNoInclude 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
FieldsformstringNo
MetaformDictionary<string, string>No
SupportCase Parameters:
NameParameterData TypeRequiredDescription
CaseAreaIdformintNo
CaseAreaformCaseAreaNo
CaseTypeIdformintNo
CaseTypeformCaseTypeNo
CaseStatusIdformintNo
CaseStatusformCaseStatusNo
CommentsformIList<CaseComment>No
CaseAreaOptionsformIList<CaseArea>No
CaseTypeOptionsformIList<CaseType>No
CaseStatusOptionsformIList<CaseStatus>No
AttachmentsformIList<CaseAttachment>No
AttachmentRelationformList<CaseAttachmentRelation>No
CompanyUserformCompanyUserNo
CompanyformCompanyNo
ActiveformboolNo
CompanyIdformGuidYes
IdformintNo
CompanyUserIdformGuidNo
TitleformstringYes
DescriptionformstringYes
CreatedByformstringYes
UpdatedByformstringYes
SolvedByformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
CaseOwnerformstringNo
ModifiedDateformDateTimeOffset?No
CaseArea Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
CaseType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
CaseStatus Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ColorformstringYes
IconformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
CaseComment Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
SupportCaseIdformintYes
IdformintNo
CommentformstringYes
DeletedformboolYes
CreatedByformstringYes
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
CaseAttachment Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
FileUrlformstringYes
ModifiedDateformDateTimeOffset?No
CaseAttachmentRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
CaseAttachmentIdformintYes
SupportCaseIdformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
CompanyUser Parameters:
NameParameterData TypeRequiredDescription
ResourceformResourceNo
RolesformList<KeyCloakRole>No
EmailformstringNo
ResourceIdformint?No
WorkerIdformstringNo
ActiveformboolYes
IsSuperAdminformboolYes
CreatedDateformDateTimeYes
UpdatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
CompanyIdformGuidYes
IdformGuidYes
UserIdformGuidNo
FirstnameformstringNo
LastnameformstringNo
PhoneformstringNo
Resource Parameters:
NameParameterData TypeRequiredDescription
PriorityformintNo
SchedulesformIList<ISchedule>No
ExceptionsformIList<ITimeException>No
BookingsformIList<IBookedTime>No
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
CompanyIdformGuidYes
IdformintNo
NameformstringYes
ActiveformboolYes
DescriptionformstringNo
ImageUrlformstringNo
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
ColorformstringYes
EmailformstringNo
MobilePhoneformstringNo
EmailNotificationformbool?No
SMSNotificationformbool?No
SendSMSReminderformboolYes
SendEmailReminderformboolYes
ModifiedDateformDateTimeOffset?No
AccessGroupformstringNo
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
ISchedule Parameters:
NameParameterData TypeRequiredDescription
ResourcesformIList<Resource>No
TypeformScheduleTypeNo
ActiveformboolNo
IsResourceSpecificformboolNo
ScheduleType Enum:
NotDefined
RecurringSchedule
DateSchedule
ITimeException Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ReasonTextformstringNo
IsBlockformboolNo
ReasonTextPublicformstringNo
IsRecurringformboolNo
ResourceIdsformint[]No
IBookedTime Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ServiceIdformintNo
BookedSpotsformintNo
TotalSpotsformintNo
PauseAfterInMinutesformintNo
StatusformBookingStatusEnumNo
StatusIdformintNo
CustomerformBookedCustomerNo
BookingStatusEnum Enum:
NameValue
Booked1
Unbooked2
Reserved3
Canceled4
AwaitingPayment5
AwaitingPaymentNoTimeLimit6
Payed7
AwaitingPaymentRequestFromAdmin8
AwaitingPaymentFromProvider9
Invoiced10
BookedCustomer Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
EmailformstringNo
PhoneformstringNo
FacebookUserNameformstringNo
ImageUrlformstringNo
CorporateIdentityNumberformstringNo
InvoiceAddress1formstringNo
InvoiceAddress2formstringNo
InvoiceCityformstringNo
InvoicePostalCodeformstringNo
InvoiceCountryCodeformstringNo
CustomFieldConfig Parameters:
NameParameterData TypeRequiredDescription
ValuesformList<CustomFieldValue>No
CustomFieldformCustomFieldNo
RegExformRegExNo
ServicesformList<Service>No
CustomFieldServiceRelationformList<CustomFieldServiceRelation>No
CompanyIdformGuidYes
IdformintNo
GroupIdformint?No
FieldIdformintYes
IconIdformintYes
RegExIdformint?No
NameformstringYes
DescriptionformstringYes
DatatypeformstringYes
MaxLengthformintYes
IsPublicformboolYes
IsHiddenformboolYes
IsMandatoryformboolYes
DefaultValueformstringNo
RegExErrorMessageformstringNo
MandatoryErrorMessageformstringNo
Widthformint?No
MultipleLineTextformboolYes
ModifiedDateformDateTimeOffset?No
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
ValueformstringYes
ActiveformboolYes
SortOrderformshort?No
ModifiedDateformDateTimeOffset?No
CustomField Parameters:
NameParameterData TypeRequiredDescription
TableformstringYes
ColumnformstringYes
DataTypeformstringYes
DescriptionformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
RegEx Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
RegExCodeformstringYes
ErrorMessageformstringNo
ModifiedDateformDateTimeOffset?No
IdformintNo
Service Parameters:
NameParameterData TypeRequiredDescription
ResourceTypesformList<ResourceType>No
ResourcesformIEnumerable<Resource>No
TotalPriceformTotalPriceInformationNo
PricesformList<ServicePrice>No
BookingStatusOptionsformList<BookingStatusOptions>No
IsGroupBookingformboolNo
IsMultipleResourceformboolNo
SettingsformBookingSettingsNo
PaymentSettingformPaymentSettingNo
BookingCustomFieldsConfigformIList<CustomFieldConfig>No
CustomerCustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
SchedulesformIList<ISchedule>No
CustomerActiveBookingsformIList<Booking>No
ScheduleTypeformScheduleTypeNo
LastTimeToUnbookThresholdformTimeSpanNo
LastTimeToBookThresholdformTimeSpanNo
RatingScoreformAverageRatingScoreNo
RatingsformList<Rating>No
CompanyIdformGuidYes
IdformintNo
NameformstringYes
DescriptionformstringYes
GroupformstringNo
ActiveformboolYes
SortOrderformintYes
PauseAfterBookingformintYes
UnbookBeforeDaysformintYes
UnbookBeforeHoursformintYes
UnbookBeforeMinutesformintYes
BookBeforeDaysformintYes
BookBeforeHoursformintYes
BookBeforeMinutesformintYes
Durationformint?No
DurationTypeIdformintNo
MinDurationformint?No
MaxDurationformint?No
DurationIntervalformint?No
TotalSpotsformint?No
ImageUrlformstringNo
ScheduleTypeIdformintYes
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
OnlyVisibleByAdminformboolYes
MinNumberOfSpotsPerBookingformintYes
MaxNumberOfSpotsPerBookingformintYes
MinNumberOfResourcesToBookformintYes
MaxNumberOfResourcesToBookformintYes
IsPaymentEnabledformboolYes
MaxPaymentTimeformintYes
LockSpotsToBookingformboolYes
EnableBookingQueueformboolYes
ModifiedDateformDateTimeOffset?No
BookingStatusIdformintYes
EnableCodeLockSyncformboolYes
EnableCustomerManualPaymentformboolYes
PriceViewTypeIdformint?No
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
ResourceType Parameters:
NameParameterData TypeRequiredDescription
SelectableByUserformboolNo
ResourcesformList<Resource>No
CompanyIdformGuidYes
IdformintNo
NameformstringYes
DescriptionformstringNo
ActiveformboolYes
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
TotalPriceInformation Parameters:
NameParameterData TypeRequiredDescription
TotalPriceformdoubleNo
TotalVATAmountformdoubleNo
TotalRebateformdoubleNo
TotalPriceBeforeRebateformdoubleNo
AppliedCodesformList<AppliedRebateCodes>No
PriceSignformstringNo
CurrencyIdformstringNo
VATformdecimalNo
AppliedRebateCodes Parameters:
NameParameterData TypeRequiredDescription
RebateCodeIdformintNo
RebateCodeSignformstringNo
RebateCodeValueformintNo
RebateAmountformdoubleNo
RebateCodeTypeformRebateCodeTypeNo
RebateCodeType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ModifiedDateformDateTimeOffset?No
IdformintNo
ServicePrice Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
ServiceformServiceNo
PriceMappingsformList<PriceMapping>No
isTimeSpecificformboolNo
isDaysOfWeekSpecificformboolNo
DayOfWeeksformList<ServicePriceDayOfWeekRelation>No
PriceBeforeRebateformdouble?No
RebateCodesAppliedformList<RebateCode>No
PriceTextformstringNo
OverlappingPricesformList<ServicePrice>No
CompanyIdformGuidYes
IdformintNo
ServiceIdformintYes
Priceformdouble?No
UpdatedformDateTimeYes
CreatedformDateTimeYes
FromTimeformTimeSpanYes
ToTimeformTimeSpanYes
VATformdecimalYes
CategoryformstringNo
ModifiedDateformDateTimeOffset?No
FromformDateTimeYes
ToformDateTimeYes
CalculationTypeIdformintYes
Currency Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
CurrencySignformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformstringYes
PriceMapping Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformGuidYes
PriceIdformintYes
ReferenceTypeformstringNo
ExternalReferenceformstringNo
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
ServicePriceDayOfWeekRelation Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformBokaMeraDayOfWeekNo
CompanyIdformGuidYes
ServicePriceIdformintYes
DayOfWeekIdformintYes
ModifiedDateformDateTimeOffset?No
IdformintNo
BokaMeraDayOfWeek Enum:
NameValue
Monday1
Tuesday2
Wednesday3
Thursday4
Friday5
Saturday6
Sunday7
RebateCode Parameters:
NameParameterData TypeRequiredDescription
RebateCodeTypeIdformintNo
RebateCodeTypeInfoformRebateCodeTypeNo
RebateCodeStatusIdformintNo
RebateCodeStatusInfoformRebateCodeStatusNo
ArticleformArticleNo
ServicesformList<Service>No
RebateCodeDayOfWeekRelationformList<RebateCodeDayOfWeekRelation>No
RebateCodeServiceRelationformList<RebateCodeServiceRelation>No
RebateCodeBookingPriceRelationformList<RebateCodeBookingPriceRelation>No
RebateCodeCustomerRelationformList<RebateCodeCustomerRelation>No
ServicesNamesformstringNo
DaysOfWeekformList<DaysOfWeek>No
RebateCodeStatusformRebateCodeStatusNo
RebateCodeTypeformRebateCodeTypeNo
TransactionsformList<RebateCodeTransaction>No
RemainingAmountformdouble?No
RemainingUsageformint?No
CurrentNumberOfUsesPerCustomerformintNo
IsSpecificByDayOfWeekformboolNo
ActiveformboolNo
ActiveByStatusformboolNo
RebateCodeCurrencySignformstringNo
CurrencyInfoformCurrencyNo
PaymentReceivedformboolNo
InternalReferenceIdformstringNo
ValidFromformDateTimeYes
ValidToformDateTimeYes
RebateCodeSignformstringYes
RebateCodeValueformintYes
MaxNumberOfUsesformintYes
MaxNumberOfUsesPerCustomerformintYes
NumberOfUsesUsedformintYes
PersonalNoteformstringNo
CreatedByformstringYes
CreatedformDateTimeYes
UpdatedByformstringYes
UpdatedDateformDateTimeYes
FromTimeformTimeSpanYes
ToTimeformTimeSpanYes
ModifiedDateformDateTimeOffset?No
IdformintNo
ArticleIdformint?No
PayableEntity Parameters:
NameParameterData TypeRequiredDescription
DbFactoryformIDbConnectionFactoryNo
QvicklyPaymentManagerformIBokameraPaymentManager<InitCheckoutRequestBody, QvicklyCheckoutResponse, QvicklyPaymentResponse>No
Payson2PaymentManagerformIBokameraPaymentManager<Payson2CheckoutResponse, Payson2CheckoutResponse, Payson2CheckoutResponse>No
StripePaymentManagerformIBokameraPaymentManager<SessionCreateOptions, CustomSessionData, CustomSessionData>No
PaysonPaymentCheckout1formIPaysonPaymentCheckout1No
LoggerformILogger<PayableEntity>No
InternalReferenceIdformstringNo
PaymentLogformList<PaymentLog>No
CompanyIdformGuidNo
PriceVatformdecimal?No
CurrencyIdformstringNo
CustomerformCustomerNo
CustomersformList<Customer>No
CompanyformCompanyNo
InitCheckoutRequestBody Parameters:
NameParameterData TypeRequiredDescription
credentialsformCredentialsNo
dataformInitCheckoutDataNo
functionformstringNo
Credentials Parameters:
NameParameterData TypeRequiredDescription
hashformstringNo
idformstringNo
versionformstringNo
clientformstringNo
serverdataformServerDataNo
timeformstringNo
testformstringNo
languageformstringNo
ServerData Parameters:
NameParameterData TypeRequiredDescription
HTTP_HOSTformstringNo
HTTP_CONNECTIONformstringNo
HTTP_CACHE_CONTROLformstringNo
HTTP_ACCEPTformstringNo
HTTP_USER_AGENTformstringNo
HTTP_ACCEPT_ENCODINGformstringNo
HTTP_ACCEPT_LANGUAGEformstringNo
PATHformstringNo
SERVER_SOFTWAREformstringNo
SERVER_NAMEformstringNo
SERVER_ADDRformstringNo
SERVER_PORTformstringNo
REMOTE_ADDRformstringNo
REMOTE_PORTformstringNo
GATEWAY_INTERFACEformstringNo
SERVER_PROTOCOLformstringNo
REQUEST_METHODformstringNo
QUERY_STRINGformstringNo
REQUEST_TIMEformstringNo
InitCheckoutData Parameters:
NameParameterData TypeRequiredDescription
CheckoutDataformCheckoutDataNo
PaymentDataformCheckoutPaymentDataNo
PaymentInfoformPaymentInfoNo
ArticlesformQvicklyArticle[]No
CartformCartNo
QvicklyCustomerformQvicklyCustomerNo
CheckoutData Parameters:
NameParameterData TypeRequiredDescription
termsformUriNo
privacyPolicyformUriNo
redirectOnSuccessformstringNo
CheckoutPaymentData Parameters:
NameParameterData TypeRequiredDescription
currencyformstringNo
languageformstringNo
countryformstringNo
autoactivateformstringNo
orderidformstringNo
returnmethodformstringNo
accepturlformUriNo
cancelurlformUriNo
callbackurlformUriNo
PaymentInfo Parameters:
NameParameterData TypeRequiredDescription
paymentdateformstringNo
paymenttermsformstringNo
yourreferenceformstringNo
ourreferenceformstringNo
projectnameformstringNo
deliverymethodformstringNo
deliverytermsformstringNo
QvicklyArticle Parameters:
NameParameterData TypeRequiredDescription
artnrformstringNo
titleformstringNo
quantityformintNo
apriceformintNo
taxformintNo
discountformintNo
withouttaxformintNo
taxrateformintNo
Cart Parameters:
NameParameterData TypeRequiredDescription
HandlingformCartHandlingNo
TotalformCartTotalNo
ShippingformShippingNo
CartHandling Parameters:
NameParameterData TypeRequiredDescription
withouttaxformstringNo
taxrateformstringNo
CartTotal Parameters:
NameParameterData TypeRequiredDescription
roundingformstringNo
withouttaxformstringNo
taxformstringNo
withtaxformstringNo
Shipping Parameters:
NameParameterData TypeRequiredDescription
firstnameformstringNo
lastnameformstringNo
companyformstringNo
streetformstringNo
street2formstringNo
zipformstringNo
cityformstringNo
countryformstringNo
phoneformstringNo
withouttaxformstringNo
taxrateformstringNo
QvicklyCustomer Parameters:
NameParameterData TypeRequiredDescription
nrformstringNo
pnoformstringNo
BillingformCustomerBillingNo
CustomerBilling Parameters:
NameParameterData TypeRequiredDescription
firstnameformstringNo
lastnameformstringNo
companyformstringNo
streetformstringNo
street2formstringNo
zipformstringNo
cityformstringNo
countryformstringNo
phoneformstringNo
emailformstringNo
QvicklyCheckoutResponse Parameters:
NameParameterData TypeRequiredDescription
NumberformintNo
StatusformstringNo
OrderIdformstringNo
UrlformstringNo
QvicklyPaymentResponse Parameters:
NameParameterData TypeRequiredDescription
PaymentDataformQvikclyPaymentDataNo
PaymentInfoformPaymentInfoNo
CardformCardNo
SettlementformSettlementNo
QvicklyCustomerformQvicklyCustomerNo
ArticlesformQvicklyArticle[]No
CartformCartNo
QvikclyPaymentData Parameters:
NameParameterData TypeRequiredDescription
methodformstringNo
paymentplanidformstringNo
currencyformstringNo
countryformstringNo
languageformstringNo
autoactivateformstringNo
orderidformstringNo
statusformstringNo
paymentid_relatedformstringNo
urlformstringNo
Card Parameters:
NameParameterData TypeRequiredDescription
promptnameformstringNo
recurringformstringNo
recurringnrformstringNo
accepturlformstringNo
cancelurlformstringNo
callbackurlformstringNo
returnmethodformstringNo
Settlement Parameters:
NameParameterData TypeRequiredDescription
numberformstringNo
dateformstringNo
Payson2CheckoutResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
ExpirationTimeformDateTime?No
SnippetformstringNo
StatusformPayson2CheckoutStatusNo
CustomerformCustomerNo
OrderformOrderNo
MerchantformMerchantNo
GuiformGuiNo
HistoryformHistoryNo
PurchaseIdformint?No
Payson2CheckoutStatus Enum:
None
Created
FormsFilled
ReadyToPay
ProcessingPayment
ReadyToShip
Shipped
PaidToAccount
Canceled
Credited
Expired
Denied
Customer Parameters:
NameParameterData TypeRequiredDescription
CityformstringNo
CountryCodeformstringNo
IdentityNumberformstringNo
EmailformstringNo
FirstNameformstringNo
LastNameformstringNo
PhoneformstringNo
PostalCodeformstringNo
StreetformstringNo
ReferenceformstringNo
TypeformCustomerTypeNo
CustomerType Enum:
Person
Business
Order Parameters:
NameParameterData TypeRequiredDescription
CurrencyformCurrencyNo
TotalFeeExcludingTaxformdecimalNo
TotalFeeIncludingTaxformdecimalNo
TotalPriceExcludingTaxformdecimalNo
TotalPriceIncludingTaxformdecimalNo
TotalTaxAmountformdecimalNo
TotalCreditedAmountformdecimalNo
ItemsformIList<Item>No
Currency Enum:
NameValue
SEK1
EUR2
Item Parameters:
NameParameterData TypeRequiredDescription
ItemIdformGuidNo
DiscountRateformdecimalNo
EanformstringNo
ImageUriformUriNo
NameformstringNo
QuantityformdecimalNo
ReferenceformstringNo
TaxRateformdecimalNo
TotalPriceExcludingTaxformdecimalNo
TotalPriceIncludingTaxformdecimalNo
TotalTaxAmountformdecimalNo
CreditedAmountformdecimalNo
TypeformItemTypeNo
UnitPriceformdecimalNo
UriformUriNo
ItemType Enum:
Physical
Service
Fee
Discount
Merchant Parameters:
NameParameterData TypeRequiredDescription
CheckoutUriformUriNo
ConfirmationUriformUriNo
NotificationUriformUriNo
ValidationUriformUriNo
TermsUriformUriNo
ReferenceformstringNo
PartnerIdformstringNo
Gui Parameters:
NameParameterData TypeRequiredDescription
ColorSchemeformColorSchemeNo
LocaleformstringNo
RequestPhoneformboolNo
PhoneOptionalformboolNo
ColorScheme Enum:
White
Blue
Gray
GrayTextLogos
BlueTextLogos
WhiteTextLogos
WhiteNoFooter
GrayNoFooter
BlueNoFooter
History Parameters:
NameParameterData TypeRequiredDescription
CreatedformDateTime?No
ReadyToPayformDateTime?No
ReadyToShipformDateTime?No
ShippedformDateTime?No
PaidToAccountformDateTime?No
CanceledformDateTime?No
ExpiredformDateTime?No
DeniedformDateTime?No
SessionCreateOptions Parameters:
NameParameterData TypeRequiredDescription
AfterExpirationformSessionAfterExpirationOptionsNo
AllowPromotionCodesformbool?No
AutomaticTaxformSessionAutomaticTaxOptionsNo
BillingAddressCollectionformstringNo
CancelUrlformstringNo
ClientReferenceIdformstringNo
ConsentCollectionformSessionConsentCollectionOptionsNo
CurrencyformstringNo
CustomFieldsformList<SessionCustomFieldOptions>No
CustomTextformSessionCustomTextOptionsNo
CustomerformstringNo
CustomerCreationformstringNo
CustomerEmailformstringNo
CustomerUpdateformSessionCustomerUpdateOptionsNo
DiscountsformList<SessionDiscountOptions>No
ExpiresAtformDateTime?No
InvoiceCreationformSessionInvoiceCreationOptionsNo
LineItemsformList<SessionLineItemOptions>No
LocaleformstringNo
MetadataformDictionary<string, string>No
ModeformstringNo
PaymentIntentDataformSessionPaymentIntentDataOptionsNo
PaymentMethodCollectionformstringNo
PaymentMethodConfigurationformstringNo
PaymentMethodDataformSessionPaymentMethodDataOptionsNo
PaymentMethodOptionsformSessionPaymentMethodOptionsOptionsNo
PaymentMethodTypesformList<string>No
PhoneNumberCollectionformSessionPhoneNumberCollectionOptionsNo
RedirectOnCompletionformstringNo
ReturnUrlformstringNo
SavedPaymentMethodOptionsformSessionSavedPaymentMethodOptionsOptionsNo
SetupIntentDataformSessionSetupIntentDataOptionsNo
ShippingAddressCollectionformSessionShippingAddressCollectionOptionsNo
ShippingOptionsformList<SessionShippingOptionOptions>No
SubmitTypeformstringNo
SubscriptionDataformSessionSubscriptionDataOptionsNo
SuccessUrlformstringNo
TaxIdCollectionformSessionTaxIdCollectionOptionsNo
UiModeformstringNo
BaseOptions Parameters:
NameParameterData TypeRequiredDescription
ExpandformList<string>No
ExtraParamsformIDictionary<string, Object>No
SessionAfterExpirationOptions Parameters:
NameParameterData TypeRequiredDescription
RecoveryformSessionAfterExpirationRecoveryOptionsNo
SessionAfterExpirationRecoveryOptions Parameters:
NameParameterData TypeRequiredDescription
AllowPromotionCodesformbool?No
Enabledformbool?No
SessionAutomaticTaxOptions Parameters:
NameParameterData TypeRequiredDescription
Enabledformbool?No
LiabilityformSessionAutomaticTaxLiabilityOptionsNo
SessionAutomaticTaxLiabilityOptions Parameters:
NameParameterData TypeRequiredDescription
AccountformstringNo
TypeformstringNo
SessionConsentCollectionOptions Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodReuseAgreementformSessionConsentCollectionPaymentMethodReuseAgreementOptionsNo
PromotionsformstringNo
TermsOfServiceformstringNo
SessionConsentCollectionPaymentMethodReuseAgreementOptions Parameters:
NameParameterData TypeRequiredDescription
PositionformstringNo
SessionCustomFieldOptions Parameters:
NameParameterData TypeRequiredDescription
DropdownformSessionCustomFieldDropdownOptionsNo
KeyformstringNo
LabelformSessionCustomFieldLabelOptionsNo
NumericformSessionCustomFieldNumericOptionsNo
Optionalformbool?No
TextformSessionCustomFieldTextOptionsNo
TypeformstringNo
SessionCustomFieldDropdownOptions Parameters:
NameParameterData TypeRequiredDescription
DefaultValueformstringNo
OptionsformList<SessionCustomFieldDropdownOptionOptions>No
SessionCustomFieldDropdownOptionOptions Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
ValueformstringNo
SessionCustomFieldLabelOptions Parameters:
NameParameterData TypeRequiredDescription
CustomformstringNo
TypeformstringNo
SessionCustomFieldNumericOptions Parameters:
NameParameterData TypeRequiredDescription
DefaultValueformstringNo
MaximumLengthformlong?No
MinimumLengthformlong?No
SessionCustomFieldTextOptions Parameters:
NameParameterData TypeRequiredDescription
DefaultValueformstringNo
MaximumLengthformlong?No
MinimumLengthformlong?No
SessionCustomTextOptions Parameters:
NameParameterData TypeRequiredDescription
AfterSubmitformSessionCustomTextAfterSubmitOptionsNo
ShippingAddressformSessionCustomTextShippingAddressOptionsNo
SubmitformSessionCustomTextSubmitOptionsNo
TermsOfServiceAcceptanceformSessionCustomTextTermsOfServiceAcceptanceOptionsNo
SessionCustomTextAfterSubmitOptions Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SessionCustomTextShippingAddressOptions Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SessionCustomTextSubmitOptions Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SessionCustomTextTermsOfServiceAcceptanceOptions Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SessionCustomerUpdateOptions Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
NameformstringNo
ShippingformstringNo
SessionDiscountOptions Parameters:
NameParameterData TypeRequiredDescription
CouponformstringNo
PromotionCodeformstringNo
SessionInvoiceCreationOptions Parameters:
NameParameterData TypeRequiredDescription
Enabledformbool?No
InvoiceDataformSessionInvoiceCreationInvoiceDataOptionsNo
SessionInvoiceCreationInvoiceDataOptions Parameters:
NameParameterData TypeRequiredDescription
AccountTaxIdsformList<string>No
CustomFieldsformList<SessionInvoiceCreationInvoiceDataCustomFieldOptions>No
DescriptionformstringNo
FooterformstringNo
IssuerformSessionInvoiceCreationInvoiceDataIssuerOptionsNo
MetadataformDictionary<string, string>No
RenderingOptionsformSessionInvoiceCreationInvoiceDataRenderingOptionsOptionsNo
SessionInvoiceCreationInvoiceDataCustomFieldOptions Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
SessionInvoiceCreationInvoiceDataIssuerOptions Parameters:
NameParameterData TypeRequiredDescription
AccountformstringNo
TypeformstringNo
SessionInvoiceCreationInvoiceDataRenderingOptionsOptions Parameters:
NameParameterData TypeRequiredDescription
AmountTaxDisplayformstringNo
SessionLineItemOptions Parameters:
NameParameterData TypeRequiredDescription
AdjustableQuantityformSessionLineItemAdjustableQuantityOptionsNo
DynamicTaxRatesformList<string>No
PriceformstringNo
PriceDataformSessionLineItemPriceDataOptionsNo
Quantityformlong?No
TaxRatesformList<string>No
SessionLineItemAdjustableQuantityOptions Parameters:
NameParameterData TypeRequiredDescription
Enabledformbool?No
Maximumformlong?No
Minimumformlong?No
SessionLineItemPriceDataOptions Parameters:
NameParameterData TypeRequiredDescription
CurrencyformstringNo
ProductformstringNo
ProductDataformSessionLineItemPriceDataProductDataOptionsNo
RecurringformSessionLineItemPriceDataRecurringOptionsNo
TaxBehaviorformstringNo
UnitAmountformlong?No
UnitAmountDecimalformdecimal?No
SessionLineItemPriceDataProductDataOptions Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
ImagesformList<string>No
MetadataformDictionary<string, string>No
NameformstringNo
TaxCodeformstringNo
SessionLineItemPriceDataRecurringOptions Parameters:
NameParameterData TypeRequiredDescription
IntervalformstringNo
IntervalCountformlong?No
SessionPaymentIntentDataOptions Parameters:
NameParameterData TypeRequiredDescription
ApplicationFeeAmountformlong?No
CaptureMethodformstringNo
DescriptionformstringNo
MetadataformDictionary<string, string>No
OnBehalfOfformstringNo
ReceiptEmailformstringNo
SetupFutureUsageformstringNo
ShippingformChargeShippingOptionsNo
StatementDescriptorformstringNo
StatementDescriptorSuffixformstringNo
TransferDataformSessionPaymentIntentDataTransferDataOptionsNo
TransferGroupformstringNo
ChargeShippingOptions Parameters:
NameParameterData TypeRequiredDescription
AddressformAddressOptionsNo
CarrierformstringNo
NameformstringNo
PhoneformstringNo
TrackingNumberformstringNo
AddressOptions Parameters:
NameParameterData TypeRequiredDescription
CityformstringNo
CountryformstringNo
Line1formstringNo
Line2formstringNo
PostalCodeformstringNo
StateformstringNo
SessionPaymentIntentDataTransferDataOptions Parameters:
NameParameterData TypeRequiredDescription
Amountformlong?No
DestinationformstringNo
SessionPaymentMethodDataOptions Parameters:
NameParameterData TypeRequiredDescription
AllowRedisplayformstringNo
SessionPaymentMethodOptionsOptions Parameters:
NameParameterData TypeRequiredDescription
AcssDebitformSessionPaymentMethodOptionsAcssDebitOptionsNo
AffirmformSessionPaymentMethodOptionsAffirmOptionsNo
AfterpayClearpayformSessionPaymentMethodOptionsAfterpayClearpayOptionsNo
AlipayformSessionPaymentMethodOptionsAlipayOptionsNo
AmazonPayformSessionPaymentMethodOptionsAmazonPayOptionsNo
AuBecsDebitformSessionPaymentMethodOptionsAuBecsDebitOptionsNo
BacsDebitformSessionPaymentMethodOptionsBacsDebitOptionsNo
BancontactformSessionPaymentMethodOptionsBancontactOptionsNo
BoletoformSessionPaymentMethodOptionsBoletoOptionsNo
CardformSessionPaymentMethodOptionsCardOptionsNo
CashappformSessionPaymentMethodOptionsCashappOptionsNo
CustomerBalanceformSessionPaymentMethodOptionsCustomerBalanceOptionsNo
EpsformSessionPaymentMethodOptionsEpsOptionsNo
FpxformSessionPaymentMethodOptionsFpxOptionsNo
GiropayformSessionPaymentMethodOptionsGiropayOptionsNo
GrabpayformSessionPaymentMethodOptionsGrabpayOptionsNo
IdealformSessionPaymentMethodOptionsIdealOptionsNo
KlarnaformSessionPaymentMethodOptionsKlarnaOptionsNo
KonbiniformSessionPaymentMethodOptionsKonbiniOptionsNo
LinkformSessionPaymentMethodOptionsLinkOptionsNo
MobilepayformSessionPaymentMethodOptionsMobilepayOptionsNo
MultibancoformSessionPaymentMethodOptionsMultibancoOptionsNo
OxxoformSessionPaymentMethodOptionsOxxoOptionsNo
P24formSessionPaymentMethodOptionsP24OptionsNo
PaynowformSessionPaymentMethodOptionsPaynowOptionsNo
PaypalformSessionPaymentMethodOptionsPaypalOptionsNo
PixformSessionPaymentMethodOptionsPixOptionsNo
RevolutPayformSessionPaymentMethodOptionsRevolutPayOptionsNo
SepaDebitformSessionPaymentMethodOptionsSepaDebitOptionsNo
SofortformSessionPaymentMethodOptionsSofortOptionsNo
SwishformSessionPaymentMethodOptionsSwishOptionsNo
UsBankAccountformSessionPaymentMethodOptionsUsBankAccountOptionsNo
WechatPayformSessionPaymentMethodOptionsWechatPayOptionsNo
SessionPaymentMethodOptionsAcssDebitOptions Parameters:
NameParameterData TypeRequiredDescription
CurrencyformstringNo
MandateOptionsformSessionPaymentMethodOptionsAcssDebitMandateOptionsOptionsNo
SetupFutureUsageformstringNo
VerificationMethodformstringNo
SessionPaymentMethodOptionsAcssDebitMandateOptionsOptions Parameters:
NameParameterData TypeRequiredDescription
CustomMandateUrlformstringNo
DefaultForformList<string>No
IntervalDescriptionformstringNo
PaymentScheduleformstringNo
TransactionTypeformstringNo
SessionPaymentMethodOptionsAffirmOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsAfterpayClearpayOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsAlipayOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsAmazonPayOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsAuBecsDebitOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsBacsDebitOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsBancontactOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsBoletoOptions Parameters:
NameParameterData TypeRequiredDescription
ExpiresAfterDaysformlong?No
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsCardOptions Parameters:
NameParameterData TypeRequiredDescription
InstallmentsformSessionPaymentMethodOptionsCardInstallmentsOptionsNo
RequestThreeDSecureformstringNo
SetupFutureUsageformstringNo
StatementDescriptorSuffixKanaformstringNo
StatementDescriptorSuffixKanjiformstringNo
SessionPaymentMethodOptionsCardInstallmentsOptions Parameters:
NameParameterData TypeRequiredDescription
Enabledformbool?No
SessionPaymentMethodOptionsCashappOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsCustomerBalanceOptions Parameters:
NameParameterData TypeRequiredDescription
BankTransferformSessionPaymentMethodOptionsCustomerBalanceBankTransferOptionsNo
FundingTypeformstringNo
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsCustomerBalanceBankTransferOptions Parameters:
NameParameterData TypeRequiredDescription
EuBankTransferformSessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferOptionsNo
RequestedAddressTypesformList<string>No
TypeformstringNo
SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferOptions Parameters:
NameParameterData TypeRequiredDescription
CountryformstringNo
SessionPaymentMethodOptionsEpsOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsFpxOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsGiropayOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsGrabpayOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsIdealOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsKlarnaOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsKonbiniOptions Parameters:
NameParameterData TypeRequiredDescription
ExpiresAfterDaysformlong?No
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsLinkOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsMobilepayOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsMultibancoOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsOxxoOptions Parameters:
NameParameterData TypeRequiredDescription
ExpiresAfterDaysformlong?No
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsP24Options Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
TosShownAndAcceptedformbool?No
SessionPaymentMethodOptionsPaynowOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsPaypalOptions Parameters:
NameParameterData TypeRequiredDescription
CaptureMethodformstringNo
PreferredLocaleformstringNo
ReferenceformstringNo
RiskCorrelationIdformstringNo
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsPixOptions Parameters:
NameParameterData TypeRequiredDescription
ExpiresAfterSecondsformlong?No
SessionPaymentMethodOptionsRevolutPayOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsSepaDebitOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsSofortOptions Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsSwishOptions Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringNo
SessionPaymentMethodOptionsUsBankAccountOptions Parameters:
NameParameterData TypeRequiredDescription
FinancialConnectionsformSessionPaymentMethodOptionsUsBankAccountFinancialConnectionsOptionsNo
SetupFutureUsageformstringNo
VerificationMethodformstringNo
SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions Parameters:
NameParameterData TypeRequiredDescription
PermissionsformList<string>No
PrefetchformList<string>No
SessionPaymentMethodOptionsWechatPayOptions Parameters:
NameParameterData TypeRequiredDescription
AppIdformstringNo
ClientformstringNo
SetupFutureUsageformstringNo
SessionPhoneNumberCollectionOptions Parameters:
NameParameterData TypeRequiredDescription
Enabledformbool?No
SessionSavedPaymentMethodOptionsOptions Parameters:
NameParameterData TypeRequiredDescription
AllowRedisplayFiltersformList<string>No
PaymentMethodSaveformstringNo
SessionSetupIntentDataOptions Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
MetadataformDictionary<string, string>No
OnBehalfOfformstringNo
SessionShippingAddressCollectionOptions Parameters:
NameParameterData TypeRequiredDescription
AllowedCountriesformList<string>No
SessionShippingOptionOptions Parameters:
NameParameterData TypeRequiredDescription
ShippingRateformstringNo
ShippingRateDataformSessionShippingOptionShippingRateDataOptionsNo
SessionShippingOptionShippingRateDataOptions Parameters:
NameParameterData TypeRequiredDescription
DeliveryEstimateformSessionShippingOptionShippingRateDataDeliveryEstimateOptionsNo
DisplayNameformstringNo
FixedAmountformSessionShippingOptionShippingRateDataFixedAmountOptionsNo
MetadataformDictionary<string, string>No
TaxBehaviorformstringNo
TaxCodeformstringNo
TypeformstringNo
SessionShippingOptionShippingRateDataDeliveryEstimateOptions Parameters:
NameParameterData TypeRequiredDescription
MaximumformSessionShippingOptionShippingRateDataDeliveryEstimateMaximumOptionsNo
MinimumformSessionShippingOptionShippingRateDataDeliveryEstimateMinimumOptionsNo
SessionShippingOptionShippingRateDataDeliveryEstimateMaximumOptions Parameters:
NameParameterData TypeRequiredDescription
UnitformstringNo
Valueformlong?No
SessionShippingOptionShippingRateDataDeliveryEstimateMinimumOptions Parameters:
NameParameterData TypeRequiredDescription
UnitformstringNo
Valueformlong?No
SessionShippingOptionShippingRateDataFixedAmountOptions Parameters:
NameParameterData TypeRequiredDescription
Amountformlong?No
CurrencyformstringNo
CurrencyOptionsformDictionary<string, SessionShippingOptionShippingRateDataFixedAmountCurrencyOptionsOptions>No
SessionShippingOptionShippingRateDataFixedAmountCurrencyOptionsOptions Parameters:
NameParameterData TypeRequiredDescription
Amountformlong?No
TaxBehaviorformstringNo
SessionSubscriptionDataOptions Parameters:
NameParameterData TypeRequiredDescription
ApplicationFeePercentformdecimal?No
BillingCycleAnchorformDateTime?No
DefaultTaxRatesformList<string>No
DescriptionformstringNo
InvoiceSettingsformSessionSubscriptionDataInvoiceSettingsOptionsNo
MetadataformDictionary<string, string>No
OnBehalfOfformstringNo
ProrationBehaviorformstringNo
TransferDataformSessionSubscriptionDataTransferDataOptionsNo
TrialEndformDateTime?No
TrialPeriodDaysformlong?No
TrialSettingsformSessionSubscriptionDataTrialSettingsOptionsNo
SessionSubscriptionDataInvoiceSettingsOptions Parameters:
NameParameterData TypeRequiredDescription
IssuerformSessionSubscriptionDataInvoiceSettingsIssuerOptionsNo
SessionSubscriptionDataInvoiceSettingsIssuerOptions Parameters:
NameParameterData TypeRequiredDescription
AccountformstringNo
TypeformstringNo
SessionSubscriptionDataTransferDataOptions Parameters:
NameParameterData TypeRequiredDescription
AmountPercentformdecimal?No
DestinationformstringNo
SessionSubscriptionDataTrialSettingsOptions Parameters:
NameParameterData TypeRequiredDescription
EndBehaviorformSessionSubscriptionDataTrialSettingsEndBehaviorOptionsNo
SessionSubscriptionDataTrialSettingsEndBehaviorOptions Parameters:
NameParameterData TypeRequiredDescription
MissingPaymentMethodformstringNo
SessionTaxIdCollectionOptions Parameters:
NameParameterData TypeRequiredDescription
Enabledformbool?No
RequiredformstringNo
CustomSessionData Parameters:
NameParameterData TypeRequiredDescription
SessionformSessionNo
LineItemsformList<LineItem>No
Session Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ObjectformstringNo
AfterExpirationformSessionAfterExpirationNo
AllowPromotionCodesformbool?No
AmountSubtotalformlong?No
AmountTotalformlong?No
AutomaticTaxformSessionAutomaticTaxNo
BillingAddressCollectionformstringNo
CancelUrlformstringNo
ClientReferenceIdformstringNo
ClientSecretformstringNo
ConsentformSessionConsentNo
ConsentCollectionformSessionConsentCollectionNo
CreatedformDateTimeNo
CurrencyformstringNo
CurrencyConversionformSessionCurrencyConversionNo
CustomFieldsformList<SessionCustomField>No
CustomTextformSessionCustomTextNo
CustomerCreationformstringNo
CustomerDetailsformSessionCustomerDetailsNo
CustomerEmailformstringNo
ExpiresAtformDateTimeNo
InvoiceCreationformSessionInvoiceCreationNo
LineItemsformStripeList<LineItem>No
LivemodeformboolNo
LocaleformstringNo
MetadataformDictionary<string, string>No
ModeformstringNo
PaymentMethodCollectionformstringNo
PaymentMethodConfigurationDetailsformSessionPaymentMethodConfigurationDetailsNo
PaymentMethodOptionsformSessionPaymentMethodOptionsNo
PaymentMethodTypesformList<string>No
PaymentStatusformstringNo
PhoneNumberCollectionformSessionPhoneNumberCollectionNo
RecoveredFromformstringNo
RedirectOnCompletionformstringNo
ReturnUrlformstringNo
SavedPaymentMethodOptionsformSessionSavedPaymentMethodOptionsNo
ShippingAddressCollectionformSessionShippingAddressCollectionNo
ShippingCostformSessionShippingCostNo
ShippingDetailsformSessionShippingDetailsNo
ShippingOptionsformList<SessionShippingOption>No
StatusformstringNo
SubmitTypeformstringNo
SuccessUrlformstringNo
TaxIdCollectionformSessionTaxIdCollectionNo
TotalDetailsformSessionTotalDetailsNo
UiModeformstringNo
UrlformstringNo
SessionAfterExpiration Parameters:
NameParameterData TypeRequiredDescription
RecoveryformSessionAfterExpirationRecoveryNo
SessionAfterExpirationRecovery Parameters:
NameParameterData TypeRequiredDescription
AllowPromotionCodesformboolNo
EnabledformboolNo
ExpiresAtformDateTime?No
UrlformstringNo
SessionAutomaticTax Parameters:
NameParameterData TypeRequiredDescription
EnabledformboolNo
LiabilityformSessionAutomaticTaxLiabilityNo
StatusformstringNo
SessionAutomaticTaxLiability Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
SessionConsent Parameters:
NameParameterData TypeRequiredDescription
PromotionsformstringNo
TermsOfServiceformstringNo
SessionConsentCollection Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodReuseAgreementformSessionConsentCollectionPaymentMethodReuseAgreementNo
PromotionsformstringNo
TermsOfServiceformstringNo
SessionConsentCollectionPaymentMethodReuseAgreement Parameters:
NameParameterData TypeRequiredDescription
PositionformstringNo
SessionCurrencyConversion Parameters:
NameParameterData TypeRequiredDescription
AmountSubtotalformlongNo
AmountTotalformlongNo
FxRateformdecimalNo
SourceCurrencyformstringNo
SessionCustomField Parameters:
NameParameterData TypeRequiredDescription
DropdownformSessionCustomFieldDropdownNo
KeyformstringNo
LabelformSessionCustomFieldLabelNo
NumericformSessionCustomFieldNumericNo
OptionalformboolNo
TextformSessionCustomFieldTextNo
TypeformstringNo
SessionCustomFieldDropdown Parameters:
NameParameterData TypeRequiredDescription
DefaultValueformstringNo
OptionsformList<SessionCustomFieldDropdownOption>No
ValueformstringNo
SessionCustomFieldDropdownOption Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
ValueformstringNo
SessionCustomFieldLabel Parameters:
NameParameterData TypeRequiredDescription
CustomformstringNo
TypeformstringNo
SessionCustomFieldNumeric Parameters:
NameParameterData TypeRequiredDescription
DefaultValueformstringNo
MaximumLengthformlong?No
MinimumLengthformlong?No
ValueformstringNo
SessionCustomFieldText Parameters:
NameParameterData TypeRequiredDescription
DefaultValueformstringNo
MaximumLengthformlong?No
MinimumLengthformlong?No
ValueformstringNo
SessionCustomText Parameters:
NameParameterData TypeRequiredDescription
AfterSubmitformSessionCustomTextAfterSubmitNo
ShippingAddressformSessionCustomTextShippingAddressNo
SubmitformSessionCustomTextSubmitNo
TermsOfServiceAcceptanceformSessionCustomTextTermsOfServiceAcceptanceNo
SessionCustomTextAfterSubmit Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SessionCustomTextShippingAddress Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SessionCustomTextSubmit Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SessionCustomTextTermsOfServiceAcceptance Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SessionCustomerDetails Parameters:
NameParameterData TypeRequiredDescription
AddressformAddressNo
EmailformstringNo
NameformstringNo
PhoneformstringNo
TaxExemptformstringNo
TaxIdsformList<SessionCustomerDetailsTaxId>No
Address Parameters:
NameParameterData TypeRequiredDescription
CityformstringNo
CountryformstringNo
Line1formstringNo
Line2formstringNo
PostalCodeformstringNo
StateformstringNo
SessionCustomerDetailsTaxId Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
ValueformstringNo
SessionInvoiceCreation Parameters:
NameParameterData TypeRequiredDescription
EnabledformboolNo
InvoiceDataformSessionInvoiceCreationInvoiceDataNo
SessionInvoiceCreationInvoiceData Parameters:
NameParameterData TypeRequiredDescription
CustomFieldsformList<SessionInvoiceCreationInvoiceDataCustomField>No
DescriptionformstringNo
FooterformstringNo
IssuerformSessionInvoiceCreationInvoiceDataIssuerNo
MetadataformDictionary<string, string>No
RenderingOptionsformSessionInvoiceCreationInvoiceDataRenderingOptionsNo
SessionInvoiceCreationInvoiceDataCustomField Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
SessionInvoiceCreationInvoiceDataIssuer Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
SessionInvoiceCreationInvoiceDataRenderingOptions Parameters:
NameParameterData TypeRequiredDescription
AmountTaxDisplayformstringNo
LineItem Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ObjectformstringNo
AmountDiscountformlongNo
AmountSubtotalformlongNo
AmountTaxformlongNo
AmountTotalformlongNo
CurrencyformstringNo
Deletedformbool?No
DescriptionformstringNo
DiscountsformList<LineItemDiscount>No
PriceformPriceNo
Quantityformlong?No
TaxesformList<LineItemTax>No
LineItemDiscount Parameters:
NameParameterData TypeRequiredDescription
AmountformlongNo
DiscountformDiscountNo
Discount Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ObjectformstringNo
CheckoutSessionformstringNo
CouponformCouponNo
Deletedformbool?No
EndformDateTime?No
InvoiceformstringNo
InvoiceItemformstringNo
StartformDateTimeNo
SubscriptionformstringNo
SubscriptionItemformstringNo
Coupon Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ObjectformstringNo
AmountOffformlong?No
AppliesToformCouponAppliesToNo
CreatedformDateTimeNo
CurrencyformstringNo
CurrencyOptionsformDictionary<string, CouponCurrencyOptions>No
Deletedformbool?No
DurationformstringNo
DurationInMonthsformlong?No
LivemodeformboolNo
MaxRedemptionsformlong?No
MetadataformDictionary<string, string>No
NameformstringNo
PercentOffformdecimal?No
RedeemByformDateTime?No
TimesRedeemedformlongNo
ValidformboolNo
CouponAppliesTo Parameters:
NameParameterData TypeRequiredDescription
ProductsformList<string>No
CouponCurrencyOptions Parameters:
NameParameterData TypeRequiredDescription
AmountOffformlongNo
Price Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ObjectformstringNo
ActiveformboolNo
BillingSchemeformstringNo
CreatedformDateTimeNo
CurrencyformstringNo
CurrencyOptionsformDictionary<string, PriceCurrencyOptions>No
CustomUnitAmountformPriceCustomUnitAmountNo
Deletedformbool?No
LivemodeformboolNo
LookupKeyformstringNo
MetadataformDictionary<string, string>No
NicknameformstringNo
RecurringformPriceRecurringNo
TaxBehaviorformstringNo
TiersformList<PriceTier>No
TiersModeformstringNo
TransformQuantityformPriceTransformQuantityNo
TypeformstringNo
UnitAmountformlong?No
UnitAmountDecimalformdecimal?No
PriceCurrencyOptions Parameters:
NameParameterData TypeRequiredDescription
CustomUnitAmountformPriceCurrencyOptionsCustomUnitAmountNo
TaxBehaviorformstringNo
TiersformList<PriceCurrencyOptionsTier>No
UnitAmountformlong?No
UnitAmountDecimalformdecimal?No
PriceCurrencyOptionsCustomUnitAmount Parameters:
NameParameterData TypeRequiredDescription
Maximumformlong?No
Minimumformlong?No
Presetformlong?No
PriceCurrencyOptionsTier Parameters:
NameParameterData TypeRequiredDescription
FlatAmountformlong?No
FlatAmountDecimalformdecimal?No
UnitAmountformlong?No
UnitAmountDecimalformdecimal?No
UpToformlong?No
PriceCustomUnitAmount Parameters:
NameParameterData TypeRequiredDescription
Maximumformlong?No
Minimumformlong?No
Presetformlong?No
PriceRecurring Parameters:
NameParameterData TypeRequiredDescription
AggregateUsageformstringNo
IntervalformstringNo
IntervalCountformlongNo
MeterformstringNo
TrialPeriodDaysformlong?No
UsageTypeformstringNo
PriceTier Parameters:
NameParameterData TypeRequiredDescription
FlatAmountformlong?No
FlatAmountDecimalformdecimal?No
UnitAmountformlong?No
UnitAmountDecimalformdecimal?No
UpToformlong?No
PriceTransformQuantity Parameters:
NameParameterData TypeRequiredDescription
DivideByformlongNo
RoundformstringNo
LineItemTax Parameters:
NameParameterData TypeRequiredDescription
AmountformlongNo
RateformTaxRateNo
TaxabilityReasonformstringNo
TaxableAmountformlong?No
TaxRate Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ObjectformstringNo
ActiveformboolNo
CountryformstringNo
CreatedformDateTimeNo
DescriptionformstringNo
DisplayNameformstringNo
EffectivePercentageformdecimal?No
InclusiveformboolNo
JurisdictionformstringNo
JurisdictionLevelformstringNo
LivemodeformboolNo
MetadataformDictionary<string, string>No
PercentageformdecimalNo
StateformstringNo
TaxTypeformstringNo
SessionPaymentMethodConfigurationDetails Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ParentformstringNo
SessionPaymentMethodOptions Parameters:
NameParameterData TypeRequiredDescription
AcssDebitformSessionPaymentMethodOptionsAcssDebitNo
AffirmformSessionPaymentMethodOptionsAffirmNo
AfterpayClearpayformSessionPaymentMethodOptionsAfterpayClearpayNo
AlipayformSessionPaymentMethodOptionsAlipayNo
AmazonPayformSessionPaymentMethodOptionsAmazonPayNo
AuBecsDebitformSessionPaymentMethodOptionsAuBecsDebitNo
BacsDebitformSessionPaymentMethodOptionsBacsDebitNo
BancontactformSessionPaymentMethodOptionsBancontactNo
BoletoformSessionPaymentMethodOptionsBoletoNo
CardformSessionPaymentMethodOptionsCardNo
CashappformSessionPaymentMethodOptionsCashappNo
CustomerBalanceformSessionPaymentMethodOptionsCustomerBalanceNo
EpsformSessionPaymentMethodOptionsEpsNo
FpxformSessionPaymentMethodOptionsFpxNo
GiropayformSessionPaymentMethodOptionsGiropayNo
GrabpayformSessionPaymentMethodOptionsGrabpayNo
IdealformSessionPaymentMethodOptionsIdealNo
KlarnaformSessionPaymentMethodOptionsKlarnaNo
KonbiniformSessionPaymentMethodOptionsKonbiniNo
LinkformSessionPaymentMethodOptionsLinkNo
MobilepayformSessionPaymentMethodOptionsMobilepayNo
MultibancoformSessionPaymentMethodOptionsMultibancoNo
OxxoformSessionPaymentMethodOptionsOxxoNo
P24formSessionPaymentMethodOptionsP24No
PaynowformSessionPaymentMethodOptionsPaynowNo
PaypalformSessionPaymentMethodOptionsPaypalNo
PixformSessionPaymentMethodOptionsPixNo
RevolutPayformSessionPaymentMethodOptionsRevolutPayNo
SepaDebitformSessionPaymentMethodOptionsSepaDebitNo
SofortformSessionPaymentMethodOptionsSofortNo
SwishformSessionPaymentMethodOptionsSwishNo
UsBankAccountformSessionPaymentMethodOptionsUsBankAccountNo
SessionPaymentMethodOptionsAcssDebit Parameters:
NameParameterData TypeRequiredDescription
CurrencyformstringNo
MandateOptionsformSessionPaymentMethodOptionsAcssDebitMandateOptionsNo
SetupFutureUsageformstringNo
VerificationMethodformstringNo
SessionPaymentMethodOptionsAcssDebitMandateOptions Parameters:
NameParameterData TypeRequiredDescription
CustomMandateUrlformstringNo
DefaultForformList<string>No
IntervalDescriptionformstringNo
PaymentScheduleformstringNo
TransactionTypeformstringNo
SessionPaymentMethodOptionsAffirm Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsAfterpayClearpay Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsAlipay Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsAmazonPay Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsAuBecsDebit Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsBacsDebit Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsBancontact Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsBoleto Parameters:
NameParameterData TypeRequiredDescription
ExpiresAfterDaysformlongNo
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsCard Parameters:
NameParameterData TypeRequiredDescription
InstallmentsformSessionPaymentMethodOptionsCardInstallmentsNo
RequestThreeDSecureformstringNo
SetupFutureUsageformstringNo
StatementDescriptorSuffixKanaformstringNo
StatementDescriptorSuffixKanjiformstringNo
SessionPaymentMethodOptionsCardInstallments Parameters:
NameParameterData TypeRequiredDescription
EnabledformboolNo
SessionPaymentMethodOptionsCashapp Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsCustomerBalance Parameters:
NameParameterData TypeRequiredDescription
BankTransferformSessionPaymentMethodOptionsCustomerBalanceBankTransferNo
FundingTypeformstringNo
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsCustomerBalanceBankTransfer Parameters:
NameParameterData TypeRequiredDescription
EuBankTransferformSessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferNo
RequestedAddressTypesformList<string>No
TypeformstringNo
SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer Parameters:
NameParameterData TypeRequiredDescription
CountryformstringNo
SessionPaymentMethodOptionsEps Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsFpx Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsGiropay Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsGrabpay Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsIdeal Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsKlarna Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsKonbini Parameters:
NameParameterData TypeRequiredDescription
ExpiresAfterDaysformlong?No
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsLink Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsMobilepay Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsMultibanco Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsOxxo Parameters:
NameParameterData TypeRequiredDescription
ExpiresAfterDaysformlongNo
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsP24 Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsPaynow Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsPaypal Parameters:
NameParameterData TypeRequiredDescription
CaptureMethodformstringNo
PreferredLocaleformstringNo
ReferenceformstringNo
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsPix Parameters:
NameParameterData TypeRequiredDescription
ExpiresAfterSecondsformlong?No
SessionPaymentMethodOptionsRevolutPay Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsSepaDebit Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsSofort Parameters:
NameParameterData TypeRequiredDescription
SetupFutureUsageformstringNo
SessionPaymentMethodOptionsSwish Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringNo
SessionPaymentMethodOptionsUsBankAccount Parameters:
NameParameterData TypeRequiredDescription
FinancialConnectionsformSessionPaymentMethodOptionsUsBankAccountFinancialConnectionsNo
SetupFutureUsageformstringNo
VerificationMethodformstringNo
SessionPaymentMethodOptionsUsBankAccountFinancialConnections Parameters:
NameParameterData TypeRequiredDescription
FiltersformSessionPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersNo
PermissionsformList<string>No
PrefetchformList<string>No
ReturnUrlformstringNo
SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters Parameters:
NameParameterData TypeRequiredDescription
AccountSubcategoriesformList<string>No
SessionPhoneNumberCollection Parameters:
NameParameterData TypeRequiredDescription
EnabledformboolNo
SessionSavedPaymentMethodOptions Parameters:
NameParameterData TypeRequiredDescription
AllowRedisplayFiltersformList<string>No
PaymentMethodRemoveformstringNo
PaymentMethodSaveformstringNo
SessionShippingAddressCollection Parameters:
NameParameterData TypeRequiredDescription
AllowedCountriesformList<string>No
SessionShippingCost Parameters:
NameParameterData TypeRequiredDescription
AmountSubtotalformlongNo
AmountTaxformlongNo
AmountTotalformlongNo
TaxesformList<SessionShippingCostTax>No
SessionShippingCostTax Parameters:
NameParameterData TypeRequiredDescription
AmountformlongNo
RateformTaxRateNo
TaxabilityReasonformstringNo
TaxableAmountformlong?No
SessionShippingDetails Parameters:
NameParameterData TypeRequiredDescription
AddressformAddressNo
CarrierformstringNo
NameformstringNo
PhoneformstringNo
TrackingNumberformstringNo
SessionShippingOption Parameters:
NameParameterData TypeRequiredDescription
ShippingAmountformlongNo
SessionTaxIdCollection Parameters:
NameParameterData TypeRequiredDescription
EnabledformboolNo
RequiredformstringNo
SessionTotalDetails Parameters:
NameParameterData TypeRequiredDescription
AmountDiscountformlongNo
AmountShippingformlong?No
AmountTaxformlongNo
BreakdownformSessionTotalDetailsBreakdownNo
SessionTotalDetailsBreakdown Parameters:
NameParameterData TypeRequiredDescription
DiscountsformList<SessionTotalDetailsBreakdownDiscount>No
TaxesformList<SessionTotalDetailsBreakdownTax>No
SessionTotalDetailsBreakdownDiscount Parameters:
NameParameterData TypeRequiredDescription
AmountformlongNo
DiscountformDiscountNo
SessionTotalDetailsBreakdownTax Parameters:
NameParameterData TypeRequiredDescription
AmountformlongNo
RateformTaxRateNo
TaxabilityReasonformstringNo
TaxableAmountformlong?No
PaymentLog Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
CompanyIdformGuidYes
IdformintNo
InternalReferenceIdformstringYes
ArticleTypeIdformintYes
PaymentReferenceIdformstringNo
PaymentProviderIdformint?No
OrderItemReferenceIdformstringNo
Amountformdouble?No
VATformdecimal?No
AmountCreditedformdouble?No
CommentsformstringNo
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
Customer Parameters:
NameParameterData TypeRequiredDescription
IdentityIdformintNo
IdformGuidNo
CustomerIdformGuidNo
AccessKeysformIList<UserAccessKeys>No
EmailformstringNo
ExternalReferencesformIList<ExternalReference>No
CompanyformCompanyNo
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
CommentsformIList<CustomerComment>No
RebateCodesformIList<RebateCode>No
FirstnameformstringNo
FullNameformstringNo
ImageUrlformstringNo
ActiveformboolYes
FacebookUsernameformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
IpAddressformstringNo
ModifiedDateformDateTimeOffset?No
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
UserIdformGuidNo
LastnameformstringNo
PhoneformstringNo
CorporateIdentityNumberformstringNo
InvoiceAddress1formstringNo
InvoiceAddress2formstringNo
InvoiceCityformstringNo
InvoicePostalCodeformstringNo
InvoiceCountryCodeformstringNo
CompanyIdformGuidYes
SubscribedToNewsletterformboolNo
UserAccessKeys Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
AccessKeyTypeIdformintYes
ValueformstringYes
CustomerIdformGuidYes
DescriptionformstringNo
IdformGuidYes
ExternalReference Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformGuidYes
OwnerIdformGuidYes
ReferenceTypeformstringYes
ExternalDataformstringNo
CreatedByformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
Company Parameters:
NameParameterData TypeRequiredDescription
StatusformCompanyStatusNo
ActiveformboolNo
CustomerCustomFieldsConfigformIList<CustomFieldConfig>No
BookingAgreementsformstringNo
BookingSettingsformBookingSettingsNo
CompanyTypeformCompanyTypeNo
CodeLockSettingsformCodeLockSettingNo
PaymentSettingsformPaymentSettingNo
SettingsformCompanySettingNo
WidgetSettingsformHomepageWidgetSettingNo
HomepageSettingsformHomepageSettingNo
RatingScoreformAverageRatingScoreNo
RatingsformList<Rating>No
Distanceformdouble?No
LicensesformList<License>No
ActiveLicensesformList<License>No
CurrentLicenseformLicenseNo
IsFreeAccountformboolNo
DefaultLanguageformCultureInfoNo
CategoryformCompanyCategoryNo
LatformdoubleNo
LonformdoubleNo
IsFavoriteformboolNo
ExternalReferencesformIList<ExternalReference>No
OrganisationNumberformstringYes
StatusIdformintYes
CategoryIdformintYes
SitePathformstringYes
NameformstringYes
Street1formstringNo
Street2formstringNo
ZipCodeformstringNo
CityformstringNo
OpeningHoursformstringNo
FaxNumberformstringNo
EmailformstringYes
PhoneformstringNo
DetailsformstringNo
LogoTypeformstringNo
ApprovedByAdminformboolYes
UpdatedformDateTimeYes
CreatedformDateTimeYes
IpAddressformstringNo
HomepageformstringNo
DomainNameformstringNo
CountryIdformstringYes
CompanyOwnerIdformintYes
TypeIdformint?No
ModifiedDateformDateTimeOffset?No
IdformGuidYes
CompanyStatus Enum:
NameValue
Registered1
AwaitingApproval2
Approved3
Inactive4
ClosedDown5
NotApproved6
BookingSettings Parameters:
NameParameterData TypeRequiredDescription
FreeSpotTextsIdformintNo
SendEmailConfirmationformboolNo
ScheduleViewOptionsformList<ScheduleView>No
WeekNumberSettingOptionsformList<WeekNumberSetting>No
BookingTemplateOptionsformList<BookingTemplate>No
CalendarTypeOptionsformList<CalendarType>No
FreeSpotTextOptionsformList<FreeSpotTexts>No
BookingStatusOptionsformList<BookingStatusOptions>No
FreeSpotTextsInfoformFreeSpotTextsNo
FreeSpotsTextSingularformstringNo
FreeSpotsTextPluralformstringNo
BookingStatusIdformintYes
ScheduleViewIdformintYes
BookingTemplateIdformintYes
CalendarTypeIdformintYes
AllowBookingOnUnbookedTimesformboolYes
SendEmailReminderformboolYes
SendSmsReminderformboolYes
SendSmsConfirmationformboolYes
EmailReminderTimeformintYes
SmsReminderTimeformintYes
MaxActiveBookingsformintYes
SendNotificationsformboolYes
SendNotificationsEmailformstringNo
EnableMobileAppformboolYes
ScheduleStartTimeformTimeSpan?No
ScheduleEndTimeformTimeSpan?No
ReceiptTemplateformstringNo
ScheduleTimeSlotMinutesformintYes
ShowFreeTimesLeftformboolYes
EnableICalGroupBookingsformboolYes
AgreementTemplateformstringNo
ScheduleShowTimeExeptionsformboolYes
EnableBookingsOnSameTimeformboolYes
ShowWeekNumberSettingIdformintYes
EnableShowBookedTimesformboolYes
EnableSendFollowUpMessageformboolYes
FollowUpMessageTimeformintYes
MessageTextformstringNo
ScheduleGroupResourcesformboolYes
BookSpotUserResponseMinutesformintYes
IsBookSpotDirectlyformboolYes
BookSpotDirectlyTimeLeftMinutesformintYes
SendEmailNotificationQueueformboolYes
SendSMSNotificationQueueformboolYes
SchedulerDisableHorizontalScrollingformboolYes
BookOnlyOnExistingCustomersformboolYes
AutoGenerateUniquePinCodeformboolYes
WeightedPricesformboolYes
ModifiedDateformDateTimeOffset?No
AutoCreateUserProfileformboolYes
ShowMultipleResourcesAsOneformboolNo
ShowMultiDayAsTimeformboolNo
IdformGuidYes
ScheduleView Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
WeekNumberSetting Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
BookingTemplate Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
UsedByApplicationformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
CalendarType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
FreeSpotTexts Parameters:
NameParameterData TypeRequiredDescription
TextSingularformstringYes
TextPluralformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
BookingStatusOptions Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
CompanyType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
CodeLockSetting Parameters:
NameParameterData TypeRequiredDescription
CodeLockSystemOptionsformList<CodeLockSystem>No
ActiveformboolYes
CodeLockSystemsIdformintYes
ValidBeforeMinutesformintYes
ValidAfterMinutesformintYes
DeleteOldByScheduleformboolYes
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
SendEmailNotificationformboolYes
SendSMSNotificationformboolYes
EmailNotificationTimeformshortYes
SMSNotificationTimeformshortYes
IdformGuidYes
CodeLockSystem Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
SupplierformstringYes
LogoTypeformstringNo
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
PaymentSetting Parameters:
NameParameterData TypeRequiredDescription
AdminPaymentOptionformAdminPaymentOptionsNo
AdminPaymentOptionsformList<AdminPaymentOptions>No
PaymentProviderOptionsformList<PaymentProviders>No
EnabledformboolYes
InvoiceFeeformintYes
AllowCreditCardPaymentformboolYes
AllowInvoicePaymentformboolYes
AllowBankPaymentformboolYes
GuaranteeOfferedformboolYes
RefundOnCancelBookingformboolYes
DefaultPaymentOptionIdformint?No
PaymentProviderIdformintYes
SendPaymentRequestDirectlyformboolYes
ModifiedDateformDateTimeOffset?No
IdformGuidYes
AdminPaymentOptions Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
PaymentProviders Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CategoryformstringYes
UrlformstringNo
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformintYes
CompanySetting Parameters:
NameParameterData TypeRequiredDescription
LanguagesformList<LanguageResponse>No
ActiveformboolYes
InactiveMessageformstringNo
SearchableformboolYes
GATrackingIdformstringNo
FacebookPixelIdformstringNo
MultiLanguageformboolYes
EnableAPITranslationformboolYes
DefaultLanguageformstringYes
ModifiedDateformDateTimeOffset?No
GTMTrackingIdformstringNo
ShowOnMarketPlaceformboolYes
GoogleAdsConversionIdformstringNo
LinkedinTagIdformstringNo
GoogleAdsConversionLabelformstringNo
SendCustomerInformationToExternalProvidersformboolNo
IdformGuidYes
LanguageResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
HomepageWidgetSetting Parameters:
NameParameterData TypeRequiredDescription
WidgetServiceLayoutOptionsformList<WidgetServiceLayouts>No
WidgetTimeLayoutOptionsformList<WidgetTimeLayouts>No
WidgetBookingLayoutOptionsformList<WidgetBookingLayouts>No
WidgetBookingMethodOptionsformList<WidgetBookingMethods>No
ServiceLayoutIdformintYes
TimeLayoutIdformintYes
BookingLayoutIdformintYes
PrimaryColorformstringYes
ShowServiceImageformboolYes
ShowNextAvailableTimeformboolYes
ShowEndTimeformboolYes
BookedTimeSlotTextformstringNo
DarkThemeformboolYes
ShowRebateCodeFieldformboolYes
ModifiedDateformDateTimeOffset?No
EnableCreateAccountformboolYes
EnableLoginformboolYes
EnableDirectBookingformboolYes
EnableFacebookLoginformboolYes
ShowSubscribeToNewsletterformboolYes
IdformGuidYes
WidgetServiceLayouts Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CodeformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
WidgetTimeLayouts Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CodeformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
WidgetBookingLayouts Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CodeformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
WidgetBookingMethods Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CodeformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
HomepageSetting Parameters:
NameParameterData TypeRequiredDescription
HomepageTemplateOptionsformList<HomepageTemplate>No
HomepageHeroSectionStyleOptionsformList<HeroSectionStyle>No
CompanyIdformGuid?No
WelcomePageHeadingformstringNo
WelcomePageBodyformstringNo
AboutUsPageHeadingformstringNo
AboutUsPageBodyformstringNo
HomePageTemplateIdformintYes
ImageUrlformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
HomepageHeadingformstringNo
HeroSectionStyleIdformintYes
ModifiedDateformDateTimeOffset?No
ShowRatingformboolYes
EnableHomepageformboolYes
IdformGuidYes
HomepageTemplate Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ImageUrlformUriNo
PremiumformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
HeroSectionStyle Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ModifiedDateformDateTimeOffset?No
IdformintYes
AverageRatingScore Parameters:
NameParameterData TypeRequiredDescription
AverageScoreformdoubleNo
Score1CountformintNo
Score2CountformintNo
Score3CountformintNo
Score4CountformintNo
Score5CountformintNo
CountformintNo
Rating Parameters:
NameParameterData TypeRequiredDescription
ReviewIdformGuid?No
ReviewformReviewNo
CompanyIdformGuidYes
BookingIdformintYes
RatingScoreformintYes
StatusformintYes
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
Review Parameters:
NameParameterData TypeRequiredDescription
ReviewIdformGuidNo
CompanyIdformGuidYes
TitleformstringYes
DescriptionformstringYes
AuthorformstringYes
StatusformintYes
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
ReviewAnswerformstringNo
License Parameters:
NameParameterData TypeRequiredDescription
TypeformLicenseTypeNo
CompanyIdformGuidYes
IdformintNo
TypeIdformintYes
ValidFromformDateTimeYes
ValidToformDateTimeYes
ActiveformboolYes
UpdatedformDateTimeYes
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
MetaDataformstringNo
LicenseType Parameters:
NameParameterData TypeRequiredDescription
LicenseItemsformIList<LicenseTypeItem>No
PricesformIList<LicensePrice>No
PeriodOfNoticeDaysformintNo
NextLicenseOptionformLicenseTypeNo
NameformstringYes
DescriptionformstringYes
ExtraLicenseOptionformboolYes
ModifiedDateformDateTimeOffset?No
ActiveformboolNo
IdformintNo
LicenseTypeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
LicenseTypeformLicenseTypeNo
LicenseTypesIdformintYes
LicenseItemsIdformintYes
NumberOfItemsformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
LicensePrice Parameters:
NameParameterData TypeRequiredDescription
CountryformCountryNo
MonthlyPaymentformboolNo
LicenseTypeIdformintYes
CountryIdformstringYes
PriceformintYes
ModifiedDateformDateTimeOffset?No
Country Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
NameformstringYes
CultureformstringNo
TimeZoneformstringNo
ModifiedDateformDateTimeOffset?No
IdformstringYes
CompanyCategory Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
HeaderformstringYes
DescriptionformstringYes
ImageUrlformUriNo
ActiveformboolYes
SortOrderformint?No
ModifiedDateformDateTimeOffset?No
IdformintNo
CustomFieldDataResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ColumnformstringNo
NameformstringNo
DescriptionformstringNo
ValueformstringNo
DataTypeformstringNoData field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
CustomerComment Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
CustomerIdformGuidYes
CommentsformstringYes
UpdatedformDateTimeYes
CreatedformDateTimeYes
ImageUrlformstringNo
ModifiedDateformDateTimeOffset?No
RebateCodeStatus Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ModifiedDateformDateTimeOffset?No
IdformintNo
Article Parameters:
NameParameterData TypeRequiredDescription
CompanyformCompanyNo
CurrencyInfoformCurrencyNo
ArticleServiceRelationsformList<ArticleServiceRelation>No
ServiceIdsformList<int>No
ArticleTypeformArticleTypeEnumNo
ArticleTypeNameformstringNo
CompanyIdformGuidYes
IdformintNo
NameformstringYes
ArticleTypeIdformintYes
DescriptionformstringNo
ImageUrlformstringNo
ActiveformboolYes
AmountformintYes
PriceformdoubleYes
CurrencyIdformstringYes
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
ArticleServiceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
ServiceIdformintYes
ArticleIdformintYes
ArticleTypeEnum Enum:
NameValue
ServiceArticle1
StandAloneArticle2
RebateCodePunchTicketArticle3
RebateCodeGiftCardArticle4
RebateCodeValueCardArticle5
RebateCodeDayOfWeekRelation Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformBokaMeraDayOfWeekNo
DayOfWeekIdformintYes
RebateCodeIdformintYes
CompanyIdformGuidYes
IdformintNo
ModifiedDateformDateTimeOffset?No
RebateCodeServiceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
ServiceIdformintYes
RebateCodeIdformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
RebateCodeBookingPriceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
PriceIdformintYes
RebateCodeIdformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
RebateCodeCustomerRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
CustomerIdformGuidYes
RebateCodeIdformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
RebateCodeEmailSentToCustomerformboolNo
MessageToReceiverformstringNo
BuyerformboolNo
DaysOfWeek Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformstringYes
DayOfWeekTranslationformstringYes
DayOfWeekActiveformbool?No
DayOfWeekSortOrderformshort?No
ModifiedDateformDateTimeOffset?No
IdformintNo
RebateCodeTransaction Parameters:
NameParameterData TypeRequiredDescription
BookingformBookingNo
RebateCodeformRebateCodeNo
CustomerformCustomerNo
IdformintNo
CompanyIdformGuidNo
NoteformstringNo
RebateCodeIdformintYes
AmountformdoubleYes
UsageformintYes
BookingIdformint?No
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
Booking Parameters:
NameParameterData TypeRequiredDescription
ServiceformServiceNo
CalendarExportformCalendarExportNo
LogformList<BookingLog>No
CheckoutLogsformList<PaymentDetails>No
PricesformList<BookingPrice>No
StatusformBookingStatusEnumNo
IsReservedformboolNo
StatusNameformstringNo
CurrencyInfoformCurrencyNo
BookingStatusformBookingStatusNo
TotalPriceformdouble?No
TotalSpotsformint?No
ResourcesformIList<Resource>No
ExternalReferencesformIList<ExternalReference>No
BookedResourcesformIList<BookedResourceType>No
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
DeterministicIdformGuidNo
ActiveformboolNo
LastTimeToUnBookformDateTime?No
PriceMappingsformList<PriceMapping>No
InternalReferenceIdformstringNo
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
IdformintNo
CustomerIdformGuidYes
ServiceIdformintYes
StatusIdformintYes
UnbookedOnformDateTime?No
UnbookedCommentsformstringNo
BookedCommentsformstringNo
BookedByformstringYes
UnBookedByformstringNo
SendSmsReminderformboolYes
SendEmailReminderformboolYes
SendSmsConfirmationformboolYes
RebateCodeformstringNo
CommentsformstringNo
IpAddressformstringNo
NumberOfBookedSpotsformintYes
CommentsToCustomerformstringNo
PaymentExpirationformDateTime?No
SendEmailConfirmationformboolYes
CancellationCodeformstringNo
ModifiedDateformDateTimeOffset?No
RatingCodeformstringNo
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
FromformDateTimeYes
ToformDateTimeYes
CalendarExport Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
BookingIdformintYes
ExceptionIdformintYes
CalendarSyncformbool?No
CalendarIdformstringNo
IsExceptionDeletedformbool?No
ModifiedDateformDateTimeOffset?No
IdformintNo
BookingLog Parameters:
NameParameterData TypeRequiredDescription
EventTypeIdformintNo
EventTypeformBookingLogEventTypeNo
CompanyIdformGuidYes
BookingIdformintYes
IdformintNo
CommentsformstringNo
UserIdformstringNo
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
BookingLogEventType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
PaymentDetails Parameters:
NameParameterData TypeRequiredDescription
QvicklyCheckoutSerializedformQvicklyCheckoutResponseNo
Payson2CheckoutSerializedformPayson2CheckoutResponseNo
CompanyIdformGuidYes
InternalReferenceIdformstringYes
ArticleTypeIdformintYes
ExternalResponseDataformstringYes
ExternalResponseReferenceformstringYes
PaymentProviderIdformintYes
CreatedDateformDateTimeYes
UpdatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
BookingPrice Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
PriceIdformint?No
CurrencyInfoformCurrencyNo
PriceTextformstringNo
AppliedCodesformList<AppliedRebateCodes>No
IsRebateformboolNo
CompanyIdformGuidYes
BookingIdformintYes
QuantityformintYes
Priceformdouble?No
VATformdecimal?No
CategoryformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
InvoicedformboolYes
OccupiesSpotformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
BookingStatus Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ColorformstringYes
IconformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
BookedResourceType Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resource type id
NameformstringNoThe resource type name
ResourcesformList<BookedResource>NoThe resources inside resource type
BookedResource Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
ColorformstringNo
ImageUrlformUriNo
EmailformstringNo
MobilePhoneformstringNo
AccessGroupformstringNo
EmailNotificationformboolNo
SMSNotificationformboolNo
EmailReminderformboolNo
SMSReminderformboolNo
CustomFieldServiceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
CustomFieldConfigIdformintYes
ServiceIdformintYes
ModifiedDateformDateTimeOffset?No
KeyCloakRole Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
SupportCaseQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe support case id
CompanyUserIdformGuidNoThe company user id
TitleformstringNoThe case title.
DescriptionformstringNoThe case description.
CaseStatusIdformintNoThe case status id.
CaseTypeIdformintNoIf the case type id.
CaseAreaIdformintNoIf the case area id.
CreatedByformstringNoThe case created by.
UpdatedByformstringNoThe case updated by.
SolvedByformstringNoThe case solved by.
UpdatedformDateTimeNoIf case updated date.
CreatedformDateTimeNoIf case created date.
CaseOwnerformstringNoWho owns the support case.
CaseStatusformSupportCaseStatusResponseNoThe case status information.
CaseTypeformSupportCaseTypeResponseNoThe case type information.
CaseAreaformSupportCaseAreaResponseNoThe case area information.
CommentsformList<SupportCaseCommentsResponse>NoThe case comments.
AttachmentsformList<SupportCaseAttachmentResponse>NoThe case attachments.
CaseStatusOptionsformList<SupportCaseStatusResponse>NoThe case status options to select from.
CaseTypeOptionsformList<SupportCaseTypeResponse>NoThe case type options to select from.
CaseAreaOptionsformList<SupportCaseAreaResponse>NoThe case area options to select from.
SupportCaseStatusResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe status id
NameformstringNoThe status name
DescriptionformstringNoThe status description
IconformstringNoThe status icon
ColorformstringNoThe status color
SupportCaseTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe type id
NameformstringNoThe type name
DescriptionformstringNoThe type description
SupportCaseAreaResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe area id
NameformstringNoThe area name
DescriptionformstringNoThe area description
SupportCaseCommentsResponse Parameters:
NameParameterData TypeRequiredDescription
SupportCaseIdformintNoThe case id
IdformintNoThe comments id
CommentformstringNoThe case comment
CreatedByformstringNoThe case comment created by
CreatedformDateTimeNoThe case comment created date
SupportCaseAttachmentResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe attachment id
FileUrlformstringNoThe attachment file url
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /support/cases HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Title":"String","Description":"String","CaseStatusId":0,"CaseTypeId":0,"CaseAreaId":0,"CreatedBy":"String","UpdatedBy":"String","SolvedBy":"String","CaseOwner":"String","CaseStatus":{"Id":0,"Name":"String","Description":"String","Icon":"String","Color":"String"},"CaseType":{"Id":0,"Name":"String","Description":"String"},"CaseArea":{"Id":0,"Name":"String","Description":"String"},"Comments":[{"SupportCaseId":0,"Id":0,"Comment":"String","CreatedBy":"String"}],"Attachments":[{"Id":0,"FileUrl":"String"}],"CaseStatusOptions":[{"Id":0,"Name":"String","Description":"String","Icon":"String","Color":"String"}],"CaseTypeOptions":[{"Id":0,"Name":"String","Description":"String"}],"CaseAreaOptions":[{"Id":0,"Name":"String","Description":"String"}]}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}