{"basePath":"/v1","consumes":["application/json"],"definitions":{"AccessObject":{"properties":{"granted":{"description":"Access granted","type":"boolean","x-nullable":true},"scopes":{"$ref":"#/definitions/AccessScopes","description":"Access scopes","x-nullable":true}},"type":"object"},"AccessScope":{"enum":["administration"],"type":"string"},"AccessScopes":{"items":{"$ref":"#/definitions/AccessScope"},"type":"array"},"AccountLimits":{"properties":{"account_available_amount":{"description":"Amount of funds on the account available for using (null if unlimited)","format":"float","type":"number","x-nullable":true},"available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits) (optional)","format":"date-time","type":"string","x-nullable":true},"available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits) (optional)","format":"date-time","type":"string","x-nullable":true},"day_limit":{"description":"Customer account day limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"day_limit_available":{"description":"Customer account day available amount, not for unlimited account (null if unlimited)","format":"float","type":"number","x-nullable":true},"day_limit_used":{"description":"Customer account day used amount","format":"float","type":"number","x-nullable":true},"month_limit":{"description":"Customer account month limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"month_limit_available":{"description":"Customer account month available amount, not for unlimited account (null if unlimited)","format":"float","type":"number","x-nullable":true},"month_limit_used":{"description":"Customer account month used amount","format":"float","type":"number","x-nullable":true},"overall_limit":{"description":"Customer account overall limit (if 0 - unlimited) (optional)","format":"float","type":"number","x-nullable":true},"overall_limit_available":{"description":"Customer account overall available amount, not for unlimited account (null if unlimited) (optional)","format":"float","type":"number","x-nullable":true},"overall_limit_used":{"description":"Customer account overall used amount (optional)","format":"float","type":"number","x-nullable":true}},"type":"object"},"AdditionalCost":{"properties":{"code":{"description":"Tax code","type":"string","x-nullable":true},"decimal_digits":{"description":"Cost decimal digits","type":"integer"},"default_value":{"description":"Cost default value","format":"float","type":"number","x-nullable":true},"id":{"description":"Cost ID","format":"uuid","type":"string","x-nullable":true},"include_in_receipt":{"description":"Include item in receipt","enum":[0,1],"type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Cost title","type":"string","x-nullable":true},"type":{"description":"Cost value type","enum":["amount","percentage"],"type":"string","x-nullable":true},"used":{"description":"Cost used by Terminals (readonly)","type":"boolean","x-nullable":true}},"type":"object"},"AdditionalCostSummaryReport":{"properties":{"additional_cost_amount":{"description":"Additional cost amount","format":"float","type":"number","x-nullable":true},"additional_cost_code":{"description":"Additional cost code","type":"string","x-nullable":true},"additional_cost_decimal_digits":{"description":"Additional cost amount decimal digits","type":"integer"},"additional_cost_id":{"description":"Additional cost ID","format":"uuid","type":"string","x-nullable":true},"additional_cost_title":{"description":"Additional cost title","type":"string","x-nullable":true},"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"items":{"description":"Detail by Items (for items summary report only)","items":{"$ref":"#/definitions/ItemAdditionalCostSummaryData"},"type":"array","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"AdditionalCostsList":{"items":{"$ref":"#/definitions/AdditionalCost"},"type":"array"},"AdditionalCostsSummaryReport":{"items":{"$ref":"#/definitions/AdditionalCostSummaryReport"},"type":"array"},"AdditionalService":{"properties":{"code":{"description":"Service code","type":"string","x-nullable":true},"cost":{"$ref":"#/definitions/AdditionalServiceCostList","description":"Service cost","x-nullable":true},"default":{"description":"Service is default","enum":[0,1],"type":"integer","x-nullable":true},"id":{"description":"Additional service ID","format":"uuid","type":"string","x-nullable":true},"public_description":{"description":"Service description","type":"string","x-nullable":true},"public_title":{"description":"Service title","type":"string","x-nullable":true},"sort_order":{"description":"Sort order weight","type":"integer"},"type":{"$ref":"#/definitions/AdditionalServiceType","description":"Service type","x-nullable":true}},"type":"object"},"AdditionalServiceCost":{"properties":{"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"min_value":{"description":"Minimal value","format":"float","type":"number","x-nullable":true},"values":{"$ref":"#/definitions/AdditionalServiceCostValueList","description":"Threshold values","x-nullable":true}},"type":"object"},"AdditionalServiceCostList":{"items":{"$ref":"#/definitions/AdditionalServiceCost"},"type":"array"},"AdditionalServiceCostType":{"enum":["amount","percentage","multiplier"],"type":"string"},"AdditionalServiceCostValue":{"properties":{"threshold":{"description":"Threshold","format":"float","type":"number","x-nullable":true},"type":{"$ref":"#/definitions/AdditionalServiceCostType","description":"Value type","x-nullable":true},"value":{"description":"Value","format":"float","type":"number","x-nullable":true}},"type":"object"},"AdditionalServiceCostValueList":{"items":{"$ref":"#/definitions/AdditionalServiceCostValue"},"type":"array"},"AdditionalServiceType":{"enum":["delivery","commission","tip"],"type":"string"},"AllTypeCustomer":{"properties":{"email":{"description":"Customer email","type":"string"},"external_id":{"description":"Customer external id (if supported)","type":"string"},"id":{"description":"Customer Id","type":"string"},"name":{"description":"Customer name","type":"string"},"phone":{"description":"Customer phone number","type":"string"},"type":{"description":"Customer type","enum":["customer","corporate-customer"],"type":"string"}},"type":"object"},"AppleAuthRequestData":{"properties":{"client_id":{"description":"Apple Service ID","type":"string"},"create":{"default":false,"description":"Create/register new user if not exists","type":"boolean"},"credential":{"description":"User Apple authorization code","type":"string"},"link_by_email":{"default":true,"description":"Link Google credentials by email with the existing account","type":"boolean"},"user":{"$ref":"#/definitions/AppleAuthUserData","description":"User information returned by Apple","x-nullable":true}},"required":["client_id","credential"],"type":"object"},"AppleAuthUserData":{"properties":{"name":{"$ref":"#/definitions/AppleAuthUserNameData","description":"User information returned by Apple","x-nullable":true}},"type":"object"},"AppleAuthUserNameData":{"properties":{"firstName":{"description":"User first name","type":"string","x-nullable":true},"lastName":{"description":"User last name","type":"string","x-nullable":true}},"type":"object"},"BankCardExternalInfo":{"properties":{"edc_card_type":{"$ref":"#/definitions/ExternalBankCardsEDCTypes","description":"Bank card EDC Type type (depends on payment system type)","x-nullable":true},"id":{"description":"Payment Id","format":"uuid","type":"string","x-nullable":true},"status":{"$ref":"#/definitions/BankCardExternalPaymentStatus","description":"Payment status","x-nullable":true},"type":{"$ref":"#/definitions/CustomerPaymentSystemType","description":"Payment system type (depends on payment type)","x-nullable":true}},"type":"object"},"BankCardExternalPaymentOperationType":{"enum":["purchase","authorize","completion","refund","cancel"],"type":"string"},"BankCardExternalPaymentStatus":{"enum":["inprocess","success","fail","canceled","error","authorized"],"type":"string"},"BankCardExternalPaymentSystemType":{"enum":["amp","pax"],"type":"string"},"BankCardExternalPaymentUnitOperationStatus":{"enum":["inprocess","success","fail"],"type":"string"},"BankCardExternalPaymentUnitOperationType":{"enum":["connect","card-transactions","mag-reader","mag-reader-result","welcome-screen"],"type":"string"},"BenefitsChargeTypeBase":{"enum":["regular-bonuses","promotional-bonuses","special-account"],"type":"string"},"BenefitsChargeTypeBaseNone":{"enum":["none","regular-bonuses","promotional-bonuses","special-account"],"type":"string"},"BenefitsChargeTypeExtended":{"enum":["none","regular-bonuses","promotional-bonuses","special-account","coupon"],"type":"string"},"BenefitsPriceType":{"enum":["bonuses","special-account"],"type":"string"},"BenefitsTopUpReferenceObjectType":{"enum":["loyalty-rule","external-system"],"type":"string"},"BillingInfo":{"properties":{"address":{"description":"Address (depends on the payment system)","type":"object"},"email":{"description":"Email","type":"string"},"name":{"description":"Name","type":"string"},"phone":{"description":"Phone number","type":"string"}},"type":"object"},"BonusAccountOperationType":{"enum":["bonus-add","bonus-write-offs","bonus-adjustment"],"type":"string"},"BonusAdded":{"properties":{"activity_id":{"description":"Activity ID (optional, check only)","format":"uuid","type":"string","x-nullable":true},"amount":{"description":"Added bonuses amount","format":"float","type":"number"},"expire":{"description":"Added bonuses expire datetime (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"object_id":{"description":"Reference object ID, up to 36 chars (optional)","maxLength":36,"type":"string","x-nullable":true},"object_type":{"$ref":"#/definitions/BenefitsTopUpReferenceObjectType","description":"Reference object type (optional)","x-nullable":true},"starting":{"description":"Added bonuses starting datetime (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true}},"required":["amount"],"type":"object"},"BonusesOperationObject":{"properties":{"amount":{"description":"Amount transaction","format":"float","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value (optional)","type":"integer","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (optional)","type":"integer","x-nullable":true},"comment":{"description":"Transaction comment","type":"string","x-nullable":true},"expire":{"description":"Date of expire (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"message":{"description":"Transaction message template","type":"string","x-nullable":true},"skip_message":{"default":false,"description":"Skip notifications","type":"boolean","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value (optional)","type":"integer","x-nullable":true},"starting":{"description":"Date of activation (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"users":{"$ref":"#/definitions/UserIDs","x-nullable":true}},"required":["terminal_id"],"type":"object"},"Business":{"properties":{"account_balance":{"description":"Account balance","format":"float","type":"number","x-nullable":true},"active":{"description":"Active flag","enum":[0,1],"type":"integer","x-nullable":true},"allow_export_customers":{"description":"Export customers allowed","enum":[0,1],"type":"integer","x-nullable":true},"auto_pay_params":{"$ref":"#/definitions/BusinessAutoPayParams","description":"Automatic balance refill payment parameters","x-nullable":true},"code":{"description":"Business code","type":"string","x-nullable":true},"country":{"description":"Busines country","type":"string"},"created":{"description":"Business created date and time","format":"date-time","type":"string","x-nullable":true},"credit_limit":{"description":"Credit limit","format":"float","type":"number","x-nullable":true},"currency":{"description":"Busines currency ISO code","type":"string"},"expenses_average_day_amount":{"description":"Average one-day Business account expenses (excluded additional services)","format":"float","type":"number","x-nullable":true},"external_data_access_exists":{"description":"The Loyalty has dedicated data access provided to the external system (optional, readonly)","type":"boolean","x-nullable":true},"id":{"description":"Business ID","format":"uuid","type":"string"},"notify_balance_less_than_by_email":{"description":"Notify when balacne less then edge value by Email","enum":[0,1],"type":"integer","x-nullable":true},"notify_balance_less_than_by_push":{"description":"Notify when balacne less then edge value by PUSH","enum":[0,1],"type":"integer","x-nullable":true},"notify_balance_less_than_by_sms":{"description":"Notify when balacne less then edge value by SMS","enum":[0,1],"type":"integer","x-nullable":true},"notify_balance_less_than_type":{"description":"Low balance notification type","enum":["automatic","manual"],"type":"string"},"notify_balance_less_than_value":{"description":"Balance edge value for notification","format":"float","type":"number","x-nullable":true},"notify_balance_less_than_value_wo_credit_limit":{"description":"Compare/calculate Business balance less than value without credit limit","type":"boolean"},"referral_code":{"description":"Business referral code","type":"string","x-nullable":true},"reseller":{"description":"Reseller","enum":[0,1],"type":"integer","x-nullable":true},"role_based_model":{"$ref":"#/definitions/BusinessRoleBasedModel","description":"Role based model info (readonly)"},"show_sc_in_transations_list":{"description":"Show special codes in transactions list","enum":[0,1],"type":"integer","x-nullable":true},"status":{"$ref":"#/definitions/BusinessStatus","description":"Business status"},"subscribe_incust_news":{"description":"inCust news subscribe","enum":[0,1],"type":"integer","x-nullable":true},"support_news_priority":{"description":"Support news priority","enum":[0,1],"type":"integer","x-nullable":true},"support_pos_priority":{"description":"Support pos priority","enum":[0,1],"type":"integer","x-nullable":true},"suspend_notification_stage":{"description":"Business suspend notification stage","type":"integer","x-nullable":true},"tariff":{"$ref":"#/definitions/Tariff","description":"Tariff details"},"tariff_plan_set":{"description":"Tariff plan set date and time","format":"date-time","type":"string","x-nullable":true},"title":{"description":"Business title","type":"string"}},"type":"object"},"BusinessApiKey":{"properties":{"api_key":{"description":"Business API KEY","type":"string","x-nullable":true},"business_id":{"description":"Business ID. Read Only.","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"BusinessAuthToken":{"properties":{"access":{"description":"Token access by type","enum":["owner","admin","business-staff"],"type":"string","x-nullable":true},"access_scopes":{"$ref":"#/definitions/BusinessAuthTokenAccessScopes","description":"Token access scopes"},"owned_by_trusted_system":{"description":"Is user owned (created) by trusted system (optional, only for auth by trusted system)","type":"boolean","x-nullable":true},"owner":{"description":"Signed in as owner","type":"boolean","x-nullable":true},"staff":{"$ref":"#/definitions/BusinessStaff","description":"Business staff (optional)","x-nullable":true},"token":{"description":"Token for next authorization requests","type":"string","x-nullable":true},"user":{"$ref":"#/definitions/UserProfile","description":"Business user profile (optional)","x-nullable":true}},"type":"object"},"BusinessAuthTokenAccessScopes":{"items":{"enum":["administration","payments","security"],"type":"string"},"type":"array"},"BusinessAutoPayParams":{"properties":{"amount":{"description":"Automatic balance refill payment amount","format":"float","type":"number","x-nullable":true},"balance_edge":{"description":"Automatic balance refill payment edge","format":"float","type":"number","x-nullable":true},"currency":{"description":"currency","type":"string","x-nullable":true},"description":{"description":"Payment desctiption (optional)","type":"string","x-nullable":true},"email":{"description":"Payment email (optional)","type":"string","x-nullable":true},"language":{"description":"Language ISO code (optional)","type":"string","x-nullable":true},"order_reference":{"description":"Referenced payment","format":"uuid","type":"string","x-nullable":true},"phone":{"description":"Payment phone (optional)","type":"string","x-nullable":true},"system":{"description":"Payment System","enum":["liqpay","wayforpay","paypro","stripe","flutterwave","global-payments","wave"],"type":"string","x-nullable":true}},"type":"object"},"BusinessBillingDetails":{"properties":{"amount":{"description":"Transaction amount","format":"float","type":"number"},"currency":{"description":"Currency ISO code","type":"string"},"details":{"$ref":"#/definitions/BusinessBillingOperationDetails","description":"Operation details (optional)","x-nullable":true},"id":{"description":"Transaction unique identifier","format":"uuid","type":"string"},"info":{"description":"Transaction info (optional)","type":"string","x-nullable":true},"processed":{"description":"Transaction processed date and time","format":"date-time","type":"string"},"public_title":{"description":"Transaction public title (optional)","type":"string","x-nullable":true},"source":{"description":"Transaction source (optional)","type":"string","x-nullable":true},"type":{"description":"Transaction type","enum":["refill","refill-cancel","discount","business-bonuses-redeemed","additional-service","account","min-day-delta","pos","terminals","redeem-discount","amount-to-pay","transaction","new-customer","sms","push","email","viber","special-account-redeem","ulg-push","ulg-sms","exchange-coupon-fee","exchange-coupon-fee-payout","exchange-coupon-fee-receipt","incust-chatbot","feedback-source","external-system-message","refill-credit","pkpass-update","pkpass-message","external-verification-service-phone","refill-credit-cancel","customer-benefits-update-notification"],"type":"string"}},"type":"object"},"BusinessBillingOperationDetails":{"properties":{"accounting":{"description":"Accounting department contacts","type":"string","x-nullable":true},"accounting_email":{"description":"Accounting department email","type":"string","x-nullable":true},"accounting_phone":{"description":"Accounting department phone","type":"string","x-nullable":true},"amount":{"description":"Operation amount","format":"float","type":"number","x-nullable":true},"billing_details":{"$ref":"#/definitions/PaymentWalletCardBillingDetails","description":"Card billing details (optional)"},"business_code":{"description":"Business code","type":"string","x-nullable":true},"business_country":{"description":"Business country ISO code","type":"string","x-nullable":true},"business_country_title":{"description":"Business country","type":"string","x-nullable":true},"card_alias":{"description":"Card alias","type":"string","x-nullable":true},"card_mask":{"description":"Card number mask","type":"string","x-nullable":true},"comment":{"description":"Operation comment","type":"string","x-nullable":true},"currency":{"description":"Operation currency ISO code","type":"string","x-nullable":true},"invoice_created":{"description":"Invoice created","format":"date-time","type":"string","x-nullable":true},"invoice_number":{"description":"Invoice number","type":"string","x-nullable":true},"legal_address":{"description":"Legal address","type":"string","x-nullable":true},"name_for_invoice":{"description":"Business name for invoice","type":"string","x-nullable":true},"owner_email":{"description":"Business owner user Email","type":"string","x-nullable":true},"owner_name":{"description":"Business owner user Name","type":"string","x-nullable":true},"owner_phone":{"description":"Business owner user Phone number","type":"string","x-nullable":true},"post_address":{"description":"Post address","type":"string","x-nullable":true},"processed":{"description":"Operation processed date and time short format","format":"date-time","type":"string","x-nullable":true},"processed_formatted":{"description":"Operation processed date and time long format","format":"date","type":"string","x-nullable":true},"referral_code":{"description":"Business referral code","type":"string","x-nullable":true},"source":{"description":"Operation source","type":"string","x-nullable":true},"tax_amount":{"description":"Tax amount (NET)","format":"float","type":"number","x-nullable":true},"tax_currency":{"description":"TAX currency ISO code","type":"string","x-nullable":true},"tax_id":{"description":"Legal TAX ID","type":"string","x-nullable":true},"tax_rate":{"description":"Tax rate","format":"float","type":"number","x-nullable":true}},"type":"object"},"BusinessExternalDataAccess":{"properties":{"api_key":{"description":"API key (readonly)","type":"string","x-nullable":true},"id":{"description":"Access ID","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"scope":{"$ref":"#/definitions/BusinessExternalDataAccessScopeList","description":"Data scope","x-nullable":true},"title":{"description":"Access title","type":"string","x-nullable":true}},"type":"object"},"BusinessExternalDataAccessList":{"items":{"$ref":"#/definitions/BusinessExternalDataAccess"},"type":"array"},"BusinessExternalDataAccessScope":{"enum":["transaction"],"type":"string"},"BusinessExternalDataAccessScopeList":{"description":"Data scope","items":{"$ref":"#/definitions/BusinessExternalDataAccessScope"},"type":"array","x-nullable":true},"BusinessLegalInfo":{"properties":{"accounting_email":{"description":"Accounting email","type":"string","x-nullable":true},"accounting_phone":{"description":"Accounting phone","type":"string","x-nullable":true},"details_for_invoice":{"description":"Details for invoice","type":"string","x-nullable":true},"legal_address":{"description":"Legal address","type":"string","x-nullable":true},"legal_ownership_type":{"description":"Legal ownership type","enum":["natural-person","legal-entity"],"type":"string","x-nullable":true},"name_for_invoice":{"description":"Name for invoice","type":"string","x-nullable":true},"post_address":{"description":"Post address","type":"string","x-nullable":true},"tax_id":{"description":"Tax ID","type":"string","x-nullable":true}},"type":"object"},"BusinessRoleBasedModel":{"properties":{"active":{"description":"Role based model state","type":"boolean"}},"type":"object"},"BusinessSettings":{"properties":{"base_time_zone":{"description":"Business base time zone (default UTC)","type":"string","x-nullable":true},"bonus_period_by_base_time_zone":{"description":"Use the Business’s base time zone for bonus point activation/expiration (default 0)","type":"boolean","x-nullable":true},"business_id":{"description":"Business ID. Read Only.","format":"uuid","type":"string","x-nullable":true},"consent_message_pincode_pattern":{"description":"Pattern of pin-code template parameter. Read Only.","type":"string","x-nullable":true},"consent_message_platform_message_pattern":{"description":"Pattern of platform consent message template parameter. Read Only.","type":"string","x-nullable":true},"consent_message_required_pattern":{"description":"Required pattern of consent message template parameter. Read Only.","type":"string","x-nullable":true},"consent_message_required_regex":{"description":"Required RegEx of consent message template. Read Only.","type":"string","x-nullable":true},"consent_request_message":{"$ref":"#/definitions/MultiLanguageObject","description":"Consent request message text (multilanguage)","x-nullable":true},"consent_request_message_platform_part_mandatory":{"description":"Consent request platform message part mandatory. Read Only.","type":"boolean","x-nullable":true},"consent_request_required":{"description":"Consent request required","type":"boolean","x-nullable":true},"coupons_period_by_base_time_zone":{"description":"Use the Business’s base time zone for coupons/gift cards emission/expiration (default 0)","type":"boolean","x-nullable":true},"customer_additional_card_scope":{"description":"Scope of customers cards","enum":["business","loyalty"],"type":"string","x-nullable":true},"group_wallet_by_business":{"description":"Group client app wallet for business","type":"boolean","x-nullable":true},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos","x-nullable":true},"platform_consent_request_message":{"$ref":"#/definitions/MultiLanguageObject","description":"Platform consent request message text (multilanguage). Read Only.","x-nullable":true},"platform_consent_request_message_business_default":{"$ref":"#/definitions/MultiLanguageObject","description":"Platform consent request business message text (multilanguage). Read Only.","x-nullable":true},"platform_consent_request_required":{"description":"Consent request required by platform settings. Read Only.","enum":["never","always","business"],"type":"string","x-nullable":true},"platform_consent_request_send_change_allow":{"description":"Consent request message text change allowed by platform settings. Read Only.","type":"boolean","x-nullable":true},"platform_welcome_message":{"$ref":"#/definitions/MultiLanguageObject","description":"Platform welcome message text (multilanguage). Read Only.","x-nullable":true},"platform_welcome_message_business_default":{"$ref":"#/definitions/MultiLanguageObject","description":"Platform business welcome message text (multilanguage). Read Only.","x-nullable":true},"platform_welcome_message_required":{"description":"Welcome message required by platform settings. Read Only.","enum":["never","always","business"],"type":"string","x-nullable":true},"platform_welcome_message_send_change_allow":{"description":"Consent welcome message text change allowed by platform settings. Read Only.","type":"boolean","x-nullable":true},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Business public description (multilanguage)","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Business public title (multilanguage)","x-nullable":true},"tour_cards_period_by_base_time_zone":{"description":"Use the Business’s base time zone for prepaid cards emission (default 0)","type":"boolean","x-nullable":true},"welcome_message":{"$ref":"#/definitions/MultiLanguageObject","description":"Welcome message text (multilanguage)","x-nullable":true},"welcome_message_platform_message_pattern":{"description":"Pattern of platform welcome message template parameter. Read Only.","type":"string","x-nullable":true},"welcome_message_platform_part_mandatory":{"description":"Welcome message platform message part mandatory. Read Only.","type":"boolean","x-nullable":true},"welcome_message_required_pattern":{"description":"Required pattern of welcome message template parameter. Read Only.","type":"string","x-nullable":true},"welcome_message_required_regex":{"description":"Required RegEx of welcome message template. Read Only.","type":"string","x-nullable":true},"welcome_message_send":{"description":"Welcome message send","type":"boolean","x-nullable":true}},"type":"object"},"BusinessStaff":{"properties":{"auth_code":{"description":"Auth Code (for creation or modification - null is clear/not exists code, 'empty string' is auto generate code, 'some code' is user specified code) (optional)","type":"string","x-nullable":true},"comment":{"description":"Comment (optional)","type":"string","x-nullable":true},"email":{"description":"Email (optional)","type":"string","x-nullable":true},"id":{"description":"Staff id","format":"uuid","type":"string","x-nullable":true},"name":{"description":"Name","type":"string","x-nullable":true},"phone":{"description":"Phone (optional)","type":"string","x-nullable":true},"role_based_model_roles":{"$ref":"#/definitions/BusinessStaffRoleBasedModelRoles","description":"Staff roles in role based model (optional)","x-nullable":true},"suspended":{"description":"Suspended flag (optional)","enum":[0,1],"type":"integer","x-nullable":true},"terminals":{"$ref":"#/definitions/TerminalsList","description":"Terminals where get access (optional)","x-nullable":true}},"type":"object"},"BusinessStaffList":{"items":{"$ref":"#/definitions/BusinessStaff"},"type":"array"},"BusinessStaffPaginatedList":{"properties":{"data":{"$ref":"#/definitions/BusinessStaffList"},"summary":{"$ref":"#/definitions/BusinessStaffSummary"}},"type":"object"},"BusinessStaffRoleBasedModelRoles":{"items":{"description":"Role","type":"string"},"type":"array"},"BusinessStaffSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"BusinessStarter":{"properties":{"business_type":{"default":"regular","description":"Business type (for Tariff Plan selection)","enum":["regular","customers-feedback"],"type":"string","x-nullable":true},"country":{"description":"Busines country","type":"string","x-nullable":true},"rate":{"description":"Percentage rate for rate type","format":"float","type":"number","x-nullable":true},"rate_type":{"default":"none","description":"Business type (for Tariff Plan selection)","enum":["none","bonus","discount"],"type":"string","x-nullable":true},"referral_code":{"description":"Referral code","type":"string","x-nullable":true},"terminal_password":{"description":"First terminal password","type":"string","x-nullable":true},"terminal_phone":{"description":"First terminal phone number","type":"string","x-nullable":true},"time_zone":{"description":"First POS Time zone","type":"string","x-nullable":true},"title":{"description":"Business title","type":"string","x-nullable":true}},"required":["title","country"],"type":"object"},"BusinessStatus":{"properties":{"account_balance":{"description":"Account balance","format":"float","type":"number","x-nullable":true},"block_date":{"description":"Business block date","format":"date","type":"string","x-nullable":true},"block_days_left":{"description":"Business block date left","type":"integer","x-nullable":true},"business_allow_export_customers":{"description":"Export customers allowed","enum":[0,1],"type":"integer","x-nullable":true},"business_bonuses_amount":{"description":"Business bonuses amount","format":"float","type":"number","x-nullable":true},"business_code":{"description":"Business code","type":"string","x-nullable":true},"business_reseller":{"description":"Reseller","enum":[0,1],"type":"integer","x-nullable":true},"credit_limit":{"description":"Credit limit","format":"float","type":"number","x-nullable":true},"customer_feedback_sources_active_count":{"description":"Active customers feedback sources count","type":"integer","x-nullable":true},"customer_feedback_sources_count":{"description":"Customers feedback sources count","type":"integer","x-nullable":true},"flag_email_confirmed":{"description":"Email confirmed","enum":[0,1],"type":"integer","x-nullable":true},"flag_insufficient_funds_on_account":{"description":"Insufficient funds on account","enum":[0,1],"type":"integer","x-nullable":true},"flag_tariff_plan_expired":{"description":"Tariff Plan Expired","enum":[0,1],"type":"integer","x-nullable":true},"show_sc_in_transations_list":{"description":"Show special codes in transactions list","enum":[0,1],"type":"integer","x-nullable":true},"support_news_priority":{"description":"Support news priority","enum":[0,1],"type":"integer","x-nullable":true},"support_pos_priority":{"description":"Support POS priority","enum":[0,1],"type":"integer","x-nullable":true},"support_unreaded_messages_count":{"description":"Unreaded support messages count","type":"integer","x-nullable":true},"support_unreplayed_messages_count":{"description":"Unreplayed support messages count","type":"integer","x-nullable":true},"tariff_plan_day_price":{"description":"Tariff plan day price","format":"float","type":"number","x-nullable":true},"tariff_plan_expire_date":{"description":"Tariff plan expire date","format":"date","type":"string","x-nullable":true},"ureaded_messages_count":{"description":"Unreaded messages count","type":"integer","x-nullable":true},"ureplayed_messages_count":{"description":"Unreplayed messages count","type":"integer","x-nullable":true}},"type":"object"},"BusinessTariffDetails":{"properties":{"billing":{"description":"Billing details","items":{"$ref":"#/definitions/BusinessBillingDetails"},"type":"array"},"business_bonuses_amount":{"description":"Bonus points on account","format":"float","type":"number"},"business_bonuses_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"customer_benefits_update_notifications_count":{"description":"Number of customer benefits update notification to external system (optional)","format":"integer","type":"number"},"customer_benefits_update_notifications_count_left":{"description":"Customer benefits update notification to external system, left in the service plan (optional)","format":"integer","type":"number"},"customer_benefits_update_notifications_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"customer_benefits_update_notifications_count_over":{"description":"Customer benefits update notification to external system, over the service plan (optional)","format":"integer","type":"number"},"customer_benefits_update_notifications_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"customer_benefits_update_notifications_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"email_count":{"description":"Number of marketing and transactional emails (optional)","format":"integer","type":"number"},"email_count_left":{"description":"Number of marketing and transactional emails, left in the service plan (optional)","format":"integer","type":"number"},"email_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"email_count_over":{"description":"Number of marketing and transactional emails, over the service plan (optional)","format":"integer","type":"number"},"email_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"email_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"evs_phone_requests_count":{"description":"Number of external verification service for phone number requests (optional)","format":"integer","type":"number"},"evs_phone_requests_count_left":{"description":"External verification service for phone number requests, left in the service plan (optional)","format":"integer","type":"number"},"evs_phone_requests_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"evs_phone_requests_count_over":{"description":"External verification service for phone number requests, over the service plan (optional)","format":"integer","type":"number"},"evs_phone_requests_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"evs_phone_requests_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"external_system_messages_count":{"description":"Number of marketing and transactional external system messages (optional)","format":"integer","type":"number"},"external_system_messages_count_left":{"description":"Number of marketing and transactional external system messages, left in the service plan (optional)","format":"integer","type":"number"},"external_system_messages_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"external_system_messages_count_over":{"description":"Number of marketing and transactional external system messages, over the service plan (optional)","format":"integer","type":"number"},"external_system_messages_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"external_system_messages_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"feedback_sources_count":{"description":"Number of feedback sources (optional)","format":"integer","type":"number"},"feedback_sources_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"incust_chatbot_count":{"description":"Number of marketing and transactional chatbot messages (optional)","format":"integer","type":"number"},"incust_chatbot_count_left":{"description":"Number of marketing and transactional chatbot messages, left in the service plan (optional)","format":"integer","type":"number"},"incust_chatbot_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"incust_chatbot_count_over":{"description":"Number of marketing and transactional chatbot messages, over the service plan (optional)","format":"integer","type":"number"},"incust_chatbot_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"incust_chatbot_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"new_customer_count":{"description":"Number of added new customer (optional)","format":"integer","type":"number"},"new_customer_count_left":{"description":"Number of added new customer, left in the service plan (optional)","format":"integer","type":"number"},"new_customer_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"new_customer_count_over":{"description":"Number of added new customer, over the service plan (optional)","format":"integer","type":"number"},"new_customer_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"new_customer_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_account_payment_amount":{"description":"Subscription fee (optional)","format":"float","type":"number"},"period_account_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_active_feedback_sources_payment_amount":{"description":"Subscription fee for active Feedback Sources (optional)","format":"float","type":"number"},"period_active_feedback_sources_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_active_pos_payment_amount":{"description":"Subscription fee for active Points of Sale (POS) (optional)","format":"float","type":"number"},"period_active_pos_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_active_terminals_payment_amount":{"description":"Subscription fee for active Terminals (optional)","format":"float","type":"number"},"period_active_terminals_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_additional_services_amount":{"description":"Supplementary maintenance and support services during the period","format":"float","type":"number"},"period_additional_services_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_amount_to_pay_payment_amount":{"description":"Loyalty Program Service fee, % of the operation total sum less applied discounts and credited bonus points during the period (optional)","format":"float","type":"number"},"period_amount_to_pay_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_begin_balance_amount":{"description":"Period begin Business balance amount","format":"float","type":"number"},"period_begin_balance_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_begin_datetime":{"description":"Period begin","format":"date-time","type":"string"},"period_business_bonuses_redeemed_amount":{"description":"Business bonus points redeemed during the period","format":"float","type":"number"},"period_business_bonuses_redeemed_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_customer_benefits_update_notifications_payment_amount":{"description":"Customer benefits update notification to external system services fee during the period (optional)","format":"float","type":"number"},"period_customer_benefits_update_notifications_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_discount_amount":{"description":"Discount provided during the period","format":"float","type":"number"},"period_discount_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_email_payment_amount":{"description":"Email sending services fee during the period (optional)","format":"float","type":"number"},"period_email_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_end_balance_amount":{"description":"Period end Business balance amount","format":"float","type":"number"},"period_end_balance_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_end_datetime":{"description":"Period end","format":"date-time","type":"string"},"period_evs_phone_requests_payment_amount":{"description":"External verification service for phone number request services fee during the period (optional)","format":"float","type":"number"},"period_evs_phone_requests_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_ex_coupon_redeem_fee_payment_amount":{"description":"Distributing coupons from exchange fee during the period (optional)","format":"float","type":"number"},"period_ex_coupon_redeem_fee_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_ex_coupon_redeem_fee_payouts_amount":{"description":"Distributing coupons redeemed fee during the period (optional)","format":"float","type":"number"},"period_ex_coupon_redeem_fee_payouts_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_ex_coupon_redeem_fee_receipts_amount":{"description":"Distributing coupons receipts fee during the period (optional)","format":"float","type":"number"},"period_ex_coupon_redeem_fee_receipts_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_incust_chatbot_payment_amount":{"description":"Chatbot sending services fee during the period (optional)","format":"float","type":"number"},"period_incust_chatbot_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_min_day_delta_amount":{"description":"Minimum support fee per day (optional)","format":"float","type":"number"},"period_min_day_delta_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_new_customers_payment_amount":{"description":"Registration of new customers fee during the period (optional)","format":"float","type":"number"},"period_new_customers_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_ordered_and_provided_services_amount":{"description":"Services provided during the period","format":"float","type":"number"},"period_ordered_and_provided_services_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_pkpass_messages_payment_amount":{"description":"PKPASS message services fee during the period (optional)","format":"float","type":"number"},"period_pkpass_messages_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_pkpass_updates_payment_amount":{"description":"PKPASS updates services fee during the period (optional)","format":"float","type":"number"},"period_pkpass_updates_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_push_payment_amount":{"description":"Push message sending services fee during the period (optional)","format":"float","type":"number"},"period_push_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_recommended_advance_payment_amount":{"description":"Recommended amount of advance payment","format":"float","type":"number"},"period_recommended_advance_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_redeemed_discount_payment_amount":{"description":"Loyalty Program Service fee, % of the applied bonus points during the period (optional)","format":"float","type":"number"},"period_redeemed_discount_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_refill_cancel_amount":{"description":"Payments canceled during the period","format":"float","type":"number"},"period_refill_cancel_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_refill_credit_cancel_amount":{"description":"Credits canceled during the period","format":"float","type":"number"},"period_refill_credit_cancel_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_refill_credit_payment_amount":{"description":"Credits received during the period","format":"float","type":"number"},"period_refill_credit_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_refill_overall_cancel_amount":{"description":"Overall refills canceled during the period","format":"float","type":"number"},"period_refill_overall_cancel_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_refill_overall_payment_amount":{"description":"Overall refills received during the period","format":"float","type":"number"},"period_refill_overall_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_refill_payment_amount":{"description":"Payments received during the period","format":"float","type":"number"},"period_refill_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_sms_payment_amount":{"description":"Services of customer acquisition using SMS messages fee during the period (optional)","format":"float","type":"number"},"period_sms_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_special_account_redeem_payment_amount":{"description":"Write-off from customer accounts, % of write-offs during the period (optional)","format":"float","type":"number"},"period_special_account_redeem_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_transactions_payment_amount":{"description":"Loyalty Program Service fee, per operation (check) during the period (optional)","format":"float","type":"number"},"period_transactions_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_ulg_push_amount":{"description":"Ultra Local Geo push message sending services fee during the period (optional)","format":"float","type":"number"},"period_ulg_push_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_ulg_sms_amount":{"description":"Ultra Local Geo SMS message sending services fee during the period (optional)","format":"float","type":"number"},"period_ulg_sms_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"period_viber_payment_amount":{"description":"Services of customer acquisition using viber messages fee during the period (optional)","format":"float","type":"number"},"period_viber_payment_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"pkpass_messages_count":{"description":"Number of PKPASS messages (optional)","format":"integer","type":"number"},"pkpass_messages_count_left":{"description":"PKPASS messages, left in the service plan (optional)","format":"integer","type":"number"},"pkpass_messages_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"pkpass_messages_count_over":{"description":"PKPASS messages, over the service plan (optional)","format":"integer","type":"number"},"pkpass_messages_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"pkpass_messages_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"pkpass_updates_count":{"description":"Number of PKPASS updates (optional)","format":"integer","type":"number"},"pkpass_updates_count_left":{"description":"PKPASS updates, left in the service plan (optional)","format":"integer","type":"number"},"pkpass_updates_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"pkpass_updates_count_over":{"description":"PKPASS updates, over the service plan (optional)","format":"integer","type":"number"},"pkpass_updates_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"pkpass_updates_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"pos_count":{"description":"Number of points of sale (POS) (optional)","format":"integer","type":"number"},"pos_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"push_count":{"description":"Number of marketing and transactional push messages (optional)","format":"integer","type":"number"},"push_count_left":{"description":"Number of marketing and transactional push messages, left in the service plan (optional)","format":"integer","type":"number"},"push_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"push_count_over":{"description":"Number of marketing and transactional push messages, over the service plan (optional)","format":"integer","type":"number"},"push_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"push_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"redeem_discount_amount":{"description":"Amount of redeemed bonus points or given discounts (optional)","format":"float","type":"number"},"redeem_discount_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"sms_count":{"description":"Number of marketing and transactional sms messages (optional)","format":"integer","type":"number"},"sms_count_left":{"description":"Number of marketing and transactional sms messages, left in the service plan (optional)","format":"integer","type":"number"},"sms_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"sms_count_over":{"description":"Number of marketing and transactional sms messages, over the service plan (optional)","format":"integer","type":"number"},"sms_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"sms_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"special_account_redeem_amount":{"description":"Amount of debiting of money from customer accounts (optional)","format":"float","type":"number"},"special_account_redeem_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"terminals_count":{"description":"Number of terminals (optional)","format":"integer","type":"number"},"terminals_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"to_pay_amount":{"description":"Amount of transactions less redeemed bonus points and given discounts (optional)","format":"float","type":"number"},"to_pay_amount_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"transactions_count":{"description":"Number of sales operations (optional)","format":"integer","type":"number"},"transactions_count_left":{"description":"Number of sales operations, left in the service plan (optional)","format":"integer","type":"number"},"transactions_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"transactions_count_over":{"description":"Number of sales operations, over the service plan (optional)","format":"integer","type":"number"},"transactions_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"transactions_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"ulg_push_count":{"description":"Number of marketing and transactional Ultra Local Geo push messages (optional)","format":"integer","type":"number"},"ulg_push_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"ulg_sms_count":{"description":"Number of marketing and transactional Ultra Local Geo sms messages (optional)","format":"integer","type":"number"},"ulg_sms_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"viber_count":{"description":"Number of marketing and transactional viber messages (optional)","format":"integer","type":"number"},"viber_count_left":{"description":"Number of marketing and transactional viber messages, left in the service plan (optional)","format":"integer","type":"number"},"viber_count_left_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"viber_count_over":{"description":"Number of marketing and transactional viber messages, over the service plan (optional)","format":"integer","type":"number"},"viber_count_over_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true},"viber_count_public_title":{"description":"Parameter public title (optional)","type":"string","x-nullable":true}},"type":"object"},"BusinessUserLanguage":{"description":"Language object","properties":{"changed":{"description":"language changed (optional, for language change operation only, readonly)","type":"boolean"},"language":{"description":"language ISO code","type":"string"}},"required":["language"],"type":"object"},"BusinessUserProfile":{"properties":{"avatar":{"description":"User avatar url","type":"string","x-nullable":true},"birth_date":{"description":"user date of birth","format":"date","type":"string","x-nullable":true},"country":{"description":"ISO code of country","type":"string","x-nullable":true},"emails":{"$ref":"#/definitions/EmailRecordsList","description":"List of users Emails","x-nullable":true},"external_id":{"description":"User external id (maximum 128 chars)","type":"string","x-nullable":true},"gender":{"$ref":"#/definitions/UserGender","description":"User gender","x-nullable":true},"id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"language":{"description":"ISO code of language","type":"string","x-nullable":true},"login":{"description":"User primary email for access to account (User login)  (maximum 80 chars)","type":"string","x-nullable":true},"name":{"description":"Public user Name (maximum 128 chars)","type":"string","x-nullable":true},"password_exist":{"description":"Password exist","type":"boolean","x-nullable":true},"phone":{"description":"User primary phone number for access to account  (maximum 20 chars)","type":"string","x-nullable":true},"phones":{"$ref":"#/definitions/PhoneRecordsList","description":"List of users phones","x-nullable":true}},"type":"object"},"CardCategoriesList":{"items":{"$ref":"#/definitions/CardCategory"},"type":"array"},"CardCategory":{"properties":{"active":{"default":1,"description":"Category is active","enum":[0,1],"type":"integer"},"active_change_allowed":{"description":"Active value changing allowed (readonly)","type":"boolean","x-nullable":true},"extended_settings":{"$ref":"#/definitions/CardCategoryExtendedSettings","description":"Extended settings for Category (optional)","x-nullable":true},"id":{"description":"Card category ID","format":"uuid","type":"string","x-nullable":true},"image":{"description":"URL of batch image (readonly)","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty id","type":"string"},"notify_customers":{"default":0,"description":"Notify the customers about the transition to this category","enum":[0,1],"type":"integer"},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Title to show (multilanguage)","x-nullable":true},"show_to_customers":{"default":0,"description":"Show category to customers","enum":[0,1],"type":"integer"},"title":{"description":"Card category title (max 80 chars)","type":"string"},"title_change_allowed":{"description":"Title value changing allowed (readonly)","type":"boolean","x-nullable":true},"type":{"description":"Category type (readonly)","enum":["base","custom"],"type":"string"},"weight":{"default":1,"description":"Category weight","type":"integer"},"weight_change_allowed":{"description":"Weight value changing allowed (readonly)","type":"boolean","x-nullable":true}},"type":"object"},"CardCategoryExtendedSettings":{"properties":{"bonus_payment_individual_settings":{"default":0,"description":"Individual settings are used for Category","enum":[0,1],"type":"integer","x-nullable":true},"bonus_payment_limit":{"description":"Limit bonus points redeem in percentage of check amount","format":"float","type":"number","x-nullable":true},"bonus_payment_type":{"description":"Type of payment by bonus points","enum":["full-check","partial","partial-rounded"],"type":"string","x-nullable":true}},"type":"object"},"CardRecord":{"description":"Customer card record","properties":{"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"code":{"description":"Card code","type":"string","x-nullable":true},"id":{"description":"Card id","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"photo":{"description":"Url of loyalty photo","type":"string","x-nullable":true},"scope":{"description":"Card scope","enum":["all","business","loyalty"],"type":"string","x-nullable":true},"title":{"description":"Card title, depends of scope (Loyalty name or Platform name)","type":"string","x-nullable":true}},"type":"object"},"CardRecordsList":{"items":{"$ref":"#/definitions/CardRecord"},"type":"array"},"CategoriesThresholdsValue":{"properties":{"card_category_id":{"description":"Card category Id","format":"uuid","type":"string","x-nullable":true},"threshold":{"description":"Threshold value","format":"float","type":"number","x-nullable":true}},"required":["threshold","card_category_id"],"type":"object"},"CategoriesThresholdsValues":{"description":"Card categories set based on thresholds","items":{"$ref":"#/definitions/CategoriesThresholdsValue"},"type":"array"},"Check":{"properties":{"amount":{"description":"Amount of check","format":"float","type":"number","x-nullable":true},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"amount_to_pay":{"description":"Amount to pay","format":"float","type":"number","x-nullable":true},"avi_id":{"description":"AVI (automatic vehicle identification) Id value (optional)","type":"string","x-nullable":true},"billing_info":{"$ref":"#/definitions/BillingInfo","description":"Billing Info","x-nullable":true},"bonuses_added":{"items":{"$ref":"#/definitions/BonusAdded"},"type":"array","x-nullable":true},"bonuses_added_amount":{"description":"Added bonuses amount","format":"float","type":"number","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer","x-nullable":true},"bonuses_redeemed_amount":{"description":"Redeemed bonuses amount","format":"float","type":"number","x-nullable":true},"business":{"$ref":"#/definitions/CheckBusiness","description":"Business info if exists (optional)","x-nullable":true},"business_staff":{"$ref":"#/definitions/CheckBusinessStaff","description":"Business Staff info if exists (readonly, optional)","x-nullable":true},"calculated_margins":{"$ref":"#/definitions/CheckMargins","description":"Total margins calculated by items total margins (optional, readonly)","x-nullable":true},"calculated_taxes":{"$ref":"#/definitions/CheckTaxes","description":"Total taxes calculated by items total taxes (optional, readonly)","x-nullable":true},"cardotppassword":{"description":"User phone number. Minimum 3 chars (optional)","type":"string","x-nullable":true},"check_items":{"items":{"$ref":"#/definitions/CheckItem"},"type":"array","x-nullable":true},"check_services":{"$ref":"#/definitions/CheckServices","description":"Services added on check (optional)","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"corporate_customer_id":{"description":"Corporate Customer ID (optional)","format":"uuid","type":"string","x-nullable":true},"corporate_customer_special_account_id":{"description":"Corporate Customer Account ID","format":"uuid","type":"string","x-nullable":true},"corporate_vehicle":{"$ref":"#/definitions/CheckCorporateVehicle","description":"Corporate vehicle Info (optional)","x-nullable":true},"customer_feedback_settings":{"$ref":"#/definitions/CheckCustomerFeedbackSettings","description":"Customer feedback settings (optional)","x-nullable":true},"customer_id":{"description":"Customer user ID (optional)","format":"uuid","type":"string","x-nullable":true},"discount_amount":{"description":"Amount of discount","format":"float","type":"number","x-nullable":true},"emitted_coupons":{"items":{"$ref":"#/definitions/CheckCoupon"},"type":"array","x-nullable":true},"external_additional_info":{"description":"Any custom external data (optional)","type":"object","x-nullable":true},"external_check_id":{"description":"External check identifier","type":"string","x-nullable":true},"external_check_id_by_user":{"default":0,"description":"Checking the uniqueness of the identifier within a user (different users may use the same identifier or campaign)","enum":[0,1],"type":"integer","x-nullable":true},"external_check_id_scope":{"$ref":"#/definitions/ExternalCheckIdScope","description":"External check identifier scope","x-nullable":true},"id":{"description":"User identifier (phone number, card code, QR code). Minimum 3 chars (optional)","type":"string","x-nullable":true},"id_type":{"$ref":"#/definitions/IdType","description":"Type of user identity (optional)","x-nullable":true},"implemented_rules":{"$ref":"#/definitions/CheckImplementedRulesList","description":"Loyalty rules implemented to check","x-nullable":true},"loyalty":{"$ref":"#/definitions/CheckLoyalty","description":"Loyalty info if exists (optional)","x-nullable":true},"manual_rules":{"description":"Specified the rules manually selected at the terminal","type":"boolean","x-nullable":true},"odometer":{"description":"Odometer/engine hours value, up to two decimal digits (optional)","format":"float","type":"number","x-nullable":true},"odometer_unit":{"$ref":"#/definitions/OdometerUnitType","description":"Odometer unit of measure (optional)","x-nullable":true},"online_store_order_id":{"description":"Online store order id","format":"uuid","type":"string","x-nullable":true},"payment_id":{"description":"Currency ISO code, special account Id or corporate special account access","type":"string","x-nullable":true},"payment_type":{"$ref":"#/definitions/TransactionPaymentType","description":"Payment type","x-nullable":true},"payments":{"items":{"$ref":"#/definitions/Payment"},"type":"array","x-nullable":true},"pos":{"$ref":"#/definitions/CheckPos","description":"Pos info if exists (optional)","x-nullable":true},"preliminary_transaction_id":{"description":"Preliminary Transaction Id (optional, only if exists)","format":"uuid","type":"string","x-nullable":true},"preliminary_transaction_type":{"$ref":"#/definitions/TransactionType","description":"Preliminary Transaction type (optional, only if exists)","x-nullable":true},"redeemed_coupons":{"items":{"$ref":"#/definitions/CheckCoupon"},"type":"array","x-nullable":true},"route_operation_id":{"description":"Route operation Id","type":"string","x-nullable":true},"services_amount":{"description":"Added on check services total amount (optional)","format":"float","type":"number","x-nullable":true},"shipping_amount":{"description":"Shipping amount (optional)","format":"float","type":"number","x-nullable":true},"skip_message":{"default":false,"description":"Skip notifications","type":"boolean","x-nullable":true},"special_account":{"$ref":"#/definitions/CheckSpecialAccount","description":"Special account info","x-nullable":true},"special_account_odometer_required":{"$ref":"#/definitions/DataRequiredType","description":"Odometer value required flag for operating with special account (response only) (optional, readonly)","x-nullable":true},"special_account_pin":{"description":"PIN code for operating with special account (request only) (optional)","type":"string","x-nullable":true},"special_account_pin_required":{"description":"PIN required flag for operating with special account (response only) (optional)","type":"boolean","x-nullable":true},"special_account_required_values_verify":{"description":"Verify special account required values flag (only for process_check, ignored in othe methods) (optional)","type":"boolean","x-nullable":true},"special_account_vehicle_id_required":{"$ref":"#/definitions/DataRequiredType","description":"VIN (other vehicle identifier) value required flag for operating with special account (response only) (optional, readonly)","x-nullable":true},"special_accounts_charges":{"items":{"$ref":"#/definitions/SpecialAccountCharge"},"type":"array","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer","x-nullable":true},"summary_amount":{"description":"Sum of amount and shipping_amount and services_amount (optional, readonly)","format":"double","type":"number","x-nullable":true},"tanks":{"description":"Tanks Data (optional)","items":{"$ref":"#/definitions/CheckTank"},"type":"array","x-nullable":true},"terminal_odometer_measurement_units":{"$ref":"#/definitions/OdometerUnitType","description":"Odometer measuremen units selection type by Terminal settings (optional)","x-nullable":true},"transaction_cancelled":{"description":"Transaction canceled flag","enum":[0,1],"type":"integer","x-nullable":true},"transaction_id":{"description":"Transaction ID","format":"uuid","type":"string","x-nullable":true},"transaction_receipt_actions":{"$ref":"#/definitions/TransactionReceiptActions","description":"Transaction receipt actions (optional)","x-nullable":true},"transaction_subtype":{"$ref":"#/definitions/TransactionSubType","description":"Transaction subtype (optional, readonly)","x-nullable":true},"transaction_type":{"$ref":"#/definitions/TransactionType","description":"Transaction type","x-nullable":true},"user_external_forms":{"$ref":"#/definitions/CheckUserExternalFormRelations","description":"External forms filled by customer (optional, readonly)","x-nullable":true},"vehicle_id":{"description":"Qr Code / Tag of vehicle or equipment value (optional)","type":"string","x-nullable":true}},"type":"object"},"CheckBusiness":{"properties":{"description":{"description":"Business title","type":"string","x-nullable":true},"id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Business logos","x-nullable":true},"title":{"description":"Business title","type":"string","x-nullable":true}},"type":"object"},"CheckBusinessStaff":{"properties":{"id":{"description":"Staff id","format":"uuid","type":"string","x-nullable":true},"name":{"description":"Name","type":"string","x-nullable":true}},"type":"object"},"CheckCorporateStaffPosition":{"properties":{"id":{"description":"Position ID","format":"uuid","type":"string"},"public_description":{"description":"Position public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Position public title (optional)","type":"string","x-nullable":true},"title":{"description":"Position title","type":"string"}},"type":"object"},"CheckCorporateVehicle":{"properties":{"avi_id":{"description":"Vehicle/Inventory AVI (automatic vehicle identification) Id (optional)","type":"string","x-nullable":true},"description":{"description":"Description (optional)","type":"string","x-nullable":true},"id":{"description":"Vehicle/Inventory unique Id","format":"uuid","type":"string","x-nullable":true},"position":{"$ref":"#/definitions/CheckCorporateStaffPosition","description":"Position info (readonly) (optional)","x-nullable":true},"position_id":{"description":"Position ID (optional)","format":"uuid","type":"string","x-nullable":true},"qr_code":{"description":"Qr Code / Tag (optional)","type":"string","x-nullable":true},"vehicle_id":{"description":"Vehicle/Inventory Id (optional)","type":"string","x-nullable":true}},"type":"object"},"CheckCoupon":{"properties":{"activity_id":{"description":"Activity ID (optional, check only)","format":"uuid","type":"string","x-nullable":true},"applicable":{"description":"Coupon check applicable for check (optional, redeem in check only)","type":"boolean","x-nullable":true},"batch":{"$ref":"#/definitions/CheckCouponBatch","description":"Batch info (optional)","x-nullable":true},"batch_id":{"description":"Batch Id (optional)","format":"uuid","type":"string","x-nullable":true},"business_code":{"description":"Business code","type":"string","x-nullable":true},"code":{"description":"Coupon code","type":"string","x-nullable":true},"description":{"description":"Coupon Description","type":"string","x-nullable":true},"do_not_add_to_wallet":{"description":"Do not add emitted coupons to the customer's wallet (optional, check only)","type":"boolean","x-nullable":true},"error":{"description":"Coupon check implementation error (optional, redeem in check only)","type":"string","x-nullable":true},"expire_date":{"description":"Date expiry of coupon","format":"date","type":"string","x-nullable":true},"external_code":{"description":"Coupon external_code (optional)","type":"string","x-nullable":true},"external_code_visibility_type":{"$ref":"#/definitions/CouponExternalCodeVisibilityType","description":"External code visibility type (optional)","x-nullable":true},"id":{"description":"Unique id of coupon","format":"uuid","type":"string","x-nullable":true},"image":{"description":"Coupon batch image (optional)","format":"url","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty emission id","format":"uuid","type":"string","x-nullable":true},"object_id":{"description":"Reference object ID, up to 36 chars (optional, check only)","type":"string","x-nullable":true},"object_type":{"$ref":"#/definitions/BenefitsTopUpReferenceObjectType","description":"Reference object type (optional, check only)","x-nullable":true},"processing_status":{"$ref":"#/definitions/CouponProcessingStatus","description":"Coupon processing status (optional, check by transaction only)","x-nullable":true},"redeem_at_terminal":{"description":"Redeem only at terminal restriction","enum":[0,1],"type":"integer","x-nullable":true},"share_allowed":{"description":"Coupons share allowed for customer","enum":[0,1],"type":"integer","x-nullable":true},"status":{"$ref":"#/definitions/CouponStatus","description":"Status of coupon","x-nullable":true},"title":{"description":"Coupon Title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/CouponType","description":"Type of coupon","x-nullable":true},"valid":{"description":"Coupon valid flag (optional)","type":"boolean","x-nullable":true}},"type":"object"},"CheckCouponBatch":{"properties":{"alias":{"$ref":"#/definitions/CouponBatchAlias","description":"Batch alias (optional, readonly)","x-nullable":true},"auto_redeem_on_add_to_wallet":{"description":"Automatically redeem on wallet add event (optional)","enum":[0,1],"type":"integer","x-nullable":true},"business_id":{"description":"Business Id","format":"uuid","type":"string","x-nullable":true},"customers_price_amount":{"description":"Coupon emission price (optional)","format":"double","type":"number","x-nullable":true},"customers_price_currency":{"description":"Coupon emission price currency (optional)","type":"string","x-nullable":true},"customers_price_special_account_id":{"description":"Coupon emission price special account Id (optional)","format":"uuid","type":"string","x-nullable":true},"customers_price_special_account_title":{"description":"Coupon emission price special account title (optional)","type":"string","x-nullable":true},"customers_price_type":{"$ref":"#/definitions/BenefitsPriceType","description":"Coupon emission price type (optional)","x-nullable":true},"id":{"description":"Unique id of coupon batch","format":"uuid","type":"string","x-nullable":true},"image":{"description":"Coupon batch image (optional)","format":"url","type":"string","x-nullable":true},"links":{"$ref":"#/definitions/CouponBatchLinks","description":"Batch links list (optional, readonly)","x-nullable":true},"loyalty_id":{"description":"Loyalty emission id","format":"uuid","type":"string","x-nullable":true},"public_description":{"description":"Coupons batch public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Coupons batch public title (optional)","type":"string","x-nullable":true},"redeem_at_terminal":{"description":"Redeem only at terminal restriction (optional)","enum":[0,1],"type":"integer","x-nullable":true},"share_allowed":{"description":"Coupons share allowed for customer (optional)","enum":[0,1],"type":"integer","x-nullable":true},"type":{"$ref":"#/definitions/CouponType","description":"Type of coupon","x-nullable":true}},"type":"object"},"CheckCustomerFeedbackSettings":{"properties":{"active":{"description":"Feedback system active flag","enum":[0,1],"type":"integer"},"feedback_source":{"$ref":"#/definitions/CheckFeedbackSource"},"print_feedback_on_check":{"$ref":"#/definitions/CustomerFeedbackPrintOnCheck","description":"Print feedback source on check"},"print_feedback_on_check_message_text":{"description":"Invitation message text for printinting on check","type":"string"}},"type":"object"},"CheckFeedbackSource":{"properties":{"id":{"description":"Feedback source ID","format":"uuid","type":"string"},"invitation_text":{"description":"Text displayed for customers as invitation","type":"string"},"title":{"description":"Title","type":"string"},"urls":{"description":"URLs for object","properties":{"base_url":{"description":"Full URL","type":"string"},"short_url":{"description":"Short URL","type":"string"}},"type":"object"}},"type":"object"},"CheckImplementedRule":{"properties":{"action_type":{"$ref":"#/definitions/LoyaltyRuleActionType","description":"Rule action dependency type (by some kinds of amount or by items)","x-nullable":true},"active":{"description":"Rule is active","enum":[0,1],"type":"integer","x-nullable":true},"applicable_api_scope":{"$ref":"#/definitions/LoyaltyRuleApplicableApiScope","description":"Rule applicable for API type (for automatic and coupon automatic only)","x-nullable":true},"applicable_for_customer":{"$ref":"#/definitions/LoyaltyRuleApplicableForCustomer","description":"Rule applicable for customer type","x-nullable":true},"applicable_for_sale":{"$ref":"#/definitions/LoyaltyRuleApplicableForSale","description":"Rule applicable for sale type","x-nullable":true},"apply_when_bonuses_redeemed":{"description":"Apply rule when bonus points redeemed","enum":[0,1],"type":"integer","x-nullable":true},"apply_when_customers_account_payment":{"description":"Apply rule when payments from customer accounts","enum":[0,1],"type":"integer","x-nullable":true},"automatic":{"description":"Rule applied type (0 - manual, 1 - automatic, 2 - coupon, 3 - display, 4 - corporate manual, 5 - corporate automatic)","enum":[0,1,2,3,4,5],"type":"integer","x-nullable":true},"card_category_id":{"description":"Card category ID (optional, for rules with retail scope only)","format":"uuid","type":"string","x-nullable":true},"charge_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Refill object type","x-nullable":true},"combine":{"description":"Combine with other rules flag","enum":[0,1],"type":"integer","x-nullable":true},"comment":{"description":"Rule comment","type":"string","x-nullable":true},"corporate_customer_category_id":{"description":"Corporate customers category ID (optional, for rules with corporate scope only)","format":"uuid","type":"string","x-nullable":true},"count_bonuses_redeemed_amount":{"description":"Consider redeemed bonuses when calculating the rule value (null if used loyalty settings)","enum":[0,1],"type":"integer","x-nullable":true},"coupon_batch_code":{"description":"Batch code of emitted coupons (optional)","type":"string","x-nullable":true},"coupon_do_not_add_to_wallet":{"description":"Do not add emitted coupons to the customer's wallet (optional)","enum":[0,1],"type":"integer"},"depends_calc_period":{"$ref":"#/definitions/LoyaltyRuleDependsCalcPeriod","description":"Rule values dependencies period (not applicable for depency 'bonuses-on-account')","x-nullable":true},"depends_calc_period_related_to_current_category":{"description":"Dependencies period limited by current category period","enum":[0,1],"type":"integer"},"depends_excluded_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc do not applied for item categories (if empty - no exceptions)","x-nullable":true},"depends_excluded_items":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc do not applied for items codes (if empty - no exceptions)","x-nullable":true},"depends_included_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc applied for item categories (if empty - applied for any categories)","x-nullable":true},"depends_included_items":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc applied for items codes (if empty - applied for any items)","x-nullable":true},"depends_type":{"$ref":"#/definitions/LoyaltyRuleDependsType","description":"Rule values dependencies type","x-nullable":true},"excluded_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Rule do not applied for item categories (if empty - no exceptions)","x-nullable":true},"excluded_items":{"$ref":"#/definitions/StringValuesList","description":"Rule do not applied for items codes (if empty - no exceptions)","x-nullable":true},"id":{"description":"Rule ID","format":"uuid","type":"string","x-nullable":true},"implementation_data":{"$ref":"#/definitions/RuleImplementationData","description":"Rule check implementation data (optional, only in check implemented rules)","x-nullable":true},"included_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Rule applied for item categories (if empty - applied for any categories)","x-nullable":true},"included_items":{"$ref":"#/definitions/StringValuesList","description":"Rule applied for items codes (if empty - applied for any items)","x-nullable":true},"item_zero_quantity_as_one_quantity":{"description":"Interpret zero quantity of an item as one (for item action types only)","enum":[0,1],"type":"integer"},"items_limit_max":{"description":"maximum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"items_limit_min":{"description":"minimum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"only_once_per_check":{"description":"Apply rule only once per check (for coupon automatic only)","enum":[0,1],"type":"integer"},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"List of POS where rule is applicable","x-nullable":true},"priority":{"description":"Rule priority(0 - the greatest one)","type":"integer","x-nullable":true},"promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type","x-nullable":true},"promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire","type":"integer","x-nullable":true},"promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type","x-nullable":true},"promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start","type":"integer","x-nullable":true},"scheduled":{"description":"Rule is scheduled","enum":[0,1],"type":"integer","x-nullable":true},"scope":{"$ref":"#/definitions/LoyaltyRuleScope","description":"Rule scope (readonly)","x-nullable":true},"special_account_id":{"description":"Special account ID","type":"string","x-nullable":true},"time_from":{"description":"Rule valid from time (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"time_to":{"description":"Rule valid to time (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"title":{"description":"Rule title","type":"string","x-nullable":true},"use_alternative_dependencies_by_items":{"description":"Alternative calc by items dependencies usage","enum":[0,1],"type":"integer"},"valid_after":{"description":"Rule valid from date (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"valid_before":{"description":"Rule valid to date (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"value":{"$ref":"#/definitions/ThresholdsValues","description":"Values set based on thresholds","x-nullable":true},"week_days":{"$ref":"#/definitions/WeekDaysList","description":"Rule valid at the days (used if rule is scheduled)","x-nullable":true}},"type":"object"},"CheckImplementedRulesList":{"items":{"$ref":"#/definitions/CheckImplementedRule"},"type":"array"},"CheckItem":{"properties":{"additions":{"$ref":"#/definitions/CheckItemAdditionalInfo","description":"Additional information for further processing","x-nullable":true},"amount":{"description":"Item row total","format":"float","type":"number","x-nullable":true},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"authorized_amount":{"description":"Item row total by authorized payment transaction","format":"float","type":"number","x-nullable":true},"authorized_quantity":{"description":"Item quantity by authorized payment transaction","format":"float","type":"number","x-nullable":true},"bonuses_added":{"description":"Amount of added bonuses","format":"float","type":"number","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer","x-nullable":true},"calculated_bonuses_redeemed_amount":{"description":"Goods item total bonus points redeemed calculated by check (for list with stock)","format":"double","type":"number","x-nullable":true},"calculated_discount_amount":{"description":"Goods item total discount calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"calculated_margins":{"$ref":"#/definitions/CheckMargins","description":"Goods item total margins calculated by margins applicable to the price (optional, readonly)","x-nullable":true},"calculated_price":{"description":"Goods item price calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"calculated_taxes":{"$ref":"#/definitions/CheckTaxes","description":"Goods item total taxes calculated by taxes applicable to the price (optional, readonly)","x-nullable":true},"calculated_unit_bonuses_redeemed_amount":{"description":"Goods item unit bonus points redeemed calculated by check (for list with stock)","format":"double","type":"number","x-nullable":true},"calculated_unit_discount_amount":{"description":"Goods item unit discount calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"category":{"description":"item category","type":"string","x-nullable":true},"code":{"description":"item code","type":"string","x-nullable":true},"discount_amount":{"description":"Amount of discount","format":"float","type":"number","x-nullable":true},"loyalty_item_id":{"description":"Loyalty item unique id related to check item (optional, readonly)","type":"string","x-nullable":true},"margins":{"$ref":"#/definitions/PriceMargins","description":"Margins applicable to the price (optional)","x-nullable":true},"passthru_data":{"$ref":"#/definitions/GoodsPassThru","description":"PassThru data for Fleet, etc (optional)","x-nullable":true},"price":{"description":"Item price","format":"float","type":"number","x-nullable":true},"price_decimal_digits":{"description":"Number of decimal digits in price value","type":"integer","x-nullable":true},"processed_amount":{"description":"Item row total by job","format":"float","type":"number","x-nullable":true},"processed_quantity":{"description":"Item quantity by job","format":"float","type":"number","x-nullable":true},"quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"quantity_decimal_digits":{"description":"Number of decimal digits in quantity value (only for quantity_recalculate_type is applicable)","type":"integer","x-nullable":true},"quantity_recalculate_type":{"$ref":"#/definitions/CheckItemQuantityRecalculateType","description":"Quantity recalculate type (if needed)","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer","x-nullable":true},"taxes":{"$ref":"#/definitions/PriceTaxes","description":"Taxes applicable to the price (optional)","x-nullable":true},"title":{"description":"item title","type":"string","x-nullable":true},"unit":{"description":"Measuring units","type":"string","x-nullable":true},"weighing":{"description":"Weight goods flag","enum":[0,1],"type":"integer","x-nullable":true},"whole_number":{"description":"Item quantity only by whole number flag","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"CheckItemAdditionalInfo":{"properties":{"job":{"$ref":"#/definitions/Job","description":"Information for further job processing","type":"string"},"loyalty_item_id":{"description":"Loyalty item unique id related to check item (optional, readonly)","type":"string","x-nullable":true},"processing_id":{"description":"Check item processing id (optional, readonly)","type":"string","x-nullable":true},"quantity_decimal_digits":{"description":"Number of decimal digits in quantity value (optional, readonly)","type":"integer","x-nullable":true},"quantity_recalculate_skipped":{"description":"Quantity recalculate skipped flag (optional, readonly)","type":"boolean","x-nullable":true},"quantity_recalculate_type":{"$ref":"#/definitions/CheckItemQuantityRecalculateType","description":"Quantity recalculate type (optional, readonly)","x-nullable":true}},"type":"object"},"CheckItemEnterMode":{"enum":["without-limits","presets-only","manually-only"],"type":"string"},"CheckItemQuantityRecalculateType":{"enum":["adjust-by-amount","recalculate-by-amount"],"type":"string"},"CheckLoyalty":{"properties":{"active":{"description":"Active flag (optional)","enum":[0,1],"type":"integer","x-nullable":true},"categories":{"$ref":"#/definitions/LoyaltyCategoriesList","description":"Categories (optional)"},"id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"legal_info":{"description":"Loyalty legal info (optional)","type":"string","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links (optional)"},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos (optional)"},"privacy_policy_url":{"description":"Loyalty privacy policy link (optional)","type":"string","x-nullable":true},"public_description":{"description":"Loyalty public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Loyalty public title (optional)","type":"string","x-nullable":true},"title":{"description":"Loyalty title","type":"string","x-nullable":true}},"type":"object"},"CheckMarginExplainDetailingItem":{"properties":{"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"include_in_receipt":{"description":"Include in receipt (optional)","type":"boolean","x-nullable":true},"source":{"$ref":"#/definitions/PriceExplainValueSource","description":"Source of value","x-nullable":true},"type":{"$ref":"#/definitions/PriceExplainValueType","description":"Type of value","x-nullable":true},"value":{"description":"Result value of current price level","format":"float","type":"number","x-nullable":true},"value_code":{"description":"Value Code if exists (optional)","type":"string","x-nullable":true},"value_id":{"description":"Value Id if exists (optional)","format":"uuid","type":"string","x-nullable":true},"value_title":{"description":"Value title if exists (optional)","type":"string","x-nullable":true}},"type":"object"},"CheckMargins":{"properties":{"terminal_additional_costs":{"description":"Terminal additional costs detailing","items":{"$ref":"#/definitions/CheckMarginExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"CheckPos":{"properties":{"active":{"description":"Terminal is active flag (optional)","enum":[0,1],"type":"integer"},"additional_services_required":{"description":"Is additional services required (optional)","enum":[0,1],"type":"integer","x-nullable":true},"addresses":{"description":"Address of sale point (optional)","type":"string","x-nullable":true},"catalog_publication_comment":{"description":"Pos catalog publication comment","type":"string","x-nullable":true},"catalog_publication_state":{"$ref":"#/definitions/PosCatalogPublicationState","description":"Pos catalog publication state (optional)","x-nullable":true},"categories":{"$ref":"#/definitions/LoyaltyCategoriesList","description":"Categories (optional)","x-nullable":true},"check_item_enter_mode":{"$ref":"#/definitions/CheckItemEnterMode","description":"Pos check items entering mode possibilities (optional)","x-nullable":true},"country":{"description":"Country code (optional)","type":"string","x-nullable":true},"id":{"description":"Point of sales ID","format":"uuid","type":"string"},"latitude":{"description":"GEO Latitude (optional)","format":"double","type":"number","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links (optional)","x-nullable":true},"longitude":{"description":"GEO Longitude (optional)","format":"double","type":"number","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","type":"string"},"maximum_service_distance":{"description":"Maximum service distance in km (0 - unlimited) (optional)","type":"integer"},"phones":{"$ref":"#/definitions/PhoneNumbersList","description":"Phones of sale point"},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos (optional)","x-nullable":true},"priority":{"description":"Priority (optional)","type":"integer"},"public_description":{"description":"Point of sale public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Point of sale public title (optional)","type":"string","x-nullable":true},"time_zone":{"description":"Time zone (optional)","type":"string","x-nullable":true},"title":{"description":"POS title","type":"string"},"type":{"$ref":"#/definitions/PosType","description":"Pos type"}},"type":"object"},"CheckService":{"properties":{"additional_service_id":{"description":"Unique Id of additional service by code (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"amount":{"description":"Service amount","format":"float","type":"number","x-nullable":true},"code":{"description":"Service code","type":"string"},"cost":{"description":"Service cost (for unit of value)","format":"float","type":"number","x-nullable":true},"decimal_digits":{"description":"Number of decimal digits in cost and amount values","type":"integer","x-nullable":true},"service_item_info":{"$ref":"#/definitions/AdditionalService","description":"Additional service info (optional, readonly)","x-nullable":true},"title":{"description":"Service title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/AdditionalServiceType","description":"Service type","x-nullable":true},"value":{"description":"Base value for calculate service cost and amount (distance, etc.)","format":"float","type":"number","x-nullable":true}},"required":["code"],"type":"object"},"CheckServices":{"items":{"$ref":"#/definitions/CheckService"},"type":"array"},"CheckSpecialAccount":{"properties":{"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"id":{"description":"Field id","type":"string","x-nullable":true},"title":{"description":"Account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type","x-nullable":true}},"type":"object"},"CheckTank":{"properties":{"address":{"description":"Title","type":"string","x-nullable":true},"code":{"description":"Tank unique code (read only)","type":"string","x-nullable":true},"goods_code":{"description":"Linked product code (optional, only for linked tank data) (read only)","type":"string","x-nullable":true},"latitude":{"description":"Latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"longitude":{"description":"Longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"physical_dip_amount":{"description":"Physical DIP Amount","format":"float","type":"number","x-nullable":true},"product_volume_after":{"description":"Tank product volume after operation (read only)","format":"float","type":"number","x-nullable":true},"product_volume_before":{"description":"Tank product volume before operation (read only)","format":"float","type":"number","x-nullable":true},"tank_id":{"description":"Tank id","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Title (read only)","type":"string","x-nullable":true},"volume":{"description":"Tank volume (read only)","format":"float","type":"number","x-nullable":true}},"type":"object"},"CheckTaxExplainDetailingItem":{"properties":{"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"exempt":{"description":"Tax/Margin exemption (optional)","type":"boolean","x-nullable":true},"include_in_receipt":{"description":"Include in receipt (optional)","type":"boolean","x-nullable":true},"source":{"$ref":"#/definitions/PriceExplainValueSource","description":"Source of value","x-nullable":true},"type":{"$ref":"#/definitions/PriceExplainValueType","description":"Type of value","x-nullable":true},"value":{"description":"Result value of current price level","format":"float","type":"number","x-nullable":true},"value_code":{"description":"Value Code if exists (optional)","type":"string","x-nullable":true},"value_id":{"description":"Value Id if exists (optional)","format":"uuid","type":"string","x-nullable":true},"value_title":{"description":"Value title if exists (optional)","type":"string","x-nullable":true}},"type":"object"},"CheckTaxes":{"properties":{"base":{"description":"Base taxes detailing","items":{"$ref":"#/definitions/CheckTaxExplainDetailingItem"},"type":"array","x-nullable":true},"sales":{"description":"Sales taxes detailing","items":{"$ref":"#/definitions/CheckTaxExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"CheckUserExternalFormRelations":{"properties":{"required":{"description":"Requred user external forms","items":{"$ref":"#/definitions/UserExternalForm"},"type":"array","x-nullable":true},"wanted":{"description":"Wanted user external forms","items":{"$ref":"#/definitions/UserExternalForm"},"type":"array","x-nullable":true}},"type":"object"},"CorporateAccountAccessLimits":{"properties":{"account_available_amount":{"description":"Amount of funds on the account available for using (null if unlimited)","format":"float","type":"number"},"account_available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"account_available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"account_day_limit":{"description":"Corporate customer account day limit (if 0 - unlimited)","format":"float","type":"number"},"account_day_limit_available":{"description":"Corporate customer account day available amount, not for unlimited account (null if unlimited)","format":"float","type":"number"},"account_day_limit_used":{"description":"Corporate customer account day used amount","format":"float","type":"number"},"account_month_limit":{"description":"Corporate customer account month limit (if 0 - unlimited)","format":"float","type":"number"},"account_month_limit_available":{"description":"Corporate customer account month available amount, not for unlimited account (null if unlimited)","format":"float","type":"number"},"account_month_limit_used":{"description":"Corporate customer account month used amount","format":"float","type":"number"},"user_available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"user_available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"user_day_limit":{"description":"User access to the account day limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"user_day_limit_available":{"description":"User access to the account day available amount, not for unlimited account (null if unlimited)","format":"float","type":"number","x-nullable":true},"user_day_limit_used":{"description":"User access to the account day used amount","format":"float","type":"number","x-nullable":true},"user_month_limit":{"description":"User access to the account month limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"user_month_limit_available":{"description":"User access to the account month available amount, not for unlimited account (null if unlimited)","format":"float","type":"number","x-nullable":true},"user_month_limit_used":{"description":"User access to the account month used amount","format":"float","type":"number","x-nullable":true},"user_overall_limit":{"description":"User access to the account overall limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"user_overall_limit_available":{"description":"User access to the account overall available amount, not for unlimited account (null if unlimited)","format":"float","type":"number","x-nullable":true},"user_overall_limit_used":{"description":"User access to the account overall used amount","format":"float","type":"number","x-nullable":true}},"type":"object"},"CorporateCustomer":{"properties":{"access":{"$ref":"#/definitions/AccessObject","description":"Business access (optional)","x-nullable":true},"additional_info":{"description":"Additional not specified customer info","type":"object","x-nullable":true},"billing_info":{"description":"Billing info","properties":{"address":{"description":"Address","type":"string","x-nullable":true},"city":{"description":"City","type":"string","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"company_name":{"description":"Company name","type":"string","x-nullable":true},"country":{"description":"Country ISO code","type":"string","x-nullable":true},"post_code":{"description":"Post/Zip code","type":"string","x-nullable":true},"region":{"description":"Region / State / Province","type":"string"},"tax_info":{"description":"Some TAX/VAT info","type":"object","x-nullable":true}},"type":"object","x-nullable":true},"category":{"$ref":"#/definitions/CorporateCustomerCategory","x-nullable":true},"category_id":{"description":"Category id","type":"string","x-nullable":true},"contacts":{"description":"Contacts list","items":{"description":"Contact info","properties":{"address":{"description":"contact address","type":"string","x-nullable":true},"comment":{"description":"contact comment","type":"string","x-nullable":true},"contact_person":{"description":"Contact person","type":"string","x-nullable":true},"email":{"description":"contact email","type":"string","x-nullable":true},"mobile":{"description":"Mobile phone number","type":"string","x-nullable":true},"phones":{"description":"Phone numbers","type":"string","x-nullable":true}},"type":"object","x-nullable":true},"type":"array"},"created":{"description":"Created datetime","format":"date-time","type":"string","x-nullable":true},"email":{"description":"Primary email ID","type":"string","x-nullable":true},"id":{"description":"Corporate customer ID","format":"uuid","type":"string","x-nullable":true},"name":{"description":"Customer name","type":"string","x-nullable":true},"questionnaire":{"$ref":"#/definitions/CorporateCustomerQuestionnaire","description":"Default questionnaire fields values","x-nullable":true},"suspended":{"description":"Suspended flag","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"CorporateCustomerAccountPriceOption":{"properties":{"active":{"description":"Overall active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"base_value_type":{"$ref":"#/definitions/PriceOptionBaseValueType","default":"posted-price","description":"Option base value type","x-nullable":true},"corporate_customer_special_account_id":{"description":"Instance of corporate customer special account ID (readonly)","format":"uuid","type":"string","x-nullable":true},"item_active":{"description":"Goods item active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"item_category_id":{"description":"Goods item category ID (readonly)","format":"uuid","type":"string","x-nullable":true},"item_category_title":{"description":"Goods item category title (readonly)","type":"string","x-nullable":true},"item_code":{"description":"Goods item code (readonly)","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string","x-nullable":true},"item_title":{"description":"Goods item title (readonly)","type":"string","x-nullable":true},"loyalty_active":{"description":"Loyalty active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (readonly)","format":"uuid","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title (readonly)","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/PriceOptionType","default":"discount","description":"Option type","x-nullable":true},"value":{"description":"Option value (optional, if value_depends_type is 'none')","format":"float","type":"number","x-nullable":true},"value_depends_by_goods":{"$ref":"#/definitions/PriceOptionDependsByGoods","default":"all","description":"Option value depends on value calculation goods (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_calc_period":{"$ref":"#/definitions/PriceOptionDependsCalcPeriod","default":"all","description":"Option value depends on value calculation period (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_matrix":{"$ref":"#/definitions/ThresholdsValues","description":"Option value depends on value matrix (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_type":{"$ref":"#/definitions/PriceOptionDependsType","default":"none","description":"Option value depends on","x-nullable":true},"value_type":{"$ref":"#/definitions/PriceOptionValueType","default":"amount","description":"Option value type","x-nullable":true}},"type":"object"},"CorporateCustomerAccountPriceOptionList":{"items":{"$ref":"#/definitions/CorporateCustomerAccountPriceOption","description":"Goods item price option object"},"type":"array"},"CorporateCustomerCategoriesList":{"items":{"$ref":"#/definitions/CorporateCustomerCategory"},"type":"array"},"CorporateCustomerCategory":{"properties":{"active":{"default":1,"description":"Category is active","enum":[0,1],"type":"integer","x-nullable":true},"active_change_allowed":{"description":"Active value changing allowed (readonly, optional)","type":"boolean","x-nullable":true},"id":{"description":"category ID","format":"uuid","type":"string","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Title to show (multilanguage, optional)","x-nullable":true},"title":{"description":"category title","type":"string","x-nullable":true},"weight":{"default":1,"description":"Category weight (optional)","type":"integer","x-nullable":true}},"type":"object"},"CorporateCustomerCategoryAccountPriceOption":{"properties":{"active":{"description":"Overall active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"base_value_type":{"$ref":"#/definitions/PriceOptionBaseValueType","default":"posted-price","description":"Option base value type","x-nullable":true},"category_id":{"description":"Corporate customer category ID","format":"uuid","type":"string","x-nullable":true},"item_active":{"description":"Goods item active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"item_category_id":{"description":"Goods item category ID (readonly)","format":"uuid","type":"string","x-nullable":true},"item_category_title":{"description":"Goods item category title (readonly)","type":"string","x-nullable":true},"item_code":{"description":"Goods item code (readonly)","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string","x-nullable":true},"item_title":{"description":"Goods item title (readonly)","type":"string","x-nullable":true},"loyalty_active":{"description":"Loyalty active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (readonly)","format":"uuid","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title (readonly)","type":"string","x-nullable":true},"special_account_id":{"description":"Special account ID","format":"uuid","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/PriceOptionType","default":"discount","description":"Option type","x-nullable":true},"value":{"description":"Option value (optional, if value_depends_type is 'none')","format":"float","type":"number","x-nullable":true},"value_depends_by_goods":{"$ref":"#/definitions/PriceOptionDependsByGoods","default":"all","description":"Option value depends on value calculation goods (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_calc_period":{"$ref":"#/definitions/PriceOptionDependsCalcPeriod","default":"all","description":"Option value depends on value calculation period (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_matrix":{"$ref":"#/definitions/ThresholdsValues","description":"Option value depends on value matrix (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_type":{"$ref":"#/definitions/PriceOptionDependsType","default":"none","description":"Option value depends on","x-nullable":true},"value_type":{"$ref":"#/definitions/PriceOptionValueType","default":"amount","description":"Option value type","x-nullable":true}},"type":"object"},"CorporateCustomerCategoryAccountPriceOptionList":{"items":{"$ref":"#/definitions/CorporateCustomerCategoryAccountPriceOption","description":"Goods item price option object"},"type":"array"},"CorporateCustomerCategoryAssign":{"properties":{"category_id":{"description":"Category ID","format":"uuid","type":"string"},"users":{"$ref":"#/definitions/ObjectIds","description":"List of User Id"}},"required":["category_id"],"type":"object"},"CorporateCustomerQuestionnaire":{"properties":{"detailing":{"description":"Detailing of questionnaire fields (readonly)","items":{"$ref":"#/definitions/CustomerQuestionnaireFieldEmbedded"},"type":"array","x-nullable":true}},"type":"object"},"CorporateCustomerSpecialAccount":{"properties":{"active":{"default":1,"description":"Account active flag","enum":[0,1],"type":"integer"},"amount":{"description":"Amount of funds on the account","format":"float","type":"number","x-nullable":true},"available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"balance":{"description":"Account balance","format":"float","type":"number","x-nullable":true},"corporate_customer_id":{"description":"Corporate customer ID","format":"uuid","type":"string"},"created":{"description":"Created datetime","format":"date-time","type":"string","x-nullable":true},"credit_limit":{"description":"Credit limit (only for 'credit' accounts)","format":"float","type":"number","x-nullable":true},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type (only for corporate accounts)","x-nullable":true},"day_limit":{"default":0,"description":"Day limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"day_limit_available":{"description":"Day available amount, null if unlimited  (readonly)","format":"float","type":"number","x-nullable":true},"day_limit_used":{"description":"Day used amount (readonly)","format":"float","type":"number","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods filter","x-nullable":true},"id":{"description":"Corporate customer special account ID","format":"uuid","type":"string","x-nullable":true},"info":{"description":"Information (optional)","type":"string","x-nullable":true},"month_limit":{"default":0,"description":"Month limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"month_limit_available":{"description":"Month available amount, null if unlimited  (readonly)","format":"float","type":"number","x-nullable":true},"month_limit_used":{"description":"Month used amount (readonly)","format":"float","type":"number","x-nullable":true},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"List of POS where account is applicable","x-nullable":true},"special_account_active":{"description":"Business special account active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"special_account_id":{"description":"Special account ID","format":"uuid","type":"string"},"special_account_title":{"description":"Business special account title (readonly)","type":"string","x-nullable":true},"special_account_type":{"$ref":"#/definitions/SpecialAccountType","description":"Business special account type","x-nullable":true}},"type":"object"},"CorporateCustomerSpecialAccountCustomerAccess":{"properties":{"available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"corporate_customer_special_account_id":{"description":"Corporate customer special account ID","format":"uuid","type":"string"},"created":{"description":"Created datetime","format":"date-time","type":"string","x-nullable":true},"day_limit":{"default":0,"description":"Day limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"day_limit_available":{"description":"Day available amount, null if unlimited (readonly)","format":"float","type":"number","x-nullable":true},"day_limit_used":{"description":"Day used amount (readonly)","format":"float","type":"number","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods filter","x-nullable":true},"id":{"description":"Customer's access to corporate customer special account ID","format":"uuid","type":"string","x-nullable":true},"month_limit":{"default":0,"description":"Month limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"month_limit_available":{"description":"Month available amount, null if unlimited  (readonly)","format":"float","type":"number","x-nullable":true},"month_limit_used":{"description":"Month used amount (readonly)","format":"float","type":"number","x-nullable":true},"odometer":{"$ref":"#/definitions/DataRequiredType","default":"no","description":"Odometer value needed flag","x-nullable":true},"overall_limit":{"description":"Customer account overall limit (if 0 - unlimited) (optional)","format":"float","type":"number","x-nullable":true},"overall_limit_available":{"description":"Customer account overall available amount, not for unlimited account (null if unlimited) (optional) (readonly)","format":"float","type":"number","x-nullable":true},"overall_limit_used":{"description":"Customer account overall used amount (optional)","format":"float","type":"number","x-nullable":true},"security_code":{"description":"Additional PIN-code (max 8 chars) for access to the account","type":"string","x-nullable":true},"special_account_id":{"description":"Special account ID","type":"string","x-nullable":true},"special_account_title":{"description":"Business special account title","type":"string","x-nullable":true},"user_email":{"description":"User Email","type":"string","x-nullable":true},"user_external_id":{"description":"User external id","type":"string","x-nullable":true},"user_id":{"description":"User ID","format":"uuid","type":"string"},"user_name":{"description":"User Name","type":"string","x-nullable":true},"user_phone":{"description":"User phone numberf","type":"string","x-nullable":true},"vehicle_id":{"$ref":"#/definitions/DataRequiredType","default":"no","description":"Vehicle ID needed flag","x-nullable":true}},"type":"object"},"CorporateCustomerSpecialAccountsList":{"items":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"},"type":"array"},"CorporateSpecialAccountOperationObject":{"properties":{"amount":{"description":"Refill amount","format":"float","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value (optional)","type":"integer","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (optional)","type":"integer","x-nullable":true},"check_services":{"$ref":"#/definitions/CheckServices","description":"Services added on check (optional)","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"overdraft_allowed":{"default":false,"description":"Allow overdraft if platform params does not restrict (fro special account write-offs only)","type":"boolean","x-nullable":false},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value (optional)","type":"integer","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountOperationType","description":"Transactions type (optional, in case if transaction type not specified by endpoint)","x-nullable":true}},"required":["amount"],"type":"object"},"CorporateStaffPosition":{"properties":{"id":{"description":"Position ID","format":"uuid","type":"string"},"public_description":{"description":"Position public description","type":"string","x-nullable":true},"public_title":{"description":"Position public title","type":"string","x-nullable":true},"title":{"description":"Position title","type":"string"}},"type":"object"},"CorporateVehicleInfo":{"properties":{"avi_id":{"description":"Vehicle/Inventory AVI (automatic vehicle identification) Id (optional)","type":"string","x-nullable":true},"description":{"description":"Description","type":"string","x-nullable":true},"id":{"description":"Vehicle/Inventory unique Id","format":"uuid","type":"string","x-nullable":true},"position":{"$ref":"#/definitions/CorporateStaffPosition","description":"Position info (readonly)","x-nullable":true},"position_id":{"description":"Position ID","format":"uuid","type":"string","x-nullable":true},"qr_code":{"description":"Qr Code / Tag","type":"string","x-nullable":true},"vehicle_id":{"description":"Vehicle/Inventory Id","type":"string","x-nullable":true}},"type":"object"},"Coupon":{"properties":{"batch":{"$ref":"#/definitions/CouponBatchEmbedded","description":"Batch info"},"batch_id":{"description":"Batch ID","format":"uuid","type":"string"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"cancel_dt":{"description":"Coupon cancelled datetime","format":"date-time","type":"string"},"code":{"description":"CODE","type":"string"},"customer":{"$ref":"#/definitions/CouponCustomer","description":"Customer who owns coupon"},"deleted_by_customer":{"description":"Coupon deleted by customer flag","enum":[0,1],"type":"integer"},"deleted_by_customer_dt":{"description":"Coupon deleted by customer datetime","format":"date-time","type":"string"},"description":{"description":"Coupon Description","type":"string","x-nullable":true},"emission_dt":{"description":"Coupon emission datetime","format":"date-time","type":"string"},"emission_transaction":{"$ref":"#/definitions/CouponEmissionTransaction","description":"Emission transaction info"},"emission_transaction_id":{"description":"Transaction ID in the result of which has been emitted a coupon","format":"uuid","type":"string"},"emitter_batch":{"$ref":"#/definitions/CouponEmmiterBatch","description":"Emmiter batch info (optional)"},"expire_date":{"description":"Coupon expire date","format":"date","type":"string"},"gift_card":{"$ref":"#/definitions/GiftCard","description":"Gift card info"},"id":{"description":"Coupon ID","format":"uuid","type":"string"},"locked":{"description":"Coupon locked by transaction process (optional)","type":"boolean","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"redeem_dt":{"description":"Coupon redeemed datetime","format":"date-time","type":"string"},"redeem_transaction":{"$ref":"#/definitions/CouponRedeemTransaction","description":"Redeem transaction info"},"redeem_transaction_id":{"description":"Transaction ID in the result of which has been redeemed a coupon","format":"uuid","type":"string"},"share":{"$ref":"#/definitions/CouponShare","description":"Coupon share info"},"status":{"$ref":"#/definitions/CouponStatus","description":"Coupon status","x-nullable":true},"taken_by_customer_dt":{"description":"Coupon taken by customer datetime","format":"date-time","type":"string"},"title":{"description":"Batch title","type":"string"}},"type":"object"},"CouponBatch":{"properties":{"active":{"description":"Batch active flag","enum":[0,1],"type":"integer","x-nullable":true},"anonymous_owned_data_access_allowed":{"description":"Allow anonymous user access to private data of user owned coupons","enum":[0,1],"type":"integer","x-nullable":true},"auto_generated_external_codes":{"description":"Auto generate CODE (optional)","enum":[0,1],"type":"integer","x-nullable":true},"base_batch_code":{"description":"Base Batch CODE (optional)","type":"string","x-nullable":true},"base_batch_id":{"description":"Base Batch Id (optional)","format":"uuid","type":"string","x-nullable":true},"bonuses_currency":{"description":"currency (optional)","type":"string","x-nullable":true},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"charge_amount":{"description":"Coupon certificate type refill amount (optional)","format":"double","type":"number","x-nullable":true},"charge_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Coupon certificate type refill object (optional)","x-nullable":true},"code":{"description":"Batch CODE","type":"string","x-nullable":true},"coupon_expire_date":{"description":"Value of coupon expire date","format":"date","type":"string","x-nullable":true},"coupon_expire_type":{"description":"Coupon expiration value type","enum":["none","date","day","month"],"type":"string","x-nullable":true},"coupon_expire_value":{"description":"Value of coupon expire","type":"integer","x-nullable":true},"created":{"description":"Batch created datetime","format":"date-time","type":"string"},"customers_price_amount":{"description":"Coupon emission price (optional)","format":"double","type":"number","x-nullable":true},"customers_price_currency":{"description":"Coupon emission price currency (optional)","type":"string","x-nullable":true},"customers_price_special_account_id":{"description":"Coupon emission price special account Id (optional)","format":"uuid","type":"string","x-nullable":true},"customers_price_special_account_title":{"description":"Coupon emission price special account title (readonly, optional)","type":"string","x-nullable":true},"customers_price_type":{"$ref":"#/definitions/BenefitsPriceType","description":"Coupon emission price type (optional)","x-nullable":true},"emission_per_customer_limit":{"description":"Batch emission coupon limit quantity per user (zero if no limits)","type":"integer","x-nullable":true},"emission_period_begin":{"description":"Batch emission period begin date","format":"date","type":"string","x-nullable":true},"emission_period_end":{"description":"Batch emission period end date","format":"date","type":"string","x-nullable":true},"emission_quantity_limit":{"description":"Batch emission coupon limit quantity (zero if no limits)","format":"int64","type":"integer","x-nullable":true},"emitted_coupons_quantity":{"description":"Batch emitted coupon quantity (readonly)","format":"int64","type":"integer","x-nullable":true},"exchange_coupon_redeem_fee":{"description":"Exchange of coupons, customer redeem coupon fee amount (optional)","format":"double","type":"number","x-nullable":true},"external_code":{"description":"Batch external code (maximum 256 chars) (optional)","type":"string","x-nullable":true},"external_code_visibility_type":{"$ref":"#/definitions/CouponExternalCodeVisibilityType","description":"External code visibility type (optional)","x-nullable":true},"external_codes_list":{"description":"Batch external codes list (optional)","items":{"$ref":"#/definitions/CouponBatchExtCode"},"type":"array","x-nullable":true},"id":{"description":"Batch ID","format":"uuid","type":"string","x-nullable":true},"image":{"description":"URL of batch image","type":"string","x-nullable":true},"links":{"$ref":"#/definitions/CouponBatchLinks","description":"Batch links list (optional, readonly)","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireTypeBase","description":"Promotional bonuses expiration value type (optional)","x-nullable":true},"promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire (optional)","type":"integer","x-nullable":true},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Batch public description (multilanguage)","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Batch public title (multilanguage)","x-nullable":true},"recommendation_fee_amount":{"description":"Recommendation fee amount (optional)","format":"double","type":"number","x-nullable":true},"recommendation_fee_bonuses_currency":{"description":"Recommendation fee bonuses currence ISO code (optional)","type":"string","x-nullable":true},"recommendation_fee_coupon_batch_code":{"description":"Recommendation fee Batch CODE (optional)","type":"string","x-nullable":true},"recommendation_fee_coupon_batch_id":{"description":"Recommendation fee Batch Id (readonly, optional)","format":"uuid","type":"string","x-nullable":true},"recommendation_fee_coupon_batch_title":{"description":"Recommendation fee Batch TITLE (readonly, optional)","type":"string","x-nullable":true},"recommendation_fee_promotional_bonuses_expire_date":{"description":"Value of recommendation fee promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"recommendation_fee_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireTypeBase","description":"Recommendation fee expiration value type (optional)","x-nullable":true},"recommendation_fee_promotional_bonuses_expire_value":{"description":"Value of recommendation fee promotional bonuses expire (optional)","type":"integer","x-nullable":true},"recommendation_fee_special_account_id":{"description":"Special account ID (optional)","format":"uuid","type":"string","x-nullable":true},"recommendation_fee_special_account_title":{"description":"Recommendation fee special account title (readonly, optional)","type":"string","x-nullable":true},"recommendation_fee_type":{"$ref":"#/definitions/BenefitsChargeTypeExtended","description":"Recommendation fee type","x-nullable":true},"redeem_at_terminal":{"description":"Redeem only at terminal restriction (frontend only)","enum":[0,1],"type":"integer","x-nullable":true},"rule_id":{"description":"Loyalty rule ID (optional) - DEPRECATED","format":"uuid","type":"string","x-nullable":true},"rules":{"description":"Loyalty rules (optional, 'check-modifier' type only)","items":{"$ref":"#/definitions/LoyaltyRule"},"type":"array","x-nullable":true},"share_allowed":{"description":"Coupons share allowed for customer","enum":[0,1],"type":"integer","x-nullable":true},"special_account_id":{"description":"Special account ID (optional)","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Batch title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/CouponTypeExtended","description":"Coupon type","x-nullable":true},"use_one_external_code":{"description":"Always use ONE CODE (optional)","enum":[0,1],"type":"integer","x-nullable":true},"use_unique_coupon_code":{"description":"Is coupon in this batch use own unique CODE","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"CouponBatchAlias":{"properties":{"active":{"description":"Alias active flag","enum":[0,1],"type":"integer","x-nullable":true},"batch_id":{"description":"Batch ID (optional)","format":"uuid","type":"string","x-nullable":true},"code":{"description":"Alias CODE","type":"string","x-nullable":true},"created":{"description":"Alias created datetime (optional)","format":"date-time","type":"string","x-nullable":true},"emission_per_customer_limit":{"description":"Alias emission coupon limit quantity per user (zero if no limits) (optional)","type":"integer","x-nullable":true},"emission_quantity_limit":{"description":"Alias emission coupon limit quantity (zero if no limits) (optional)","format":"int64","type":"integer","x-nullable":true},"emitted_coupons_quantity":{"description":"Alias emitted coupon quantity (readonly) (optional)","format":"int64","type":"integer","x-nullable":true},"expire_date":{"description":"Value of coupon expire date (optional)","format":"date","type":"string","x-nullable":true},"expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Coupon expiration value type (optional)","x-nullable":true},"expire_value":{"description":"Value of coupon expire (optional)","type":"integer","x-nullable":true},"id":{"description":"Alias ID (optional)","format":"uuid","type":"string","x-nullable":true},"user_email":{"format":"Customer user email (optional)","type":"string"},"user_external_id":{"format":"Customer user external id (if platform support) (optional)","type":"string"},"user_id":{"description":"User ID (optional)","format":"uuid","type":"string","x-nullable":true},"user_name":{"description":"User Name (optional)","format":"uuid","type":"string","x-nullable":true},"user_phone":{"format":"Customer user phone (optional)","type":"string"}},"type":"object"},"CouponBatchAliases":{"items":{"$ref":"#/definitions/CouponBatchAlias"},"type":"array"},"CouponBatchAliasesCreateData":{"properties":{"alias":{"$ref":"#/definitions/CouponBatchAlias","description":"Alias creation template"},"count":{"description":"Number of aliases to be created","type":"integer"},"users":{"$ref":"#/definitions/ObjectIds","description":"Customer/User IDs to which aliases will be assigned (optional)"}},"type":"object"},"CouponBatchAliasesListRequestData":{"properties":{"batch_id":{"description":"Batch ID","format":"uuid","type":"string","x-nullable":true},"code":{"description":"Alias code (matching)","type":"string","x-nullable":true},"count":{"default":20,"description":"Count in page (optional)","type":"integer"},"created_from":{"description":"Alias created date and time filter from in RFC3339","format":"date-time","type":"string","x-nullable":true},"created_to":{"description":"Alias created date and time filter from in RFC3339","format":"date-time","type":"string","x-nullable":true},"customer_id_type":{"$ref":"#/definitions/IdType","description":"Type of customer user identifier","x-nullable":true},"customer_id_value":{"description":"Customer user identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"minimal_info":{"description":"return minimal information about aliases","type":"boolean"},"only_active":{"description":"Return only active aliases (matching)","type":"boolean","x-nullable":true},"page":{"default":1,"description":"List page number (optional)","type":"integer"},"sort_field":{"default":"code","description":"Sort field (optional)","enum":["code","created","batch_id","batch_code","batch_title"],"type":"string"},"sort_order":{"$ref":"#/definitions/SortDirection","default":"asc","description":"Sort order (optional)"}},"type":"object"},"CouponBatchAliasesModifyData":{"properties":{"alias":{"$ref":"#/definitions/CouponBatchAlias","description":"Alias modification template"}},"type":"object"},"CouponBatchAliasesPaginated":{"properties":{"data":{"$ref":"#/definitions/CouponBatchAliases"},"summary":{"$ref":"#/definitions/CouponBatchAliasesSummary"}},"type":"object"},"CouponBatchAliasesSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"CouponBatchEmbedded":{"properties":{"active":{"description":"Coupons active flag","enum":[0,1],"type":"integer","x-nullable":true},"alias":{"$ref":"#/definitions/CouponBatchAlias","description":"Batch alias (optional, readonly)","x-nullable":true},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"code":{"description":"Coupon batch code","type":"string","x-nullable":true},"id":{"description":"Batch ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"public_description":{"description":"Batch public description (optional)","type":"string"},"public_title":{"description":"Batch public title (optional)","type":"string"},"title":{"description":"Batch title","type":"string"},"type":{"$ref":"#/definitions/CouponType","description":"Type of coupon","x-nullable":true}},"type":"object"},"CouponBatchExtCode":{"properties":{"code":{"description":"external code","type":"string"},"used":{"description":"Code already used","enum":[0,1],"type":"integer"}},"type":"object"},"CouponBatchExtCodeOperationResult":{"description":"Operation result summary","properties":{"processed":{"description":"Processed codes count","type":"integer"},"skipped":{"description":"Skipped codes count","type":"integer"},"unique":{"description":"Unique codes count","type":"integer"}},"type":"object"},"CouponBatchExtCodeResult":{"properties":{"operation_result":{"$ref":"#/definitions/CouponBatchExtCodeOperationResult"}},"type":"object"},"CouponBatchLink":{"properties":{"app_code":{"description":"White Label application Code (optional)","type":"string","x-nullable":true},"app_id":{"description":"White Label application Id (optional)","format":"uuid","type":"string","x-nullable":true},"app_title":{"description":"White Label application Title (optional)","type":"string","x-nullable":true},"coupon_path_qr":{"description":"Link path for QR","type":"string","x-nullable":true},"coupon_path_share":{"description":"Link path for share","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/CouponBatchLinkType","description":"Link type","x-nullable":true}},"type":"object"},"CouponBatchLinkType":{"enum":["base","white-label-app"],"type":"string"},"CouponBatchLinks":{"items":{"$ref":"#/definitions/CouponBatchLink"},"type":"array"},"CouponBatchesList":{"items":{"$ref":"#/definitions/CouponBatch"},"type":"array"},"CouponBatchesPaginatedList":{"properties":{"data":{"$ref":"#/definitions/CouponBatchesList"},"summary":{"$ref":"#/definitions/CouponBatchesSummary"}},"type":"object"},"CouponBatchesSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"CouponCustomer":{"properties":{"email":{"description":"User email","type":"string"},"external_id":{"description":"User external id","type":"string"},"id":{"description":"User ID","format":"uuid","type":"string"},"name":{"description":"User name","type":"string"},"phone":{"description":"User phone","type":"string"}},"type":"object"},"CouponEmissionTransaction":{"properties":{"id":{"description":"Transaction ID","format":"uuid","type":"string"},"pos_id":{"description":"POS ID","format":"uuid","type":"string"},"pos_public_title":{"description":"POS public title","type":"string"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"terminal_title":{"description":"Terminal title","type":"string"}},"type":"object"},"CouponEmmiterBatch":{"properties":{"business_id":{"description":"Business ID","format":"uuid","type":"string"},"id":{"description":"Batch ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_public_title":{"description":"Loyalty public title","type":"string"},"public_title":{"description":"Batch public title","type":"string"}},"type":"object"},"CouponExternalCodeVisibilityType":{"enum":["always-open","on-redeem"],"type":"string"},"CouponProcessingStatus":{"enum":["pending","processed","error"],"type":"string"},"CouponRedeemTransaction":{"properties":{"id":{"description":"Transaction ID","format":"uuid","type":"string"},"pos_id":{"description":"POS ID","format":"uuid","type":"string"},"pos_public_title":{"description":"POS public title","type":"string"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"terminal_title":{"description":"Terminal title","type":"string"}},"type":"object"},"CouponShare":{"properties":{"coupon_code":{"description":"Coupon CODE","type":"string"},"coupon_id":{"description":"Coupon ID","format":"uuid","type":"string"},"id":{"description":"Share ID","format":"uuid","type":"string"},"user_id":{"description":"User ID","format":"uuid","type":"string"},"user_name":{"description":"User name","type":"string"},"user_phone":{"description":"User phone","type":"string"}},"type":"object"},"CouponStatus":{"enum":["open","redeemed","cancelled"],"type":"string"},"CouponType":{"enum":["check-modifier","certificate","external"],"type":"string"},"CouponTypeExtended":{"enum":["check-modifier","certificate","external","cross-business"],"type":"string"},"CouponsListRequestData":{"properties":{"alias_code":{"description":"Batch alias code (matching)","type":"string","x-nullable":true},"batch_id":{"description":"Batch ID","format":"uuid","type":"string","x-nullable":true},"count":{"default":20,"description":"Count in page (optional)","type":"integer"},"coupon_added_to_wallet":{"description":"Filter by coupon added to the customer's wallet state","enum":["all","yes","no"],"type":"string","x-nullable":true},"coupon_code":{"description":"Coupon code (matching)","type":"string","x-nullable":true},"coupon_deleted":{"description":"Filter by deleted by customers state","enum":["all","yes","no"],"type":"string","x-nullable":true},"coupon_emission_dt_from":{"description":"Coupon emit from date and time filter from in RFC3339","format":"date-time","type":"string","x-nullable":true},"coupon_emission_dt_to":{"description":"Coupon emit to date and time to from in RFC3339","format":"date-time","type":"string","x-nullable":true},"coupon_expired":{"description":"Filter by coupon expired state","enum":["all","yes","no"],"type":"string","x-nullable":true},"coupon_redeem_dt_from":{"description":"Coupon redeem from date and time filter from in RFC3339","format":"date-time","type":"string","x-nullable":true},"coupon_redeem_dt_to":{"description":"Coupon redeem to date and time to from in RFC3339","format":"date-time","type":"string","x-nullable":true},"coupon_status":{"description":"Filter by coupon status","enum":["all","open","redeemed","cancelled"],"type":"string","x-nullable":true},"coupon_taken_by_customer_dt_from":{"description":"Coupon taken by customer (added to wallet) from date and time filter from in RFC3339","format":"date-time","type":"string","x-nullable":true},"coupon_taken_by_customer_dt_to":{"description":"Coupon taken by customer (added to wallet) to date and time to from in RFC3339","format":"date-time","type":"string","x-nullable":true},"customer_email":{"description":"Customer user email if need (search by contains)","type":"string","x-nullable":true},"customer_external_id":{"description":"Customer user external id if need (search by contains)","type":"string","x-nullable":true},"customer_id_type":{"$ref":"#/definitions/IdType","description":"Type of customer user identifier","x-nullable":true},"customer_id_value":{"description":"Customer user identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","type":"string","x-nullable":true},"customer_phone":{"description":"Customer user phone if need (search by contains)","type":"string","x-nullable":true},"emitter_batch_id":{"description":"Batch ID, which emitted coupons","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"page":{"default":1,"description":"List page number (optional)","type":"integer"},"sort_field":{"description":"Sort field (optional)","enum":["code","emission_dt","cancel_dt","redeem_dt","taken_by_customer_dt","deleted_by_customer_dt","expire_date","user_id","deleted_by_customer","status"],"type":"string"},"sort_order":{"$ref":"#/definitions/SortDirection","description":"Sort order (optional)"}},"type":"object"},"CouponsSendOperationObject":{"properties":{"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (optional)","type":"integer","x-nullable":true},"comment":{"description":"Message text (if empty or null send standard text from brand templates)","type":"string","x-nullable":true},"emit_new_coupons":{"description":"Emit new coupons end send it","type":"boolean","x-nullable":true},"skip_message":{"default":false,"description":"Skip sending notification message","type":"boolean"},"users":{"$ref":"#/definitions/ObjectIds"}},"required":["users"],"type":"object"},"Currencies":{"items":{"description":"Currency ISO code","type":"string"},"type":"array"},"CustomPreferencesParameter":{"properties":{"name":{"description":"Preferences parameter name","type":"string"},"value":{"description":"Preferences parameter value","type":"object","x-nullable":true}},"type":"object"},"CustomPreferencesParameterRequest":{"properties":{"name":{"description":"Preferences parameter name","type":"string"}},"required":["name"],"type":"object"},"CustomerAccessAssign":{"properties":{"access_type":{"$ref":"#/definitions/CustomerAccessType","description":"New access type value"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"users":{"$ref":"#/definitions/ObjectIds","description":"List of User Id"}},"required":["loyalty_id","access_type"],"type":"object"},"CustomerAccessType":{"enum":["full-bonuses-access","add-bonuses-only","waiting-for-confirmation","in-black-list"],"type":"string"},"CustomerAdditionalCards":{"items":{"description":"Card number","type":"string"},"type":"array"},"CustomerBonusesAccount":{"properties":{"bonuses_added":{"description":"Total bonuses added on account (optional)","format":"float","type":"number","x-nullable":true},"bonuses_amount":{"description":"Total activated bonuses amount on account (ready for use)","format":"float","type":"number","x-nullable":true},"bonuses_redeemed":{"description":"Total bonuses redeemed from account (optional)","format":"float","type":"number","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"currency_name":{"description":"Currensy name","type":"string","x-nullable":true},"deferred_bonuses_amount":{"description":"Total not activated yet bonuses amount on account (optional)","format":"float","type":"number","x-nullable":true},"deferred_permanent_bonuses_amount":{"description":"Amount of not activated yet permanent bonuses on account (optional)","format":"float","type":"number","x-nullable":true},"deferred_promotion_bonuses_amount":{"description":"Amount of not activated yet promotional bonuses on account (optional)","format":"float","type":"number","x-nullable":true},"deferred_temporary_bonuses_amount":{"description":"Alias of deferred_promotion_bonuses_amount","format":"float","type":"number","x-nullable":true},"permanent_bonuses_added":{"description":"Permanent bonuses added on account (optional)","format":"float","type":"number","x-nullable":true},"permanent_bonuses_amount":{"description":"Amount of activated permanent bonuses on account (ready for use)","format":"float","type":"number","x-nullable":true},"permanent_bonuses_detailing":{"description":"Detailing of available permanent bonus points (optional)","items":{"$ref":"#/definitions/CustomerBonusesAccountActivity"},"type":"array"},"permanent_bonuses_redeemed":{"description":"Permanent bonuses redeemed from account (optional)","format":"float","type":"number","x-nullable":true},"promotion_bonuses_added":{"description":"Promotional bonuses added on account (optional)","format":"float","type":"number","x-nullable":true},"promotion_bonuses_amount":{"description":"Amount of activated promotional bonuses on account (ready for use)","format":"float","type":"number","x-nullable":true},"promotion_bonuses_detailing":{"description":"Detailing of available promotional bonus points (optional)","items":{"$ref":"#/definitions/CustomerBonusesAccountActivity"},"type":"array"},"promotion_bonuses_redeemed":{"description":"Promotional bonuses redeemed from account (optional)","format":"float","type":"number","x-nullable":true},"temporary_bonuses_amount":{"description":"Alias of promotion_bonuses_amount","format":"float","type":"number","x-nullable":true}},"type":"object"},"CustomerBonusesAccountActivity":{"properties":{"activated":{"description":"Bonuses are ready for use","type":"boolean","x-nullable":true},"available_amount":{"description":"Available bonus points amount","format":"float","type":"number","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"expired":{"description":"Date of bonuses expiration (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date-time","type":"string","x-nullable":true},"processed":{"description":"Bonus points added date and time","format":"date-time","type":"string","x-nullable":true},"starting":{"description":"Date of bonuses activation (date from which bonuses are ready for use) (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date-time","type":"string","x-nullable":true},"transaction_id":{"description":"Unique Id of the transaction that added bonuses","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"CustomerBonusesAccounts":{"description":"Bonuses by currency ISO code list","items":{"$ref":"#/definitions/CustomerBonusesAccount"},"type":"array"},"CustomerBonusesOperationObject":{"properties":{"amount":{"description":"Amount transaction","format":"float","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value (optional)","type":"integer","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (optional)","type":"integer","x-nullable":true},"comment":{"description":"Transaction comment (optional)","type":"string","x-nullable":true},"expire":{"description":"Date of expire (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (optional)","format":"uuid","type":"string","x-nullable":true},"message":{"description":"Transaction message template (optional)","type":"string","x-nullable":true},"skip_message":{"default":false,"description":"Skip notifications (optional)","type":"boolean","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value (optional)","type":"integer","x-nullable":true},"starting":{"description":"Date of activation (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"terminal_id":{"description":"Terminal Id (optional)","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/BonusAccountOperationType","description":"Transactions type (optional, in case if transaction type not specified by endpoint)","x-nullable":true}},"required":["amount"],"type":"object"},"CustomerCategoryAccountPriceOption":{"properties":{"active":{"description":"Overall active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"base_value_type":{"$ref":"#/definitions/PriceOptionBaseValueType","default":"posted-price","description":"Option base value type","x-nullable":true},"category_id":{"description":"Customer category ID","format":"uuid","type":"string","x-nullable":true},"item_active":{"description":"Goods item active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"item_category_id":{"description":"Goods item category ID (readonly)","format":"uuid","type":"string","x-nullable":true},"item_category_title":{"description":"Goods item category title (readonly)","type":"string","x-nullable":true},"item_code":{"description":"Goods item code (readonly)","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string","x-nullable":true},"item_title":{"description":"Goods item title (readonly)","type":"string","x-nullable":true},"loyalty_active":{"description":"Loyalty active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (readonly)","format":"uuid","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title (readonly)","type":"string","x-nullable":true},"special_account_id":{"description":"Special account ID","format":"uuid","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/PriceOptionType","default":"discount","description":"Option type","x-nullable":true},"value":{"description":"Option value (optional, if value_depends_type is 'none')","format":"float","type":"number","x-nullable":true},"value_depends_by_goods":{"$ref":"#/definitions/PriceOptionDependsByGoods","default":"all","description":"Option value depends on value calculation goods (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_calc_period":{"$ref":"#/definitions/PriceOptionDependsCalcPeriod","default":"all","description":"Option value depends on value calculation period (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_matrix":{"$ref":"#/definitions/ThresholdsValues","description":"Option value depends on value matrix (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_type":{"$ref":"#/definitions/PriceOptionDependsType","default":"none","description":"Option value depends on","x-nullable":true},"value_type":{"$ref":"#/definitions/PriceOptionValueType","default":"amount","description":"Option value type","x-nullable":true}},"type":"object"},"CustomerCategoryAccountPriceOptionList":{"items":{"$ref":"#/definitions/CustomerCategoryAccountPriceOption","description":"Goods item price option object"},"type":"array"},"CustomerCategoryAssign":{"properties":{"category_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"users":{"$ref":"#/definitions/ObjectIds","description":"List of User Id"}},"required":["loyalty_id","category_id"],"type":"object"},"CustomerCategoryCurrencyPriceOption":{"properties":{"active":{"description":"Overall active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"base_value_type":{"$ref":"#/definitions/PriceOptionBaseValueType","default":"posted-price","description":"Option base value type","x-nullable":true},"category_id":{"description":"Customer category ID","format":"uuid","type":"string","x-nullable":true},"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"item_active":{"description":"Goods item active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"item_category_id":{"description":"Goods item category ID (readonly)","format":"uuid","type":"string","x-nullable":true},"item_category_title":{"description":"Goods item category title (readonly)","type":"string","x-nullable":true},"item_code":{"description":"Goods item code (readonly)","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string","x-nullable":true},"item_title":{"description":"Goods item title (readonly)","type":"string","x-nullable":true},"loyalty_active":{"description":"Loyalty active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (readonly)","format":"uuid","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title (readonly)","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/PriceOptionType","default":"discount","description":"Option type","x-nullable":true},"value":{"description":"Option value (optional, if value_depends_type is 'none')","format":"float","type":"number","x-nullable":true},"value_depends_by_goods":{"$ref":"#/definitions/PriceOptionDependsByGoods","default":"all","description":"Option value depends on value calculation goods (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_calc_period":{"$ref":"#/definitions/PriceOptionDependsCalcPeriod","default":"all","description":"Option value depends on value calculation period (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_matrix":{"$ref":"#/definitions/ThresholdsValues","description":"Option value depends on value matrix (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_type":{"$ref":"#/definitions/PriceOptionDependsType","default":"none","description":"Option value depends on","x-nullable":true},"value_type":{"$ref":"#/definitions/PriceOptionValueType","default":"amount","description":"Option value type","x-nullable":true}},"type":"object"},"CustomerCategoryCurrencyPriceOptionList":{"items":{"$ref":"#/definitions/CustomerCategoryCurrencyPriceOption","description":"Goods item price option object"},"type":"array"},"CustomerExtendedInfo":{"properties":{"bonuses":{"$ref":"#/definitions/CustomerBonusesAccounts","description":"List of available bonuses accounts","x-nullable":true},"external_forms_filled_exists":{"description":"Customer has filled external forms","type":"boolean","x-nullable":true},"specials":{"$ref":"#/definitions/CustomerSpecialAccounts","description":"List of available special accounts","x-nullable":true}},"type":"object"},"CustomerFeedback":{"properties":{"attached_files":{"description":"Feedback attached files","items":{"$ref":"#/definitions/CustomerFeedbackFile"},"type":"array"},"attached_files_exists":{"description":"Feedback contains attachments","type":"boolean"},"contact_info":{"description":"Contact info","type":"string"},"feedback_source_id":{"description":"Feedback source ID","format":"uuid","type":"string"},"feedback_source_tag":{"description":"Feedback source tag","type":"string"},"feedback_source_title":{"description":"Feedback source title","type":"string"},"id":{"description":"Feedback ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_title":{"description":"Loyalty title","type":"string"},"published":{"description":"Feedback published datetime","format":"date-time","type":"string"},"rating":{"description":"Rating value","enum":[1,2,3,4,5],"type":"integer"},"readed":{"description":"Feedback readed flag","enum":[0,1],"type":"integer"},"text":{"description":"Feedback text","type":"string"},"user_id":{"description":"User ID","format":"uuid","type":"string"}},"type":"object"},"CustomerFeedbackFile":{"properties":{"id":{"description":"File ID","format":"uuid","type":"string"},"mime_type":{"description":"File mime type","type":"string"},"type":{"description":"File type","enum":["picture","voice","video"],"type":"string"}},"type":"object"},"CustomerFeedbackPrintOnCheck":{"enum":["none","qr-code","url","all"],"type":"string"},"CustomerField":{"properties":{"description":{"description":"Some help for user","type":"string"},"dictionary_values":{"$ref":"#/definitions/StringValuesList","description":"Dictionary values"},"id":{"description":"Field id","type":"string"},"sort_order":{"description":"Sort order weight","type":"integer"},"type":{"description":"Field type","enum":["string","integer","money","date","dictionary"],"type":"string"},"value_field_name":{"description":"Field value key name","type":"string"}},"required":["type","description"],"type":"object"},"CustomerFieldsList":{"items":{"$ref":"#/definitions/CustomerField"},"type":"array"},"CustomerInfo":{"properties":{"access_type":{"$ref":"#/definitions/CustomerAccessType","description":"Access type","x-nullable":true},"average_cheque":{"description":"Sale transactions average check calculated by amount","format":"double","type":"number","x-nullable":true},"average_cheque_amount_to_pay":{"description":"Sale transactions average check calculated by amount to pay","format":"double","type":"number","x-nullable":true},"bonuses_added":{"description":"Transactions total bonus points added","format":"double","type":"number","x-nullable":true},"bonuses_on_hand":{"description":"Bonus points accounts balance","format":"double","type":"number","x-nullable":true},"bonuses_redeemed":{"description":"Transactions total bonus points redeemed","format":"double","type":"number","x-nullable":true},"business_id":{"description":"Unique identifier of business","format":"uuid","type":"string"},"card_category_id":{"description":"Card category ID","format":"uuid","type":"string","x-nullable":true},"card_category_title":{"description":"Card category Title (readonly)","type":"string","x-nullable":true},"card_category_type":{"description":"Card category Type (readonly)","enum":["base","custom"],"type":"string","x-nullable":true},"consent":{"description":"Customer user consent description","type":"string","x-nullable":true},"consent_exist":{"description":"Customer user consent exists flag (readonly)","type":"boolean","x-nullable":true},"customer_additional_cards":{"$ref":"#/definitions/CustomerAdditionalCards","description":"List of customers additional cards","x-nullable":true},"customer_info":{"$ref":"#/definitions/CustomerExtendedInfo","description":"Customer extended info"},"discount_amount":{"description":"Transactions total discount amount","format":"double","type":"number","x-nullable":true},"first_sale_transaction_date":{"description":"First sale transaction date","format":"date","type":"string","x-nullable":true},"first_sale_transaction_days_from":{"description":"Days from first sale transaction","type":"integer","x-nullable":true},"first_sale_transaction_dt":{"description":"First sale transaction date and time","format":"date-time","type":"string","x-nullable":true},"first_transaction_date":{"description":"First transaction date","format":"date","type":"string","x-nullable":true},"first_transaction_days_from":{"description":"Days from first transaction","type":"integer","x-nullable":true},"first_transaction_dt":{"description":"First transaction date and time","format":"date-time","type":"string","x-nullable":true},"id":{"description":"Customer ID","format":"uuid","type":"string","x-nullable":true},"last_sale_transaction_date":{"description":"Last sale transaction date","format":"date","type":"string","x-nullable":true},"last_sale_transaction_days_from":{"description":"Days from first sale transaction","type":"integer","x-nullable":true},"last_sale_transaction_dt":{"description":"Last sale transaction date and time","format":"date-time","type":"string","x-nullable":true},"last_transaction_date":{"description":"Last transaction date","format":"date","type":"string","x-nullable":true},"last_transaction_days_from":{"description":"Days from first transaction","type":"integer","x-nullable":true},"last_transaction_dt":{"description":"Last transaction date and time","format":"date-time","type":"string","x-nullable":true},"loyalty_id":{"description":"Unique identifier of loyalty","format":"uuid","type":"string"},"readonly":{"description":"Indicating if this object could modify system data (optional, for embedded objects only)","type":"boolean","x-nullable":true},"sale_amount":{"description":"Sale transactions total amount","format":"double","type":"number","x-nullable":true},"sale_amount_to_pay":{"description":"Sale transactions total amount to pay","format":"double","type":"number","x-nullable":true},"sale_count":{"description":"Sale transactions total numder","type":"integer","x-nullable":true},"transactions_amount":{"description":"Transactions total amount","format":"double","type":"number","x-nullable":true},"transactions_amount_to_pay":{"description":"Transactions total amount to pay","format":"double","type":"number","x-nullable":true},"transactions_count":{"description":"Transactions total numder","type":"integer","x-nullable":true},"transactions_discount_amount":{"description":"Alias of discount_amount - DEPRECATED","format":"double","type":"number","x-nullable":true},"user_birth_date":{"description":"Customer user birthdate","type":"string","x-nullable":true},"user_birth_date_change_allowed":{"description":"Customer user birthdate changing allowed (readonly)","type":"boolean","x-nullable":true},"user_birth_date_day":{"description":"Customer user birthdate day part","type":"integer","x-nullable":true},"user_birth_date_month":{"description":"Customer user birthdate month part","type":"integer","x-nullable":true},"user_birth_date_year":{"description":"Customer user birthdate year part","type":"integer","x-nullable":true},"user_country":{"description":"Customer user country ISO code","type":"string","x-nullable":true},"user_email":{"description":"Customer user primary email (for access to account / login)","type":"string","x-nullable":true},"user_external_id":{"description":"Customer user external id (if platform support)","type":"string","x-nullable":true},"user_gender":{"$ref":"#/definitions/UserGender","description":"Customer user gender","x-nullable":true},"user_gender_change_allowed":{"description":"Customer user gender changing allowed (readonly)","type":"boolean","x-nullable":true},"user_id":{"description":"Customer user ID","format":"uuid","type":"string","x-nullable":true},"user_language":{"description":"Customer user language ISO code","type":"string","x-nullable":true},"user_marketing_email":{"description":"Customer marketing emails allowed","enum":[0,1],"type":"integer","x-nullable":true},"user_marketing_sms":{"description":"Customer marketing SMS allowed","enum":[0,1],"type":"integer","x-nullable":true},"user_mobile_client_in_use":{"description":"Customer user has mobileapp tokens (use mobileapp)","enum":[0,1],"type":"integer","x-nullable":true},"user_name":{"description":"Public Customer user Name","type":"string","x-nullable":true},"user_name_change_allowed":{"description":"Public Customer user Name changing allowed (readonly)","type":"boolean","x-nullable":true},"user_phone":{"description":"Customer user phone number","type":"string","x-nullable":true},"user_pkpass_in_use":{"description":"Customer user has pkpass device tokens (use pkpass in wallet)","enum":[0,1],"type":"integer","x-nullable":true},"user_status":{"$ref":"#/definitions/UserStatus","description":"Customer user status","x-nullable":true}},"type":"object"},"CustomerPaymentSystemType":{"enum":["ipay","stripe","amp","4bill","eway","flutterwave","global-payments","wave","pax"],"type":"string"},"CustomerPrice":{"properties":{"account_id":{"description":"Alias for special_account_id - DEPRECATED","format":"uuid","type":"string","x-nullable":true},"applicable":{"description":"Is the price applicable to the customer (readonly)","type":"boolean","x-nullable":true},"currency":{"description":"Currensy ISO code (optional)","type":"string","x-nullable":true},"customer_access_account":{"$ref":"#/definitions/PriceCustomerSpecialAccountAccess","description":"Customer special account access info (optional)","x-nullable":true},"customer_access_account_id":{"description":"Customer special account ID (optional)","format":"uuid","type":"string","x-nullable":true},"customer_account":{"$ref":"#/definitions/PriceCustomerSpecialAccount","description":"Customer special account info (optional)","x-nullable":true},"customer_account_id":{"description":"Customer special account ID (optional)","format":"uuid","type":"string","x-nullable":true},"id":{"description":"Object (special account, access or currency ISO code) ID","type":"string","x-nullable":true},"margins":{"$ref":"#/definitions/PriceMargins","description":"Price margins (optional)","x-nullable":true},"price":{"description":"Price value at which the product/service is sold (in common mapped to price_sale)","format":"float","type":"number","x-nullable":true},"price_base":{"description":"Base price from which the price is calculated","format":"float","type":"number","x-nullable":true},"price_customer":{"description":"Customer (calculated by modifiers) price (optional)","format":"float","type":"number","x-nullable":true},"price_decimal_digits":{"description":"Number of decimal digits in price value","type":"integer","x-nullable":true},"price_explain":{"$ref":"#/definitions/PriceExplain","description":"Price explain (optional)","x-nullable":true},"price_sale":{"description":"Sale (check, receipt) price (optional)","format":"float","type":"number","x-nullable":true},"special_account":{"$ref":"#/definitions/PriceSpecialAccount","description":"Special account info (optional)","x-nullable":true},"special_account_id":{"description":"Special account ID (optional)","format":"uuid","type":"string","x-nullable":true},"taxes":{"$ref":"#/definitions/PriceTaxes","description":"Price taxes (optional)","x-nullable":true},"type":{"$ref":"#/definitions/CustomerPriceType","description":"Object (special account or access) type","x-nullable":true}},"type":"object"},"CustomerPriceType":{"enum":["currency","retail-special-account","retail-special-account-access","corporate-special-account","corporate-special-account-access"],"type":"string"},"CustomerQuestionnaireFieldEmbedded":{"properties":{"description":{"description":"Field description","type":"string","x-nullable":true},"id":{"description":"Field id","type":"string"},"sort_order":{"description":"Sort order weight","type":"integer","x-nullable":true},"title":{"description":"Field title","type":"string","x-nullable":true},"type":{"description":"Field type","enum":["string","integer","money","date","dictionary"],"type":"string"},"value":{"description":"Field value (readonly)","x-nullable":true},"value_field_name":{"description":"Field value key name (readonly)","type":"string","x-nullable":true}},"type":"object"},"CustomerSpecialAccount":{"properties":{"amount":{"description":"Amount of funds on the account","format":"float","type":"number","x-nullable":true},"available_amount":{"description":"Amount of funds in the account available for using (null if unlimited)","format":"float","type":"number","x-nullable":true},"available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"balance":{"description":"Account balance","format":"float","type":"number","x-nullable":true},"created":{"description":"Created datetime","format":"date-time","type":"string","x-nullable":true},"credit_limit":{"description":"Credit limit (only for 'credit' accounts)","format":"float","type":"number","x-nullable":true},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type","x-nullable":true},"currency":{"description":"Currensy ISO code (optional)","type":"string","x-nullable":true},"currency_name":{"description":"Currensy name (optional)","type":"string","x-nullable":true},"customer":{"$ref":"#/definitions/CustomerInfo","description":"Customer Info (optional, for set by business special account case only, in case if user_id specified readonly)","x-nullable":true},"customer_special_account_id":{"description":"Alias of id (optional)","format":"uuid","type":"string","x-nullable":true},"day_limit":{"default":0,"description":"Day limit (if 0 - unlimited) (optional, only for extended accounts)","format":"float","type":"number","x-nullable":true},"day_limit_available":{"description":"Day available amount, null if unlimited  (readonly) (optional, only for extended accounts)","format":"float","type":"number","x-nullable":true},"day_limit_used":{"description":"Day used amount (readonly) (optional, only for extended accounts)","format":"float","type":"number","x-nullable":true},"extended":{"description":"Account extended flag","enum":[0,1],"type":"integer","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods filter (optional, only for extended accounts)","x-nullable":true},"id":{"description":"Customer special account id","format":"uuid","type":"string","x-nullable":true},"month_limit":{"default":0,"description":"Month limit (if 0 - unlimited) (optional, only for extended accounts)","format":"float","type":"number","x-nullable":true},"month_limit_available":{"description":"Month available amount, null if unlimited  (readonly) (optional, only for extended accounts)","format":"float","type":"number","x-nullable":true},"month_limit_used":{"description":"Month used amount (readonly) (optional, only for extended accounts)","format":"float","type":"number","x-nullable":true},"odometer":{"$ref":"#/definitions/DataRequiredType","default":"no","description":"Odometer value needed flag (optional, only for extended accounts)","x-nullable":true},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"List of POS where account is applicable (optional, only for extended accounts)","x-nullable":true},"redeem_amount":{"description":"Write-off from account amout (optional)","format":"float","type":"number","x-nullable":true},"refill_amount":{"description":"Total refill account amount (optional)","format":"float","type":"number","x-nullable":true},"security_code":{"description":"Additional PIN-code (max 8 chars) for access to the account (optional, only for extended accounts)","type":"string","x-nullable":true},"special_account_active":{"description":"Business special account active flag (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"special_account_id":{"description":"Business special account ID","format":"uuid","type":"string","x-nullable":true},"special_account_title":{"description":"Business special account title (readonly)","type":"string","x-nullable":true},"special_account_type":{"$ref":"#/definitions/SpecialAccountType","description":"Business special account type","x-nullable":true},"title":{"description":"Alias of special_account_title (optional)","type":"string","x-nullable":true},"transaction":{"$ref":"#/definitions/CustomerSpecialAccountOperationObject","description":"Operation on customer account (optional)","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Alias of special_account_type (optional)","x-nullable":true},"user_id":{"description":"User id (optional)","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"CustomerSpecialAccountOperationObject":{"properties":{"amount":{"description":"Refill amount","format":"float","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value (optional)","type":"integer","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (optional)","type":"integer","x-nullable":true},"check_services":{"$ref":"#/definitions/CheckServices","description":"Services added on check (optional)","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (optional)","format":"uuid","type":"string","x-nullable":true},"overdraft_allowed":{"default":false,"description":"Allow overdraft if platform params does not restrict (fro special account write-offs only)","type":"boolean","x-nullable":false},"skip_message":{"default":false,"description":"Skip notifications","type":"boolean","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value (optional)","type":"integer","x-nullable":true},"terminal_id":{"description":"Terminal Id (optional)","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountOperationType","description":"Transactions type (optional, in case if transaction type not specified by endpoint)","x-nullable":true}},"required":["amount"],"type":"object"},"CustomerSpecialAccounts":{"items":{"$ref":"#/definitions/CustomerSpecialAccount"},"type":"array"},"CustomerSpecialAccountsListPaginated":{"properties":{"data":{"$ref":"#/definitions/CustomerSpecialAccounts"},"summary":{"$ref":"#/definitions/CustomerSpecialAccountsSummary"}},"type":"object"},"CustomerSpecialAccountsSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"CustomersListPaginated":{"properties":{"data":{"items":{"$ref":"#/definitions/CustomerInfo"},"type":"array"},"summary":{"$ref":"#/definitions/CustomersListSummary"}},"type":"object"},"CustomersListRequestData":{"properties":{"conditions":{"description":"Expression","type":"string"},"count":{"description":"Users count in page (default 10)","type":"integer"},"loyalty_id":{"description":"Loyalty ID","type":"string"},"page":{"description":"List page number (default 1)","type":"integer"},"pos_id":{"description":"POS ID","type":"string","x-nullable":true},"sort":{"description":"Sort field name with direction","type":"string"}},"required":["loyalty_id"],"type":"object"},"CustomersListSummary":{"properties":{"total_rows_count":{"description":"Total customers count","type":"integer"}},"type":"object"},"DataRequiredType":{"enum":["no","yes","possible"],"type":"string"},"EmailRecord":{"description":"E-mail address record","properties":{"confirm":{"description":"Email address is confirmed","enum":[0,1],"type":"integer"},"id":{"description":"Email id (optional)","format":"uuid","type":"string"},"primary":{"description":"Email address is primary (used for access to account)","enum":[0,1],"type":"integer"},"value":{"description":"Email address","type":"string"}},"type":"object"},"EmailRecordsList":{"items":{"$ref":"#/definitions/EmailRecord"},"type":"array"},"EmailsList":{"items":{"description":"Email","type":"string"},"type":"array"},"EquipmentController":{"properties":{"active":{"description":"Controller active flag","enum":[0,1],"type":"integer","x-nullable":true},"communication_settings":{"$ref":"#/definitions/EquipmentControllerCommunicationSettings","description":"Controller connection settings","x-nullable":true},"connection_lost_notification_emails":{"description":"Connection lost notification recipients email list","items":{"description":"Recipient email","type":"string"},"type":"array","x-nullable":true},"connection_lost_notification_frequency":{"description":"Connection lost notification sending frequency in hour (if 0 - one time sending)","type":"integer","x-nullable":true},"id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"last_connection_success":{"description":"Controller success connection last date and time","format":"date-time","type":"string","x-nullable":true},"last_connection_try":{"description":"Controller connection try last date and time","format":"date-time","type":"string","x-nullable":true},"notify_if_connection_lost_more_then":{"description":"Notification sent if the connection fails more than the specified period in minutes (if 0 - not notify)","type":"integer","x-nullable":true},"status":{"$ref":"#/definitions/EquipmentControllerStatus","description":"Controller status (read only)","x-nullable":true},"terminal":{"$ref":"#/definitions/Terminal","description":"Controller linked Terminal (optional)","x-nullable":true},"terminal_id":{"description":"Controller linked Terminal ID","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Controller title","type":"string"},"type":{"$ref":"#/definitions/EquipmentControllerType","description":"Controller type","x-nullable":true}},"type":"object"},"EquipmentControllerCommunicationSettings":{"properties":{"remote_host":{"description":"Controller IP address or domain name","type":"string","x-nullable":true},"remote_port":{"description":"Controller Port number","format":"int16","type":"integer","x-nullable":true}},"type":"object"},"EquipmentControllerEquipment":{"properties":{"active":{"description":"Equipment active flag","enum":[0,1],"type":"integer","x-nullable":true},"available":{"description":"Equipment availability status (read only)","type":"boolean","x-nullable":true},"id":{"description":"Equipment ID","format":"uuid","type":"string","x-nullable":true},"input_number":{"description":"Controller input number, which equipment is connected if monitor_working_status turned on (from 0 to 99 for 'plc-modicon-m241' controller type) (optional)","type":"integer","x-nullable":true},"monitor_working_status":{"description":"Ability to monitor the working condition flag","enum":[0,1],"type":"integer","x-nullable":true},"output_number":{"description":"Controller output number, which equipment is connected (from 0 to 99 for 'plc-modicon-m241' controller type)","type":"integer","x-nullable":true},"title":{"description":"Equipment title","type":"string"},"type":{"$ref":"#/definitions/EquipmentType","description":"Equipment type","x-nullable":true}},"type":"object"},"EquipmentControllerEquipmentsList":{"items":{"$ref":"#/definitions/EquipmentControllerEquipment"},"type":"array"},"EquipmentControllerList":{"items":{"$ref":"#/definitions/EquipmentController"},"type":"array"},"EquipmentControllerStatus":{"enum":["created","connection-failed","available","unavailable"],"type":"string"},"EquipmentControllerType":{"enum":["plc-modicon-m241"],"type":"string"},"EquipmentType":{"enum":["car-wash"],"type":"string"},"EventStatus":{"properties":{"business_staff":{"$ref":"#/definitions/BusinessStaff","description":"Business Staff Info"},"id":{"description":"Event Id (readonly)","format":"uuid","type":"string","x-nullable":true},"processed":{"description":"Event UTC processed date-time","format":"date-time","type":"string","x-nullable":true},"remote_addr":{"description":"Remote address (remote IP)","type":"string","x-nullable":true},"status":{"$ref":"#/definitions/TerminalEventStatusCode","description":"Event Status","x-nullable":true}},"type":"object"},"EventStatusList":{"properties":{"data":{"description":"Event status items list","items":{"$ref":"#/definitions/EventStatus"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"},"EvsRequestData":{"properties":{"billing_amount":{"description":"Request cost for business","format":"float","type":"number"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"id":{"description":"Record ID","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"processed":{"description":"Processed time","format":"date-time","type":"string"},"src_type":{"enum":["system","business"],"type":"string"},"user_email":{"description":"User email","type":"string"},"user_external_id":{"description":"User external id (optional)","type":"string"},"user_id":{"description":"User ID","format":"uuid","type":"string"},"user_name":{"description":"User name","type":"string"},"user_phone":{"description":"User phone number","type":"string"},"verified_object":{"description":"Verified object (phone number, etc) which has been verified","type":"string"},"verify_code":{"description":"Verification (PIN) code","type":"string"}},"type":"object"},"EvsUsage":{"items":{"$ref":"#/definitions/EvsRequestData"},"type":"array"},"EvsUsagePaginatedList":{"properties":{"data":{"items":{"$ref":"#/definitions/EvsUsage"},"type":"array"},"summary":{"$ref":"#/definitions/EvsUsageSummary"}},"type":"object"},"EvsUsageSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"ExtendedAdditionalService":{"properties":{"code":{"description":"Service code","type":"string","x-nullable":true},"cost":{"description":"Service cost","items":{"$ref":"#/definitions/ExtendedAdditionalServiceCost"},"type":"array"},"default":{"default":0,"description":"Service is default","enum":[0,1],"type":"integer"},"id":{"description":"Additional service ID","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Service public description (multilanguage)","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Service public title (multilanguage)","x-nullable":true},"sort_order":{"description":"Sort order weight","type":"integer"},"title":{"description":"Service title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/AdditionalServiceType","description":"Service type","x-nullable":true}},"type":"object"},"ExtendedAdditionalServiceCost":{"properties":{"currency":{"description":"Currency ISO code","type":"string"},"decimal_digits":{"default":2,"description":"Number of decimal digits in value","type":"integer"},"min_value":{"default":0,"description":"Minimal value","format":"float","type":"number"},"values":{"description":"Threshold values","items":{"$ref":"#/definitions/ExtendedAdditionalServiceCostValue"},"type":"array"}},"required":["currency"],"type":"object"},"ExtendedAdditionalServiceCostValue":{"properties":{"threshold":{"description":"Threshold","format":"float","type":"number"},"type":{"$ref":"#/definitions/AdditionalServiceCostType","default":"amount","description":"Value type"},"value":{"default":0,"description":"Value","format":"float","type":"number"}},"required":["threshold"],"type":"object"},"ExtendedAdditionalServicesList":{"items":{"$ref":"#/definitions/ExtendedAdditionalService"},"type":"array"},"ExternalBankCardsEDCTypes":{"enum":["auto","credit","debit","gift"],"type":"string"},"ExternalCheckIdScope":{"enum":["system","business","loyalty","pos","terminal"],"type":"string"},"ExternalDataAccessScopeList":{"properties":{"title":{"description":"Scope title","type":"string"},"value":{"description":"Scope value","type":"string"}},"type":"object"},"ExternalForm":{"properties":{"active":{"description":"Form active flag","enum":[0,1],"type":"integer"},"country":{"description":"Country ISO code","type":"string","x-nullable":true},"file":{"description":"Empty form file URL (optional)","type":"string","x-nullable":true},"filled_forms_exist":{"description":"There are forms filled out by users (optional, readfonly)","type":"boolean","x-nullable":true},"form_data":{"description":"Form data object (optional)"},"id":{"description":"Form ID","type":"string","x-nullable":true},"rule_exists":{"description":"Form-related rule exists (optional, readfonly)","type":"boolean","x-nullable":true},"title":{"description":"Form title","type":"string","x-nullable":true},"type":{"description":"Form type","enum":["tax"],"type":"string","x-nullable":true},"version":{"description":"Version number","type":"integer","x-nullable":true}},"type":"object"},"ExternalForms":{"items":{"$ref":"#/definitions/ExternalForm"},"type":"array"},"ExternalFormsPaginatedList":{"properties":{"data":{"$ref":"#/definitions/ExternalForms"},"summary":{"$ref":"#/definitions/ExternalFormsSummary"}},"type":"object"},"ExternalFormsSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"FeedbackSource":{"properties":{"active":{"default":1,"description":"Feedback source active flag","enum":[0,1],"type":"integer"},"allow_pictures":{"default":0,"description":"Allow add picture to the feddback flag","enum":[0,1],"type":"integer"},"allow_video":{"default":0,"description":"Allow add picture to the feddback flag","enum":[0,1],"type":"integer"},"allow_voice":{"default":0,"description":"Allow add picture to the feddback flag","enum":[0,1],"type":"integer"},"created":{"description":"Source created datetime","format":"date-time","type":"string"},"customer_actions":{"default":"rate-and-review","description":"Allowed/required customers action","enum":["rate-only","review-only","rate-or-review","rate-and-review"],"type":"string"},"id":{"description":"Feedback source ID","format":"uuid","type":"string"},"invitation_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Text displayed for customers as invitation (multilanguage)"},"loyalty":{"$ref":"#/definitions/Loyalty","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"notification_emails":{"description":"Business notification email","type":"string","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Public title (multilanguage)","x-nullable":true},"reward_bonuses_currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"reward_coupon_batch_id":{"description":"Coupon batch ID","format":"uuid","type":"string","x-nullable":true},"reward_promotional_bonuses_expire_date":{"description":"Bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"reward_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireTypeBase","description":"Bonuses expiration type","x-nullable":true},"reward_promotional_bonuses_expire_value":{"description":"Number of days/months","type":"integer","x-nullable":true},"reward_special_account_id":{"description":"Special account ID","format":"uuid","type":"string","x-nullable":true},"reward_type":{"$ref":"#/definitions/BenefitsChargeTypeExtended","default":"none","description":"Type of reward for feedback"},"reward_value":{"description":"Reward value","format":"float","type":"number","x-nullable":true},"tag":{"description":"Tag (send to the business with customer feedback)","type":"string","x-nullable":true},"title":{"description":"Title","type":"string"},"urls":{"description":"URLs for object","properties":{"base_url":{"description":"Full URL","type":"string"},"short_url":{"description":"Short URL","type":"string"}},"type":"object"}},"type":"object"},"FinalizeCheck":{"properties":{"comment":{"description":"Comment","type":"string"},"id":{"description":"Transaction Id (optional, not used if the identifier is passed in the path)","format":"uuid","type":"string"},"transaction_id":{"description":"Alias to id","format":"uuid","type":"string"}},"type":"object"},"FuelController":{"properties":{"active":{"description":"Controller active flag","enum":[0,1],"type":"integer","x-nullable":true},"actual_gps_data":{"$ref":"#/definitions/FuelControllerGpsData","description":"Actual GPS coordinates","x-nullable":true},"alarm_notification":{"description":"Send alarm notification","enum":[0,1],"type":"integer","x-nullable":true},"alarm_notification_emails":{"$ref":"#/definitions/EmailsList","description":"Alarm notification recipients email list","x-nullable":true},"alarm_notification_frequency":{"description":"Alarm notification sending frequency in hour (if 0 - one time sending)","type":"integer","x-nullable":true},"communication_settings":{"$ref":"#/definitions/FuelControllerCommunicationSettings","description":"Controller connection settings","x-nullable":true},"configuration":{"$ref":"#/definitions/FuelControllerConfiguration","description":"Controller configuration (depends on controller, only for detailed view, not for list)","x-nullable":true},"configuration_reading_status":{"$ref":"#/definitions/FuelControllerConfigurationReadingStatus","description":"Configuration reading status (read only)","x-nullable":true},"configuration_updated":{"description":"Controller configuration last updated time","format":"date-time","type":"string","x-nullable":true},"connection_lost_notification_emails":{"$ref":"#/definitions/EmailsList","description":"Connection lost notification recipients email list","x-nullable":true},"connection_lost_notification_frequency":{"description":"Connection lost notification sending frequency in hour (if 0 - one time sending)","type":"integer","x-nullable":true},"delete_tank_grade_link_by_zero":{"default":0,"description":"Break Tank to Grade link if received zero volume product (only if used manual Tank to Grade link)","enum":[0,1],"type":"integer","x-nullable":true},"external_data_access_exists":{"description":"The controller has dedicated data access provided to the external system (optional, readonly)","type":"boolean","x-nullable":true},"grades":{"$ref":"#/definitions/FuelGradesList","description":"Grades info (only for detailed view, not for list)","x-nullable":true},"id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"manual_pump_nozzle_grade_link":{"default":0,"description":"Use manual Pump Nozzle to Grade link","enum":[0,1],"type":"integer","x-nullable":true},"manual_pump_nozzle_tank_link":{"default":0,"description":"Use manual Pump Nozzle to Tank link","enum":[0,1],"type":"integer","x-nullable":true},"manual_tank_grade_link":{"default":0,"description":"Use manual Tank to Grade link","enum":[0,1],"type":"integer","x-nullable":true},"notify_if_connection_lost_more_then":{"description":"Notification sent if the connection fails more than the specified period in minutes (if 0 - not notify)","type":"integer","x-nullable":true},"nozzles":{"$ref":"#/definitions/FuelPumpNozzleList","description":"Pump nozzles info (only for detailed view, not for list)","x-nullable":true},"pos":{"$ref":"#/definitions/PosEmbedded","x-nullable":true},"pos_id":{"description":"Controller linked POS ID","format":"uuid","type":"string","x-nullable":true},"price_changed_notification":{"description":"Send price changed notification (optional, for 'price-from-controller' price control scheme only)","enum":[0,1],"type":"integer","x-nullable":true},"price_changed_notification_emails":{"$ref":"#/definitions/EmailsList","description":"Price changed notification recipients email list (optional, for 'price-from-controller' price control scheme only)","x-nullable":true},"price_control_scheme":{"$ref":"#/definitions/FuelControllerPriceControlScheme","description":"Price control schema","x-nullable":true},"price_pump_nozzles_instead_grades":{"default":0,"description":"Use pump nozzles prices instead of grades prices (optional, for 'price-from-controller' price control scheme only)","enum":[0,1],"type":"integer","x-nullable":true},"pump_authorize_confirmation":{"$ref":"#/definitions/FuelControllerPumpAuthorizeConfirmation","description":"Pump authorize confirmation type","x-nullable":true},"pump_authorize_type":{"$ref":"#/definitions/FuelFillingType","description":"Pump authorize type","x-nullable":true},"pumps":{"description":"Pumps info (only for detailed view, not for list)","items":{"$ref":"#/definitions/FuelPump"},"type":"array","x-nullable":true},"read_gps_data":{"description":"Read and store GPS data from controller","enum":[0,1],"type":"integer","x-nullable":true},"read_probe_measurements":{"description":"Read and store tank level (probe measurements) data from controller","enum":[0,1],"type":"integer","x-nullable":true},"skip_pumps_in_selection":{"description":"Skip pumps when selecting fuel for filling","enum":[0,1],"type":"integer","x-nullable":true},"tanks":{"$ref":"#/definitions/FuelTankList","description":"Tanks info (only for detailed view, not for list)","x-nullable":true},"title":{"description":"Controller title","type":"string"},"type":{"$ref":"#/definitions/FuelControllerType","description":"Controller type","x-nullable":true}},"type":"object"},"FuelControllerCommunicationSettings":{"properties":{"admin_interface_url":{"description":"Controller URL","type":"string","x-nullable":true},"password":{"description":"Password","type":"string","x-nullable":true},"url":{"description":"Controller URL","type":"string","x-nullable":true},"user":{"description":"User name","type":"string","x-nullable":true}},"type":"object"},"FuelControllerConfiguration":{"properties":{"decimal_digits":{"$ref":"#/definitions/FuelControllerConfigurationDecimalDigits","description":"Controller decimal digits configuration","x-nullable":true},"measurement_units":{"$ref":"#/definitions/FuelControllerConfigurationMeasurementUnits","x-nullable":true}},"type":"object"},"FuelControllerConfigurationDecimalDigits":{"properties":{"amount":{"description":"Number of decimal digits in amount value","type":"integer"},"price":{"description":"Number of decimal digits in price value","type":"integer"},"volume":{"description":"Number of decimal digits in volume value","type":"integer"}},"type":"object"},"FuelControllerConfigurationMeasurementUnits":{"properties":{"volume":{"$ref":"#/definitions/FuelControllerVolumeMeasurementUnit","description":"Volume measurement unit","x-nullable":true}},"type":"object"},"FuelControllerConfigurationReadingStatus":{"enum":["connection-not-configured","ready-to-read","success","fail"],"type":"string"},"FuelControllerExternalDataAccess":{"properties":{"api_key":{"description":"API key (readonly)","type":"string","x-nullable":true},"controller_id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"id":{"description":"Access ID","format":"uuid","type":"string","x-nullable":true},"scope":{"$ref":"#/definitions/FuelControllerExternalDataAccessScopeList","description":"Data scope","x-nullable":true},"title":{"description":"Access title","type":"string","x-nullable":true}},"type":"object"},"FuelControllerExternalDataAccessList":{"items":{"$ref":"#/definitions/FuelControllerExternalDataAccess"},"type":"array"},"FuelControllerExternalDataAccessScope":{"enum":["configuration","grades","pumps","nozzles","tanks","gps-data"],"type":"string"},"FuelControllerExternalDataAccessScopeList":{"description":"Data scope","items":{"$ref":"#/definitions/FuelControllerExternalDataAccessScope"},"type":"array","x-nullable":true},"FuelControllerGpsData":{"properties":{"controller_id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"heading":{"description":"Heading value in degrees","format":"float","type":"number","x-nullable":true},"latitude":{"description":"Latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"live":{"description":"GPS data live (from GPS module on controller) flag","type":"boolean","x-nullable":true},"longitude":{"description":"Longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"metadata":{"$ref":"#/definitions/GpsDataMetadata","description":"Metadata (optional)","x-nullable":true},"processed":{"description":"GPS data time (UTC)","format":"date-time","type":"string","x-nullable":true},"speed":{"description":"Speed over ground in kilometers per hour","format":"float","type":"number","x-nullable":true},"valid":{"description":"Flag of validity data","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"FuelControllerGpsDataList":{"items":{"$ref":"#/definitions/FuelControllerGpsData"},"type":"array"},"FuelControllerPriceControlScheme":{"enum":["none","price-from-system","price-from-controller"],"type":"string"},"FuelControllerPumpAuthorizeConfirmation":{"enum":["selected-nozzle-up","without-nozzle-confirmation"],"type":"string"},"FuelControllerType":{"enum":["pts-2"],"type":"string"},"FuelControllerVolumeMeasurementUnit":{"enum":["L","G"],"type":"string"},"FuelControllersList":{"items":{"$ref":"#/definitions/FuelController"},"type":"array"},"FuelFillingType":{"enum":["amount","volume"],"type":"string"},"FuelGrade":{"properties":{"average_cost":{"$ref":"#/definitions/GradeFuelDelivery","description":"Last actual average cost of fuel by deliveries (optional)","x-nullable":true},"code":{"description":"Grade code","type":"string","x-nullable":true},"id":{"description":"Grade ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal grade ID","type":"string","x-nullable":true},"price":{"description":"Grade price","format":"float","type":"number","x-nullable":true},"price_decimal_digits":{"description":"Number of decimal digits in price value","type":"integer","x-nullable":true}},"type":"object"},"FuelGradesList":{"items":{"$ref":"#/definitions/FuelGrade"},"type":"array"},"FuelPump":{"properties":{"additional_terminals":{"$ref":"#/definitions/FuelPumpTerminalList","description":"Linked additional terminals (optional)","x-nullable":true},"id":{"description":"Pump ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal pump ID / Pump number","type":"string","x-nullable":true},"terminal":{"$ref":"#/definitions/FuelPumpTerminal","description":"Linked main terminal (optional)","x-nullable":true},"terminal_id":{"description":"Linked main terminal ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"FuelPumpNozzle":{"properties":{"code":{"description":"Grade code (optional)","type":"string","x-nullable":true},"grade_id":{"description":"Grade ID","format":"uuid","type":"string","x-nullable":true},"id":{"description":"Nozzle ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal pump nozzle ID / Pump nozzle number","type":"string","x-nullable":true},"pump_id":{"description":"Pump ID","format":"uuid","type":"string","x-nullable":true},"tank_id":{"description":"Tank ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"FuelPumpNozzleList":{"items":{"$ref":"#/definitions/FuelPumpNozzle"},"type":"array"},"FuelPumpTerminal":{"properties":{"active":{"default":1,"description":"Terminal is active flag","enum":[0,1],"type":"integer"},"currency":{"description":"Currensy ISO code","type":"string"},"id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"last_event_status":{"$ref":"#/definitions/FuelPumpTerminalEventStatus","description":"Last event status","x-nullable":true},"login":{"description":"Terminal login (optional)","type":"string"},"title":{"description":"Terminal title","type":"string"},"type":{"$ref":"#/definitions/TerminalType","description":"Terminal type"}},"type":"object"},"FuelPumpTerminalEventStatus":{"properties":{"id":{"description":"Event Id (readonly)","format":"uuid","type":"string","x-nullable":true},"processed":{"description":"Event UTC processed date-time","format":"date-time","type":"string","x-nullable":true},"remote_addr":{"description":"Remote address (remote IP)","type":"string","x-nullable":true},"status":{"$ref":"#/definitions/TerminalEventStatusCode","description":"Event Status","x-nullable":true}},"type":"object"},"FuelPumpTerminalList":{"items":{"$ref":"#/definitions/FuelPumpTerminal"},"type":"array"},"FuelTank":{"properties":{"actual_measurements":{"$ref":"#/definitions/ProbeMeasurements","description":"Last known measurements (optional)","x-nullable":true},"configuration":{"$ref":"#/definitions/TankConfiguration","description":"Tank configuration (optional)","x-nullable":true},"finish_measurements":{"$ref":"#/definitions/ProbeMeasurements","description":"Probe measurements on finish fueling(optional, only for Job)","x-nullable":true},"grade_code":{"description":"Grade code","type":"string","x-nullable":true},"grade_id":{"description":"Grade ID","format":"uuid","type":"string","x-nullable":true},"id":{"description":"Tank ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal tank ID","type":"string","x-nullable":true},"start_measurements":{"$ref":"#/definitions/ProbeMeasurements","description":"Probe measurements on start fueling(optional, only for Job)","x-nullable":true}},"type":"object"},"FuelTankList":{"items":{"$ref":"#/definitions/FuelTank"},"type":"array"},"GiftCard":{"properties":{"active":{"description":"Gift card active flag","enum":[0,1],"type":"integer"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"code":{"description":"Gift card CODE","type":"string"},"coupon_batches":{"$ref":"#/definitions/CouponBatchesList","description":"Coupon batches list"},"created":{"description":"Gift card created datetime","format":"date-time","type":"string"},"customer_usage_timeout":{"description":"Gift card customer usage timeout limit (in hours)","type":"integer"},"id":{"description":"Gift card ID","format":"uuid","type":"string"},"image":{"description":"URL of batch image","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Gift card public description (multilanguage)"},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Gift card public title (multilanguage)"},"random_emission_quantity":{"description":"Gift card random emission coupon limit quantity","format":"int64","type":"integer"},"title":{"description":"Gift card title","type":"string"},"usage_count":{"description":"Gift card usage count","format":"int64","type":"integer"},"usage_limit_per_customer":{"description":"Gift card usage per customer limit quantity","format":"int64","type":"integer"},"usage_limit_quantity":{"description":"Gift card usage limit quantity","format":"int64","type":"integer"},"validity_period_begin":{"description":"Gift card validity period begin date","format":"date","type":"string"},"validity_period_end":{"description":"Gift card validity period end date","format":"date","type":"string"}},"type":"object"},"Goods":{"properties":{"active":{"description":"Goods active (1) or not (0)","enum":[0,1],"type":"integer"},"additional_images":{"$ref":"#/definitions/ImageObjectsList","description":"Additional images array"},"code":{"description":"Goods code","type":"string","x-nullable":true},"color":{"description":"Color","type":"integer","x-nullable":true},"id":{"description":"Goods ID","format":"uuid","type":"string"},"image":{"$ref":"#/definitions/ImageObject","description":"Main image object"},"loyalty_id":{"description":"Loyalty ID (optional)","format":"uuid","type":"string"},"loyalty_title":{"description":"Loyalty title (readonly) (optional)","type":"string"},"online_store_available":{"description":"Available in Online Store","enum":[0,1],"type":"integer","x-nullable":true},"passthru_data":{"$ref":"#/definitions/GoodsPassThru","description":"PassThru data for Fleet, etc","x-nullable":true},"preconfigured_values":{"description":"Pre-configured values with amount or totals","items":{"$ref":"#/definitions/PreConfiguredValues"},"type":"array"},"price":{"description":"Price values","items":{"$ref":"#/definitions/GoodsPrice"},"type":"array"},"service_types":{"$ref":"#/definitions/StringValuesList","description":"Service types of goods"},"title":{"description":"Title","type":"string","x-nullable":true},"unit":{"description":"Measuring units","type":"string","x-nullable":true},"variable_price":{"description":"Price change allowed","enum":[0,1],"type":"integer","x-nullable":true},"variable_total":{"description":"Total change allowed","enum":[0,1],"type":"integer","x-nullable":true},"whole_number":{"description":"Quantity is integer number only","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"GoodsCategories":{"items":{"properties":{"id":{"description":"Goods category ID","format":"uuid","type":"string"}},"type":"object"},"type":"array"},"GoodsCategory":{"properties":{"active":{"default":1,"description":"Category is active flag","enum":[0,1],"type":"integer","x-nullable":true},"color":{"description":"Color","type":"integer","x-nullable":true},"id":{"description":"Goods category ID","format":"uuid","type":"string"},"image":{"$ref":"#/definitions/ImageObject","description":"Category image","x-nullable":true},"link":{"description":"Category link","type":"string","x-nullable":true},"online_store_available":{"default":0,"description":"Category available in online store flag","enum":[0,1],"type":"integer","x-nullable":true},"parent_id":{"description":"Parent category ID","format":"uuid","type":"string","x-nullable":true},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Category public description (multilanguage)","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Category public title (multilanguage)","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true}},"type":"object"},"GoodsCodes":{"items":{"description":"goods code","type":"string"},"type":"array"},"GoodsList":{"items":{"$ref":"#/definitions/Goods"},"type":"array"},"GoodsPaginatedList":{"properties":{"data":{"$ref":"#/definitions/GoodsList"},"summary":{"$ref":"#/definitions/GoodsSummary"}},"type":"object"},"GoodsPassThru":{"properties":{"fleet":{"$ref":"#/definitions/GoodsPassThruFleet","description":"PassThru data for Fleet","x-nullable":true}},"type":"object"},"GoodsPassThruFleet":{"properties":{"measure_unit":{"description":"Unit of measure","enum":["L","G"],"type":"string","x-nullable":true},"product_code":{"description":"NACS Product Code","type":"string","x-nullable":true}},"type":"object"},"GoodsPrice":{"properties":{"applicable":{"description":"Is price applicable for customer/corporate customer (readonly)","type":"boolean","x-nullable":true},"applicable_identified_customers_only":{"description":"Price is applied only to identified customers, not to anonymous one (optional)","type":"boolean","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"customer_prices":{"description":"Prices available for customer","items":{"$ref":"#/definitions/CustomerPrice"},"type":"array","x-nullable":true},"id":{"description":"Price ID","format":"uuid","type":"string","x-nullable":true},"margins":{"$ref":"#/definitions/PriceMargins","description":"Price margins (optional)","x-nullable":true},"price":{"description":"Price value at which the product/service is sold (in common mapped to price_sale)","format":"float","type":"number","x-nullable":true},"price_decimal_digits":{"description":"Number of decimal digits in price value","type":"integer","x-nullable":true},"price_explain":{"$ref":"#/definitions/PriceExplain","description":"Price explain (optional)","x-nullable":true},"price_including_taxes":{"description":"Price including taxes (optional)","format":"float","type":"number","x-nullable":true},"price_posted":{"description":"Posted (station level) price (optional)","format":"float","type":"number","x-nullable":true},"price_sale":{"description":"Sale (check, receipt) price (optional)","format":"float","type":"number","x-nullable":true},"special_account":{"$ref":"#/definitions/PriceSpecialAccount","description":"Special account info","x-nullable":true},"special_account_id":{"description":"Special account ID","format":"uuid","type":"string","x-nullable":true},"taxes":{"$ref":"#/definitions/PriceTaxes","description":"Price taxes (optional)","x-nullable":true},"type":{"$ref":"#/definitions/PriceType","description":"Type of price origin","x-nullable":true}},"type":"object"},"GoodsSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"GoogleAuthRequestData":{"properties":{"client_id":{"description":"Google OAuth 2.0 Client ID","type":"string"},"create":{"default":false,"description":"Create/register new user if not exists","type":"boolean"},"credential":{"description":"User Google ID token","type":"string"},"link_by_email":{"default":true,"description":"Link Google credentials by email with the existing account","type":"boolean"}},"required":["client_id","credential"],"type":"object"},"GpsDataMetadata":{"properties":{"good":{"description":"GPS data goodness flag","type":"boolean","x-nullable":true},"stop_data":{"$ref":"#/definitions/GpsParkingDataMetadata","description":"Stop/parking point additional data","x-nullable":true},"stop_point":{"description":"Is GPS data is stop/parking point","type":"boolean","x-nullable":true}},"type":"object"},"GpsParkingDataMetadata":{"properties":{"begin":{"description":"Stop/parking begin time (UTC)","format":"date-time","type":"string","x-nullable":true},"end":{"description":"Stop/parking end time (UTC)","format":"date-time","type":"string","x-nullable":true},"latitude":{"description":"Stop/parking latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"longitude":{"description":"Stop/parking longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"number":{"description":"Stop/parking number in route","type":"integer","x-nullable":true},"points_count":{"description":"Stop/parking suppressed points count","type":"integer","x-nullable":true}},"type":"object"},"GradeFuelDeliveriesList":{"items":{"$ref":"#/definitions/GradeFuelDelivery"},"type":"array"},"GradeFuelDelivery":{"properties":{"average_cost":{"description":"Value of product average cost per volume measure unit based on delivery (optional, readonly)","format":"double","type":"number","x-nullable":true},"controller_id":{"description":"Controller ID (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"delivery_cost":{"description":"Value of product delivery cost per volume measure unit (optional)","format":"double","type":"number","x-nullable":true},"delivery_datetime":{"description":"Delivery date and time (optional)","format":"date-time","type":"string","x-nullable":true},"delivery_id":{"description":"Delivery ID (optional)","format":"uuid","type":"string","x-nullable":true},"delivery_vehicle_id":{"description":"Delivery vehicle / rail car number/id (optional)","type":"string","x-nullable":true},"delivery_volume":{"description":"Value of product delivery volume in volume measure units (optional)","format":"double","type":"number","x-nullable":true},"exists":{"description":"Delivery data existence (readonly)","type":"boolean","x-nullable":true},"grade_id":{"description":"Grade ID (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"product_volume_before_delivery":{"description":"Value of product volume before delivery in volume measure units (optional)","format":"double","type":"number","x-nullable":true},"volume_measure_unit":{"$ref":"#/definitions/FuelControllerVolumeMeasurementUnit","description":"Unit of volume measure (optional, readonly)","x-nullable":true}},"type":"object"},"GradeSummaryVolume":{"properties":{"controller_id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"date":{"description":"Measurements time","format":"date-time","type":"string","x-nullable":true},"exists":{"description":"Tanks measurements/volume exists","type":"boolean","x-nullable":true},"grade_id":{"description":"Grade ID","format":"uuid","type":"string","x-nullable":true},"product_height":{"description":"Value of product height in 0.1 mm","format":"double","type":"number","x-nullable":true},"product_volume":{"description":"Value of product volume in volume measure units (optional)","format":"double","type":"number","x-nullable":true},"volume_measure_unit":{"$ref":"#/definitions/VolumeUnitType","description":"Unit of volume measure","x-nullable":true},"water_height":{"description":"Value of water height in 0.1 mm","format":"double","type":"number","x-nullable":true},"water_volume":{"description":"Value of water volume in volume measure units (optional)","format":"double","type":"number","x-nullable":true}},"type":"object"},"IdType":{"enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"type":"string"},"IdentifierValidationRequestObject":{"properties":{"value":{"description":"Identifier (phone number, email) value","type":"string","x-nullable":true}},"required":["value"],"type":"object"},"IdentifierVerificationRequestObject":{"properties":{"pin":{"description":"One-time code sent to recipient by identifier (optional)","type":"string","x-nullable":true},"recaptcha_token":{"description":"Protection recaptcha token","type":"string","x-nullable":true},"token":{"description":"Token previous verified object (optional, for phone verification only)","type":"string","x-nullable":true},"value":{"description":"Identifier (phone number, email) value","type":"string","x-nullable":true}},"required":["value"],"type":"object"},"IdentifierVerifiedObject":{"properties":{"expire":{"description":"Date and time of token expire (UTC)","format":"date-time","type":"string"},"token":{"description":"One-time token of verified object","type":"string"},"value":{"description":"Identifier (phone number, email) value","type":"string","x-nullable":true}},"required":["value"],"type":"object"},"ImageObject":{"properties":{"id":{"description":"Image asset ID","format":"uuid","type":"string","x-nullable":true},"url":{"description":"Image asset URL","type":"string","x-nullable":true}},"type":"object"},"ImageObjectsList":{"items":{"$ref":"#/definitions/ImageObject"},"type":"array"},"ImportCustomersData":{"properties":{"customers":{"description":"Customers data","items":{"items":{"type":"string","x-nullable":true},"type":"array"},"type":"array"},"fields":{"$ref":"#/definitions/StringValuesList"},"loyalty_id":{"description":"Loyalty ID","type":"string"},"primary_id_type":{"enum":["phone","email","external-id"],"type":"string"},"skip_category_change_message":{"default":false,"description":"Don't send messages about category changed","type":"boolean"},"skip_transaction_message":{"default":false,"description":"Don't send transactions messages","type":"boolean"}},"required":["loyalty_id","fields","customers"],"type":"object"},"ImportCustomersResult":{"properties":{"add":{"description":"Number of new added customers","type":"integer"},"error":{"description":"Number of strings imported with errors","type":"integer"},"errors":{"description":"Error details","items":{"properties":{"error_str":{"description":"Error string","type":"string"},"row":{"description":"Line number where the error occurred","type":"integer"}},"type":"object"},"type":"array"},"result":{"properties":{"fields":{"description":"Fields list of customers data","items":{"type":"string"},"type":"array"},"rows":{"description":"Import result data","items":{"items":{"type":"string"},"type":"array"},"type":"array"}},"type":"object"},"update":{"description":"Number of updated customers","type":"integer"}},"required":["add","update","error"],"type":"object"},"ItemAdditionalCostSummaryData":{"properties":{"additional_cost_amount":{"description":"Additional cost amount","format":"float","type":"number","x-nullable":true},"additional_cost_decimal_digits":{"description":"Additional cost amount decimal digits","type":"integer"},"item_code":{"description":"Item code","type":"string","x-nullable":true},"item_id":{"description":"Loyalty Item ID","format":"uuid","type":"string","x-nullable":true},"item_title":{"description":"Item title","type":"string","x-nullable":true}},"type":"object"},"ItemTaxSummaryData":{"properties":{"item_code":{"description":"Item code","type":"string","x-nullable":true},"item_id":{"description":"Loyalty Item ID","format":"uuid","type":"string","x-nullable":true},"item_title":{"description":"Item title","type":"string","x-nullable":true},"tax_amount":{"description":"Tax amount","format":"float","type":"number","x-nullable":true},"tax_decimal_digits":{"description":"Tax amount decimal digits","type":"integer"}},"type":"object"},"ItemsTaxOption":{"properties":{"item_active":{"description":"Goods item active flag","enum":[0,1],"type":"integer","x-nullable":true},"item_category_id":{"description":"Goods item category ID","format":"uuid","type":"string","x-nullable":true},"item_category_title":{"description":"Goods item category title","type":"string","x-nullable":true},"item_code":{"description":"Goods item code","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string"},"item_title":{"description":"Goods item title","type":"string","x-nullable":true},"taxes":{"$ref":"#/definitions/TaxOptionsList","description":"Tax options","x-nullable":true}},"type":"object"},"ItemsTaxOptionsList":{"items":{"$ref":"#/definitions/ItemsTaxOption","description":"Goods item tax option object"},"type":"array"},"ItemsTaxOptionsPaginatedList":{"properties":{"data":{"$ref":"#/definitions/ItemsTaxOptionsList"},"summary":{"$ref":"#/definitions/ItemsTaxOptionsSummary"}},"type":"object"},"ItemsTaxOptionsSummary":{"properties":{"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"},"Job":{"properties":{"auto_capture_parent_transaction":{"description":"Automaticaly capture funds of authorized payment transactions when job finished","type":"boolean"},"auto_start":{"description":"Automaticaly start the job after creation","type":"boolean"},"corporate_user_id":{"description":"Corporate User ID (optional)","format":"uuid","type":"string"},"created":{"description":"Created time","format":"date-time","type":"string"},"details":{"$ref":"#/definitions/JobDetails","description":"Details object (required for Job creation)"},"finalize_transaction_errors":{"description":"Capturing transaction errors list","items":{"$ref":"#/definitions/TransactionErrors"},"type":"array"},"finalize_transaction_failed":{"description":"Flag of finalize transaction failed. Exists and set to TRUE if capture funds of authorized payment failed","type":"boolean"},"finalize_transaction_id":{"description":"Сapture funds of authorized payment or cancellation transaction ID (optional)","format":"uuid","type":"string"},"finished":{"description":"Finished time","format":"date-time","type":"string"},"id":{"description":"Job ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID (optional)","format":"uuid","type":"string"},"pos_id":{"description":"POS ID (optional)","format":"uuid","type":"string"},"started":{"description":"Started time","format":"date-time","type":"string"},"status":{"description":"Job status","enum":["created","starting","inprocess","stopping","finished"],"type":"string"},"terminal_id":{"description":"Terminal/Register ID (optional)","format":"uuid","type":"string"},"transaction_id":{"description":"Linked transaction ID (optional)","format":"uuid","type":"string"},"type":{"description":"Job type (required for Job creation)","enum":["fuel","equipment"],"type":"string"},"user_id":{"description":"User ID (optional)","format":"uuid","type":"string"}},"type":"object"},"JobDetails":{"properties":{"equipment":{"$ref":"#/definitions/JobEquipment","description":"Equipment details (depending of job type, required for Job creation)"},"finish_endpoint_url":{"description":"Webhook endpoint URL to receive Job finished status","type":"string","x-nullable":true},"fuel":{"$ref":"#/definitions/JobFuel","description":"Fuel details (depending of job type, required for Job creation)"}},"type":"object"},"JobEquipment":{"properties":{"authorized_amount":{"description":"Authorized item amount","format":"float","type":"number","x-nullable":true},"authorized_price":{"description":"Authorized item price","format":"float","type":"number","x-nullable":true},"authorized_price_currency":{"description":"Authorized price currency ISO code (Only if filling_price_type is 'currency')","type":"string","x-nullable":true},"authorized_price_margins":{"$ref":"#/definitions/PriceMargins","description":"Authorized targins applicable to the price (optional)","x-nullable":true},"authorized_price_special_account_id":{"description":"Authorized price special account Id (Only if filling_price_type is 'special-account')","format":"uuid","type":"string","x-nullable":true},"authorized_price_taxes":{"$ref":"#/definitions/PriceTaxes","description":"Authorized taxes applicable to the price (optional)","x-nullable":true},"authorized_price_type":{"$ref":"#/definitions/PriceType","description":"Authorized price type","x-nullable":true},"authorized_price_unit":{"description":"Authorized price unit - quantity or currency ISO code (Only if filling_price_type is 'special-account')","type":"string","x-nullable":true},"authorized_quantity":{"description":"Authorized item quantity","format":"float","type":"number","x-nullable":true},"avi_id":{"description":"AVI (automatic vehicle identification) Id value (optional)","type":"string","x-nullable":true},"captured_amount":{"description":"Item amount captured by check","format":"float","type":"number","x-nullable":true},"captured_price":{"description":"Item price captured by check","format":"float","type":"number","x-nullable":true},"captured_quantity":{"description":"Item quantity captured by check","format":"float","type":"number","x-nullable":true},"charged_amount":{"description":"Charged item amount","format":"float","type":"number","x-nullable":true},"charged_price":{"description":"Charged item price","format":"float","type":"number","x-nullable":true},"charged_quantity":{"description":"Charged item quantity","format":"float","type":"number","x-nullable":true},"charging_amount":{"description":"Charging item amount","format":"float","type":"number","x-nullable":true},"charging_price":{"description":"Charging item price","format":"float","type":"number","x-nullable":true},"charging_quantity":{"description":"Charging item quantity","format":"float","type":"number","x-nullable":true},"connection_failed":{"description":"Controller connection failed flag (Exists and set to true only if connection with controller failed)","type":"boolean","x-nullable":true},"controller_id":{"description":"Controller Id","format":"uuid","type":"string","x-nullable":true},"controller_type":{"$ref":"#/definitions/EquipmentControllerType","description":"Controller type","x-nullable":true},"equipment_id":{"description":"Equipment Id","format":"uuid","type":"string","x-nullable":true},"equipment_input_number":{"description":"Controller input number","type":"integer","x-nullable":true},"equipment_monitor_working_status":{"description":"Ability to monitor the working condition flag","enum":[0,1],"type":"integer","x-nullable":true},"equipment_output_number":{"description":"Controller output number","type":"integer","x-nullable":true},"equipment_type":{"$ref":"#/definitions/EquipmentType","description":"Equipment type","x-nullable":true},"error_message":{"description":"Error message (Exists only if controller send error message)","type":"string","x-nullable":true},"goods_code":{"description":"Goods code","type":"string","x-nullable":true},"goods_title":{"description":"Goods title (optional)","type":"string","x-nullable":true},"item_amount":{"description":"Item amount","format":"float","type":"number","x-nullable":true},"item_code":{"description":"Item code (optional)","type":"string","x-nullable":true},"item_price":{"description":"Item price","format":"float","type":"number","x-nullable":true},"item_quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"item_title":{"description":"Item title (optional)","type":"string","x-nullable":true},"odometer":{"description":"Odometer/engine hours value, up to two decimal digits (optional)","format":"float","type":"number","x-nullable":true},"odometer_unit":{"$ref":"#/definitions/OdometerUnitType","description":"Odometer unit of measure (optional)","x-nullable":true},"status":{"description":"Equipment charging status","enum":["waiting-for-process","processing","processing-stopping","processing-finished","processing-failed"],"type":"string","x-nullable":true},"vehicle_id":{"description":"Qr Code / Tag of vehicle or equipment value (optional)","type":"string","x-nullable":true}},"required":["equipment_id"],"type":"object"},"JobFuel":{"properties":{"avi_id":{"description":"AVI (automatic vehicle identification) Id value (optional)","type":"string","x-nullable":true},"captured_amount":{"description":"Fuel amount captured by check (optional)","format":"float","type":"number","x-nullable":true},"captured_price":{"description":"Fuel price captured by check (optional)","format":"float","type":"number","x-nullable":true},"captured_volume":{"description":"Fuel volume captured by check (optional)","format":"float","type":"number","x-nullable":true},"connection_failed":{"description":"Controller connection failed flag (Exists and set to true only if connection with controller failed) (optional)","type":"boolean","x-nullable":true},"controller":{"description":"Internal controller ID (optional)","type":"string","x-nullable":true},"controller_configuration":{"$ref":"#/definitions/FuelControllerConfiguration","description":"Controller configuration (optional)","x-nullable":true},"controller_id":{"description":"Controller Id (optional)","format":"uuid","type":"string","x-nullable":true},"controller_type":{"$ref":"#/definitions/FuelControllerType","description":"Controller type (optional)","x-nullable":true},"error_message":{"description":"Error message (Exists only if controller send error message) (optional)","type":"string","x-nullable":true},"filled_amount":{"description":"Job money amount (optional)","format":"float","type":"number","x-nullable":true},"filled_volume":{"description":"Job filled volume (optional)","format":"float","type":"number","x-nullable":true},"filling_doze":{"description":"Filling preset dose in volume units (for preset type Volume) or in currency units (for preset type Amount) (optional)","format":"float","type":"number","x-nullable":true},"filling_price":{"description":"Filling fuel price (optional)","format":"float","type":"number","x-nullable":true},"filling_price_currency":{"description":"Filling price currency ISO code (Only if filling_price_type is 'currency') (optional)","type":"string","x-nullable":true},"filling_price_margins":{"$ref":"#/definitions/PriceMargins","description":"Margins applicable to the price (optional)","x-nullable":true},"filling_price_special_account_id":{"description":"Filling price special account Id (Only if filling_price_type is 'special-account') (optional)","format":"uuid","type":"string","x-nullable":true},"filling_price_taxes":{"$ref":"#/definitions/PriceTaxes","description":"Taxes applicable to the price (optional)","x-nullable":true},"filling_price_type":{"$ref":"#/definitions/PriceType","description":"Filling price type (optional)","x-nullable":true},"filling_price_unit":{"description":"Filling price unit - quantity or currency ISO code (Only if filling_price_type is 'special-account') (optional)","type":"string","x-nullable":true},"filling_type":{"$ref":"#/definitions/FuelFillingType","description":"Filling preset type (optional)","x-nullable":true},"goods_code":{"description":"Goods code (optional)","type":"string","x-nullable":true},"goods_title":{"description":"Goods title (optional)","type":"string","x-nullable":true},"grade":{"description":"Internal grade ID / Grade number (optional)","type":"string","x-nullable":true},"grade_id":{"description":"Grade Id (optional)","format":"uuid","type":"string","x-nullable":true},"item_amount":{"description":"Item amount (optional)","format":"float","type":"number","x-nullable":true},"item_code":{"description":"Item code (optional)","type":"string","x-nullable":true},"item_price":{"description":"Item price (optional)","format":"float","type":"number","x-nullable":true},"item_quantity":{"description":"Item quantity (optional)","format":"float","type":"number","x-nullable":true},"item_title":{"description":"Item title (optional)","type":"string","x-nullable":true},"nozzle":{"description":"Internal nozzle ID / Pump nozzle (optional)","type":"string","x-nullable":true},"nozzle_id":{"description":"Nozzle Id (optional)","format":"uuid","type":"string","x-nullable":true},"odometer":{"description":"Odometer/engine hours value, up to two decimal digits (optional)","format":"float","type":"number","x-nullable":true},"odometer_unit":{"$ref":"#/definitions/OdometerUnitType","description":"Odometer unit of measure (optional)","x-nullable":true},"pump":{"description":"Internal pump ID / Pump number (optional)","type":"string","x-nullable":true},"pump_authorize_confirmation":{"$ref":"#/definitions/FuelControllerPumpAuthorizeConfirmation","description":"Pump authorize confirmation type (optional)","x-nullable":true},"pump_id":{"description":"Pump Id (optional)","format":"uuid","type":"string","x-nullable":true},"status":{"description":"Fuel filling status (optional)","enum":["waiting-for-process","pump-is-offline","pump-is-busy","nozzle-not-taken-up","wrong-nozzle-taken-up","ready-for-filling","filling","filling-stopping","filling-finished","filling-failed"],"type":"string","x-nullable":true},"tank":{"description":"Internal tank ID / Tank number (optional)","type":"string","x-nullable":true},"tank_details":{"$ref":"#/definitions/FuelTank","description":"Tank info (optional)","x-nullable":true},"tank_id":{"description":"Tank Id (optional)","format":"uuid","type":"string","x-nullable":true},"transaction":{"description":"Internal controller transaction number (optional)","type":"string","x-nullable":true},"transaction_finish_dt":{"description":"Internal controller transaction finish date time in '%Y-%m-%d %H:%M:%S' format (optional)","type":"string","x-nullable":true},"transaction_start_dt":{"description":"Internal controller transaction start date time in '%Y-%m-%d %H:%M:%S' format (optional)","type":"string","x-nullable":true},"transaction_tag":{"description":"Internal controller transaction tag (optional)","type":"string","x-nullable":true},"vehicle_id":{"description":"Qr Code / Tag of vehicle or equipment value (optional)","type":"string","x-nullable":true}},"type":"object"},"JobsList":{"items":{"$ref":"#/definitions/Job"},"type":"array"},"JobsPaginatedList":{"properties":{"data":{"$ref":"#/definitions/JobsList"},"summary":{"$ref":"#/definitions/JobsSummary"}},"type":"object"},"JobsSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"LiqPayBusinessPaymentData":{"properties":{"data":{"description":"Encoded payment data","type":"string","x-nullable":true},"integration_types":{"$ref":"#/definitions/LiqPayIntegrationTypes","description":"Supported integration types"},"language":{"description":"Language ISO code","type":"string","x-nullable":true},"order_reference":{"description":"Reference payment order id","format":"uuid","type":"string","x-nullable":true},"signature":{"description":"Payment signature","type":"string","x-nullable":true}},"type":"object"},"LiqPayBusinessPaymentNewInitialData":{"properties":{"amount":{"description":"Amount of payment","format":"float","type":"number","x-nullable":true},"currency":{"description":"Payment currency","type":"string","x-nullable":true},"description":{"description":"Payment desctiption","type":"string","x-nullable":true},"fail_url":{"description":"The URL to which should send customers when payment is failed (for LiqPay checkout page only)","type":"string","x-nullable":true},"success_url":{"description":"The URL to which should send customers when payment is completed (for LiqPay checkout page only)","type":"string","x-nullable":true}},"required":["currency","amount"],"type":"object"},"LiqPayIntegrationTypes":{"items":{"enum":["checkout","widget"],"type":"string"},"type":"array"},"LiqPayRegularPaymentData":{"properties":{"amount":{"description":"Payment amount","format":"float","type":"number","x-nullable":true},"balance_amount":{"description":"Balance amount for pay","format":"float","type":"number","x-nullable":true},"currency":{"description":"currency","type":"string","x-nullable":true},"description":{"description":"Payment desctiption (optional)","type":"string","x-nullable":true},"language":{"description":"Language ISO code (optional)","type":"string","x-nullable":true},"order_reference":{"description":"Referenced payment","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"Loan":{"properties":{"amount":{"description":"Loan principal amount (readonly)","format":"float","type":"number","x-nullable":true},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"client_notifications":{"description":"Notifying the Client about the approval, rejection, or deduction of funds under installment payments","enum":[0,1],"type":"integer","x-nullable":true},"commission_amount":{"description":"Loan commission fee amount (readonly)","format":"float","type":"number","x-nullable":true},"created":{"description":"Loan created date and time (readonly) (optional)","format":"date-time","type":"string","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"first_payment_date":{"description":"Loan first installment payments date (readonly) (optional)","format":"date","type":"string","x-nullable":true},"id":{"description":"Loan ID (readonly)","format":"uuid","type":"string","x-nullable":true},"installment_payments":{"$ref":"#/definitions/LoanInstallmentPayments","description":"Installment payments","x-nullable":true},"issued":{"description":"Loan issued date and time (readonly) (optional)","format":"date-time","type":"string","x-nullable":true},"last_payment_date":{"description":"Loan first installment payments date (readonly) (optional)","format":"date","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title (readonly) (optional)","type":"string"},"next_payment_date":{"description":"Loan next installment payments date (readonly) (optional)","format":"date","type":"string","x-nullable":true},"notification_settings":{"$ref":"#/definitions/LoanNotificationSettings","description":"Custom messages notification settings and templates (optional)","x-nullable":true},"payment_type":{"description":"Loan installment payments type","enum":["currency","special-account"],"type":"string","x-nullable":true},"payments_number":{"description":"Loan installment payments number (readonly) (optional)","type":"integer","x-nullable":true},"processed":{"description":"Loan last processed date and time (readonly) (optional)","format":"date-time","type":"string","x-nullable":true},"processed_amount":{"description":"Loan processed/paid principal amount (readonly)","format":"float","type":"number","x-nullable":true},"processed_commission_amount":{"description":"Loan processed/paid commission fee amount (readonly)","format":"float","type":"number","x-nullable":true},"processed_payments_number":{"description":"Loan processed installment payments number (readonly) (optional)","type":"integer","x-nullable":true},"processed_total_amount":{"description":"Loan processed/paid total amount including principal and commission fee (readonly)","format":"float","type":"number","x-nullable":true},"repaid":{"description":"Loan repaid date and time (readonly) (optional)","format":"date-time","type":"string","x-nullable":true},"special_account_currency":{"description":"Special account currency ISO code (readonly) (optional)","type":"string","x-nullable":true},"special_account_id":{"description":"Special account ID (if transaction payment is 'special-account')","format":"uuid","type":"string","x-nullable":true},"special_account_title":{"description":"Special account title (readonly) (optional)","type":"string","x-nullable":true},"special_account_type":{"$ref":"#/definitions/SpecialAccountType","description":"Special account type (readonly) (optional)","x-nullable":true},"status":{"description":"Loan status (readonly)","enum":["created","approved","declined","declined-first-installment","issued","canceled","partially-repaid","repaid"],"type":"string","x-nullable":true},"term":{"description":"Loan term","type":"integer","x-nullable":true},"term_basis":{"description":"Loan term basis","enum":["day","month","year"],"type":"string","x-nullable":true},"total_amount":{"description":"Loan total amount including principal and commission fee (readonly)","format":"float","type":"number","x-nullable":true},"type":{"description":"Loan type","enum":["payment-in-installments"],"type":"string","x-nullable":true},"user_email":{"description":"Customer user primary email (readonly) (optional)","type":"string","x-nullable":true},"user_external_id":{"description":"Customer user external id (if platform support) (readonly) (optional)","type":"string","x-nullable":true},"user_id":{"description":"Customer user ID (optional)","format":"uuid","type":"string","x-nullable":true},"user_name":{"description":"Public Customer user Name (readonly) (optional)","type":"string","x-nullable":true},"user_phone":{"description":"Customer user primary phone number (readonly) (optional)","type":"string","x-nullable":true}},"type":"object"},"LoanInstallmentPayment":{"properties":{"amount":{"description":"Installment payment principal amount","format":"float","type":"number","x-nullable":true},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"automatic":{"description":"Automatic debit/repayment of the installment payment","enum":[0,1],"type":"integer","x-nullable":true},"client_notifications":{"description":"Notifying the Client about the processing status installment payment","enum":[0,1],"type":"integer","x-nullable":true},"comment":{"description":"Comment of the non-automatic installment payment (optional)","type":"string","x-nullable":true},"commission_amount":{"description":"Installment payment commission fee amount (readonly)","format":"float","type":"number","x-nullable":true},"fees":{"$ref":"#/definitions/LoanInstallmentPaymentFees","description":"Installment payment commission fees (optional)","x-nullable":true},"id":{"description":"Installment payment ID (readonly)","format":"uuid","type":"string","x-nullable":true},"loan_id":{"description":"Loan ID (readonly)","format":"uuid","type":"string","x-nullable":true},"number":{"description":"Installment payment number (readonly)","type":"integer","x-nullable":true},"overdraft":{"description":"Overdraft allowed for debit/repayment of the installment payment (optional)","enum":[0,1],"type":"integer","x-nullable":true},"preliminary_transaction_id":{"description":"Preliminary Transaction Id (optional, only for first installment payment) (optional)","format":"uuid","type":"string","x-nullable":true},"processed":{"description":"Installment payment processed date and time (readonly) (optional)","format":"date-time","type":"string","x-nullable":true},"processed_by":{"description":"Installment payment processed by (readonly) (optional)","enum":["system","business","customer"],"type":"string","x-nullable":true},"processed_early":{"description":"Operation of an early loan payment flag (readonly) (optional)","enum":[0,1],"type":"integer","x-nullable":true},"scheduled_date":{"description":"Scheduled date of the automatic installment payment (optional)","format":"date","type":"string","x-nullable":true},"status":{"description":"Installment payment status (readonly)","enum":["created","processed","failed"],"type":"string","x-nullable":true},"total_amount":{"description":"Installment payment total amount including principal and commission fee (readonly)","format":"float","type":"number","x-nullable":true},"transaction_id":{"description":"Transaction Id (Finalized transaction Id) (readonly) (optional)","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"LoanInstallmentPaymentFee":{"properties":{"additional_service_id":{"description":"Unique Id of additional service by code (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"amount":{"description":"Fee amount","format":"float","type":"number","x-nullable":true},"code":{"description":"Fee code","type":"string"},"cost":{"description":"Fee cost (for unit of value)","format":"float","type":"number","x-nullable":true},"decimal_digits":{"description":"Number of decimal digits in cost and amount values","type":"integer","x-nullable":true},"service_item_info":{"$ref":"#/definitions/AdditionalService","description":"Additional service info (optional, readonly)","x-nullable":true},"title":{"description":"Fee title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/AdditionalServiceType","description":"Fee type","x-nullable":true},"value":{"description":"Base value for calculate fee cost and amount","format":"float","type":"number","x-nullable":true}},"required":["code"],"type":"object"},"LoanInstallmentPaymentFees":{"items":{"$ref":"#/definitions/LoanInstallmentPaymentFee"},"type":"array"},"LoanInstallmentPaymentOperationRequestData":{"properties":{"comment":{"description":"Operation coment","type":"string","x-nullable":true}},"type":"object"},"LoanInstallmentPayments":{"items":{"$ref":"#/definitions/LoanInstallmentPayment"},"type":"array"},"LoanNotificationMessageSettings":{"properties":{"notify":{"description":"Send notification message","enum":[0,1],"type":"integer","x-nullable":true},"template":{"description":"Notification message template (optional)","type":"string","x-nullable":true},"template_id":{"description":"Message template ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"LoanNotificationSettings":{"items":{"$ref":"#/definitions/LoanNotificationMessageSettings"},"type":"array"},"LoanOperationRequestData":{"properties":{"comment":{"description":"Operation coment","type":"string","x-nullable":true}},"type":"object"},"LoansList":{"items":{"$ref":"#/definitions/Loan"},"type":"array"},"LoansLoyaltySettings":{"properties":{"active":{"default":0,"description":"Active flag","enum":[0,1],"type":"integer","x-nullable":true},"automatic_installment_payments":{"default":1,"description":"Automatic debit/repayment of the scheduled installment payments","enum":[0,1],"type":"integer","x-nullable":true},"client_notifications":{"default":1,"description":"Notifying the Client about the approval, rejection, or deduction of funds under installment payments","enum":[0,1],"type":"integer","x-nullable":true},"notification_emails":{"$ref":"#/definitions/EmailsList","description":"List of the Business’s email addresses to which notifications about Loans will be sent (null value means no notifications)","x-nullable":true},"notification_endpoint_url":{"description":"URL (webhook) to which information about the deduction of a Scheduled Payment will be sent (null value means that the information will not be sent)","type":"string","x-nullable":true},"number_allowed_unpaid_loans":{"description":"The number of allowed current (unpaid) loans for a single Customer (null value means no limits)","maximum":255,"minimum":1,"type":"integer","x-nullable":true},"overdraft_installment_payments":{"default":1,"description":"Overdraft allowed for debit/repayment of the scheduled installment payments","enum":[0,1],"type":"integer","x-nullable":true},"period_begin_month_day":{"default":1,"description":"The day of the month on which the automatic deduction of funds will be made under installment payments (If a day number is specified that exceeds the number of days in the month, for example 31, it will mean the last day of the month)","maximum":31,"minimum":1,"type":"integer","x-nullable":true},"special_account_id":{"description":"Special Account ID","format":"uuid","type":"string","x-nullable":true},"time_zone":{"description":"Time zone","type":"string","x-nullable":true},"total_amount_allowed_unpaid_loans":{"description":"The allowable loan amount for a single Customer, meaning the total of all the Customer’s current (unpaid) loans (null value means no limits)","format":"float","type":"number","x-nullable":true}},"type":"object"},"LoansPaginatedList":{"properties":{"data":{"$ref":"#/definitions/LoansList"},"summary":{"$ref":"#/definitions/LoansSummary"}},"type":"object"},"LoansSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"LoyaltiesList":{"description":"List of Loyalties","items":{"$ref":"#/definitions/Loyalty"},"type":"array","x-nullable":true},"Loyalty":{"properties":{"active":{"description":"Active flag","enum":[0,1],"type":"integer","x-nullable":true},"categories":{"description":"Categories","items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array"},"external_data_access_exists":{"description":"The Loyalty has dedicated data access provided to the external system (optional, readonly)","type":"boolean","x-nullable":true},"id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"legal_info":{"description":"Loyalty legal info","type":"string","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links"},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos"},"privacy_policy_url":{"description":"Loyalty privacy policy link","type":"string","x-nullable":true},"public_description":{"description":"Loyalty public description","type":"string","x-nullable":true},"public_title":{"description":"Loyalty public title","type":"string","x-nullable":true},"title":{"description":"Loyalty title","type":"string","x-nullable":true}},"type":"object"},"LoyaltyCardCategoriesRule":{"properties":{"action_allowed":{"description":"Rule action allowed (to any category or depending on weight)","enum":["any-weight","greater-weight-only","less-weight-only"],"type":"string"},"action_type":{"description":"Rule action dependency type (by some kinds of amount or by sold items)","enum":["category-change-by-amount","category-change-by-item"],"type":"string"},"active":{"default":1,"description":"Rule is active","enum":[0,1],"type":"integer"},"automatic":{"default":1,"description":"Rule applied type (1 - automatic)","enum":[1],"type":"integer"},"card_category_id":{"description":"Card category ID","format":"uuid","type":"string"},"combine":{"default":1,"description":"Combine with other rules flag","enum":[0,1],"type":"integer"},"comment":{"description":"Rule comment","type":"string","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string"},"depends_calc_period":{"$ref":"#/definitions/LoyaltyRuleDependsCalcPeriod","description":"Rule values dependencies period (not applicable for depency 'bonuses-on-account')","x-nullable":true},"depends_excluded_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc do not applied for item categories (if empty - no exceptions)","x-nullable":true},"depends_excluded_items":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc do not applied for items codes (if empty - no exceptions)","x-nullable":true},"depends_included_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc applied for item categories (if empty - applied for any categories)","x-nullable":true},"depends_included_items":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc applied for items codes (if empty - applied for any items)","x-nullable":true},"depends_type":{"$ref":"#/definitions/LoyaltyRuleDependsType","description":"Rule values dependencies type (for category-change-by-amount rule action type available values 'none', 'amount', 'bonuses-earned', 'bonuses-on-account'; for category-change-by-item rule action type available values 'none', 'amount', 'quantity')","x-nullable":true},"excluded_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Rule do not applied for item categories (if empty - no exceptions)"},"excluded_items":{"$ref":"#/definitions/StringValuesList","description":"Rule do not applied for items codes (if empty - no exceptions)"},"id":{"description":"Rule ID","format":"uuid","type":"string","x-nullable":true},"included_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Rule applied for item categories (if empty - applied for any categories)"},"included_items":{"$ref":"#/definitions/StringValuesList","description":"Rule applied for items codes (if empty - applied for any items)"},"items_limit_max":{"default":0,"description":"maximum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"items_limit_min":{"default":0,"description":"minimum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"List of POS where rule is applicable","x-nullable":true},"priority":{"default":0,"description":"Rule priority(0 - the greatest one)","type":"integer"},"scheduled":{"default":0,"description":"Rule is scheduled","enum":[0,1],"type":"integer"},"time_from":{"description":"Rule valid from time (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"time_to":{"description":"Rule valid to time (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"title":{"description":"Rule title","type":"string"},"use_alternative_dependencies_by_items":{"default":0,"description":"Alternative calc by items dependencies usage","enum":[0,1],"type":"integer"},"valid_after":{"description":"Rule valid from date (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"valid_before":{"description":"Rule valid to date (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"value":{"$ref":"#/definitions/CategoriesThresholdsValues","description":"Card categories set based on thresholds","x-nullable":true},"week_days":{"$ref":"#/definitions/WeekDaysList","description":"Rule valid at the days (used if rule is scheduled)","x-nullable":true}},"type":"object"},"LoyaltyCardCategoriesSettings":{"properties":{"apply_rules_when_bonuses_activated_expired":{"default":1,"description":"Apply the rules when bonuses are activated or expired","enum":[0,1],"type":"integer"},"category_set_notification_type":{"default":"none","description":"Card category set or change notification type","enum":["none","push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","incust-messenger","external-system"],"type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"notify_category_change_down":{"default":1,"description":"Notify when a category is changed to a less weight category","enum":[0,1],"type":"integer"},"notify_category_change_up":{"default":1,"description":"Notify when a category is changed to a greater weight category","enum":[0,1],"type":"integer"},"notify_category_initial_setup":{"default":1,"description":"Notify about initial category setup during customer creation","enum":[0,1],"type":"integer"}},"type":"object"},"LoyaltyCategoriesList":{"items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array"},"LoyaltyCategory":{"properties":{"id":{"description":"ID","type":"integer"},"image_url":{"description":"Image URL (optional)","type":"string"},"title":{"description":"Title","type":"string"}},"type":"object"},"LoyaltyCustomerFeedbackSettings":{"properties":{"active":{"default":0,"description":"Feedback system active flag","enum":[0,1],"type":"integer"},"allow_attach_file_for_unauthorized_customer":{"default":0,"description":"Allow unauthorized customers attach files to feedback","enum":[0,1],"type":"integer"},"allow_rating_for_unauthorized_customer":{"default":0,"description":"Allow unauthorized customers leave ratings","enum":[0,1],"type":"integer"},"allow_review_for_unauthorized_customer":{"default":0,"description":"Allow unauthorized customers leave reviews","enum":[0,1],"type":"integer"},"chatbot_feedback_allowed":{"default":"none","description":"Allow leave ratings/reviews in chat-bot","enum":["none","authorized-users-only","all-users"],"type":"string"},"chatbot_feedback_invitation_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Invitation text for chat-bot (multilanguage)"},"chatbot_feedback_source_id":{"description":"Feedback source ID for chat-bot","format":"uuid","type":"string"},"feedback_per_customer_limit":{"default":0,"description":"Maximum allowable number of ratings/reviews from the customer to one feedback source (0 is unlimited).","type":"integer"},"feedback_source_id":{"description":"Feedback source ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"mobile_app_feedback_allowed":{"default":"none","description":"Allow leave ratings/reviews in mobile app","enum":["none","authorized-users-only","all-users"],"type":"string"},"mobile_app_feedback_invitation_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Invitation text for mobile app (multilanguage)"},"mobile_app_feedback_source_id":{"description":"Feedback source ID for mobile app","format":"uuid","type":"string"},"notification_emails":{"description":"Business notification email","type":"string"},"transaction_feedback_message_delay":{"default":0,"description":"Invitation message delay (minutes)","type":"integer"},"transaction_feedback_message_send":{"default":0,"description":"Send invitation to ratings/reviews in mobile app when finalioze transaction","enum":[0,1],"type":"integer"},"transaction_feedback_message_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Invitation message text (multilanguage)"},"transaction_feedback_message_type":{"default":"push-chatbot-viber-sms","description":"Invitation message type","enum":["push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","external-system"],"type":"string"},"transaction_feedback_source_id":{"description":"Feedback source ID for trasnsaction finalize","format":"uuid","type":"string"}},"type":"object"},"LoyaltyCustomersMessageTemplateTestRequestData":{"properties":{"id":{"description":"Message Id","format":"uuid","type":"string"},"language":{"description":"Template language","type":"string"},"template":{"description":"Template","type":"string"}},"required":["id"],"type":"object"},"LoyaltyCustomersMessageTemplateTestResponseData":{"properties":{"error":{"description":"Error in the template","type":"boolean"},"error_string":{"description":"Template error string","type":"string"},"example":{"description":"Rendered template example","type":"string"},"id":{"description":"Message Id","format":"uuid","type":"string"},"language":{"description":"Template language","type":"string"},"template":{"description":"Template","type":"string"}},"type":"object"},"LoyaltyCustomersMessages":{"properties":{"default_template":{"$ref":"#/definitions/MultiLanguageObject","description":"Default message template (multilanguage), used if custom template is empty"},"example":{"$ref":"#/definitions/MultiLanguageObject","description":"Rendered template example"},"group_id":{"description":"Group Id","format":"uuid","type":"string"},"id":{"description":"Message Id","format":"uuid","type":"string"},"sort_order":{"description":"Sort order weight","type":"integer"},"template":{"$ref":"#/definitions/MultiLanguageObject","description":"Custom message template (multilanguage)"},"title":{"description":"Message title","type":"string"}},"type":"object"},"LoyaltyCustomersMessagesGroup":{"properties":{"order_id":{"description":"Payment order Id","format":"uuid","type":"string"},"sort_order":{"description":"Sort order weight","type":"integer"},"title":{"description":"Group title","type":"string"}},"type":"object"},"LoyaltyCustomersMessagesGroupList":{"items":{"$ref":"#/definitions/LoyaltyCustomersMessagesGroup"},"type":"array"},"LoyaltyCustomersMessagesList":{"items":{"$ref":"#/definitions/LoyaltyCustomersMessages"},"type":"array"},"LoyaltyCustomersMessagesValues":{"properties":{"example":{"description":"Example","type":"string"},"id":{"description":"Value Id","format":"uuid","type":"string"},"title":{"description":"Title","type":"string"},"type":{"description":"Type of value","enum":["string","integer","float"],"type":"string"},"value":{"description":"Value","type":"string"}},"type":"object"},"LoyaltyCustomersMessagesValuesList":{"items":{"$ref":"#/definitions/LoyaltyCustomersMessagesValues"},"type":"array"},"LoyaltyDeliveryType":{"properties":{"active":{"description":"Object active flag","enum":[0,1],"type":"integer"},"additional_customer_info":{"$ref":"#/definitions/MultiLanguageObject","description":"Additional customer info (multilanguage)"},"delivery_address_required":{"default":"none","description":"Delivery address required","enum":["none","pos","customer"],"type":"string"},"delivery_date_required":{"description":"Delivery date required","enum":[0,1],"type":"integer"},"delivery_time_required":{"description":"Delivery time required","enum":[0,1],"type":"integer"},"id":{"description":"Delivery type ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"price":{"$ref":"#/definitions/ThresholdsValues","description":"Price values depends of thresholds","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Online store public title (multilanguage)"},"title":{"description":"Title","type":"string"}},"type":"object"},"LoyaltyExternalDataAccess":{"properties":{"api_key":{"description":"API key (readonly)","type":"string","x-nullable":true},"id":{"description":"Access ID","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"scope":{"$ref":"#/definitions/LoyaltyExternalDataAccessScopeList","description":"Data scope","x-nullable":true},"title":{"description":"Access title","type":"string","x-nullable":true}},"type":"object"},"LoyaltyExternalDataAccessList":{"items":{"$ref":"#/definitions/LoyaltyExternalDataAccess"},"type":"array"},"LoyaltyExternalDataAccessScope":{"enum":["fuel","transaction"],"type":"string"},"LoyaltyExternalDataAccessScopeList":{"description":"Data scope","items":{"$ref":"#/definitions/LoyaltyExternalDataAccessScope"},"type":"array","x-nullable":true},"LoyaltyExternalFormsRule":{"properties":{"active":{"description":"Rule active flag","enum":[0,1],"type":"integer","x-nullable":true},"conditions":{"$ref":"#/definitions/LoyaltyExternalFormsRuleConditions","description":"List of rule conditions (optional)","x-nullable":true},"expire_period":{"default":"none","description":"Form expire period","enum":["none","day","month","year","current-day","current-month","current-quarter","current-year"],"type":"string","x-nullable":true},"expire_value":{"description":"Value of form expire","type":"integer"},"external_form_id":{"description":"External Form Id","format":"uuid","type":"string","x-nullable":true},"id":{"description":"Rule Id","format":"uuid","type":"string","x-nullable":true},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"List of POS where rule is applicable","x-nullable":true},"scope":{"default":"all","description":"Rule scope","enum":["all","retail-customers","corporate-customers"],"type":"string","x-nullable":true},"title":{"description":"Rule title","type":"string","x-nullable":true}},"type":"object"},"LoyaltyExternalFormsRuleCondition":{"properties":{"applicable_for_customer":{"$ref":"#/definitions/LoyaltyRuleApplicableForCustomer","default":"identified","description":"Condition applicable for customer type"},"card_category_id":{"description":"Card category ID (optional, for rules with retail-customers and all scope only)","format":"uuid","type":"string","x-nullable":true},"corporate_customer_category_id":{"description":"Corporate customers category ID (optional, for rules with corporate-customers and all scope only)","format":"uuid","type":"string","x-nullable":true},"currency":{"description":"Currency for which applicable rule (related to depends with amount, applicable for any carrencies if empty)","type":"string","x-nullable":true},"depends_type":{"description":"Depends for which applicable rule","enum":["check-amount","item-amount","item-quantity"],"type":"string","x-nullable":true},"goods_items":{"$ref":"#/definitions/LoyaltyExternalFormsRuleConditionItemsCodes","description":"Goods for which applicable rule (applicable for any goods if empty)","x-nullable":true},"id":{"description":"Condition Id","format":"uuid","type":"string","x-nullable":true},"nonblocking":{"default":0,"description":"The condition does not block the transaction","enum":[0,1],"type":"integer","x-nullable":true},"payment_type":{"default":"all","description":"Payment type for which applicable rule","enum":["all","currency","special-account-money","special-account-goods","special-account-punches"],"type":"string","x-nullable":true},"rule_id":{"description":"Rule Id","format":"uuid","type":"string","x-nullable":true},"value":{"description":"Value for which applicable rule (related to depends)","format":"float","type":"number","x-nullable":true}},"type":"object"},"LoyaltyExternalFormsRuleConditionItemsCodes":{"items":{"description":"goods code","type":"string"},"type":"array"},"LoyaltyExternalFormsRuleConditions":{"items":{"$ref":"#/definitions/LoyaltyExternalFormsRuleCondition"},"type":"array"},"LoyaltyExternalFormsRules":{"items":{"$ref":"#/definitions/LoyaltyExternalFormsRule"},"type":"array"},"LoyaltyLinks":{"properties":{"facebook":{"type":"string"},"google":{"type":"string"},"instagram":{"type":"string"},"linkedin":{"type":"string"},"pinterest":{"type":"string"},"twitter":{"type":"string"},"vk":{"type":"string"},"web":{"type":"string"}},"type":"object"},"LoyaltyMultilingual":{"properties":{"active":{"description":"Active flag","enum":[0,1],"type":"integer","x-nullable":true},"categories":{"description":"Categories","items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array"},"id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"legal_info":{"$ref":"#/definitions/MultiLanguageObject","description":"Loyalty legal info","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links"},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos"},"privacy_policy_url":{"$ref":"#/definitions/MultiLanguageObject","description":"Loyalty privacy policy link","x-nullable":true},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Loyalty public description","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Loyalty public title","x-nullable":true},"title":{"description":"Loyalty title","type":"string","x-nullable":true}},"type":"object"},"LoyaltyOnlineStore":{"properties":{"active":{"description":"Object active flag","enum":[0,1],"type":"integer"},"additional_customer_info":{"$ref":"#/definitions/MultiLanguageObject","description":"Additional customer info (multilanguage)"},"cart_expire_days":{"description":"Users cart expire period in days","type":"integer"},"id":{"description":"Online store ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"notification_emails":{"description":"Order status changes notification recipients email list","items":{"description":"Recipient email","type":"string"},"type":"array","x-nullable":true},"payment_type":{"default":"none","description":"Payment in store","enum":["none","bonuses","possible","required"],"type":"string"},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Online store public title (multilanguage)"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"time_zone":{"description":"Time zone ID","type":"string"}},"type":"object"},"LoyaltyPkPassSettings":{"properties":{"background_color":{"description":"The background color (HTML Hex Color Code), used for the background of the front and back of the pass (Loyalty level)","type":"string","x-nullable":true},"foreground_color":{"description":"The foreground color (HTML Hex Color Code), used for the values of fields shown on the front of the pass (Loyalty level)","type":"string","x-nullable":true},"label_color":{"description":"The label color (HTML Hex Color Code), used for the labels of fields shown on the front of the pass (Loyalty level)","type":"string","x-nullable":true},"platform_background_color":{"description":"The background color (HTML Hex Color Code), used for the background of the front and back of the pass (Platform level, readonly)","format":"uuid","type":"string","x-nullable":true},"platform_foreground_color":{"description":"The foreground color (HTML Hex Color Code), used for the values of fields shown on the front of the pass (Platform level, readonly)","format":"uuid","type":"string","x-nullable":true},"platform_label_color":{"description":"The label color (HTML Hex Color Code), used for the labels of fields shown on the front of the pass (Platform level, readonly)","format":"uuid","type":"string","x-nullable":true},"use_individual_settings":{"description":"Are individual settings used for pkpass","type":"boolean"}},"type":"object"},"LoyaltyReferralProgram":{"properties":{"active":{"description":"Object active flag","enum":[0,1],"type":"integer","x-nullable":true},"id":{"description":"Referral program ID","format":"uuid","type":"string","x-nullable":true},"levels":{"description":"Levels of referral program","items":{"$ref":"#/definitions/RefferalProgramLevel"},"type":"array","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Referral program public description (multilanguage)","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Referral program public title (multilanguage)","x-nullable":true},"referral_logo":{"$ref":"#/definitions/ImageObject","description":"Referral program logo object for referral (readonly)","x-nullable":true},"referral_public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Referral program public description for referral (multilanguage)","x-nullable":true},"referral_public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Referral program public title for referral (multilanguage)","x-nullable":true},"referral_reward_bonuses_currency":{"description":"Bonuses currency","type":"string","x-nullable":true},"referral_reward_coupon_batch_id":{"description":"Coupon batch ID","format":"uuid","type":"string","x-nullable":true},"referral_reward_promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"referral_reward_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type","x-nullable":true},"referral_reward_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire","type":"integer","x-nullable":true},"referral_reward_promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"referral_reward_promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type","x-nullable":true},"referral_reward_promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start","type":"integer","x-nullable":true},"referral_reward_special_account_id":{"description":"Special (customer) account ID","format":"uuid","type":"string","x-nullable":true},"referral_reward_type":{"$ref":"#/definitions/BenefitsChargeTypeExtended","default":"none","description":"Referral reward type","x-nullable":true},"referral_reward_value":{"description":"Referral reward value","format":"float","type":"number","x-nullable":true},"referral_type":{"$ref":"#/definitions/ReferralProgramReferralType","description":"Referral type (Users who may be referral)","x-nullable":true},"referrer_logo":{"$ref":"#/definitions/ImageObject","description":"Referral program logo object for referrer (readonly)","x-nullable":true},"referrer_public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Referral program public description for referrer (multilanguage)","x-nullable":true},"referrer_public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Referral program public title for referrer (multilanguage)","x-nullable":true},"referrer_reward_grant_checks_number":{"description":"Value of the number of checks that will be rewarded","type":"integer","x-nullable":true},"referrer_reward_grant_period_type":{"$ref":"#/definitions/RewardGrantPeriodType","description":"Type of time period that will be rewarder","x-nullable":true},"referrer_reward_grant_period_value":{"description":"Value of time period that will be rewarder","type":"integer","x-nullable":true},"referrer_reward_grant_type":{"$ref":"#/definitions/ReferralProgramReferrerRewardGrantType","default":"for-every-check","description":"Referral reward grant type","x-nullable":true},"referrer_reward_items":{"$ref":"#/definitions/GoodsCodes","description":"Referrer reward applicable goods filter (optional)","x-nullable":true},"referrer_reward_promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"referrer_reward_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type","x-nullable":true},"referrer_reward_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire","type":"integer","x-nullable":true},"referrer_reward_promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"referrer_reward_promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type","x-nullable":true},"referrer_reward_promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start","type":"integer","x-nullable":true},"referrer_reward_restricted_by_items":{"description":"Referrer reward restricted by applicable goods","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_special_account_id":{"description":"Special (customer) account ID","format":"uuid","type":"string","x-nullable":true},"referrer_reward_specified_items_amount_only":{"description":"Referrer reward calculated only for the amount of the specified applicable goods (for 'check-percentage' reward type) (optional)","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_specified_items_exclusively_check":{"description":"Referrer reward applied only for checks that contain the specified applicable goods exclusively (optional)","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Referral reward type","x-nullable":true},"referrer_reward_value":{"description":"Referrer reward value","format":"float","type":"number","x-nullable":true},"referrer_reward_value_type":{"$ref":"#/definitions/RewardValueType","description":"Referral reward value type","x-nullable":true},"referrer_type":{"$ref":"#/definitions/ReferralProgramReferrerType","description":"Referrer type (Users who may be referrer)","x-nullable":true}},"type":"object"},"LoyaltyReferralProgramPublic":{"properties":{"active":{"description":"Referral program active flag","enum":[0,1],"type":"integer","x-nullable":true},"code":{"description":"Referral program invitation code","type":"string"},"loyalty":{"$ref":"#/definitions/RefferalProgramLoyalty","description":"Loyalty info (optional)","x-nullable":true},"public_description":{"description":"Referral program public description","type":"string","x-nullable":true},"public_title":{"description":"Referral program public title","type":"string","x-nullable":true},"referral_logo":{"description":"Referral program logo object for referral (optional)","type":"string","x-nullable":true},"referral_public_description":{"description":"Referral program public description for referral (optional)","type":"string","x-nullable":true},"referral_public_title":{"description":"Referral program public title for referral (optional)","type":"string","x-nullable":true},"referral_reward_bonuses_currency":{"description":"Bonuses currency (optional)","type":"string","x-nullable":true},"referral_reward_coupon_batch":{"$ref":"#/definitions/RefferalProgramRewardCouponBatch","description":"Batch info (optional)","x-nullable":true},"referral_reward_promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"referral_reward_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type (optional)","x-nullable":true},"referral_reward_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire (optional)","type":"integer","x-nullable":true},"referral_reward_promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"referral_reward_promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type (optional)","x-nullable":true},"referral_reward_promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start (optional)","type":"integer","x-nullable":true},"referral_reward_special_account":{"$ref":"#/definitions/RefferalProgramRewardSpecialAccount","description":"Referral reward special account info (optional)","x-nullable":true},"referral_reward_type":{"$ref":"#/definitions/BenefitsChargeTypeExtended","description":"Referral reward type (optional)","x-nullable":true},"referral_reward_value":{"description":"Referral reward value (optional)","format":"float","type":"number","x-nullable":true},"referrer_logo":{"description":"Referral program logo URL for referrer (readonly)","type":"string","x-nullable":true},"referrer_public_description":{"description":"Referral program public description for referrer","type":"string","x-nullable":true},"referrer_public_title":{"description":"Referral program public title for referrer","type":"string","x-nullable":true},"referrer_reward_grant_checks_number":{"description":"Value of the number of checks that will be rewarded","type":"integer","x-nullable":true},"referrer_reward_grant_period_type":{"$ref":"#/definitions/RewardGrantPeriodType","description":"Type of time period that will be rewarder","x-nullable":true},"referrer_reward_grant_period_value":{"description":"Value of time period that will be rewarder","type":"integer","x-nullable":true},"referrer_reward_grant_type":{"$ref":"#/definitions/ReferralProgramReferrerRewardGrantType","description":"Referral reward grant type","x-nullable":true},"referrer_reward_items":{"$ref":"#/definitions/GoodsCodes","description":"Referrer reward applicable goods filter (optional)","x-nullable":true},"referrer_reward_levels":{"description":"Levels of referral program","items":{"$ref":"#/definitions/RefferalProgramLevel"},"type":"array","x-nullable":true},"referrer_reward_promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"referrer_reward_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type","x-nullable":true},"referrer_reward_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire","type":"integer","x-nullable":true},"referrer_reward_promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"referrer_reward_promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type","x-nullable":true},"referrer_reward_promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start","type":"integer","x-nullable":true},"referrer_reward_restricted_by_items":{"description":"Referrer reward restricted by applicable goods","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_special_account":{"$ref":"#/definitions/RefferalProgramRewardSpecialAccount","description":"Referrer reward special account info (optional)","x-nullable":true},"referrer_reward_specified_items_amount_only":{"description":"Referrer reward calculated only for the amount of the specified applicable goods (for 'check-percentage' reward type) (optional)","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_specified_items_exclusively_check":{"description":"Referrer reward applied only for checks that contain the specified applicable goods exclusively (optional)","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Referral reward type","x-nullable":true},"referrer_reward_value":{"description":"Referrer reward value","format":"float","type":"number","x-nullable":true},"referrer_reward_value_type":{"$ref":"#/definitions/RewardValueType","description":"Referral reward value type","x-nullable":true},"referrer_user":{"$ref":"#/definitions/RefferalProgramReferrerUser","description":"Referrer user info (optional)","x-nullable":true}},"type":"object"},"LoyaltyRule":{"properties":{"action_type":{"description":"Rule action dependency type (by some kinds of amount or by items)","enum":["discount-percent-by-item","discount-amount-by-item","special-price-by-item","discount-percent-by-check","discount-amount-by-check","charge-percent-by-item","charge-amount-by-item","charge-percent-by-check","charge-amount-by-check","emission-coupon-by-item","emission-coupon-by-check"],"type":"string"},"active":{"default":1,"description":"Rule is active","enum":[0,1],"type":"integer"},"applicable_api_scope":{"$ref":"#/definitions/LoyaltyRuleApplicableApiScope","default":"all","description":"Rule applicable for API type (for automatic and coupon automatic only)"},"applicable_for_customer":{"$ref":"#/definitions/LoyaltyRuleApplicableForCustomer","default":"identified","description":"Rule applicable for customer type"},"applicable_for_sale":{"$ref":"#/definitions/LoyaltyRuleApplicableForSale","default":"all","description":"Rule applicable for sale type"},"apply_when_bonuses_redeemed":{"default":1,"description":"Apply rule when bonus points redeemed","enum":[0,1],"type":"integer"},"apply_when_customers_account_payment":{"default":0,"description":"Apply rule when payments from customer accounts","enum":[0,1],"type":"integer"},"automatic":{"default":1,"description":"Rule applied type (0 - manual, 1 - automatic, 2 - coupon, 3 - display, 4 - corporate manual, 5 - corporate automatic)","enum":[0,1,2,3,4,5],"type":"integer"},"card_category_id":{"description":"Card category ID (optional, for rules with retail scope only)","format":"uuid","type":"string","x-nullable":true},"charge_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Refill object type","x-nullable":true},"combine":{"default":1,"description":"Combine with other rules flag","enum":[0,1],"type":"integer"},"comment":{"description":"Rule comment","type":"string","x-nullable":true},"corporate_customer_category_id":{"description":"Corporate customers category ID (optional, for rules with corporate scope only)","format":"uuid","type":"string","x-nullable":true},"count_bonuses_redeemed_amount":{"description":"Consider redeemed bonuses when calculating the rule value (null if used loyalty settings)","enum":[0,1],"type":"integer","x-nullable":true},"coupon_batch_code":{"description":"Batch code of emitted coupons (optional)","type":"string","x-nullable":true},"coupon_do_not_add_to_wallet":{"default":0,"description":"Do not add emitted coupons to the customer's wallet (optional)","enum":[0,1],"type":"integer"},"depends_calc_period":{"$ref":"#/definitions/LoyaltyRuleDependsCalcPeriod","description":"Rule values dependencies period (not applicable for depency 'bonuses-on-account')","x-nullable":true},"depends_calc_period_related_to_current_category":{"default":0,"description":"Dependencies period limited by current category period","enum":[0,1],"type":"integer"},"depends_excluded_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc do not applied for item categories (if empty - no exceptions)","x-nullable":true},"depends_excluded_items":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc do not applied for items codes (if empty - no exceptions)","x-nullable":true},"depends_included_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc applied for item categories (if empty - applied for any categories)","x-nullable":true},"depends_included_items":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc applied for items codes (if empty - applied for any items)","x-nullable":true},"depends_type":{"$ref":"#/definitions/LoyaltyRuleDependsType","description":"Rule values dependencies type"},"excluded_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Rule do not applied for item categories (if empty - no exceptions)","x-nullable":true},"excluded_items":{"$ref":"#/definitions/StringValuesList","description":"Rule do not applied for items codes (if empty - no exceptions)","x-nullable":true},"id":{"description":"Rule ID","format":"uuid","type":"string","x-nullable":true},"included_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Rule applied for item categories (if empty - applied for any categories)","x-nullable":true},"included_items":{"$ref":"#/definitions/StringValuesList","description":"Rule applied for items codes (if empty - applied for any items)","x-nullable":true},"item_zero_quantity_as_one_quantity":{"default":0,"description":"Interpret zero quantity of an item as one (for item action types only)","enum":[0,1],"type":"integer"},"items_limit_max":{"default":0,"description":"maximum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"items_limit_min":{"default":0,"description":"minimum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"only_once_per_check":{"default":0,"description":"Apply rule only once per check (for coupon automatic only)","enum":[0,1],"type":"integer"},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"List of POS where rule is applicable","x-nullable":true},"priority":{"default":0,"description":"Rule priority(0 - the greatest one)","type":"integer"},"promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type","x-nullable":true},"promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire","type":"integer","x-nullable":true},"promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type","x-nullable":true},"promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start","type":"integer","x-nullable":true},"scheduled":{"default":0,"description":"Rule is scheduled","enum":[0,1],"type":"integer"},"scope":{"$ref":"#/definitions/LoyaltyRuleScope","description":"Rule scope (readonly)","x-nullable":true},"special_account_id":{"description":"Special account ID","type":"string"},"time_from":{"description":"Rule valid from time (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"time_to":{"description":"Rule valid to time (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"title":{"description":"Rule title","type":"string"},"use_alternative_dependencies_by_items":{"default":0,"description":"Alternative calc by items dependencies usage","enum":[0,1],"type":"integer"},"valid_after":{"description":"Rule valid from date (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"valid_before":{"description":"Rule valid to date (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"value":{"$ref":"#/definitions/ThresholdsValues","description":"Values set based on thresholds","x-nullable":true},"week_days":{"$ref":"#/definitions/WeekDaysList","description":"Rule valid at the days (used if rule is scheduled)","x-nullable":true}},"type":"object"},"LoyaltyRuleActionType":{"enum":["discount-percent-by-item","discount-amount-by-item","special-price-by-item","discount-percent-by-check","discount-amount-by-check","charge-percent-by-item","charge-amount-by-item","charge-percent-by-check","charge-amount-by-check","emission-coupon-by-item","emission-coupon-by-check"],"type":"string"},"LoyaltyRuleApplicableApiScope":{"enum":["all","client","terminal"],"type":"string"},"LoyaltyRuleApplicableForCustomer":{"enum":["identified","anonymous","all"],"type":"string"},"LoyaltyRuleApplicableForSale":{"enum":["all","first-only","all-but-first"],"type":"string"},"LoyaltyRuleDependsCalcPeriod":{"enum":["all","check","day","week","month","three-month","year","current-week","past-week","current-month","past-month","current-quarter","past-quarter","current-year","past-year"],"type":"string"},"LoyaltyRuleDependsTimeZone":{"enum":["system","pos"],"type":"string"},"LoyaltyRuleDependsType":{"enum":["none","amount","quantity","bonuses-earned","bonuses-on-account"],"type":"string"},"LoyaltyRuleImplementedBy":{"enum":["automatic-rule","manual-rule","display-rule","coupon"],"type":"string"},"LoyaltyRuleImplementedCalculationType":{"enum":["summarizing","maximum","sequential"],"type":"string"},"LoyaltyRuleList":{"items":{"$ref":"#/definitions/LoyaltyRule"},"type":"array"},"LoyaltyRuleScope":{"enum":["retail","corporate"],"type":"string"},"LoyaltyRulesSettings":{"properties":{"count_bonuses_redeemed_amount_for_charge":{"default":1,"description":"Consider redeemed bonuses when calculating the benefits","enum":[0,1],"type":"integer"},"count_bonuses_redeemed_amount_for_discount":{"default":0,"description":"Consider redeemed bonuses when calculating the discount","enum":[0,1],"type":"integer"},"coupon_rules_usage_type":{"default":"in-cooperation","description":"Coupon rules usage type (exclusively - if coupon rules are applied don't apply any other rules)","enum":["in-cooperation","exclusively"],"type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"manual_rules_usage_type":{"default":"in-cooperation","description":"Manual rules usage type (exclusively - if manual rules are applied don't apply any automatic rules)","enum":["in-cooperation","exclusively"],"type":"string"},"only_one_coupon_rule_per_check":{"default":0,"description":"Apply only one coupon with same rule per check","enum":[0,1],"type":"integer"},"rules_calc_scheme":{"$ref":"#/definitions/LoyaltyRuleImplementedCalculationType","default":"summarizing","description":"Rules calculation and implementation type"}},"type":"object"},"LoyaltySettings":{"properties":{"birthdate_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireTypeBase","description":"Expiration type of birthday gift bonus points"},"birthdate_message_type":{"default":"push-chatbot-viber-sms","description":"Birtday message type","enum":["none","push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","incust-messenger","external-system"],"type":"string"},"bonus_payment_limit":{"description":"Limit bonus points redeem in percentage of check amount","format":"float","type":"number"},"bonus_payment_type":{"description":"Type of payment by bonus points","enum":["full-check","partial","partial-rounded"],"type":"string"},"bonuses_activation_notification_type":{"default":"none","description":"Bonus points activation notification type","enum":["none","push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","incust-messenger","external-system"],"type":"string"},"bonuses_expire_notification_type":{"default":"none","description":"Bonus points expiration notification type","enum":["none","push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","incust-messenger","external-system"],"type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"new_customer_access_type":{"$ref":"#/definitions/CustomerAccessType","default":"full-bonuses-access","description":"New customers access type"},"recommendation_fee_notification_type":{"default":"push-chatbot-viber-sms","description":"Recommendation fee notification type","enum":["none","push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","incust-messenger","external-system"],"type":"string"},"show_customers_questionnaire":{"default":"do-not-show","description":"Automatic show customers questionaries in terminal","enum":["do-not-show","show-only-for-new","show-for-all"],"type":"string"},"standard_bonus_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireTypeBase","description":"Expiration type of standard bonus points"},"transaction_notification_type":{"default":"push-chatbot-viber-sms","description":"Transaction notification type","enum":["none","push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","incust-messenger","external-system"],"type":"string"}},"type":"object"},"Message":{"properties":{"billing_amount":{"description":"Message cost for business","format":"float","type":"number"},"dst_email":{"description":"Destination email","type":"string"},"dst_external_id":{"description":"Destination external id","type":"string"},"dst_phone":{"description":"Destination phone number","type":"string"},"dst_type":{"enum":["system","business","user"],"type":"string"},"external_id":{"description":"Message Id in operator system","type":"string"},"external_status":{"description":"Message status in operator system","type":"string"},"id":{"description":"Message ID","format":"uuid","type":"string"},"message":{"description":"Message body","type":"string"},"message_extended":{"description":"Message HTML/Plain Text extended representation (for email messages, optional if exists)","type":"string"},"readed":{"description":"Message read status","enum":[0,1],"type":"integer"},"src_type":{"enum":["system","business","user"],"type":"string"},"status":{"enum":["wait","sent","delivered","error","rejected","replied"],"type":"string"},"support":{"description":"Message in support scope flag","enum":[0,1],"type":"integer"},"title":{"description":"Subject of message","type":"string"},"type":{"enum":["sms","push","viber","email","incust-messenger","incust-chatbot","external-system","pkpass-message"],"type":"string"},"user_email":{"description":"User email","type":"string"},"user_external_id":{"description":"User external id","type":"string"},"user_id":{"description":"User ID","format":"uuid","type":"string"},"user_name":{"description":"User name","type":"string"},"user_phone":{"description":"User phone number","type":"string"}},"type":"object"},"MessageCustomServiceProvider":{"properties":{"settings":{"$ref":"#/definitions/MessageCustomServiceProviderFields","description":"Provider settings options"},"type":{"description":"Provider type","type":"string"}},"type":"object"},"MessageCustomServiceProviderField":{"properties":{"name":{"description":"Option name","type":"string"},"type":{"description":"Option type (readonly)","enum":["boolean","string","float","integer"],"type":"string"},"value":{"description":"Option value (string representation)","type":"string","x-nullable":true}},"type":"object"},"MessageCustomServiceProviderFields":{"items":{"$ref":"#/definitions/MessageCustomServiceProviderField"},"type":"array"},"MessageResponse":{"properties":{"code":{"description":"Error code","format":"int32","type":"integer"},"description":{"description":"Error description","type":"string"},"message":{"description":"Error message","type":"string"},"recipient":{"description":"Recipien masked address (optional)","type":"string"}},"type":"object"},"MessageSendRequest":{"properties":{"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer"},"duplicate_by_pkpass":{"description":"Duplicate messages to PKPASS","type":"boolean","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","type":"string"},"message":{"description":"Message text","type":"string","x-nullable":true},"type":{"default":"push-chatbot-viber-sms","description":"Message type","enum":["push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","external-system"],"type":"string"},"users":{"$ref":"#/definitions/UserIDs","description":"User IDs"}},"required":["loyalty_id"],"type":"object"},"Messages":{"items":{"$ref":"#/definitions/Message"},"type":"array"},"MessagesPaginatedList":{"properties":{"data":{"items":{"$ref":"#/definitions/Messages"},"type":"array"},"summary":{"$ref":"#/definitions/MessagesSummary"}},"type":"object"},"MessagesSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"MobileAppInfo":{"properties":{"id":{"description":"Payment Id","format":"uuid","type":"string","x-nullable":true},"status":{"$ref":"#/definitions/BankCardExternalPaymentStatus","description":"Payment status","x-nullable":true},"type":{"$ref":"#/definitions/CustomerPaymentSystemType","description":"Payment system type (depends on payment type)","x-nullable":true}},"type":"object"},"MultiLanguageObject":{"description":"ISO language code / Value pairs","properties":{"az":{"type":"string","x-nullable":true},"de":{"type":"string","x-nullable":true},"en":{"type":"string","x-nullable":true},"fr":{"type":"string","x-nullable":true},"pl":{"type":"string","x-nullable":true},"ru":{"type":"string","x-nullable":true},"sk":{"type":"string","x-nullable":true},"uk":{"type":"string","x-nullable":true}},"type":"object"},"News":{"properties":{"active":{"description":"Active flag","enum":[0,1],"type":"integer"},"category_id":{"description":"category ID","format":"uuid","type":"string"},"category_title":{"description":"Category title","type":"string"},"coupon_batches":{"items":{"description":"Coupon batch data","properties":{"id":{"description":"Batch ID","format":"uuid","type":"string"},"title":{"description":"Batch title","type":"string"}},"type":"object"}},"created":{"description":"News date","format":"date-time","type":"string"},"description":{"$ref":"#/definitions/MultiLanguageObject","description":"Description news"},"description_extended":{"$ref":"#/definitions/MultiLanguageObject","description":"Extended description of news"},"id":{"description":"News ID","format":"uuid","type":"string"},"link":{"description":"Url of news","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"photo":{"description":"Url of news photo","type":"string"},"pos_id":{"description":"Pos ID","format":"uuid","type":"string","x-nullable":true},"priority":{"default":0,"description":"News priority(0 - the greatest one)","type":"integer"},"title":{"$ref":"#/definitions/MultiLanguageObject","description":"Title of news"},"type":{"description":"Type of news","enum":["text","html","link"],"type":"string"},"valid_after":{"description":"News activated datetime","format":"date-time","type":"string"},"valid_before":{"description":"News expiration datetime","format":"date-time","type":"string"}},"type":"object"},"NewsList":{"items":{"$ref":"#/definitions/News"},"type":"array"},"NewsMessageSendRequest":{"properties":{"news_id":{"description":"News ID","type":"string"},"type":{"default":"push-chatbot-viber-sms","description":"Message type","enum":["push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","external-system"],"type":"string"},"users":{"$ref":"#/definitions/UserIDs","description":"User IDs"}},"required":["news_id"],"type":"object"},"NewsPaginatedList":{"properties":{"data":{"$ref":"#/definitions/NewsList"},"summary":{"$ref":"#/definitions/NewsSummary"}},"type":"object"},"NewsSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"NotificationsSettingsBusiness":{"properties":{"notify_balance_less_than_by_email":{"description":"Notify if balance less than specified value by Email (readonly if automatic type)","enum":[0,1],"type":"integer"},"notify_balance_less_than_by_push":{"description":"Notify if balance less than specified value by PUSH (readonly if automatic type)","enum":[0,1],"type":"integer"},"notify_balance_less_than_by_sms":{"description":"Notify if balance less than specified value by SMS (readonly if automatic type)","enum":[0,1],"type":"integer"},"notify_balance_less_than_type":{"description":"Low balance notification type","enum":["automatic","manual"],"type":"string"},"notify_balance_less_than_value":{"description":"Balance value for notifications less than (readonly if automatic type)","format":"float","type":"number"},"subscribe_incust_news":{"description":"Subscribe for inCust news","enum":[0,1],"type":"integer"}},"type":"object"},"ObjectIds":{"items":{"description":"Object ID","format":"uuid","type":"string"},"type":"array"},"OdometerUnitType":{"enum":["K","M","H"],"type":"string"},"OperationResult":{"properties":{"error":{"description":"Failed object count (optional)","type":"integer"},"processed":{"description":"Processed object count (optional)","type":"integer"},"skipped":{"description":"Skipped object count (optional)","type":"integer"}},"type":"object"},"Order":{"properties":{"check":{"$ref":"#/definitions/Check","description":"Check object","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"created":{"description":"Created order time","format":"date-time","type":"string","x-nullable":true},"delivered":{"description":"Delivered time","format":"date-time","type":"string","x-nullable":true},"fuel_delivery":{"$ref":"#/definitions/OrderFuelDelivery","description":"Fuel delivery object"},"id":{"description":"Order ID","format":"uuid","type":"string","x-nullable":true},"loyalty":{"$ref":"#/definitions/Loyalty","description":"Loyalty object (optional)","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"number":{"description":"Order number","type":"string","x-nullable":true},"online_store":{"$ref":"#/definitions/LoyaltyOnlineStore","description":"Online store object (optional)","x-nullable":true},"paid":{"description":"Order paid flag","type":"boolean","x-nullable":true},"payment_method":{"description":"Order payment method","enum":["payment-at-checkout","payment-upon-receipt"],"type":"string","x-nullable":true},"pos_id":{"description":"Pos ID","format":"uuid","type":"string","x-nullable":true},"shipping":{"$ref":"#/definitions/Shipping","description":"Shipping object","x-nullable":true},"status":{"description":"Order status","enum":["created","inprocess","delivered","canceled"],"type":"string","x-nullable":true},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"time_zone":{"description":"Time zone","type":"string","x-nullable":true},"transaction":{"description":"Order transactions","items":{"$ref":"#/definitions/Transaction"},"type":"array","x-nullable":true},"type":{"description":"Order type","enum":["online-store","fuel-taxi"],"type":"string","x-nullable":true},"user_email":{"description":"User email","type":"string","x-nullable":true},"user_external_id":{"description":"User external id","type":"string","x-nullable":true},"user_id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"user_name":{"description":"User name","type":"string","x-nullable":true},"user_phone":{"description":"User phone number","type":"string","x-nullable":true}},"type":"object"},"OrderFuelDelivery":{"properties":{"address":{"description":"Delivery address","type":"string","x-nullable":true},"comment":{"description":"Delivery instruction","type":"string","x-nullable":true},"latitude":{"description":"Delivery Latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"longitude":{"description":"Delivery Longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"user_vehicle":{"$ref":"#/definitions/UserVehicle","description":"User vehicle object","x-nullable":true}},"type":"object"},"OrderListItem":{"properties":{"amount":{"format":"double","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer"},"amount_to_pay":{"format":"double","type":"number"},"bonuses_added_amount":{"format":"double","type":"number"},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer"},"bonuses_redeemed_amount":{"format":"double","type":"number"},"comment":{"description":"Comment","type":"string"},"created":{"description":"Created order time","format":"date-time","type":"string"},"created_local":{"description":"Created order local (by POS time zone) time","format":"date-time","type":"string"},"currency":{"description":"Currency ISO code","type":"string"},"delivered":{"description":"Delivered time","format":"date-time","type":"string"},"delivered_local":{"description":"Delivered local (by POS time zone) time","format":"date-time","type":"string"},"delivery_date":{"description":"Preferred delivery date in RFC3339","format":"date","type":"string"},"delivery_id":{"description":"Delivery method ID","format":"uuid","type":"string"},"delivery_pos_id":{"description":"Point of sale ID, at which the product or service will be provided","format":"uuid","type":"string"},"delivery_time":{"description":"Preferred delivery time in RFC3339","type":"string"},"discount_amount":{"format":"double","type":"number"},"fuel_delivery_address":{"description":"Address for fuel delivery","type":"string"},"fuel_delivery_comment":{"description":"Comment/instruction for fuel delivery","type":"string"},"fuel_delivery_latitude":{"description":"GEO Latitude for fuel delivery","format":"double","type":"number"},"fuel_delivery_longitude":{"description":"GEO Longitude for fuel delivery","format":"double","type":"number"},"id":{"description":"Order ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_title":{"description":"Loyalty title","type":"string"},"number":{"description":"Order number","type":"string"},"paid":{"description":"Order paid flag","enum":[0,1],"type":"integer"},"payment_method":{"description":"Order payment method","enum":["payment-at-checkout","payment-upon-receipt"],"type":"string"},"payment_type":{"$ref":"#/definitions/TransactionPaymentType","description":"Payment type"},"pos_id":{"description":"Pos ID","format":"uuid","type":"string"},"services_amount":{"format":"float","type":"number"},"ship_to_id":{"description":"Ship to address ID","format":"uuid","type":"string"},"shipping_amount":{"format":"double","type":"number"},"special_account_currency":{"description":"Special account currency ISO code","type":"string"},"special_account_id":{"description":"Special account ID (if transaction payment in 'special-account', 'corporate-special-account-access', 'retail-special-account-access')","format":"uuid","type":"string"},"special_account_title":{"description":"Special account title","type":"string"},"special_account_type":{"$ref":"#/definitions/SpecialAccountType","description":"Special account type"},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer"},"status":{"description":"Order status","enum":["created","inprocess","delivered","canceled"],"type":"string"},"summary_amount":{"description":"Sum of amount and shipping_amount and services_amount","format":"double","type":"number"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"time_zone":{"description":"Time zone","type":"string"},"type":{"description":"Order type","enum":["online-store","fuel-taxi"],"type":"string"},"user_email":{"description":"User email","type":"string"},"user_external_id":{"description":"User external id (if platform support)","type":"string"},"user_id":{"description":"User ID","format":"uuid","type":"string"},"user_name":{"description":"User name","type":"string"},"user_phone":{"description":"User phone number","type":"string"},"user_vehicle_color":{"description":"User vehicle color","type":"string"},"user_vehicle_id":{"description":"User vehicle Id","format":"uuid","type":"string"},"user_vehicle_model":{"description":"User vehicle model","type":"string","x-nullable":true},"user_vehicle_plate_number":{"description":"User vehicle plate number","type":"string","x-nullable":true},"user_vehicle_type":{"description":"User vehicle type","enum":["car","suv","truck","van","equipment"],"type":"string"}},"type":"object"},"OrderListResult":{"properties":{"data":{"description":"Orders list","items":{"$ref":"#/definitions/OrderListItem"},"type":"array"},"summary":{"properties":{"total_amount":{"description":"Amount of check","format":"float","type":"number"},"total_amount_to_pay":{"description":"Amount to pay","format":"float","type":"number"},"total_bonuses_redeemed_amount":{"description":"Redeemed bonuses amount","format":"float","type":"number"},"total_discount_amount":{"description":"Amount of discount","format":"float","type":"number"},"total_rows_count":{"description":"Total orders count","type":"integer"},"total_services_amount":{"description":"Services amount","format":"float","type":"number"},"total_shipping_amount":{"description":"Shipping amount","format":"float","type":"number"},"total_summary_amount":{"description":"Sum of amount and shipping_amount and services_amount","format":"float","type":"number"}},"type":"object"}},"type":"object"},"POS":{"properties":{"active":{"default":1,"description":"Terminal is active flag","enum":[0,1],"type":"integer"},"additional_services_required":{"default":0,"description":"Is additional services required","enum":[0,1],"type":"integer"},"addresses":{"$ref":"#/definitions/MultiLanguageObject","description":"Address of sale point","x-nullable":true},"catalog_publication_comment":{"description":"Pos catalog publication comment","type":"string","x-nullable":true},"catalog_publication_state":{"$ref":"#/definitions/PosCatalogPublicationState","description":"Pos catalog publication state","x-nullable":true},"categories":{"description":"Categories","items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array","x-nullable":true},"check_item_enter_mode":{"$ref":"#/definitions/CheckItemEnterMode","description":"Pos check items entering mode possibilities"},"country":{"description":"Country code","type":"string","x-nullable":true},"id":{"description":"Point of sales ID","format":"uuid","type":"string"},"latitude":{"description":"GEO Latitude","format":"double","type":"number","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links","x-nullable":true},"longitude":{"description":"GEO Longitude","format":"double","type":"number","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","type":"string"},"maximum_service_distance":{"default":0,"description":"Maximum service distance in km (0 - unlimited)","type":"integer"},"phones":{"$ref":"#/definitions/PhoneNumbersList","description":"Phones of sale point"},"photos":{"$ref":"#/definitions/ImageObjectsList","x-nullable":true},"priority":{"default":0,"description":"Priority","type":"integer"},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Point of sale public description (same as description)","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Point of sale public title (same as title)","x-nullable":true},"time_zone":{"description":"Time zone","type":"string","x-nullable":true},"title":{"description":"POS title","type":"string"},"type":{"$ref":"#/definitions/PosType","description":"Pos type"}},"type":"object"},"PayProOrderData":{"properties":{"encrypted_data":{"description":"encrypted payment data","type":"string","x-nullable":true},"order_id":{"description":"order id","format":"int32","type":"integer","x-nullable":true},"order_reference":{"description":"reference order id","format":"uuid","type":"string","x-nullable":true},"payment_processing_url":{"description":"callback URL for payment status","type":"string","x-nullable":true}},"type":"object"},"PayProOrderRequestData":{"properties":{"amount":{"description":"Payment amount","format":"float","type":"number","x-nullable":true},"currency":{"description":"Currency ISO code","type":"string","x-nullable":true}},"type":"object"},"Payment":{"properties":{"amount":{"description":"To pay amount","format":"float","type":"number","x-nullable":true},"bank_card_external":{"$ref":"#/definitions/BankCardExternalInfo","description":"bank-card-external payment type info (optional)","x-nullable":true},"business_fee_amount":{"description":"Business fee amount (optional, only for 'mobile-app' type)","format":"float","type":"number","x-nullable":true},"change":{"description":"Payment change (optional, only for 'cash' type)","format":"float","type":"number"},"currency":{"description":"Currensy ISO code (depends on transaction type)","type":"string","x-nullable":true},"customer_fee_amount":{"description":"Customer fee amount (optional, only for 'mobile-app' type)","format":"float","type":"number","x-nullable":true},"external_info":{"$ref":"#/definitions/PaymentExternalInfo","description":"payment external system info (optional)","x-nullable":true},"id":{"description":"Payment Id","format":"uuid","type":"string","x-nullable":true},"mobileapp":{"$ref":"#/definitions/MobileAppInfo","description":"mobile-app payment type info (optional)","x-nullable":true},"receipt":{"description":"Payment receipt (optional, only for 'cash' type)","format":"float","type":"number"},"status":{"$ref":"#/definitions/BankCardExternalPaymentStatus","description":"Operation status","x-nullable":true},"type":{"$ref":"#/definitions/PaymentType","description":"Payment type","x-nullable":true}},"type":"object"},"PaymentExternalInfo":{"properties":{"app_version":{"description":"Software version","type":"string","x-nullable":true},"auth_code":{"description":"Authorization code","type":"string","x-nullable":true},"bank_response_code":{"description":"Bank response code","type":"string","x-nullable":true},"batch_number":{"description":"Batch number","type":"string","x-nullable":true},"card_holder_name":{"description":"Card holder name","type":"string","x-nullable":true},"card_issuer_name":{"description":"Card issuer name","type":"string","x-nullable":true},"card_label":{"description":"Card label","type":"string","x-nullable":true},"card_wallet":{"description":"Card wallet like 'Apple Pay', 'Google Pay', 'Masterpass', 'Visa Checkout', etc (optional)","type":"string","x-nullable":true},"cvm":{"description":"Card verification method","type":"string","x-nullable":true},"emv_ac":{"description":"EMV Application Cryptogram","type":"string","x-nullable":true},"emv_aid":{"description":"EMV Application Identifier","type":"string","x-nullable":true},"emv_aid_name":{"description":"EMV Application Name","type":"string","x-nullable":true},"emv_atc":{"description":"EMV Application Transaction Counter","type":"string","x-nullable":true},"emv_iad":{"description":"EMV Issuer Application Data","type":"string","x-nullable":true},"emv_tsi":{"description":"EMV Transaction Status Indicator","type":"string","x-nullable":true},"emv_tvr":{"description":"EMV Transaction Verification Results","type":"string","x-nullable":true},"entry_mode":{"description":"Card entry mode","type":"string","x-nullable":true},"gateway_transaction_id":{"description":"Receipt gateway transaction Id","type":"string","x-nullable":true},"host_timestamp":{"description":"Host timestamp","type":"string","x-nullable":true},"invoice_number":{"description":"Invoice/receipt number","type":"string","x-nullable":true},"merchant_id":{"description":"Merchant Id","type":"string","x-nullable":true},"pan":{"description":"Masked primary account number","type":"string","x-nullable":true},"response_code":{"description":"Response code from host","type":"string","x-nullable":true},"response_code_iso":{"description":"ISO response code","type":"string","x-nullable":true},"response_text":{"description":"Response text from host","type":"string","x-nullable":true},"sequence_number":{"description":"Sequence number","type":"string","x-nullable":true},"system_type":{"$ref":"#/definitions/CustomerPaymentSystemType","description":"Payment system type (depends on payment type)","x-nullable":true},"terminal_id":{"description":"Termsnal Id","type":"string","x-nullable":true},"transaction_name":{"description":"Receipt transaction name","type":"string","x-nullable":true},"transaction_reference_number":{"description":"Receipt transaction reference number","type":"string","x-nullable":true}},"type":"object"},"PaymentType":{"enum":["cash","bank-card","bank-card-external","mobile-app","special-account"],"type":"string"},"PaymentWalletCardBillingDetails":{"description":"Card billing details","properties":{"address":{"description":"Address (depends on the payment system) (optional)","type":"object"},"email":{"description":"User email (optional)","type":"string"},"name":{"description":"User name (optional)","type":"string"},"phone":{"description":"User phone number (optional)","type":"string"}},"type":"object"},"PhoneNumber":{"properties":{"number":{"description":"Phone number","type":"string"}},"type":"object"},"PhoneNumbersList":{"items":{"$ref":"#/definitions/PhoneNumber"},"type":"array"},"PhoneRecord":{"description":"Phone address record","properties":{"compact":{"description":"Phone number (E164 format)","type":"string"},"confirm":{"description":"Phone number is confirmed","enum":[0,1],"type":"integer"},"id":{"description":"Phone id","format":"uuid","type":"string"},"primary":{"description":"Phone number is primary (used for access to account)","enum":[0,1],"type":"integer"},"value":{"description":"Phone number (prettified international format)","type":"string"}},"type":"object"},"PhoneRecordsList":{"items":{"$ref":"#/definitions/PhoneRecord"},"type":"array"},"PinConfirmationResponse":{"properties":{"code":{"description":"Response code","format":"int32","type":"integer"},"description":{"description":"Error description","type":"string"},"info":{"properties":{"channel":{"description":"Confirmation channel","enum":["sms","email","external-system","external-verification-service"],"type":"string"},"code":{"description":"PIN-code (masked)","type":"string"},"length":{"description":"PIN-code length","type":"integer"},"recipient":{"description":"Recipien masked address","type":"string"}},"type":"object"},"message":{"description":"Response message","type":"string"},"recipient":{"description":"Recipien masked address","type":"string"}},"type":"object"},"PosCatalogPublicationState":{"enum":["none","requested","rejected","allowed"],"type":"string"},"PosCustomerFeedbackSettings":{"properties":{"active":{"default":0,"description":"Feedback system active flag","enum":[0,1],"type":"integer"},"feedback_source_id":{"description":"Feedback source ID","format":"uuid","type":"string"},"pos_id":{"description":"POS ID","format":"uuid","type":"string"},"print_feedback_on_check":{"$ref":"#/definitions/CustomerFeedbackPrintOnCheck","default":"none","description":"Print feedback source on check"},"print_feedback_on_check_message_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Invitation message text for printinting on check (multilanguage)"},"transaction_feedback_message_delay":{"default":0,"description":"Invitation message delay (minutes)","type":"integer"},"transaction_feedback_message_send":{"default":0,"description":"Send invitation to ratings/reviews in mobile app when finalioze transaction","enum":[0,1],"type":"integer"},"transaction_feedback_message_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Invitation message text (multilanguage)"},"transaction_feedback_message_type":{"default":"push-chatbot-viber-sms","description":"Invitation message type","enum":["push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","external-system"],"type":"string"},"transaction_feedback_source_id":{"description":"Feedback source ID for trasnsaction finalize","format":"uuid","type":"string"},"use_individual_settings":{"default":0,"description":"Feedback system with individual settings flag","enum":[0,1],"type":"integer"}},"type":"object"},"PosEmbedded":{"properties":{"active":{"description":"Terminal is active flag (optional)","enum":[0,1],"type":"integer","x-nullable":true},"additional_services_required":{"default":0,"description":"Is additional services required (optional)","enum":[0,1],"type":"integer","x-nullable":true},"addresses":{"description":"Address of sale point (optional)","type":"string","x-nullable":true},"categories":{"$ref":"#/definitions/LoyaltyCategoriesList","description":"Categories (optional)","x-nullable":true},"country":{"description":"Country ISO code (optional)","type":"string","x-nullable":true},"id":{"description":"POS Id","format":"uuid","type":"string"},"latitude":{"description":"GEO Latitude (optional)","format":"double","type":"number","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links (optional)","x-nullable":true},"longitude":{"description":"GEO Longitude (optional)","format":"double","type":"number","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (optional)","type":"string","x-nullable":true},"maximum_service_distance":{"default":0,"description":"Maximum service distance in km (0 - unlimited) (optional)","type":"integer","x-nullable":true},"phones":{"$ref":"#/definitions/PhoneNumbersList","description":"Phones of sale point (optional)","x-nullable":true},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos (optional)","x-nullable":true},"public_description":{"description":"Point of sale public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Point of sale public title (optional)","type":"string","x-nullable":true},"title":{"description":"POS Title (optional)","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/PosType","description":"Pos type (optional)","x-nullable":true}},"type":"object"},"PosEmbeddedList":{"description":"List of related POS","items":{"$ref":"#/definitions/PosEmbedded"},"type":"array","x-nullable":true},"PosList":{"description":"List of POS","items":{"$ref":"#/definitions/POS"},"type":"array","x-nullable":true},"PosOnlineStore":{"properties":{"cart_expire_days":{"description":"Users cart expire period in days","type":"integer","x-nullable":true},"notification_emails":{"description":"Order status changes notification recipients email list","items":{"description":"Recipient email","type":"string"},"type":"array","x-nullable":true},"order_type":{"description":"Order type used in schema","enum":["online-store","fuel-taxi"],"type":"string","x-nullable":true},"payment_type":{"description":"Payment in store","enum":["none","bonuses","possible","required"],"type":"string","x-nullable":true},"pos_id":{"description":"POS ID","format":"uuid","type":"string"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"transaction_type":{"description":"Transaction type used in schema","enum":["sale","reserve","authorize-payment"],"type":"string","x-nullable":true}},"type":"object"},"PosType":{"enum":["pos","road-tanker","online-store"],"type":"string"},"PosterApplication":{"properties":{"id":{"description":"Poster Application Id","type":"string"},"name":{"description":"Poster Application Name","type":"string"}},"type":"object"},"PosterApplicationsList":{"items":{"$ref":"#/definitions/PosterApplication"},"type":"array"},"PosterTerminalSettings":{"properties":{"account":{"description":"Poster Company Account","type":"string"},"active":{"description":"Is Poster active for Terminal","type":"boolean"},"application_id":{"description":"Poster Application ID","type":"string"},"client_number":{"description":"Poster Customer Number","type":"string"},"settings":{"description":"Poster Settings","type":"object","x-nullable":true},"spot_id":{"description":"Poster Location Id","type":"integer"},"spot_tablet_id":{"description":"Poster Register Id","type":"integer"}},"type":"object"},"PreConfiguredValues":{"properties":{"color":{"description":"Color","type":"integer","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"id":{"description":"Price ID","format":"uuid","type":"string","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Title (multilanguage) (optional)"},"sort_order":{"description":"Sort order weight","type":"integer","x-nullable":true},"title":{"description":"Title (optional)","type":"string","x-nullable":true},"type":{"description":"Enum('currency', 'volume')","type":"string","x-nullable":true},"value":{"description":"Value","format":"float","type":"number","x-nullable":true}},"type":"object"},"PreProcessingResult":{"properties":{"protection_options":{"$ref":"#/definitions/ProtectionOptions"}},"type":"object"},"PriceCorporateCustomer":{"properties":{"corporate_user":{"$ref":"#/definitions/PriceCorporateUser","description":"Corporate user info"},"id":{"description":"Customer id","format":"uuid","type":"string","x-nullable":true},"name":{"description":"Customer name","type":"string","x-nullable":true},"suspended":{"description":"Customer suspended flag","enum":[0,1],"type":"integer"}},"type":"object"},"PriceCorporateUser":{"description":"Corporate customer","properties":{"email":{"description":"Corporate user Email","type":"string"},"name":{"description":"Corporate user name","type":"string"},"status":{"description":"User status (1 - active, 0 - suspended)","format":"int32","type":"integer"}},"type":"object"},"PriceCustomerSpecialAccount":{"properties":{"active":{"description":"Active flag","enum":[0,1],"type":"integer","x-nullable":true},"available_amount":{"description":"Amount of funds in the account available for using (null if unlimited)(optional, for extended accounts info only)","format":"float","type":"number","x-nullable":true},"corporate_customer":{"$ref":"#/definitions/PriceCorporateCustomer","description":"Corporate customer info (optional)","x-nullable":true},"credit_limit":{"description":"Credit limit (only for 'credit' accounts)","format":"float","type":"number","x-nullable":true},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type","x-nullable":true},"id":{"description":"Customer account id","format":"uuid","type":"string","x-nullable":true},"limits":{"$ref":"#/definitions/AccountLimits","description":"Access limits (optional, for extended accounts info only)","x-nullable":true},"odometer":{"$ref":"#/definitions/DataRequiredType","default":"no","description":"Odometer value needed flag (optional, for \"retail-special-account\" only)"},"retail_customer":{"$ref":"#/definitions/PriceRetailCustomer","description":"Retail customer info (optional)","x-nullable":true},"security_code":{"description":"Additional PIN-code for access to the account (optional, for \"retail-special-account\" only)","type":"string","x-nullable":true}},"type":"object"},"PriceCustomerSpecialAccountAccess":{"properties":{"available_amount":{"description":"Amount of funds in the account available for using (null if unlimited)(optional, for extended accounts info only)","format":"float","type":"number","x-nullable":true},"id":{"description":"Customer access id","format":"uuid","type":"string","x-nullable":true},"limits":{"$ref":"#/definitions/CorporateAccountAccessLimits","description":"Access limits (optional, for extended accounts info only)"},"odometer":{"$ref":"#/definitions/DataRequiredType","default":"no","description":"Odometer value needed flag"},"security_code":{"description":"Additional PIN-code for access to the account","type":"string","x-nullable":true},"vehicle_id":{"$ref":"#/definitions/DataRequiredType","default":"no","description":"Vehicle QR Code / Tag needed flag","x-nullable":true},"vehicle_id_verify":{"default":0,"description":"Vehicle QR Code / Tag needed to be verify by Vehicles/Inventory list","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"PriceExplain":{"description":"Price explain","items":{"$ref":"#/definitions/PriceExplainLevelItem"},"type":"array"},"PriceExplainDetailingItem":{"properties":{"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"exempt":{"description":"Tax/Margin exemption (optional)","type":"boolean","x-nullable":true},"include_in_receipt":{"description":"Include in receipt (optional)","type":"boolean","x-nullable":true},"initial_value":{"description":"Initial value of current price level","format":"float","type":"number","x-nullable":true},"reverse_calculation":{"description":"Reverse calculation used (optional)","type":"boolean","x-nullable":true},"source":{"$ref":"#/definitions/PriceExplainValueSource","description":"Source of value","x-nullable":true},"type":{"$ref":"#/definitions/PriceExplainValueType","description":"Type of value","x-nullable":true},"value":{"description":"Result value of current price level","format":"float","type":"number","x-nullable":true},"value_base_type":{"$ref":"#/definitions/PriceExplainValueBaseType","description":"Option base value type","x-nullable":true},"value_code":{"description":"Value Code if exists (optional)","type":"string","x-nullable":true},"value_id":{"description":"Value Id if exists (optional)","format":"uuid","type":"string","x-nullable":true},"value_option":{"$ref":"#/definitions/PriceExplainOriginValueOption","description":"Original value action if exists (optional)","x-nullable":true},"value_origin":{"description":"Original (base) value if exists (optional)","format":"float","type":"number","x-nullable":true},"value_title":{"description":"Value title if exists (optional)","type":"string","x-nullable":true},"value_type":{"$ref":"#/definitions/PriceExplainOriginValueType","description":"Original value type if exists (optional)","x-nullable":true}},"type":"object"},"PriceExplainLevelItem":{"properties":{"datetime":{"description":"Master price selection date and type (optional)","format":"date-time","type":"string","x-nullable":true},"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"initial_value":{"description":"Initial value of current price level","format":"float","type":"number","x-nullable":true},"level":{"description":"Level number (optional, for first level items only)","type":"integer","x-nullable":true},"level_type":{"description":"Level type (optional, for first level items only)","enum":["price-base","price-including-taxes","price-posted","price-sale","price-corporate-customer","price-retail-customer"],"type":"string"},"modifier":{"$ref":"#/definitions/PriceExplainModifierItem","description":"Value modifier (optional)","x-nullable":true},"source":{"$ref":"#/definitions/PriceExplainValueSource","description":"Source of value","x-nullable":true},"type":{"$ref":"#/definitions/PriceExplainValueType","description":"Type of value","x-nullable":true},"value":{"description":"Result value of current price level","format":"float","type":"number","x-nullable":true},"value_id":{"description":"Value Id if exists (optional)","format":"uuid","type":"string"},"value_title":{"description":"Value title if exists (optional)","type":"string"}},"type":"object"},"PriceExplainModifierItem":{"properties":{"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"detailing":{"description":"Modifier detailing (optional)","items":{"$ref":"#/definitions/PriceExplainDetailingItem"},"type":"array","x-nullable":true},"initial_value":{"description":"Initial value of current price level","format":"float","type":"number","x-nullable":true},"source":{"$ref":"#/definitions/PriceExplainValueSource","description":"Source of value","x-nullable":true},"type":{"$ref":"#/definitions/PriceExplainValueType","description":"Type of value","x-nullable":true},"value":{"description":"Result value of current price level","format":"float","type":"number","x-nullable":true}},"type":"object"},"PriceExplainOriginValueOption":{"enum":["discount","markup"],"type":"string"},"PriceExplainOriginValueType":{"enum":["percentage","amount"],"type":"string"},"PriceExplainValueBaseType":{"enum":["base-price","sale-price","posted-price","price-including-taxes"],"type":"string"},"PriceExplainValueSource":{"enum":["defined","received","calculated","reseted","price-by-item","price-by-special-account","master-price-by-date","price-group-tax-by-item","price-group-tax-default","price-group-tax-default-base","terminal-additional-cost-by-item","terminal-additional-cost-default","terminal-additional-cost-default-base","corporate-account-price-option-by-item","corporate-category-account-price-option-by-item","retail-category-account-price-option-by-item","retail-category-currency-price-option-by-item"],"type":"string"},"PriceExplainValueType":{"enum":["price","base-tax","base-taxes","sales-tax","sales-taxes","margin","margins","option","options"],"type":"string"},"PriceGroup":{"properties":{"base_price_is_sale_price":{"description":"Group base price is the sale price, price that included all taxes and vates (optional)","type":"boolean","x-nullable":true},"currency":{"description":"Group currency ISO code (optional)","type":"string","x-nullable":true},"default_time_zone":{"description":"Price Group default time zone db name (optional)","type":"string"},"id":{"description":"Cost ID","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (optional)","format":"uuid","type":"string","x-nullable":true},"price_decimal_digits":{"description":"Items price decimal digits (optional)","type":"integer"},"terminal_items_master_price_change_allowed":{"default":0,"description":"Allowed change items master prices by Terminal API","enum":[0,1],"type":"integer"},"terminal_items_taxes_change_allowed":{"default":0,"description":"Allowed change items taxes by Terminal API","enum":[0,1],"type":"integer"},"title":{"description":"Tax title","type":"string","x-nullable":true},"used":{"description":"Price Group used by Terminals (optional) (readonly)","type":"boolean","x-nullable":true}},"type":"object"},"PriceGroupItem":{"properties":{"already_exists":{"description":"Item already exists in Price group (optional, for items add operation only) (readonly)","type":"boolean","x-nullable":true},"created":{"description":"Date and time when item added to group","format":"date-time","type":"string"},"item_active":{"description":"Goods item active flag","enum":[0,1],"type":"integer","x-nullable":true},"item_category_id":{"description":"Goods item category ID","format":"uuid","type":"string","x-nullable":true},"item_category_title":{"description":"Goods item category title","type":"string","x-nullable":true},"item_code":{"description":"Goods item code","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string"},"item_title":{"description":"Goods item title","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID (optional) (readonly)","format":"uuid","type":"string"},"master_price":{"$ref":"#/definitions/PriceGroupMasterPrice","description":"Last entered master price (optional)"},"master_prices":{"description":"Master price change history (optional)","items":{"$ref":"#/definitions/PriceGroupMasterPrice"},"type":"array"},"price_group_id":{"description":"Price group ID (optional) (readonly)","format":"uuid","type":"string"},"prices":{"$ref":"#/definitions/PriceGroupPrices","description":"Master price and price including taxes for a given date and time (optional)"},"tax_rates":{"description":"Tax rates (optional)","items":{"$ref":"#/definitions/PriceGroupTaxRate"},"type":"array"}},"required":["item_id"],"type":"object"},"PriceGroupItemsList":{"items":{"$ref":"#/definitions/PriceGroupItem"},"type":"array"},"PriceGroupItemsListPaginated":{"properties":{"data":{"$ref":"#/definitions/PriceGroupItemsList","description":"Price group items list"},"summary":{"$ref":"#/definitions/PriceGroupItemsSummary","description":"Price group items summary"}},"type":"object"},"PriceGroupItemsSummary":{"properties":{"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"},"PriceGroupMasterPrice":{"properties":{"created":{"description":"Date and time when master price created (optional) (readonly)","format":"date-time","type":"string","x-nullable":true},"currency":{"description":"Currency ISO code (readonly)","type":"string","x-nullable":true},"current_price":{"description":"Current price flag (optional) (readonly)","type":"boolean","x-nullable":true},"delete_allowed":{"description":"Delete allowed flag (optional) (readonly)","type":"boolean","x-nullable":true},"id":{"description":"Master price unique ID","format":"uuid","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string"},"price_decimal_digits":{"description":"Items price decimal digits (readonly)","type":"integer","x-nullable":true},"price_group_id":{"description":"Price group ID","format":"uuid","type":"string"},"starting":{"description":"Date and time from which master price is valid","format":"date-time","type":"string","x-nullable":true},"time_zone":{"description":"Starting value time zone db name","type":"string","x-nullable":true},"value":{"description":"Master price value","format":"float","type":"number","x-nullable":true}},"type":"object"},"PriceGroupMatrixAxes":{"properties":{"items":{"description":"Loyalty items included in price groups","items":{"$ref":"#/definitions/PriceGroupItem"}},"price_groups":{"description":"Price groups","items":{"$ref":"#/definitions/PriceGroup"},"type":"array"}},"type":"object"},"PriceGroupMatrixValues":{"properties":{"items":{"description":"Price group items master price data objects","items":{"$ref":"#/definitions/PriceGroupItem"}},"price_group_id":{"description":"Price group ID (optional) (readonly)","format":"uuid","type":"string"}},"type":"object"},"PriceGroupPrices":{"properties":{"calculating_datetime":{"description":"Date and time for which price calculated (readonly)","format":"date-time","type":"string"},"currency":{"description":"Currency ISO code (readonly)","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID (readonly)","format":"uuid","type":"string"},"master_price_value":{"description":"Master price value (readonly)","format":"float","type":"number","x-nullable":true},"price_decimal_digits":{"description":"Items price decimal digits (readonly)","type":"integer"},"price_group_id":{"description":"Price group ID","format":"uuid","type":"string"},"price_including_taxes_value":{"description":"Price including taxes value (readonly)","format":"float","type":"number","x-nullable":true},"time_zone":{"description":"Time zone for which price calculated (readonly)","type":"string"}},"type":"object"},"PriceGroupTax":{"properties":{"currency":{"description":"Currency ISO code (readonly)","type":"string","x-nullable":true},"default_value":{"description":"Tax rate default value in the Price Group","format":"float","type":"number","x-nullable":true},"tax_classification":{"description":"Tax classification","enum":["base-tax","sales-tax"],"type":"string","x-nullable":true},"tax_code":{"description":"Tax code","type":"string","x-nullable":true},"tax_decimal_digits":{"description":"Tax rate decimal digits (readonly)","type":"integer"},"tax_id":{"description":"Tax ID","format":"uuid","type":"string","x-nullable":true},"tax_title":{"description":"Tax title  (readonly)","type":"string","x-nullable":true},"tax_type":{"description":"Tax rate value type  (readonly)","enum":["amount","percentage"],"type":"string","x-nullable":true},"use_base_tax_value":{"description":"Use tax rate default value from base Loyalty taxes in the Price Group","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"PriceGroupTaxRate":{"properties":{"currency":{"description":"Currency ISO code (readonly)","type":"string","x-nullable":true},"default_value":{"description":"Tax rate default value in the Price Group (readonly)","format":"float","type":"number","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string"},"price_group_id":{"description":"Price group ID","format":"uuid","type":"string"},"tax_classification":{"description":"Tax classification","enum":["base-tax","sales-tax"],"type":"string","x-nullable":true},"tax_code":{"description":"Tax code","type":"string","x-nullable":true},"tax_decimal_digits":{"description":"Tax rate decimal digits (readonly)","type":"integer"},"tax_id":{"description":"Tax ID","format":"uuid","type":"string","x-nullable":true},"tax_not_used":{"description":"Tax not used for Item in Price Group","enum":[0,1],"type":"integer","x-nullable":true},"tax_title":{"description":"Tax title (readonly)","type":"string","x-nullable":true},"tax_type":{"description":"Tax rate value type (readonly)","enum":["amount","percentage"],"type":"string","x-nullable":true},"use_base_tax_value":{"description":"Use tax rate default value from base Loyalty taxes in the Price Group (readonly)","enum":[0,1],"type":"integer","x-nullable":true},"value":{"description":"Tax rate actual value in the Price Group","format":"float","type":"number","x-nullable":true}},"type":"object"},"PriceMargins":{"properties":{"terminal_additional_costs":{"description":"Terminal additional costs detailing","items":{"$ref":"#/definitions/PriceExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"PriceOptionBaseValueType":{"enum":["posted-price","price-including-taxes","base-price"],"type":"string"},"PriceOptionDependsByGoods":{"enum":["all","current"],"type":"string"},"PriceOptionDependsCalcPeriod":{"enum":["all","day","week","month","three-month","year","current-week","past-week","current-month","past-month","current-quarter","past-quarter","current-year","past-year"],"type":"string"},"PriceOptionDependsType":{"enum":["none","amount","quantity"],"type":"string"},"PriceOptionType":{"enum":["discount","markup","value","forbidden"],"type":"string"},"PriceOptionValueType":{"enum":["amount","percentage"],"type":"string"},"PriceRetailCustomer":{"properties":{"id":{"description":"Customer id","format":"uuid","type":"string","x-nullable":true},"user":{"$ref":"#/definitions/PriceUser","description":"User info","x-nullable":true}},"type":"object"},"PriceSpecialAccount":{"properties":{"active":{"description":"Active flag","enum":[0,1],"type":"integer","x-nullable":true},"corporate":{"description":"Corporate accoiunt flag","enum":[0,1],"type":"integer","x-nullable":true},"credit_limit":{"description":"Credit limit (only for 'credit' accounts)","format":"float","type":"number","x-nullable":true},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type (only for corporate accounts)","x-nullable":true},"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods","x-nullable":true},"id":{"description":"Special account id","format":"uuid","type":"string","x-nullable":true},"public_title":{"description":"Title to show","type":"string","x-nullable":true},"title":{"description":"Account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type","x-nullable":true},"unconfirmed_redeem_amount":{"description":"The limit of redemption from customer account without an confirmation","format":"float","type":"number","x-nullable":true}},"type":"object"},"PriceTaxes":{"properties":{"base":{"description":"Base taxes detailing","items":{"$ref":"#/definitions/PriceExplainDetailingItem"},"type":"array","x-nullable":true},"sales":{"description":"Sales taxes detailing","items":{"$ref":"#/definitions/PriceExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"PriceType":{"enum":["currency","special-account"],"type":"string"},"PriceUser":{"properties":{"email":{"description":"Email","type":"string","x-nullable":true},"external_id":{"description":"External id","type":"string","x-nullable":true},"name":{"description":"Name","type":"string","x-nullable":true},"phone":{"description":"Phone number","type":"string","x-nullable":true},"status":{"$ref":"#/definitions/UserStatus","description":"User status"}},"type":"object"},"PrimaryIdentifierChangeObject":{"properties":{"pin":{"description":"Verification pin (optional)","type":"string"},"value":{"description":"Primary identifier value or verified token","type":"string"}},"required":["value"],"type":"object"},"ProbeAlarm":{"properties":{"created":{"description":"Alarm rised date and time","format":"date-time","type":"string","x-nullable":true},"type":{"description":"Alarm type","enum":["critical-high-product","critical-low-product","high-product","low-product","high-water"],"type":"string","x-nullable":true}},"type":"object"},"ProbeAlarmList":{"items":{"$ref":"#/definitions/ProbeAlarm"},"type":"array"},"ProbeMeasurements":{"properties":{"alarms":{"$ref":"#/definitions/ProbeAlarmList","description":"Alarms (if present)","x-nullable":true},"controller_id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"processed":{"description":"Measurements time","format":"date-time","type":"string","x-nullable":true},"product_density":{"description":"Value of product density in in 0.1 kg/m3 units","format":"double","type":"number","x-nullable":true},"product_height":{"description":"Value of product height in 0.1 mm","format":"double","type":"number","x-nullable":true},"product_mass":{"description":"Value of product mass in 0.1 kg","format":"double","type":"number","x-nullable":true},"product_tc_volume":{"description":"Value of product temperature compensated volume in liters","format":"double","type":"number","x-nullable":true},"product_ullage":{"description":"Value of product ullage in liters","format":"double","type":"number","x-nullable":true},"product_volume":{"description":"Value of product volume in liters","format":"double","type":"number","x-nullable":true},"status":{"description":"Status of probe and measurements","enum":["OK","Error","Offline"],"type":"string","x-nullable":true},"tank_filling_percentage":{"description":"Value of tank filling in percentage","format":"double","type":"number","x-nullable":true},"tank_id":{"description":"Tank ID","format":"uuid","type":"string","x-nullable":true},"temperature":{"description":"Value product temperature in 0.1 degrees Celcium","format":"double","type":"number","x-nullable":true},"water_height":{"description":"Value of water height in 0.1 mm","format":"double","type":"number","x-nullable":true},"water_volume":{"description":"Value of water volume in liters","format":"double","type":"number","x-nullable":true}},"type":"object"},"ProbeMeasurementsList":{"items":{"$ref":"#/definitions/ProbeMeasurements"},"type":"array"},"PromotionalBonusesExpireType":{"enum":["none","date","day","month"],"type":"string"},"PromotionalBonusesExpireTypeBase":{"enum":["date","day","month"],"type":"string"},"PromotionalBonusesStartingType":{"enum":["immediately","date","day","month"],"type":"string"},"ProtectionOptions":{"properties":{"operation":{"description":"Protected action marker","enum":["signup_request","signup_process","signin_request","signin_process","verification_request","verification_process","identifier_change_request","identifier_change_process"],"type":"string"},"params":{"description":"Protection parameters (depends on protection type)","type":"object"},"protection":{"description":"Protection type ('none' - without protection)","enum":["none","recaptcha"],"type":"string"}},"type":"object"},"QrCodeLegacy":{"description":"Language object","properties":{"qr_v1_allowed":{"description":"QR Code version 1 alloved (readonly)","type":"boolean","x-nullable":true},"qr_v1_user_id":{"description":"User ID for QR code generation (readonly)","type":"string","x-nullable":true}},"type":"object"},"QuestionnaireField":{"properties":{"dictionary_values":{"items":{"description":"Dictionary values","type":"string"},"type":"array","x-nullable":true},"id":{"description":"Field id","type":"string"},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Some help for user","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Title to show (multilanguage)","x-nullable":true},"sort_order":{"description":"Sort order weight","type":"integer"},"title":{"description":"Field title","type":"string","x-nullable":true},"type":{"description":"Field type","enum":["string","integer","money","date","dictionary"],"type":"string"},"value_field_name":{"description":"Field value key name (readonly)","type":"string"}},"type":"object"},"ReceiptLegalInfo":{"properties":{"description":{"description":"Description","type":"string","x-nullable":true},"details_for_receipt":{"description":"Legal Info for receipt","type":"string","x-nullable":true},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Logos","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true}},"type":"object"},"ReferencedPos":{"properties":{"children":{"$ref":"#/definitions/PosEmbeddedList","x-nullable":true},"parents":{"$ref":"#/definitions/PosEmbeddedList","x-nullable":true}},"type":"object"},"ReferencedPosContainer":{"properties":{"order_processing":{"$ref":"#/definitions/ReferencedPos","description":"Order processing POS","x-nullable":true}},"type":"object"},"ReferralProgram":{"properties":{"active":{"description":"Referral program active flag","enum":[0,1],"type":"integer","x-nullable":true},"description":{"description":"Description (optional)","type":"string","x-nullable":true},"referral_description":{"description":"Referral program public description for referral (optional)","type":"string","x-nullable":true},"referral_logo":{"$ref":"#/definitions/ImageObject","description":"Referral program logo object for referral (optional)","x-nullable":true},"referral_reward_bonuses_currency":{"description":"Bonuses currency (optional)","type":"string","x-nullable":true},"referral_reward_coupon_batch":{"$ref":"#/definitions/RefferalProgramRewardCouponBatch","description":"Batch info (optional)","x-nullable":true},"referral_reward_promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"referral_reward_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type (optional)","x-nullable":true},"referral_reward_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire (optional)","type":"integer","x-nullable":true},"referral_reward_promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (by default, based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"referral_reward_promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type (optional)","x-nullable":true},"referral_reward_promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start (optional)","type":"integer","x-nullable":true},"referral_reward_special_account":{"$ref":"#/definitions/RefferalProgramRewardSpecialAccount","description":"Special account info (optional)","x-nullable":true},"referral_reward_type":{"$ref":"#/definitions/BenefitsChargeTypeExtended","description":"Referral reward type (optional)","x-nullable":true},"referral_reward_value":{"description":"Referral reward value (optional)","format":"float","type":"number","x-nullable":true},"referral_title":{"description":"Referral program public title for referral (optional)","type":"string","x-nullable":true},"referrer_description":{"description":"Referral program public description for referrer (optional)","type":"string","x-nullable":true},"referrer_logo":{"$ref":"#/definitions/ImageObject","description":"Referral program logo object for referrer (optional)","x-nullable":true},"referrer_reward_grant_checks_number":{"description":"Value of the number of checks that will be rewarded (optional)","type":"integer","x-nullable":true},"referrer_reward_grant_period_type":{"$ref":"#/definitions/RewardGrantPeriodType","description":"Type of time period that will be rewarder (optional)","x-nullable":true},"referrer_reward_grant_period_value":{"description":"Value of time period that will be rewarder (optional)","type":"integer","x-nullable":true},"referrer_reward_grant_type":{"$ref":"#/definitions/ReferralProgramReferrerRewardGrantType","description":"Referral reward grant type (optional)","x-nullable":true},"referrer_reward_items":{"$ref":"#/definitions/GoodsCodes","description":"Referrer reward applicable goods filter (optional)","x-nullable":true},"referrer_reward_levels":{"description":"Levels of referral program (optional)","items":{"$ref":"#/definitions/RefferalProgramLevel"},"type":"array","x-nullable":true},"referrer_reward_promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"referrer_reward_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type (optional)","x-nullable":true},"referrer_reward_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire (optional)","type":"integer","x-nullable":true},"referrer_reward_promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (depends on the Business settings; by default, it is based on the UTC time zone) (optional)","format":"date","type":"string","x-nullable":true},"referrer_reward_promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type (optional)","x-nullable":true},"referrer_reward_promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start (optional)","type":"integer","x-nullable":true},"referrer_reward_restricted_by_items":{"description":"Referrer reward restricted by applicable goods","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_special_account":{"$ref":"#/definitions/RefferalProgramRewardSpecialAccount","description":"Special account info (optional)","x-nullable":true},"referrer_reward_specified_items_amount_only":{"description":"Referrer reward calculated only for the amount of the specified applicable goods (for 'check-percentage' reward type) (optional)","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_specified_items_exclusively_check":{"description":"Referrer reward applied only for checks that contain the specified applicable goods exclusively (optional)","enum":[0,1],"type":"integer","x-nullable":true},"referrer_reward_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Referral reward type (optional)","x-nullable":true},"referrer_reward_value":{"description":"Referrer reward value (optional)","format":"float","type":"number","x-nullable":true},"referrer_reward_value_type":{"$ref":"#/definitions/RewardValueType","description":"Referral reward value type (optional)","x-nullable":true},"referrer_title":{"description":"Referral program public title for referrer (optional)","type":"string","x-nullable":true},"title":{"description":"Title (optional)","type":"string","x-nullable":true}},"type":"object"},"ReferralProgramAccountsBenefits":{"properties":{"amount":{"description":"Amount","format":"double","type":"number","x-nullable":true},"currency":{"description":"Currency ISO code (optional)","type":"string","x-nullable":true},"currency_name":{"description":"Currency name","type":"string","x-nullable":true},"id":{"type":"string","x-nullable":true},"title":{"type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Type of account","x-nullable":true}},"type":"object"},"ReferralProgramBonusesBenefits":{"properties":{"amount":{"description":"Amount","format":"double","type":"number","x-nullable":true},"currency":{"description":"Сurrency code","type":"string","x-nullable":true},"currency_name":{"type":"string"}},"type":"object"},"ReferralProgramChain":{"properties":{"loyalty_id":{"description":"Loyalty Id","format":"uuid","type":"string","x-nullable":true},"referrals":{"description":"Referrals list","items":{"$ref":"#/definitions/ReferralProgramChainNode"},"type":"array","x-nullable":true}},"type":"object"},"ReferralProgramChainNode":{"properties":{"invitation_accepted":{"description":"Invitation accepted","type":"boolean","x-nullable":true},"invitation_accepted_dt":{"description":"Invitation accepted date and time","format":"date-time","type":"string","x-nullable":true},"invitation_confirmed":{"description":"Invitation confirmed by sale transaction","type":"boolean","x-nullable":true},"invitation_confirmed_dt":{"description":"Invitation confirmed by sale transaction","format":"date-time","type":"string","x-nullable":true},"level":{"description":"Level number (optional)","type":"integer","x-nullable":true},"referrals":{"items":{"$ref":"#/definitions/ReferralProgramChainNode","description":"Referrals list (optional)","type":"object"},"type":"array","x-nullable":true},"referrer_user_id":{"description":"Referrer User ID","format":"uuid","type":"string","x-nullable":true},"rewards":{"$ref":"#/definitions/ReferralProgramCustomerBenefits","description":"Rewards summary info (optiona)","x-nullable":true},"type":{"description":"Type","enum":["referrer","referral"],"type":"string","x-nullable":true},"user_email":{"description":"User email","type":"string","x-nullable":true},"user_external_id":{"description":"User external id (optional, if platform support)","type":"string","x-nullable":true},"user_id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"user_name":{"description":"User name","type":"string","x-nullable":true},"user_phone":{"description":"User phone number","type":"string","x-nullable":true}},"type":"object"},"ReferralProgramCode":{"properties":{"code":{"description":"Referral code","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"}},"type":"object"},"ReferralProgramCustomerBenefits":{"properties":{"accounts":{"description":"Special account info","items":{"$ref":"#/definitions/ReferralProgramAccountsBenefits"},"type":"array","x-nullable":true},"bonuses":{"description":"The bonuses info","items":{"$ref":"#/definitions/ReferralProgramBonusesBenefits"},"type":"array","x-nullable":true}},"type":"object"},"ReferralProgramLevelSummary":{"properties":{"confirmed_referrals_count":{"description":"Total referrals count who confirmed invitation by sale transaction","type":"integer","x-nullable":true},"level":{"description":"Level number","type":"integer","x-nullable":true},"referrals_count":{"description":"Total referrals count who accepted invitation","type":"integer","x-nullable":true},"rewards":{"$ref":"#/definitions/ReferralProgramCustomerBenefits","description":"Rewards summary info"}},"type":"object"},"ReferralProgramReferralType":{"enum":["not-in-business-customers","not-making-purchases"],"type":"string"},"ReferralProgramReferrerRewardGrantType":{"enum":["none","for-every-check","for-valued-first-checks","for-valued-period-time"],"type":"string"},"ReferralProgramReferrerType":{"enum":["all-users","users-who-made-purchases"],"type":"string"},"ReferralProgramSummary":{"properties":{"confirmed_referrals_count":{"description":"Total referrals count who confirmed invitation by sale transaction","type":"integer","x-nullable":true},"levels":{"items":{"$ref":"#/definitions/ReferralProgramLevelSummary","description":"Level summary info"},"type":"array"},"loyalty_id":{"description":"Loyalty Id","format":"uuid","type":"string","x-nullable":true},"referrals_count":{"description":"Total referrals count who accepted invitation","type":"integer","x-nullable":true},"referrer_user":{"$ref":"#/definitions/RefferalProgramReferrerUser","description":"Referrer user info (optional)"},"rewards":{"$ref":"#/definitions/ReferralProgramCustomerBenefits","description":"Rewards summary info"}},"type":"object"},"RefferalProgramLevel":{"properties":{"level":{"description":"Level number`","type":"integer"},"value":{"description":"Reward value (optional, if value_depends_type is 'none')","format":"float","type":"number","x-nullable":true},"value_depends_matrix":{"$ref":"#/definitions/ThresholdsValues","description":"Reward value depends on value matrix, threshold value must be 1 or greater (optional, if value_depends_type is not 'none')","x-nullable":true},"value_depends_type":{"default":"none","description":"Reward value depends on","enum":["none","level-referrals-number","level-referrals-sale-number"],"type":"string","x-nullable":true}},"type":"object"},"RefferalProgramLoyalty":{"properties":{"categories":{"description":"Categories","items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array"},"id":{"description":"Loyalty ID","format":"uuid","type":"string"},"legal_info":{"description":"Loyalty legal info","type":"string"},"links":{"$ref":"#/definitions/LoyaltyLinks"},"photos":{"$ref":"#/definitions/ImageObjectsList"},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"Points of sale","x-nullable":true},"privacy_policy_url":{"description":"Loyalty privacy policy link","type":"string"},"public_description":{"description":"Loyalty public description","type":"string","x-nullable":true},"public_title":{"description":"Loyalty public title","type":"string","x-nullable":true}},"type":"object"},"RefferalProgramReferrerUser":{"properties":{"email":{"description":"User email","type":"string","x-nullable":true},"exists":{"description":"Referrer user exists","type":"boolean"},"external_id":{"description":"User external id (optional, if platform support)","type":"string","x-nullable":true},"id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"name":{"description":"User name","type":"string","x-nullable":true},"phone":{"description":"User phone","type":"string","x-nullable":true}},"type":"object"},"RefferalProgramRewardCouponBatch":{"properties":{"active":{"description":"Coupons active flag","enum":[0,1],"type":"integer","x-nullable":true},"code":{"description":"Coupon batch code","type":"string","x-nullable":true},"description":{"description":"Coupon batch description","type":"string","x-nullable":true},"id":{"description":"Coupon batch ID","format":"uuid","type":"string","x-nullable":true},"image":{"description":"Coupon batch image URL (optional)","format":"url","type":"string","x-nullable":true},"title":{"description":"Coupon batch title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/CouponType","description":"Type of coupon","x-nullable":true}},"type":"object"},"RefferalProgramRewardSpecialAccount":{"properties":{"id":{"description":"Account ID","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Account title","type":"string","x-nullable":true}},"type":"object"},"RelatedTerminalsSettings":{"properties":{"transaction_cancel":{"description":"Transactions cancel operation allowed","enum":[0,1],"type":"integer"},"transaction_finalize":{"description":"Transactions finalize operation allowed","enum":[0,1],"type":"integer"},"transaction_info":{"description":"Access to the transactions information","enum":[0,1],"type":"integer"},"transaction_list":{"description":"Access to the transactions list","enum":[0,1],"type":"integer"},"transaction_receipt":{"description":"Access to the transactions receipt","enum":[0,1],"type":"integer"}},"type":"object"},"RetailCustomerQuestionnaire":{"properties":{"detailing":{"description":"Detailing of questionnaire fields (readonly)","items":{"$ref":"#/definitions/CustomerQuestionnaireFieldEmbedded"},"type":"array","x-nullable":true}},"type":"object"},"RewardGrantPeriodType":{"enum":["day","month"],"type":"string"},"RewardValueType":{"enum":["check-percentage","fixed-amount"],"type":"string"},"RouteOperation":{"properties":{"assistance_type":{"description":"Assistance trouble type (only if status is 'customer-assistance-needed')","enum":["fuel-cap-locked","vehicle-not-found"],"type":"string","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"details":{"$ref":"#/definitions/RouteOperationDetails","description":"Operation details (depends on type)","x-nullable":true},"id":{"description":"Operation Id","type":"string"},"route_id":{"description":"Route Id","type":"string"},"scheduled":{"description":"Scheduled time in HH:mm format","type":"string","x-nullable":true},"status":{"description":"Operation status","enum":["pending","processed","failed","canceled","shipping","customer-assistance-needed"],"type":"string"},"transaction_id":{"description":"Transaction Id (Finalized transaction Id)","format":"uuid","type":"string"},"type":{"description":"Operation type","enum":["sale-fuel-to-tank","fuel-taxi-order-delivery","online-store-order-delivery"],"type":"string"}},"type":"object"},"RouteOperationDetails":{"properties":{"order":{"$ref":"#/definitions/Order","description":"Order object (for 'fuel-taxi-order-delivery', 'online-store-order-delivery' types)","x-nullable":true},"product_volume":{"description":"Current product volume (for 'sale-fuel-to-tank' type)","format":"float","type":"number","x-nullable":true},"quantity":{"description":"Quantity which will be fill (for 'sale-fuel-to-tank' type)","format":"float","type":"number","x-nullable":true},"tank":{"$ref":"#/definitions/Tank","description":"Tank object (for 'sale-fuel-to-tank' type)","x-nullable":true},"tank_id":{"description":"Tank Id (for 'sale-fuel-to-tank' type)","type":"string","x-nullable":true}},"type":"object"},"RouteOperationsCount":{"properties":{"canceled":{"type":"integer","x-nullable":true},"failed":{"type":"integer","x-nullable":true},"pending":{"type":"integer","x-nullable":true},"processed":{"type":"integer","x-nullable":true},"shipping":{"type":"integer","x-nullable":true}},"type":"object"},"RouteTerminal":{"properties":{"active":{"default":1,"description":"Route is active flag","enum":[0,1],"type":"integer"},"comment":{"description":"Comment","type":"string","x-nullable":true},"date":{"description":"Route date in format YYYY-MM-DD (if null or not exists - create route on current date)","format":"date","type":"string","x-nullable":true},"id":{"description":"Route id","format":"uuid","type":"string"},"operations_count":{"$ref":"#/definitions/RouteOperationsCount","description":"Operations count by status","x-nullable":true},"terminal_id":{"description":"Terminal Id","format":"uuid","type":"string","x-nullable":true},"terminal_title":{"description":"Terminal title","type":"string","x-nullable":true},"terminal_type":{"$ref":"#/definitions/TerminalType","description":"Terminal type","x-nullable":true}},"type":"object"},"RuleCalculationBaseData":{"properties":{"amount":{"description":"Check amount","format":"float","type":"number","x-nullable":true},"bonuses_redeemed_amount":{"description":"Check bonus points redeem amount","format":"float","type":"number","x-nullable":true}},"type":"object"},"RuleCalculationBaseItemData":{"properties":{"amount":{"description":"Item amount","format":"float","type":"number","x-nullable":true},"bonuses_redeemed_amount":{"description":"Item total bonus points redeemed calculated by check","format":"float","type":"number","x-nullable":true},"index":{"description":"Check item index","format":"int32","type":"integer","x-nullable":true},"price":{"description":"Item price","format":"float","type":"number","x-nullable":true},"quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"unit_bonuses_redeemed_amount":{"description":"Item unit bonus points redeemed calculated by check","format":"float","type":"number","x-nullable":true}},"type":"object"},"RuleImplementationData":{"properties":{"calculated_result":{"$ref":"#/definitions/RuleImplementationResultData","description":"Rule calculated result (optional)","x-nullable":true},"coupon":{"$ref":"#/definitions/CheckCoupon","description":"Redeemed coupon that fires the rule (optional, only for implemented by 'coupon')","x-nullable":true},"dependencies_time_zone":{"$ref":"#/definitions/LoyaltyRuleDependsTimeZone","x-nullable":true},"dependencies_time_zone_value":{"type":"string","x-nullable":true},"depends_amount":{"description":"Amount/value, according to the rule dependency type, on which the rule was triggered (optional)","format":"float","type":"number","x-nullable":true},"depends_calc_period":{"$ref":"#/definitions/LoyaltyRuleDependsCalcPeriod","x-nullable":true},"depends_type":{"$ref":"#/definitions/LoyaltyRuleDependsType","description":"Rule dependency type value (optional)","x-nullable":true},"depends_user_category_id":{"description":"Customer category ID, according to the rule dependency type, on which the rule was triggered (optional)","format":"uuid","type":"string","x-nullable":true},"depends_user_category_valid_from":{"description":"Customer category valid from date and time, according to the rule dependency type, on which the rule was triggered (optional)","format":"datetime","type":"string","x-nullable":true},"implemented_by":{"$ref":"#/definitions/LoyaltyRuleImplementedBy","description":"Implemented by","x-nullable":true},"implemented_calculation_type":{"$ref":"#/definitions/LoyaltyRuleImplementedCalculationType","description":"Rules calculation and implementation type","x-nullable":true},"result":{"$ref":"#/definitions/RuleImplementationResultData","description":"Rule implemented result","x-nullable":true}},"type":"object"},"RuleImplementationResultData":{"properties":{"bonuses_added":{"description":"Bonuses added (optional)","items":{"$ref":"#/definitions/BonusAdded"},"type":"array","x-nullable":true},"calculation_base":{"$ref":"#/definitions/RuleCalculationBaseData","description":"Calculation base data","x-nullable":true},"discount":{"description":"Discount amount (optional)","format":"float","type":"number","x-nullable":true},"emitted_coupons":{"description":"Emitted coupons (optional)","items":{"$ref":"#/definitions/CheckCoupon"},"type":"array","x-nullable":true},"error":{"description":"Implementation error (optional)","type":"string","x-nullable":true},"error_code":{"description":"Implementation error code (optional)","format":"int32","type":"integer","x-nullable":true},"items":{"description":"Result by items (optional)","items":{"$ref":"#/definitions/RuleImplementationResultItemData"},"type":"array","x-nullable":true},"special_accounts_charges":{"description":"Special account charges (optional)","items":{"$ref":"#/definitions/SpecialAccountCharge"},"type":"array","x-nullable":true}},"type":"object"},"RuleImplementationResultItemData":{"properties":{"amount":{"description":"Rule amount for item row","format":"float","type":"number","x-nullable":true},"calculation_base":{"$ref":"#/definitions/RuleCalculationBaseItemData","description":"Calculation base data","x-nullable":true},"unit_amount":{"description":"Rule amount for item unit row (optional)","format":"float","type":"number","x-nullable":true}},"type":"object"},"Shipping":{"properties":{"delivery":{"$ref":"#/definitions/LoyaltyDeliveryType","description":"Delivery"},"delivery_date":{"description":"Preferred delivery date in RFC3339","format":"date","type":"string"},"delivery_time":{"description":"Preferred delivery time in RFC3339","type":"string"},"pos":{"$ref":"#/definitions/POS","description":"Point of sale, at which the product or service will be provided"},"ship_to":{"$ref":"#/definitions/UserShipToAddress","description":"Ship to address"}},"type":"object"},"SignInRequestData":{"properties":{"login":{"description":"User phone number/email or verified object token. Minimum 3 chars","minLength":3,"type":"string"},"password":{"description":"User password","type":"string","x-nullable":true}},"required":["login"],"type":"object"},"SignUpRequestData":{"properties":{"country":{"description":"User country","type":"string","x-nullable":true},"login":{"description":"User email or verified object token. Minimum 3 chars","minLength":3,"type":"string","x-nullable":true},"name":{"description":"User public name","type":"string","x-nullable":true},"password":{"description":"User login password","type":"string","x-nullable":true},"phone":{"description":"User phone number or verified object token","type":"string","x-nullable":true},"pincode":{"description":"Secure pin code","type":"string","x-nullable":true}},"type":"object"},"SocialIdentityProviderRecord":{"description":"Social network record","properties":{"id":{"description":"Social Identity Providers unique identifier","type":"string"},"type":{"description":"Social Identity Provider type","enum":["google"],"type":"string"}},"type":"object"},"SocialIdentityProviderRecordsList":{"items":{"$ref":"#/definitions/SocialIdentityProviderRecord"},"type":"array"},"SortDirection":{"enum":["asc","desc"],"type":"string"},"SpecialAccount":{"properties":{"active":{"description":"Active flag","enum":[0,1],"type":"integer","x-nullable":true},"corporate":{"description":"Corporate accoiunt flag","enum":[0,1],"type":"integer","x-nullable":true},"credit_limit":{"description":"Credit limit (only for 'credit' accounts) (optional)","format":"float","type":"number","x-nullable":true},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type (only for corporate accounts) (optional)","x-nullable":true},"currency":{"description":"Currensy ISO code (optional)","type":"string","x-nullable":true},"currency_name":{"description":"Currensy name (optional)","type":"string","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods (optional)","x-nullable":true},"id":{"description":"Account id","type":"string","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Title to show (multilanguage) (optional)","x-nullable":true},"title":{"description":"Account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type","x-nullable":true},"unconfirmed_redeem_amount":{"description":"The limit of redemption from customer account without an confirmation (optional)","format":"float","type":"number","x-nullable":true}},"type":"object"},"SpecialAccountCharge":{"properties":{"activity_id":{"description":"Activity ID (optional, check only)","format":"uuid","type":"string","x-nullable":true},"amount":{"description":"Charge amount","format":"float","type":"number"},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"id":{"description":"Special account id","format":"uuid","type":"string"},"object_id":{"description":"Reference object ID, up to 36 chars (optional)","maxLength":36,"type":"string","x-nullable":true},"object_type":{"$ref":"#/definitions/BenefitsTopUpReferenceObjectType","description":"Reference object type (optional)","x-nullable":true},"title":{"description":"Title (optional)","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type"}},"required":["amount"],"type":"object"},"SpecialAccountCreditType":{"enum":["debit","credit","credit-unlimited"],"type":"string"},"SpecialAccountOperationObject":{"properties":{"amount":{"description":"Amount transaction","format":"float","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value (optional)","type":"integer","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (optional)","type":"integer","x-nullable":true},"check_services":{"$ref":"#/definitions/CheckServices","description":"Services added on check (optional)","x-nullable":true},"comment":{"description":"Transaction comment","type":"string","x-nullable":true},"message":{"description":"Transaction message template","type":"string","x-nullable":true},"skip_message":{"default":false,"description":"Skip notifications","type":"boolean","x-nullable":true},"special_account_id":{"description":"Special account ID","type":"string"},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value (optional)","type":"integer","x-nullable":true},"terminal_id":{"description":"Terminal ID","type":"string"},"users":{"$ref":"#/definitions/UserIDs","x-nullable":true}},"required":["special_account_id","terminal_id"],"type":"object"},"SpecialAccountOperationType":{"enum":["special-account-refill","special-account-write-offs","special-account-adjustment"],"type":"string"},"SpecialAccountType":{"enum":["money","goods","punches"],"type":"string"},"SpecialAccountsList":{"items":{"$ref":"#/definitions/SpecialAccount"},"type":"array"},"StaffSignInRequestData":{"properties":{"auth_code":{"description":"Staff auth code","type":"string"},"comment":{"type":"string","x-nullable":true}},"required":["auth_code"],"type":"object"},"StaffSignOutRequestData":{"properties":{"comment":{"type":"string","x-nullable":true}},"type":"object"},"StringValuesList":{"items":{"description":"Value","type":"string"},"type":"array"},"StripeBusinessPaymentData":{"properties":{"id":{"description":"Stripe payment object Id","type":"string"},"integration_type":{"description":"Integration type used for payment","enum":["checkout","elements"],"type":"string"},"secret":{"description":"Stripe payment object client secret (for 'elements' integration only)","type":"string"},"url":{"description":"Redirect url for Stripe payment page (for 'checkout' integration only)","type":"string"}},"type":"object"},"StripeBusinessPaymentNewInitialData":{"properties":{"amount":{"description":"Amount of payment","format":"float","type":"number"},"cancel_url":{"description":"The URL to which Stripe should send customers when payment is canceled (for 'checkout' integration only)","type":"string"},"currency":{"description":"currency","type":"string"},"integration_type":{"default":"elements","description":"Integration type used for payment","enum":["checkout","elements"],"type":"string"},"save_for_future_use":{"description":"Process check and refill bonuses","type":"boolean"},"success_url":{"description":"The URL to which Stripe should send customers when payment is completed (for 'checkout' integration only)","type":"string"}},"required":["currency","amount"],"type":"object"},"StripeBusinessPaymentSavedInitialData":{"properties":{"amount":{"description":"Amount of payment","format":"float","type":"number"},"card_id":{"description":"Saved card id","format":"uuid","type":"string"},"currency":{"description":"currency","type":"string"}},"required":["currency","amount","card_id"],"type":"object"},"StripeIntegrationTypes":{"items":{"enum":["checkout","elements"],"type":"string"},"type":"array"},"StripePaymentInfo":{"properties":{"currency":{"description":"currency","type":"string"},"integration_types":{"$ref":"#/definitions/StripeIntegrationTypes","description":"Supported integration types"},"key":{"description":"Publishable key","type":"string"},"min_amount":{"description":"Minimal amount of payment","format":"float","type":"number"},"saved_payment_methods":{"items":{"$ref":"#/definitions/StripePaymentMethod"},"type":"array"}},"type":"object"},"StripePaymentMethod":{"properties":{"alias":{"description":"Card alias","type":"string"},"brand":{"description":"Card brand ('amex', 'diners', 'discover', 'jcb', 'mastercard', 'unionpay', 'visa', 'unknown')","type":"string"},"funding":{"description":"Card funding type. Can be 'credit', 'debit', 'prepaid', 'unknown'.","type":"string"},"id":{"description":"Method Id","format":"uuid","type":"string"},"integration_types":{"$ref":"#/definitions/StripeIntegrationTypes","description":"Integration type used for card (optional)"},"mask":{"description":"Card mask","type":"string"},"payment_type":{"description":"Payment type (card)","type":"string"}},"type":"object"},"Tank":{"properties":{"active":{"default":1,"description":"Tank is active flag","enum":[0,1],"type":"integer"},"address":{"description":"Title","type":"string","x-nullable":true},"code":{"description":"Tank unique code","type":"string","x-nullable":true},"goods_code":{"description":"Linked product code (optional, only for linked tank data)","type":"string","x-nullable":true},"id":{"description":"Tank id","format":"uuid","type":"string","x-nullable":true},"latitude":{"description":"Latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"linked":{"description":"Tank linked with Business flag","type":"boolean"},"longitude":{"description":"Longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"owner_email":{"description":"Tank owner email (User, Corporate User depends on owner_type)","type":"string"},"owner_external_id":{"description":"Tank owner external Id (User, Corporate User depends on owner_type)","type":"string"},"owner_id":{"description":"Tank owner Id (User, Corporate User depends on owner_type)","format":"uuid","type":"string"},"owner_name":{"description":"Tank owner name (User, Corporate User depends on owner_type)","type":"string"},"owner_phone":{"description":"Tank owner phone (User, Corporate User depends on owner_type)","type":"string"},"owner_type":{"description":"Tank owner type","enum":["customer","corporate-customer"],"type":"string"},"product_title":{"description":"Product title (for information only)","type":"string","x-nullable":true},"product_volume":{"description":"Current product volume","format":"float","type":"number","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true},"ullage_volume":{"description":"Current product volume","format":"float","type":"number","x-nullable":true},"unit":{"description":"Measuring units","type":"string","x-nullable":true},"volume":{"description":"Tank volume","format":"float","type":"number","x-nullable":true}},"type":"object"},"TankConfiguration":{"properties":{"critical_high_product_alarm_height":{"description":"Critical high product height alarm, mm","type":"integer","x-nullable":true},"critical_low_product_alarm_height":{"description":"Critical low product height alarm, mm","type":"integer","x-nullable":true},"height":{"description":"Height, mm","type":"integer","x-nullable":true},"high_product_alarm_height":{"description":"High product height alarm, mm","type":"integer","x-nullable":true},"high_water_alarm_height":{"description":"High water alarm height, mm","type":"integer","x-nullable":true},"low_product_alarm_height":{"description":"Low product height alarm, mm","type":"integer","x-nullable":true}},"type":"object"},"Tariff":{"properties":{"active":{"description":"Tariff is active","enum":[0,1],"type":"integer","x-nullable":true},"active_customer_categories_number":{"default":0,"type":"integer","x-nullable":true},"active_customer_categories_number_public_title":{"type":"string","x-nullable":true},"active_customer_categories_number_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"active_loyalty_rules_number":{"default":0,"type":"integer","x-nullable":true},"active_loyalty_rules_number_public_title":{"type":"string","x-nullable":true},"active_loyalty_rules_number_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"allow_feedback_source_attachments":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"allow_feedback_source_attachments_public_title":{"type":"string","x-nullable":true},"allow_feedback_source_attachments_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"amount_to_pay_percentage":{"default":0,"format":"float","type":"number","x-nullable":true},"amount_to_pay_percentage_public_title":{"type":"string","x-nullable":true},"amount_to_pay_percentage_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"analytics_available":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"analytics_available_public_title":{"type":"string","x-nullable":true},"analytics_available_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"base_tariff_plan_id":{"description":"Base Tariff ID","format":"uuid","type":"string","x-nullable":true},"change_bill_payment_mobile_payments":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_bill_payment_mobile_payments_public_title":{"type":"string","x-nullable":true},"change_bill_payment_mobile_payments_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_bill_payment_with_credit_card":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_bill_payment_with_credit_card_public_title":{"type":"string","x-nullable":true},"change_bill_payment_with_credit_card_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_bill_payment_with_emoney":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_bill_payment_with_emoney_public_title":{"type":"string","x-nullable":true},"change_bill_payment_with_emoney_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_bill_payment_with_paypal":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_bill_payment_with_paypal_public_title":{"type":"string","x-nullable":true},"change_bill_payment_with_paypal_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_bonuses_payment":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_bonuses_payment_percentage":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_bonuses_payment_percentage_public_title":{"type":"string","x-nullable":true},"change_bonuses_payment_percentage_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_bonuses_payment_public_title":{"type":"string","x-nullable":true},"change_bonuses_payment_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_customer_birthday_greetings":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_customer_birthday_greetings_public_title":{"type":"string","x-nullable":true},"change_customer_birthday_greetings_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_customer_earn_bonuses_themselves":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_customer_earn_bonuses_themselves_public_title":{"type":"string","x-nullable":true},"change_customer_earn_bonuses_themselves_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_customer_questionnaire":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_customer_questionnaire_public_title":{"type":"string","x-nullable":true},"change_customer_questionnaire_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_earn_encouraging_bonuses_mobileapp":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_earn_encouraging_bonuses_mobileapp_public_title":{"type":"string","x-nullable":true},"change_earn_encouraging_bonuses_mobileapp_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_how_notify_about_reward":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_how_notify_about_reward_public_title":{"type":"string","x-nullable":true},"change_how_notify_about_reward_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_limit_bonuses_redeem_wo_confirmation":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_limit_bonuses_redeem_wo_confirmation_public_title":{"type":"string","x-nullable":true},"change_limit_bonuses_redeem_wo_confirmation_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_limit_discount_wo_confirmation":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_limit_discount_wo_confirmation_public_title":{"type":"string","x-nullable":true},"change_limit_discount_wo_confirmation_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_max_transactions_amount_wo_notify":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_max_transactions_amount_wo_notify_public_title":{"type":"string","x-nullable":true},"change_max_transactions_amount_wo_notify_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_message_signature":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_message_signature_public_title":{"type":"string","x-nullable":true},"change_message_signature_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_messages_src_alphaname":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_messages_src_alphaname_public_title":{"type":"string","x-nullable":true},"change_messages_src_alphaname_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_new_customer_status":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_new_customer_status_public_title":{"type":"string","x-nullable":true},"change_new_customer_status_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_notify_customers_bonuses_activation":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_notify_customers_bonuses_activation_public_title":{"type":"string","x-nullable":true},"change_notify_customers_bonuses_activation_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_notify_customers_bonuses_expiration":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_notify_customers_bonuses_expiration_public_title":{"type":"string","x-nullable":true},"change_notify_customers_bonuses_expiration_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_notify_customers_transactions":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_notify_customers_transactions_public_title":{"type":"string","x-nullable":true},"change_notify_customers_transactions_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_register_display_customer_profile":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_register_display_customer_profile_public_title":{"type":"string","x-nullable":true},"change_register_display_customer_profile_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_round_bonuses_when_earn":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_round_bonuses_when_earn_public_title":{"type":"string","x-nullable":true},"change_round_bonuses_when_earn_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_use_pin_with_bonuses_redeem_by_card":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_use_pin_with_bonuses_redeem_by_card_public_title":{"type":"string","x-nullable":true},"change_use_pin_with_bonuses_redeem_by_card_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_use_reward_frend_recommendation":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_use_reward_frend_recommendation_public_title":{"type":"string","x-nullable":true},"change_use_reward_frend_recommendation_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"change_use_reward_sharing_recommendation":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"change_use_reward_sharing_recommendation_public_title":{"type":"string","x-nullable":true},"change_use_reward_sharing_recommendation_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"country":{"description":"Country ISO code","type":"string","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"customer_benefits_update_notification_price":{"default":0,"format":"float","type":"number","x-nullable":true},"customer_benefits_update_notification_price_public_title":{"$ref":"#/definitions/MultiLanguageObject","x-nullable":true},"customer_benefits_update_notification_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"customize_platform_business_logic":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"customize_platform_business_logic_public_title":{"type":"string","x-nullable":true},"customize_platform_business_logic_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"description":{"description":"Description","type":"string","x-nullable":true},"downgrade_allowed":{"description":"Tariff downgrade allowed","type":"boolean","x-nullable":true},"email_price":{"default":0,"format":"float","type":"number","x-nullable":true},"email_price_public_title":{"type":"string","x-nullable":true},"email_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"evs_phone_request_price":{"default":0,"format":"float","type":"number","x-nullable":true},"evs_phone_request_price_public_title":{"$ref":"#/definitions/MultiLanguageObject","x-nullable":true},"evs_phone_request_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"exchange_coupon_redeem_fee_percentage":{"default":0,"format":"float","type":"number","x-nullable":true},"exchange_coupon_redeem_fee_percentage_public_title":{"type":"string","x-nullable":true},"exchange_coupon_redeem_fee_percentage_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"export_customer_database":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"export_customer_database_public_title":{"type":"string","x-nullable":true},"export_customer_database_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"export_transactions_list":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"export_transactions_list_public_title":{"type":"string","x-nullable":true},"export_transactions_list_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"external_system_message_price":{"default":0,"format":"float","type":"number","x-nullable":true},"external_system_message_price_public_title":{"type":"string","x-nullable":true},"external_system_message_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_active_pos_count":{"default":0,"type":"integer","x-nullable":true},"free_active_pos_count_public_title":{"type":"string","x-nullable":true},"free_active_pos_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_active_terminals_count":{"default":0,"type":"integer","x-nullable":true},"free_active_terminals_count_public_title":{"type":"string","x-nullable":true},"free_active_terminals_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_customer_benefits_update_notifications_count":{"default":0,"type":"integer","x-nullable":true},"free_customer_benefits_update_notifications_count_public_title":{"$ref":"#/definitions/MultiLanguageObject","x-nullable":true},"free_customer_benefits_update_notifications_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_customers_count":{"default":0,"type":"integer","x-nullable":true},"free_customers_count_public_title":{"type":"string","x-nullable":true},"free_customers_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_email_count":{"default":0,"type":"integer","x-nullable":true},"free_email_count_public_title":{"type":"string","x-nullable":true},"free_email_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_evs_phone_requests_count":{"default":0,"type":"integer","x-nullable":true},"free_evs_phone_requests_count_public_title":{"$ref":"#/definitions/MultiLanguageObject","x-nullable":true},"free_evs_phone_requests_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_external_system_messages_count":{"default":0,"type":"integer","x-nullable":true},"free_external_system_messages_count_public_title":{"type":"string","x-nullable":true},"free_external_system_messages_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_feedback_sources_count":{"default":0,"type":"integer","x-nullable":true},"free_feedback_sources_count_public_title":{"type":"string","x-nullable":true},"free_feedback_sources_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_incust_chatbot_count":{"default":0,"type":"integer","x-nullable":true},"free_incust_chatbot_count_public_title":{"type":"string","x-nullable":true},"free_incust_chatbot_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_pkpass_messages_count":{"default":0,"type":"integer","x-nullable":true},"free_pkpass_messages_count_public_title":{"$ref":"#/definitions/MultiLanguageObject","x-nullable":true},"free_pkpass_messages_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_pkpass_updates_count":{"default":0,"type":"integer","x-nullable":true},"free_pkpass_updates_count_public_title":{"$ref":"#/definitions/MultiLanguageObject","x-nullable":true},"free_pkpass_updates_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_push_count":{"default":0,"type":"integer","x-nullable":true},"free_push_count_public_title":{"type":"string","x-nullable":true},"free_push_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_sms_count":{"default":0,"type":"integer","x-nullable":true},"free_sms_count_public_title":{"type":"string","x-nullable":true},"free_sms_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_transactions_count":{"default":0,"type":"integer","x-nullable":true},"free_transactions_count_public_title":{"type":"string","x-nullable":true},"free_transactions_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"free_viber_count":{"default":0,"type":"integer","x-nullable":true},"free_viber_count_public_title":{"type":"string","x-nullable":true},"free_viber_count_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"id":{"description":"Tariff ID","format":"uuid","type":"string","x-nullable":true},"incust_chatbot_price":{"default":0,"format":"float","type":"number","x-nullable":true},"incust_chatbot_price_public_title":{"type":"string","x-nullable":true},"incust_chatbot_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"individual_mobile_app":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"individual_mobile_app_public_title":{"type":"string","x-nullable":true},"individual_mobile_app_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"integration_with_pos":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"integration_with_pos_public_title":{"type":"string","x-nullable":true},"integration_with_pos_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"min_day_account_price":{"default":0,"format":"float","type":"number","x-nullable":true},"min_day_account_price_public_title":{"type":"string","x-nullable":true},"min_day_account_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"mobile_app_main_page_news":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"mobile_app_main_page_news_public_title":{"type":"string","x-nullable":true},"mobile_app_main_page_news_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"mobile_app_payment":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"mobile_app_payment_public_title":{"type":"string","x-nullable":true},"mobile_app_payment_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"mobile_app_publishing":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"mobile_app_publishing_public_title":{"type":"string","x-nullable":true},"mobile_app_publishing_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"month_account_price":{"default":0,"format":"float","type":"number","x-nullable":true},"month_account_price_public_title":{"type":"string","x-nullable":true},"month_account_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"month_active_pos_price":{"default":0,"format":"float","type":"number","x-nullable":true},"month_active_pos_price_public_title":{"type":"string","x-nullable":true},"month_active_pos_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"month_active_terminal_price":{"default":0,"format":"float","type":"number","x-nullable":true},"month_active_terminal_price_public_title":{"type":"string","x-nullable":true},"month_active_terminal_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"month_feedback_sources_price":{"default":0,"format":"float","type":"number","x-nullable":true},"month_feedback_sources_price_public_title":{"type":"string","x-nullable":true},"month_feedback_sources_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"new_customer_price":{"default":0,"format":"float","type":"number","x-nullable":true},"new_customer_price_public_title":{"type":"string","x-nullable":true},"new_customer_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"pkpass_message_price":{"default":0,"format":"float","type":"number","x-nullable":true},"pkpass_message_price_public_title":{"$ref":"#/definitions/MultiLanguageObject","x-nullable":true},"pkpass_message_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"pkpass_update_price":{"default":0,"format":"float","type":"number","x-nullable":true},"pkpass_update_price_public_title":{"$ref":"#/definitions/MultiLanguageObject","x-nullable":true},"pkpass_update_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"promotional_bonuses_support":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"promotional_bonuses_support_public_title":{"type":"string","x-nullable":true},"promotional_bonuses_support_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"push_price":{"default":0,"format":"float","type":"number","x-nullable":true},"push_price_public_title":{"type":"string","x-nullable":true},"push_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"redeemed_discount_percentage":{"default":0,"format":"float","type":"number","x-nullable":true},"redeemed_discount_percentage_public_title":{"type":"string","x-nullable":true},"redeemed_discount_percentage_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"sms_add_price":{"default":0,"format":"float","type":"number","x-nullable":true},"sms_add_price_public_title":{"type":"string","x-nullable":true},"sms_add_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"sms_tariff_plan_id":{"description":"SMS Tariff Plan ID","format":"uuid","type":"string","x-nullable":true},"sms_tariff_plan_id_public_title":{"type":"string","x-nullable":true},"sms_tariff_plan_id_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"special_account_redeem_percentage":{"default":0,"format":"float","type":"number","x-nullable":true},"special_account_redeem_percentage_public_title":{"type":"string","x-nullable":true},"special_account_redeem_percentage_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"special_accounts_processing":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"special_accounts_processing_public_title":{"type":"string","x-nullable":true},"special_accounts_processing_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"transaction_price":{"default":0,"format":"float","type":"number","x-nullable":true},"transaction_price_public_title":{"type":"string","x-nullable":true},"transaction_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"trial":{"default":0,"description":"Tariff is Trial","enum":[0,1],"type":"integer","x-nullable":true},"ulg_push_price":{"default":0,"format":"float","type":"number","x-nullable":true},"ulg_push_price_public_title":{"type":"string","x-nullable":true},"ulg_push_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"ulg_sms_price":{"default":0,"format":"float","type":"number","x-nullable":true},"ulg_sms_price_public_title":{"type":"string","x-nullable":true},"ulg_sms_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"ulg_targeting_support":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"ulg_targeting_support_public_title":{"type":"string","x-nullable":true},"ulg_targeting_support_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"upgrade_allowed":{"description":"Tariff upgrade allowed","type":"boolean","x-nullable":true},"use_advanced_customer_filters":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"use_advanced_customer_filters_public_title":{"type":"string","x-nullable":true},"use_advanced_customer_filters_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"use_coupon_exchange":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"use_coupon_exchange_public_title":{"type":"string","x-nullable":true},"use_coupon_exchange_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"use_coupons_and_certificates":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"use_coupons_and_certificates_public_title":{"type":"string","x-nullable":true},"use_coupons_and_certificates_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"use_gift_cards":{"default":1,"enum":[0,1],"type":"integer","x-nullable":true},"use_gift_cards_public_title":{"type":"string","x-nullable":true},"use_gift_cards_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"use_on_own_servers":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"use_on_own_servers_public_title":{"type":"string","x-nullable":true},"use_on_own_servers_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"valid_days":{"default":0,"description":"Trial Tariff valid days","type":"integer","x-nullable":true},"viber_add_price":{"default":0,"format":"float","type":"number","x-nullable":true},"viber_add_price_public_title":{"type":"string","x-nullable":true},"viber_add_price_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true},"viber_tariff_plan_id":{"description":"Viber Tariff Plan ID","format":"uuid","type":"string","x-nullable":true},"viber_tariff_plan_id_public_title":{"type":"string","x-nullable":true},"viber_tariff_plan_id_visible":{"default":0,"enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"TariffList":{"items":{"$ref":"#/definitions/Tariff"},"type":"array"},"TariffSetRequestData":{"properties":{"id":{"description":"Tariff Id","format":"uuid","type":"string"}},"required":["id"],"type":"object"},"Tax":{"properties":{"classification":{"description":"Tax classification ('base-tax' like excise, fee, duty, etc; 'sales-tax' like vat, gst, etc)","enum":["base-tax","sales-tax"],"type":"string","x-nullable":true},"code":{"description":"Tax code","type":"string","x-nullable":true},"decimal_digits":{"description":"Tax rate decimal digits","type":"integer"},"default_value":{"description":"Tax rate default value","format":"float","type":"number","x-nullable":true},"id":{"description":"Tax ID","format":"uuid","type":"string","x-nullable":true},"include_in_receipt":{"description":"Include item in receipt","enum":[0,1],"type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Tax title","type":"string","x-nullable":true},"type":{"description":"Tax rate value type ('amount' not allowed for 'sales-tax' class)","enum":["amount","percentage"],"type":"string","x-nullable":true},"used":{"description":"Tax used by price groups (readonly)","type":"boolean","x-nullable":true}},"type":"object"},"TaxOption":{"properties":{"default_value":{"description":"Tax rate default value","format":"float","type":"number","x-nullable":true},"exempt":{"description":"Tax exempt flag","type":"boolean","x-nullable":true},"exempt_change_allowed":{"description":"Tax exempt change allowed","type":"boolean","x-nullable":true},"loyalty_id":{"description":"Loyalty id","format":"uuid","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title","type":"string","x-nullable":true},"tax_classification":{"description":"Tax classification","enum":["base-tax","sales-tax"],"type":"string","x-nullable":true},"tax_code":{"description":"Tax code","type":"string","x-nullable":true},"tax_decimal_digits":{"description":"Tax rate decimal digits (readonly)","type":"integer"},"tax_id":{"description":"Tax id","format":"uuid","type":"string","x-nullable":true},"tax_title":{"description":"Tax title","type":"string","x-nullable":true},"tax_type":{"description":"Tax rate value type  (readonly)","enum":["amount","percentage"],"type":"string","x-nullable":true}},"type":"object"},"TaxOptionsList":{"items":{"$ref":"#/definitions/TaxOption","description":"Tax option object"},"type":"array"},"TaxSummaryData":{"properties":{"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"items":{"description":"Detail by Items (for items summary report only)","items":{"$ref":"#/definitions/ItemTaxSummaryData"},"type":"array","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"tax_amount":{"description":"Tax amount","format":"float","type":"number","x-nullable":true},"tax_classification":{"description":"Tax classification ('base-tax' like excise, fee, duty, etc; 'sales-tax' like vat, gst, etc)","enum":["base-tax","sales-tax"],"type":"string","x-nullable":true},"tax_code":{"description":"Tax code","type":"string","x-nullable":true},"tax_decimal_digits":{"description":"Tax amount decimal digits","type":"integer"},"tax_id":{"description":"Tax ID","format":"uuid","type":"string","x-nullable":true},"tax_title":{"description":"Tax title","type":"string","x-nullable":true}},"type":"object"},"TaxesList":{"items":{"$ref":"#/definitions/Tax"},"type":"array"},"TaxesSummaryReport":{"items":{"$ref":"#/definitions/TaxSummaryData"},"type":"array"},"TemporaryCode":{"properties":{"code":{"description":"Temporary code","type":"string"},"redeem_allowed":{"description":"Allowed redeem bonuses or special account flag","type":"boolean"}},"type":"object"},"Terminal":{"properties":{"active":{"default":1,"description":"Terminal is active flag","enum":[0,1],"type":"integer"},"api_key":{"description":"API key","type":"string","x-nullable":true},"begin_work_with_customer_select":{"default":1,"description":"Start work in the Register by customer identification","enum":[0,1],"type":"integer","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string"},"customer_messages_language":{"description":"Default language ISO code for customers messages","type":"string","x-nullable":true},"display_account_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Display account type","x-nullable":true},"display_active":{"default":0,"description":"Terminal has active display","enum":[0,1],"type":"integer","x-nullable":true},"display_customer_reward_amount":{"description":"Customer reward amount for using Display","format":"float","type":"number","x-nullable":true},"display_promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"display_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type","x-nullable":true},"display_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire","type":"integer","x-nullable":true},"display_refill_timeout":{"description":"Value of timeout between customer rewards","type":"integer","x-nullable":true},"display_special_account_id":{"description":"Special account ID","type":"string","x-nullable":true},"display_type":{"description":"Display type","enum":["customer-identity","gift-redeem","login-pad","steward"],"type":"string","x-nullable":true},"external_id":{"description":"Terminal External ID (up to 128 symbols)","type":"string","x-nullable":true},"goods_preset_recommnded_values_only":{"description":"Only preset recommended values allowed","enum":[0,1],"type":"integer","x-nullable":true},"ibeacon_account_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"iBeacon account type","x-nullable":true},"ibeacon_active":{"default":0,"description":"Terminal has active iBeacon","enum":[0,1],"type":"integer","x-nullable":true},"ibeacon_customer_reward_amount":{"description":"Customer reward amount for using iBeacon","format":"float","type":"number","x-nullable":true},"ibeacon_major":{"description":"iBeacon major number","type":"integer","x-nullable":true},"ibeacon_minor":{"description":"iBeacon minor number","type":"integer","x-nullable":true},"ibeacon_promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"ibeacon_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type","x-nullable":true},"ibeacon_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire","type":"integer","x-nullable":true},"ibeacon_refill_timeout":{"description":"Value of timeout between customer rewards","type":"integer","x-nullable":true},"ibeacon_special_account_id":{"description":"Special account ID","type":"string","x-nullable":true},"ibeacon_uuid":{"description":"iBeacon UUID","type":"string","x-nullable":true},"id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"last_event_status":{"$ref":"#/definitions/EventStatus","description":"Last event status","x-nullable":true},"login":{"description":"Terminal login","type":"string"},"mobile_app_payment_amount_free":{"default":0,"description":"Mobile app payment of an arbitrary amount allowed","enum":[0,1],"type":"integer","x-nullable":true},"password":{"description":"Terminal password","type":"string","x-nullable":true},"phone":{"description":"Terminal buyer/manager phone","type":"string","x-nullable":true},"pos_id":{"description":"Point of sales ID","format":"uuid","type":"string"},"price_group":{"$ref":"#/definitions/PriceGroup"},"price_group_id":{"description":"Price Group ID","type":"string","x-nullable":true},"related_terminals_settings":{"$ref":"#/definitions/RelatedTerminalsSettings","description":"Settings for related terminals data access (optional)","x-nullable":true},"reuse_temporary_code":{"default":0,"description":"Reuse of temporary code allowed","enum":[0,1],"type":"integer","x-nullable":true},"screensaver_settings":{"$ref":"#/definitions/TerminalScreensaverSettings","description":"Settings for screensaver (optional)","x-nullable":true},"staff":{"description":"Business staff who get access","items":{"$ref":"#/definitions/BusinessStaff"},"type":"array","x-nullable":true},"staff_sign_in_required":{"description":"Terminal required staff sign in for work","enum":[0,1],"type":"integer"},"title":{"description":"Terminal title","type":"string"},"type":{"$ref":"#/definitions/TerminalType","description":"Terminal type"},"vehicle_fuel_settings":{"$ref":"#/definitions/TerminalVehicleFuelSettings","description":"Settings for vehicles and refuels (optional)","x-nullable":true}},"type":"object"},"TerminalAdditionalCost":{"properties":{"additional_cost_code":{"description":"Additional cost code  (readonly)","type":"string","x-nullable":true},"additional_cost_decimal_digits":{"description":"Additional cost decimal digits (readonly)","type":"integer"},"additional_cost_id":{"description":"Additional cost ID","format":"uuid","type":"string","x-nullable":true},"additional_cost_title":{"description":"Additional cost title  (readonly)","type":"string","x-nullable":true},"additional_cost_type":{"description":"Additional cost value type  (readonly)","enum":["amount","percentage"],"type":"string","x-nullable":true},"default_value":{"description":"Additional cost default value for Terminal","format":"float","type":"number","x-nullable":true},"use_base_cost_value":{"description":"Use additional cost default value from base Loyalty additional costs for Terminal","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"TerminalAdditionalCostValue":{"properties":{"additional_cost_code":{"description":"Additional cost code  (readonly)","type":"string","x-nullable":true},"additional_cost_decimal_digits":{"description":"Additional cost decimal digits (readonly)","type":"integer"},"additional_cost_id":{"description":"Additional cost ID","format":"uuid","type":"string","x-nullable":true},"additional_cost_title":{"description":"Additional cost title  (readonly)","type":"string","x-nullable":true},"additional_cost_type":{"description":"Additional cost value type  (readonly)","enum":["amount","percentage"],"type":"string","x-nullable":true},"default_value":{"description":"Additional cost default value for Terminal","format":"float","type":"number","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string"},"use_base_cost_value":{"description":"Use additional cost default value from base Loyalty additional costs for Terminal","enum":[0,1],"type":"integer","x-nullable":true},"value":{"description":"Additional cost actual value","format":"float","type":"number","x-nullable":true}},"type":"object"},"TerminalAdditionalCostsItem":{"properties":{"additional_costs":{"description":"Additional costs","items":{"$ref":"#/definitions/TerminalAdditionalCostValue"},"type":"array"},"item_active":{"description":"Goods item active flag","enum":[0,1],"type":"integer","x-nullable":true},"item_category_id":{"description":"Goods item category ID","format":"uuid","type":"string","x-nullable":true},"item_category_title":{"description":"Goods item category title","type":"string","x-nullable":true},"item_code":{"description":"Goods item code","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string"},"item_title":{"description":"Goods item title","type":"string","x-nullable":true}},"required":["item_id"],"type":"object"},"TerminalApplicationSettings":{"type":"object"},"TerminalCustomerFeedbackSettings":{"properties":{"active":{"default":0,"description":"Feedback system active flag","enum":[0,1],"type":"integer"},"display_feedback_allowed":{"default":"none","description":"Allow leave ratings/reviews in display","enum":["none","authorized-users-only","all-users"],"type":"string"},"display_feedback_invitation_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Invitation text for mobile app (multilanguage)"},"display_feedback_source_id":{"description":"Feedback source ID for display","format":"uuid","type":"string"},"display_leave_feedback_allowed":{"default":0,"description":"Allow leave feedback in display","enum":[0,1],"type":"integer"},"display_show_qr_code_allowed":{"default":0,"description":"Allow show feedback source QR-code in display","enum":[0,1],"type":"integer"},"feedback_source_id":{"description":"Feedback source ID","format":"uuid","type":"string"},"print_feedback_on_check":{"$ref":"#/definitions/CustomerFeedbackPrintOnCheck","default":"none","description":"Print feedback source on check"},"print_feedback_on_check_message_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Invitation message text for printinting on check (multilanguage)"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"transaction_feedback_message_delay":{"default":0,"description":"Invitation message delay (minutes)","type":"integer"},"transaction_feedback_message_send":{"default":0,"description":"Send invitation to ratings/reviews in mobile app when finalioze transaction","enum":[0,1],"type":"integer"},"transaction_feedback_message_text":{"$ref":"#/definitions/MultiLanguageObject","description":"Invitation message text (multilanguage)"},"transaction_feedback_message_type":{"default":"push-chatbot-viber-sms","description":"Invitation message type","enum":["push-chatbot-viber-sms","push-chatbot-sms","push-chatbot-viber","push-chatbot","viber-sms","push","chatbot","viber","sms","email","external-system"],"type":"string"},"transaction_feedback_source_id":{"description":"Feedback source ID for trasnsaction finalize","format":"uuid","type":"string"},"use_individual_settings":{"default":0,"description":"Feedback system with individual settings flag","enum":[0,1],"type":"integer"}},"type":"object"},"TerminalEventStatusCode":{"enum":["terminal-sign-in-awaiting","staff-sign-in-awaiting","customer-awaiting","customer-processing","refueling-started","refueling-finished","terminal-settings-processing","customer-tap-splashscreen","payment-process"],"type":"string"},"TerminalExternalAmpDevice":{"properties":{"connection_type":{"description":"Device connection type","enum":["local"],"type":"string"},"settings":{"description":"Device settings (depends on device type)","type":"object"},"type":{"description":"Device type","enum":["payment-terminal"],"type":"string"},"vendor_type":{"description":"Device vendor specific type","enum":["amp-6500"],"type":"string"}},"type":"object"},"TerminalExternalAmpSettings":{"properties":{"devices":{"items":{"$ref":"#/definitions/TerminalExternalAmpDevice"},"type":"array"}},"type":"object"},"TerminalExternalDevicesSettings":{"properties":{"amp":{"$ref":"#/definitions/TerminalExternalAmpSettings","description":"AMP devices connected to the terminal","x-nullable":true},"pax":{"$ref":"#/definitions/TerminalExternalPaxSettings","description":"AMP devices connected to the terminal","x-nullable":true},"stripe":{"$ref":"#/definitions/TerminalExternalStripeSettings","description":"Stripe readers connected to the terminal","x-nullable":true}},"type":"object"},"TerminalExternalPaxDevice":{"properties":{"connection_type":{"description":"Device connection type","enum":["local"],"type":"string"},"settings":{"description":"Device settings (depends on device type)","type":"object"}},"type":"object"},"TerminalExternalPaxSettings":{"properties":{"devices":{"items":{"$ref":"#/definitions/TerminalExternalPaxDevice"},"type":"array"},"ignore_duplicate_transactions":{"description":"Allow PAX terminal not check for duplicate, also it will override the local duplicate check (default true)","type":"boolean"},"send_entry_mode":{"description":"Send entry mode in AUTH requests (default true)","type":"boolean"},"send_fuel_amount":{"description":"Send the fuel amount (fleet goods) regardless of the payment amount (default false)","type":"boolean"},"zero_amount_auth":{"description":"Use AUTH with zero amount (default false)","type":"boolean"}},"type":"object"},"TerminalExternalStripeLocation":{"properties":{"address":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["line1","city","state","country","postal_code"],"type":"object"},"id":{"description":"Location Id (readonly)","type":"string","x-nullable":true}},"required":["address"],"type":"object"},"TerminalExternalStripeReader":{"type":"object"},"TerminalExternalStripeSettings":{"properties":{"devices":{"items":{"$ref":"#/definitions/TerminalExternalStripeReader"},"type":"array"},"location":{"$ref":"#/definitions/TerminalExternalStripeLocation","x-nullable":true}},"type":"object"},"TerminalNotificationsSettings":{"properties":{"active":{"description":"Is notifications active for Terminal","type":"boolean"},"connection_lost_notification_emails":{"$ref":"#/definitions/EmailsList","description":"List of emails for connection lost notifications","x-nullable":true},"logged_out_notification_emails":{"$ref":"#/definitions/EmailsList","description":"List of emails for Terminal logged out notifications","x-nullable":true},"notify_if_connection_lost_more_then":{"description":"Notify if the Terminal state does not receive more than the specified times (time range in minutes)","format":"int16","type":"integer"},"notify_if_logged_out_more_then":{"description":"Notify if the Terminal state is logged out more than the specified times (time range in minutes)","format":"int16","type":"integer"}},"type":"object"},"TerminalScreensaverSettings":{"properties":{"sources":{"description":"Coupon batches list","items":{"$ref":"#/definitions/TerminalScreensaverSource"},"type":"array"}},"type":"object"},"TerminalScreensaverSource":{"properties":{"order":{"description":"Source order (non-negative)","type":"integer"},"show_time":{"description":"Show time (null or greater than zero)","type":"integer","x-nullable":true},"type":{"description":"Source type","enum":["youtube","image"],"type":"string"},"url":{"description":"Source url","type":"string","x-nullable":true}},"type":"object"},"TerminalType":{"enum":["register","steward","validator","prepaid-services","road-tanker-driver","kiosk","kiosk-and-register"],"type":"string"},"TerminalVehicleFuelSettings":{"properties":{"odometer_measurement_units":{"default":"set-by-volume-unit","description":"Odometer measuremen units selection type","enum":["kilometer","mile","hour","selected-by-customer","set-by-volume-unit"],"type":"string","x-nullable":true}},"type":"object"},"TerminalsList":{"items":{"$ref":"#/definitions/Terminal"},"type":"array"},"ThresholdsValue":{"properties":{"threshold":{"description":"Threshold","format":"float","type":"number","x-nullable":true},"value":{"description":"Value","format":"float","type":"number","x-nullable":true}},"required":["threshold","value"],"type":"object"},"ThresholdsValues":{"description":"Values set based on thresholds","items":{"$ref":"#/definitions/ThresholdsValue"},"type":"array"},"TourCard":{"properties":{"activated_dt":{"description":"Card activated datetime","format":"date-time","type":"string"},"active":{"description":"Active flag","enum":[0,1],"type":"integer"},"batch":{"$ref":"#/definitions/TourCardBatch","description":"Batch object (readOnly)"},"canceled":{"description":"Canceled flag","enum":[0,1],"type":"integer"},"code":{"description":"CODE (readOnly)","type":"string"},"customer":{"$ref":"#/definitions/TourCardCustomer","description":"Customer who owns tourist card"},"emitted_dt":{"description":"Card emission datetime (readOnly)","format":"date-time","type":"string"},"expire_dt":{"description":"Card expire datetime","format":"date-time","type":"string"},"id":{"description":"Card ID (readOnly)","format":"uuid","type":"string"},"referral_code":{"description":"Referral code of partner/seller (readOnly)","type":"string"}},"type":"object"},"TourCardAccount":{"properties":{"active":{"description":"Object active flag","enum":[0,1],"type":"integer"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"id":{"description":"Account ID","format":"uuid","type":"string"},"precision":{"description":"Account precision","enum":["integer","two-decimal-places","three-decimal-places"],"type":"string"},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Account public title (multilanguage)"},"title":{"description":"Account title","type":"string"}},"type":"object"},"TourCardBatch":{"properties":{"accounts":{"description":"Batch services list","items":{"$ref":"#/definitions/TourCardBatchAccount"},"type":"array"},"active":{"description":"Batch active flag","enum":[0,1],"type":"integer"},"auto_generated_codes":{"description":"Auto generate CODE","enum":[0,1],"type":"integer"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"codes_count":{"description":"Batch codes count (readOnly)","format":"int64","type":"integer"},"codes_used_count":{"description":"Batch used codes count (readOnly)","format":"int64","type":"integer"},"created":{"description":"Batch created datetime","format":"date-time","type":"string"},"emission_period_begin":{"description":"Batch emission period begin date","format":"date","type":"string"},"emission_period_end":{"description":"Batch emission period end date","format":"date","type":"string"},"emission_quantity_limit":{"description":"Batch emission limit quantity","format":"int64","type":"integer"},"emitted_quantity":{"description":"Batch emitted cards quantity (readOnly)","format":"int64","type":"integer"},"expire_date":{"description":"Value of card expire date","format":"date","type":"string"},"expire_type":{"description":"Card expiration value type","enum":["none","date","hour","day","month"],"type":"string"},"expire_value":{"description":"Value of card expire","type":"integer"},"id":{"description":"Batch ID","format":"uuid","type":"string"},"image":{"description":"URL of batch image","type":"string"},"price":{"description":"Card price","format":"float","type":"number"},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Batch public description (multilanguage)"},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Batch public title (multilanguage)"},"services":{"description":"Batch services list","items":{"$ref":"#/definitions/TourCardService"},"type":"array"},"time_zone":{"description":"Card Time zone ID","type":"string"},"title":{"description":"Batch title","type":"string"}},"type":"object"},"TourCardBatchAccount":{"properties":{"account":{"$ref":"#/definitions/TourCardAccount","description":"external code"},"initial_amount":{"description":"Initial account amount","format":"float","type":"number"}},"type":"object"},"TourCardBatchCode":{"properties":{"code":{"description":"external code","type":"string"},"used":{"description":"Code already used","enum":[0,1],"type":"integer"}},"type":"object"},"TourCardCategory":{"properties":{"active":{"description":"Object active flag","enum":[0,1],"type":"integer"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"id":{"description":"Category ID","format":"uuid","type":"string"},"order":{"description":"Category sort order","type":"integer"},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Category public title (multilanguage)"},"title":{"description":"Category title","type":"string"}},"type":"object"},"TourCardCustomer":{"properties":{"email":{"description":"User email","type":"string"},"external_id":{"description":"User external id","type":"string"},"id":{"description":"User ID","format":"uuid","type":"string"},"name":{"description":"User name","type":"string"},"phone":{"description":"User phone","type":"string"}},"type":"object"},"TourCardService":{"properties":{"account":{"$ref":"#/definitions/TourCardAccount","description":"Customer who owns tourist card"},"active":{"description":"Object active flag","enum":[0,1],"type":"integer"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"category":{"$ref":"#/definitions/TourCardCategory","description":"Tourist card service category"},"decrement_step":{"description":"Decrement step of account amount","format":"float","type":"number"},"id":{"description":"Service ID","format":"uuid","type":"string"},"image":{"description":"URL of object image","type":"string"},"pos_count":{"description":"Number of pos where the service is available (readOnly)","format":"int64","type":"integer"},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Service public description (multilanguage)"},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Service public title (multilanguage)"},"title":{"description":"Service title","type":"string"},"usage_limit_per_loyalty":{"description":"Usage limit per loyalty","type":"integer"},"usage_limit_per_loyalty_period_type":{"description":"Usage limit per loyalty period type","enum":["all-card-time","hour","day","month"],"type":"string"},"usage_limit_per_loyalty_period_value":{"description":"Usage limit per loyalty period value","type":"integer"},"usage_limit_per_pos":{"description":"Usage limit per POS","type":"integer"},"usage_limit_per_pos_period_type":{"description":"Usage limit per POS period type","enum":["all-card-time","hour","day","month"],"type":"string"},"usage_limit_per_pos_period_value":{"description":"Usage limit per POS period value","type":"integer"}},"type":"object"},"Transaction":{"properties":{"amount":{"format":"double","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer"},"amount_to_pay":{"format":"double","type":"number"},"bonuses_added":{"format":"double","type":"number","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer"},"bonuses_on_account":{"format":"double","type":"number","x-nullable":true},"bonuses_redeemed":{"format":"double","type":"number","x-nullable":true},"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"business_staff_id":{"description":"Business Staff ID (optional)","format":"uuid","type":"string","x-nullable":true},"business_staff_name":{"description":"Business Staff name (optional)","type":"string","x-nullable":true},"calculated_margins":{"$ref":"#/definitions/CheckMargins","description":"Calculated margins applied to the transaction / transaction item","x-nullable":true},"calculated_taxes":{"$ref":"#/definitions/CheckTaxes","description":"Calculated taxes applied to the transaction / transaction item","x-nullable":true},"cancellation_comment":{"description":"Cancel transaction сomment","type":"string","x-nullable":true},"cancellation_processed":{"description":"Cancel transaction UTC processed date-time","format":"date-time","type":"string"},"cancellation_processed_local":{"description":"Cancel transaction local (by POS time zone) processed date-time","format":"date-time","type":"string"},"cancelled":{"description":"Transaction canceled flag","enum":[0,1],"type":"integer","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"confirmation_comment":{"description":"Confirmation transaction сomment","type":"string","x-nullable":true},"confirmation_processed":{"description":"Confirmation transaction UTC processed date-time","format":"date-time","type":"string"},"confirmation_processed_local":{"description":"Confirmation transaction local (by POS time zone) processed date-time","format":"date-time","type":"string"},"corporate_customer_email":{"description":"Corporate customer email","type":"string","x-nullable":true},"corporate_customer_id":{"description":"Corporate customer ID","format":"uuid","type":"string","x-nullable":true},"corporate_customer_name":{"description":"Corporate customer name","type":"string","x-nullable":true},"corporate_customer_questionnaire":{"$ref":"#/definitions/CorporateCustomerQuestionnaire","description":"Questionnaire fields values corporate customer","x-nullable":true},"corporate_customer_special_account_id":{"description":"Instance of corporate customer special account ID","format":"uuid","type":"string","x-nullable":true},"corporate_position_id":{"description":"Position ID","format":"uuid","type":"string","x-nullable":true},"corporate_position_title":{"description":"Position title","type":"string","x-nullable":true},"corporate_staff_comment":{"description":"Staff comment","type":"string","x-nullable":true},"corporate_staff_id":{"description":"Staff ID","format":"uuid","type":"string","x-nullable":true},"corporate_staff_suspended":{"description":"Staff suspended flag","enum":[0,1],"type":"integer","x-nullable":true},"corporate_vehicle_description":{"description":"Vehicle/Inventory description  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_id":{"description":"Vehicle/Inventory unique Id  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_position_id":{"description":"Vehicle/Inventory Position id (if include_corporate_vehicle parameter is True)","format":"uuid","type":"string","x-nullable":true},"corporate_vehicle_position_title":{"description":"Vehicle/Inventory Position title  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_qr_code":{"description":"Vehicle/Inventory qr-code / tag  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_vehicle_id":{"description":"Vehicle/Inventory Id  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"currency":{"description":"Currency ISO code (if transaction payment 'currency')","type":"string","x-nullable":true},"customer_additional_cards":{"$ref":"#/definitions/CustomerAdditionalCards","description":"List of customers additional cards","x-nullable":true},"customer_special_account_id":{"description":"Instance of customer special account ID","format":"uuid","type":"string","x-nullable":true},"discount_amount":{"format":"double","type":"number","x-nullable":true},"errors":{"description":"Errors list","items":{"$ref":"#/definitions/TransactionErrors"},"type":"array","x-nullable":true},"finalized":{"description":"Transaction UTC finalized date-timeb (optional, readonly)","format":"date-time","type":"string","x-nullable":true},"id":{"description":"Transaction ID","format":"uuid","type":"string"},"item_amount":{"description":"Goods item amount (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_amount_decimal_digits":{"description":"Number of decimal digits in amount value (for list with stock only)","type":"integer","x-nullable":true},"item_amount_inc_discount":{"description":"Goods item amount inclusive calculated discount (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (for list with stock only)","type":"integer","x-nullable":true},"item_calculated_bonuses_redeemed_amount":{"description":"Goods item total bonus points redeemed calculated by check (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_calculated_discount_amount":{"description":"Goods item total discount calculated by rules (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_calculated_price":{"description":"Goods item price calculated by rules (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_calculated_unit_discount_amount":{"description":"Goods item unit discount calculated by rules (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_category":{"description":"Goods item category (for list with stock only)","type":"string","x-nullable":true},"item_code":{"description":"Goods item code (for list with stock only)","type":"string","x-nullable":true},"item_discount_amount":{"description":"Goods item discount amount (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_id":{"description":"Transaction item unique identifier (for list with stock only)","type":"string","x-nullable":true},"item_price":{"description":"Goods item price (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_price_decimal_digits":{"description":"Number of decimal digits in price value (for list with stock only)","type":"integer","x-nullable":true},"item_quantity":{"description":"Goods item quantity (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value (for list with stock only)","type":"integer","x-nullable":true},"item_title":{"description":"Goods item title (for list with stock only)","type":"string","x-nullable":true},"item_unit":{"description":"Goods item measuring units (for list with stock only)","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title","type":"string","x-nullable":true},"odometer":{"description":"Odometer/engine hours value, up to two decimal digits (if include_odometer parameter is True)","format":"float","type":"number","x-nullable":true},"online_store_order_id":{"description":"Online store order ID","format":"uuid","type":"string","x-nullable":true},"payment_type":{"$ref":"#/definitions/TransactionPaymentType","description":"Payment type","x-nullable":true},"pos_id":{"description":"Pos ID","format":"uuid","type":"string","x-nullable":true},"pos_title":{"description":"POS title","type":"string","x-nullable":true},"processed":{"description":"Transaction UTC processed date-time","format":"date-time","type":"string"},"processed_local":{"description":"Transaction local (by POS time zone) processed date-time","format":"date-time","type":"string"},"sc_bonuses_redeem":{"description":"Temporary code bonus points redeem allowed flag","enum":[0,1],"type":"integer","x-nullable":true},"sc_code":{"description":"Temporary code","type":"string","x-nullable":true},"sc_created":{"format":"Temporary code created UTC date-time","type":"string","x-nullable":true},"sc_terminal_external_id":{"description":"Temporary code terminal external Id","type":"string","x-nullable":true},"sc_terminal_id":{"description":"Temporary code terminal ID","format":"uuid","type":"string","x-nullable":true},"sc_terminal_login":{"description":"Temporary code terminal login","type":"string","x-nullable":true},"sc_terminal_phone":{"description":"Temporary code terminal phone","type":"string","x-nullable":true},"sc_terminal_title":{"description":"Temporary code terminal title","type":"string","x-nullable":true},"services_amount":{"format":"float","type":"number"},"shipping_amount":{"format":"double","type":"number"},"special_account_amount":{"format":"double","type":"number","x-nullable":true},"special_account_currency":{"description":"Special account currency ISO code","type":"string","x-nullable":true},"special_account_id":{"description":"Special account ID (if transaction payment in 'special-account', 'corporate-special-account-access', 'retail-special-account-access')","format":"uuid","type":"string","x-nullable":true},"special_account_title":{"description":"Special account title","type":"string","x-nullable":true},"special_account_type":{"$ref":"#/definitions/SpecialAccountType","description":"Special account type","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer"},"subtype":{"$ref":"#/definitions/TransactionSubType","description":"Transaction subtype (optional, readonly)","x-nullable":true},"summary_amount":{"description":"Sum of amount and shipping_amount and services_amount","format":"double","type":"number"},"terminal_external_id":{"description":"Terminal External Id","type":"string","x-nullable":true},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"terminal_login":{"description":"Terminal login","type":"string","x-nullable":true},"terminal_phone":{"description":"Terminal phone","type":"string","x-nullable":true},"terminal_title":{"description":"Terminal title","type":"string","x-nullable":true},"transaction_id":{"description":"Referenced transaction ID","format":"uuid","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/TransactionType","description":"Transaction type"},"user_email":{"description":"User email","type":"string","x-nullable":true},"user_external_id":{"description":"User external id","type":"string","x-nullable":true},"user_id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"user_name":{"description":"User name","type":"string","x-nullable":true},"user_phone":{"description":"User phone number","type":"string","x-nullable":true},"user_questionnaire":{"$ref":"#/definitions/RetailCustomerQuestionnaire","description":"Questionnaire fields values for user (retail customer)","x-nullable":true},"vehicle_id":{"description":"Vehicle/inventory identifier/tag value  (if include_vehicle_id parameter is True)","type":"string","x-nullable":true}},"type":"object"},"TransactionErrors":{"properties":{"code":{"description":"Error code","type":"string"},"level":{"description":"Error level","enum":["warning","error"],"type":"string"},"message":{"description":"Error message","type":"string"},"type":{"description":"Error type","enum":["authorized-payment-capture","transaction-post-processing"],"type":"string"}},"type":"object"},"TransactionPaymentType":{"enum":["currency","special-account","corporate-special-account-access","retail-special-account-access"],"type":"string"},"TransactionReceipt":{"properties":{"check":{"$ref":"#/definitions/Check","description":"Transaction check (optional)"},"id":{"description":"Transaction ID","format":"uuid","type":"string","x-nullable":true},"lang":{"description":"language ISO code","type":"string","x-nullable":true},"legal_info":{"$ref":"#/definitions/ReceiptLegalInfo","description":"Business legal info (optional)"},"print_date":{"description":"Check print local (by POS time zone) date-time","format":"date-time","type":"string","x-nullable":true},"template":{"$ref":"#/definitions/TransactionReceiptTemplateType","description":"Receipt template","x-nullable":true},"transaction":{"$ref":"#/definitions/Transaction","description":"Transaction check (optional)"}},"type":"object"},"TransactionReceiptActions":{"properties":{"print_on_terminal":{"description":"Customer's receipt print on terminal (optional)","type":"boolean","x-nullable":true},"send_to_customer":{"$ref":"#/definitions/TransactionReceiptSendTo","description":"Customer's receipt send to (optional)","x-nullable":true}},"type":"object"},"TransactionReceiptSendTo":{"items":{"description":"email","type":"string"},"type":"array"},"TransactionReceiptTemplateType":{"enum":["business","customer","commercial"],"type":"string"},"TransactionSubType":{"enum":["sale","special-account-refill","special-account-refill-direct","special-account-refill-by-customer","special-account-write-offs-direct","special-account-write-offs-loan","special-account-write-offs-scheduled"],"type":"string"},"TransactionType":{"enum":["reserve","presale","sale","cancel","redeem-giftcard","bonus-add","special-account-refill","coupon-sale","authorize-payment","bonus-write-offs","special-account-write-offs"],"type":"string"},"TransactionsList":{"items":{"$ref":"#/definitions/Transaction"},"type":"array"},"TransactionsPaginatedList":{"properties":{"data":{"$ref":"#/definitions/TransactionsList"},"summary":{"$ref":"#/definitions/TransactionsSummary"}},"type":"object"},"TransactionsSummary":{"properties":{"total_amount":{"format":"double","type":"number"},"total_amount_to_pay":{"format":"double","type":"number"},"total_bonuses_added":{"format":"double","type":"number"},"total_bonuses_redeemed":{"format":"double","type":"number"},"total_discount_amount":{"format":"double","type":"number"},"total_rows_count":{"type":"integer"},"total_services_amount":{"format":"double","type":"number"},"total_shipping_amount":{"format":"double","type":"number"},"total_summary_amount":{"format":"double","type":"number"}},"type":"object"},"TrustedAuthRequestData":{"properties":{"create":{"default":false,"description":"Create/register new user if not exists","type":"boolean"},"system":{"description":"Trusted system type","type":"string"},"token":{"description":"User token from trusted system","type":"string"}},"required":["system","token"],"type":"object"},"UserExternalForm":{"properties":{"created":{"description":"Form filled date (optional, for filled forms only, readonly)","format":"date-time","type":"string"},"external_form_id":{"description":"External Form Id (readonly)","format":"uuid","type":"string","x-nullable":true},"file":{"description":"Empty form file URL","type":"string","x-nullable":true},"form_data":{"description":"Form data object"},"id":{"description":"User Form Id (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"signature":{"$ref":"#/definitions/UserSignature","description":"User signatue (optional)"},"signed":{"description":"Form signed by user (optional, for filled forms only, readonly)","type":"boolean","x-nullable":true},"title":{"description":"Form title","type":"string","x-nullable":true},"type":{"description":"Form type","enum":["tax"],"type":"string","x-nullable":true},"user_data":{"description":"User data object"},"user_id":{"description":"User Id (optional, readonly)","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"UserExternalForms":{"items":{"$ref":"#/definitions/UserExternalForm"},"type":"array"},"UserExternalFormsPaginated":{"properties":{"data":{"$ref":"#/definitions/UserExternalForms"},"summary":{"$ref":"#/definitions/UserExternalFormsSummary"}},"type":"object"},"UserExternalFormsSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"UserGender":{"enum":["male","female","other"],"type":"string"},"UserIDs":{"items":{"description":"User ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"UserProfile":{"properties":{"avatar":{"description":"User avatar url","type":"string","x-nullable":true},"birth_date":{"description":"user date of birth","format":"date","type":"string","x-nullable":true},"cards":{"$ref":"#/definitions/CardRecordsList","description":"List of users customer cards","x-nullable":true},"country":{"description":"ISO code of country","type":"string","x-nullable":true},"emails":{"$ref":"#/definitions/EmailRecordsList","description":"List of users Emails","x-nullable":true},"external_id":{"description":"User external id (maximum 128 chars)","type":"string","x-nullable":true},"gender":{"$ref":"#/definitions/UserGender","description":"User gender","x-nullable":true},"id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"language":{"description":"ISO code of language","type":"string","x-nullable":true},"login":{"description":"User primary email for access to account (User login)  (maximum 80 chars)","type":"string","x-nullable":true},"marketing_email":{"description":"Allow send marketing emails to the user","enum":[0,1],"type":"integer","x-nullable":true},"marketing_sms":{"description":"Allow send marketing SMS to the user","enum":[0,1],"type":"integer","x-nullable":true},"name":{"description":"Public user Name (maximum 128 chars)","type":"string","x-nullable":true},"news_email":{"description":"Allow send news emails to the user","enum":[0,1],"type":"integer","x-nullable":true},"password_exist":{"description":"Password exist (optional)","type":"boolean","x-nullable":true},"phone":{"description":"User primary phone number for access to account  (maximum 20 chars)","type":"string","x-nullable":true},"phones":{"$ref":"#/definitions/PhoneRecordsList","description":"List of users phones","x-nullable":true},"qr_legacy":{"$ref":"#/definitions/QrCodeLegacy","description":"QR code legacy info (readonly) (optional)","x-nullable":true},"qr_secret_key":{"description":"Secret key for QR code generation (readonly) (optional)","type":"string","x-nullable":true},"qr_user_id":{"description":"User ID for QR code generation (readonly) (optional)","type":"string","x-nullable":true},"qr_version":{"description":"Current version of QR code (readonly) (optional)","type":"integer","x-nullable":true},"social_identity_providers":{"$ref":"#/definitions/SocialIdentityProviderRecordsList","description":"List of users social networks","x-nullable":true},"transactional_sms":{"description":"Allow send transactional SMS to the user","enum":[0,1],"type":"integer","x-nullable":true},"welcome_message_sent":{"description":"Welcome message sent to the user","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"UserShipToAddress":{"properties":{"address":{"description":"Address string","type":"string"},"first_name":{"description":"First name","type":"string"},"id":{"description":"Address ID","format":"uuid","type":"string"},"last_name":{"description":"Last name","type":"string"},"phone":{"description":"Phone number","type":"string"}},"required":["first_name","phone","address"],"type":"object"},"UserSignature":{"properties":{"data":{"description":"Signature data (base64 encoded)","type":"string","x-nullable":true},"mime_type":{"description":"Signature data mime type","type":"string","x-nullable":true}},"type":"object"},"UserStatus":{"enum":["deleted","blocked","banned","suspended","registered","active"],"type":"string"},"UserStatusForAdmin":{"enum":["deleted","blocked","banned","suspended","registered","activated"],"type":"string"},"UserVehicle":{"properties":{"color":{"description":"Vehicle color","type":"string"},"created":{"description":"Vehicle added date and time (read only)","format":"date-time","type":"string","x-nullable":true},"fuel_tank_cap_locked":{"default":0,"description":"Fuel cap locked flag","enum":[0,1],"type":"integer"},"id":{"description":"Vehicle ID","format":"uuid","type":"string","x-nullable":true},"model":{"description":"Vehicle model","type":"string","x-nullable":true},"photo":{"$ref":"#/definitions/ImageObject","description":"Photo image object (optional)","x-nullable":true},"plate_number":{"description":"Vehicle plate number","type":"string","x-nullable":true},"type":{"description":"Vehicle type","enum":["car","suv","truck","van","equipment"],"type":"string"}},"type":"object"},"VolumeUnitType":{"enum":["L","G"],"type":"string"},"WayForPayDigestData":{"properties":{"merchant_account":{"description":"merchant account","type":"string","x-nullable":true},"merchant_domain_name":{"description":"merchant domain name","type":"string","x-nullable":true},"merchant_signature":{"description":"signature of payment data","type":"string","x-nullable":true},"order_reference":{"description":"reference order id","format":"uuid","type":"string","x-nullable":true},"payment_processing_url":{"description":"callback URL for payment status","type":"string","x-nullable":true}},"type":"object"},"WayForPayDigestRequestData":{"properties":{"amount":{"description":"Payment amount","format":"float","type":"number","x-nullable":true},"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"order_date":{"description":"Order date (unix timestamp)","type":"integer","x-nullable":true},"product_count":{"description":"Product price","format":"float","type":"number","x-nullable":true},"product_name":{"description":"Product name","type":"string","x-nullable":true},"product_price":{"description":"Product price","format":"float","type":"number","x-nullable":true}},"type":"object"},"WayForPayRegularPaymentData":{"properties":{"amount":{"description":"payment amount","format":"float","type":"number","x-nullable":true},"balance_amount":{"description":"balance amount for pay","format":"float","type":"number","x-nullable":true},"currency":{"description":"currency","type":"string","x-nullable":true},"email":{"description":"email","type":"string","x-nullable":true},"order_reference":{"description":"Order reference","format":"uuid","type":"string","x-nullable":true},"purchase":{"properties":{"amount":{"description":"Payment amount","format":"float","type":"number","x-nullable":true},"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"order_date":{"description":"Order date (unix timestamp)","type":"integer","x-nullable":true},"product_count":{"description":"Product price","format":"float","type":"number","x-nullable":true},"product_name":{"description":"Product name","type":"string","x-nullable":true},"product_price":{"description":"Product price","format":"float","type":"number","x-nullable":true}},"type":"object"},"token":{"description":"Card token","type":"string","x-nullable":true}},"required":["currency","amount"],"type":"object"},"WeekDaysList":{"items":{"description":"Day of week","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"type":"string"},"type":"array"},"WhiteLabelApp":{"properties":{"active":{"description":"Active flag","enum":[0,1],"type":"integer"},"code":{"description":"App Code (readonly)","type":"string","x-nullable":true},"id":{"description":"App ID","type":"string","x-nullable":true},"title":{"description":"App Title","type":"string"}},"type":"object"},"WhiteLabelApps":{"items":{"$ref":"#/definitions/WhiteLabelApp"},"type":"array"}},"info":{"description":"### Methods\n`GET`: \t\tRetrieve resources  \n`POST`:\t\tCrete resources      `PATCH`:\tUpdate resources\n\n**Why use PATCH rather than a PUT?**\n`JLab13`: I think PATCH method is the correct choice for updating an\nexisting resources. PUT should only be used if you're replacing a \nresource in its entirety.\n\nFurther information on partial resource modification is available in\n[RFC 5789](http://tools.ietf.org/html/rfc5789). Specifically, the\nPUT method is described as follows:\n\n> Several applications extending the Hypertext Transfer Protocol (HTTP)\n> require a feature to do partial resource modification. The existing\n> HTTP PUT method only allows a complete replacement of a document. \n> This proposal adds a new HTTP method, PATCH, to modify an\n> existing HTTP resource.  \n\n### X-Application-Type HTTP Header\nAll requests must contain a header **X-Application-Type**.  \nThis header defines the type of application that makes the request.  \n\n**Available values:**  \n`web`: \t\t    application that runs in browser as web application  \n`android`: \t\tapplication that runs on android as android application  \n`ios`: \t\t    application that runs on iPhone/iPad/etc as iOS application  \n`windows`: \t\tapplication that runs on windows as windows application  \n`chatbot`: \t    application that runs as chatbot\n`external`: \texternal application and systems which itegrated with inCust API\n","title":"inCust API","version":"1.0"},"paths":{"/all_type_customers":{"get":{"description":"Return list of customers (retail and corporate)","operationId":"incust.controllers.customers_search.search_customers","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Customer's type filtering","enum":["all","customer","corporate-customer"],"in":"query","name":"customer_type","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (email, phone, name, external_id)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"title","description":"Sort field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Customer data object array","schema":{"properties":{"data":{"description":"Customer list","items":{"$ref":"#/definitions/AllTypeCustomer"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]}},"/business":{"get":{"description":"Return Business info","operationId":"incust.controllers.business.business","parameters":[{"default":false,"description":"Extension requared data. Set as 'title' for return 'currency_tittle' and 'country_title' fields","in":"query","name":"ext","required":false,"type":"boolean","x-nullable":true},{"default":false,"description":"If need get tariff plan detail","in":"query","name":"tariff","required":false,"type":"boolean","x-nullable":true}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]},"patch":{"description":"Change exist Business info","operationId":"incust.controllers.business.business_patch","parameters":[{"default":false,"description":"Extension requared data. Set as 'title' for return 'currency_tittle' and 'country_title' fields","in":"query","name":"ext","required":false,"type":"boolean","x-nullable":true},{"description":"Business data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Business"}}],"responses":{"202":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{"fields":{"forbidden":["credit_limit","active"]}},"role":"businessdashboard.business.administrator"}]},"post":{"description":"Add new Business + first Loyalty + first POS + first terminal","operationId":"incust.controllers.business.business_post","parameters":[{"default":false,"description":"Extension requared data. Set as 'title' for return 'currency_tittle' and 'country_title' fields","in":"query","name":"ext","required":false,"type":"boolean","x-nullable":true},{"description":"Business data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessStarter"}}],"responses":{"201":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{"forbidden":["api-key"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/api_key":{"delete":{"description":"Delete/Clear api key for Business","operationId":"incust.controllers.business.delete_api_key","responses":{"200":{"description":"Api key data","schema":{"$ref":"#/definitions/BusinessApiKey"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"get":{"description":"Return the existing API KEY or generate new one for Business","operationId":"incust.controllers.business.get_api_key","parameters":[{"default":false,"description":"Delete the existing API KEY and generate a new one","in":"query","name":"generate","type":"boolean"}],"responses":{"200":{"description":"Api key data","schema":{"$ref":"#/definitions/BusinessApiKey"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/auth/register":{"post":{"description":"Business user register","operationId":"incust.controllers.business_auth.register","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignUpRequestData"}}],"responses":{"201":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/BusinessAuthToken"}},"202":{"description":"Sent pin code for access","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Auth"],"x-application-access-scope-restriction":{"forbidden":["api-key"]},"x-application-role-based-restriction":[]}},"/business/auth/register/pre":{"post":{"description":"Business user register pre-processing","operationId":"incust.controllers.business_auth.register_pre_processing","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignUpRequestData"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Auth"],"x-application-access-scope-restriction":{"forbidden":["api-key"]},"x-application-role-based-restriction":[]}},"/business/auth/social_login/google/token":{"post":{"description":"User authentication via Google Auth. If the user does not exist, a user is created if this is enabled.","operationId":"incust.controllers.business_auth.auth_social_login_google","parameters":[{"description":"User auth data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/GoogleAuthRequestData"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/BusinessAuthToken"}},"202":{"description":"Sent pin code for access","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Auth"],"x-application-access-scope-restriction":{"forbidden":["api-key"]},"x-application-role-based-restriction":[]}},"/business/auth/staff/signin":{"post":{"description":"Staff sign in, return business auth token","operationId":"incust.controllers.business_auth.staff_sign_in","parameters":[{"description":"Staff sign in data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/StaffSignInRequestData"}}],"responses":{"200":{"description":"Authentication TOKEN data","schema":{"$ref":"#/definitions/BusinessAuthToken"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Auth"],"x-application-access-scope-restriction":{"forbidden":["api-key","administration"]},"x-application-role-based-restriction":[]}},"/business/auth/staff/signout":{"post":{"description":"Staff sign out, return business auth token","operationId":"incust.controllers.business_auth.staff_sign_out","parameters":[{"description":"Staff sign in data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/StaffSignOutRequestData"}}],"responses":{"200":{"description":"Authentication TOKEN data","schema":{"$ref":"#/definitions/BusinessAuthToken"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Auth"],"x-application-access-scope-restriction":{"forbidden":["api-key","administration"]},"x-application-role-based-restriction":[]}},"/business/auth/token":{"post":{"description":"Authorize business user Can be use as e-mail/password or phone/pin.","operationId":"incust.controllers.business_auth.token","parameters":[{"description":"User auth data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignInRequestData"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/BusinessAuthToken"}},"202":{"description":"Sent pin code for access","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Auth"],"x-application-access-scope-restriction":{"forbidden":["api-key"]},"x-application-role-based-restriction":[]}},"/business/auth/token/pre":{"post":{"description":"Authorize business user pre-processing","operationId":"incust.controllers.business_auth.token_pre_processing","parameters":[{"description":"User auth data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignInRequestData"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Auth"],"x-application-access-scope-restriction":{"forbidden":["api-key"]},"x-application-role-based-restriction":[]}},"/business/auth/token/renew":{"get":{"description":"Renew and return new business auth token","operationId":"incust.controllers.business_auth.token_renew","responses":{"200":{"description":"Authentication TOKEN data","schema":{"$ref":"#/definitions/BusinessAuthToken"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Auth"],"x-application-access-scope-restriction":{"forbidden":["api-key"]},"x-application-role-based-restriction":[]}},"/business/bonuses_redeem":{"post":{"description":"Redeem Incust business bonuses","operationId":"incust.controllers.business.incust_bonuses_redeem","parameters":[{"description":"bonuses redeem object","in":"body","name":"data","required":true,"schema":{"type":"object"}}],"responses":{"200":{"description":"Payment info"},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/check_referral/{code}":{"get":{"description":"Check exist referral code","operationId":"incust.controllers.business.check_referral_code","parameters":[{"description":"Business code number","in":"path","name":"code","required":true,"type":"string"}],"responses":{"200":{"description":"Ok or error","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"]}},"/business/currencies":{"get":{"description":"Return array of business currencies","operationId":"incust.controllers.business.currencies_get","parameters":[{"description":"Unique identifier of loyalty","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"default":false,"description":"Include goods prices currencies","in":"query","name":"goods_prices_currencies","required":false,"type":"boolean"}],"responses":{"200":{"description":"Array of business customers","schema":{"$ref":"#/definitions/Currencies"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/business/custom/preferences":{"patch":{"description":"Set custom preferences parameter by name","operationId":"incust.controllers.business.business_user_preferences_set","parameters":[{"description":"Parameter data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomPreferencesParameter"}}],"responses":{"202":{"description":"Parameter data","schema":{"$ref":"#/definitions/CustomPreferencesParameter"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]},"post":{"description":"Get custom preferences parameter by name","operationId":"incust.controllers.business.business_user_preferences_get","parameters":[{"description":"Parameter data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomPreferencesParameterRequest"}}],"responses":{"202":{"description":"Parameter data","schema":{"$ref":"#/definitions/CustomPreferencesParameter"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/business/dashboard":{"get":{"description":"Return Business info for dashboard","operationId":"incust.controllers.business.dashboard","responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/business/flutterwave/create_payment_new":{"post":{"description":"Create new Flutterwave payment","operationId":"incust.controllers.business.flutterwave_create_payment_new","parameters":[{"description":"Customer access type","in":"body","name":"data","required":true,"schema":{"properties":{"amount":{"description":"Amount of payment","format":"float","type":"number"},"currency":{"description":"currency","type":"string"}},"required":["currency","amount"],"type":"object"}}],"responses":{"200":{"description":"Flutterwave payment object","schema":{"properties":{"payment_id":{"description":"Payment unique Id","type":"string"},"payment_processing_url":{"description":"Payment processing URL","type":"string"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/general_status":{"get":{"description":"Return Business general status","operationId":"incust.controllers.business.general_status","responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/business/legal_info":{"get":{"description":"Return business legal info","operationId":"incust.controllers.business.legal_info","responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/BusinessLegalInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Add special account","operationId":"incust.controllers.business.legal_info_edit","parameters":[{"description":"Account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessLegalInfo"}}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/BusinessLegalInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/business/liqpay/create_payment_new":{"post":{"description":"Create new LiqPay payment","operationId":"incust.controllers.business.liqpay_create_payment_new","parameters":[{"description":"Customer access type","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LiqPayBusinessPaymentNewInitialData"}}],"responses":{"200":{"description":"Payment Data object","schema":{"$ref":"#/definitions/LiqPayBusinessPaymentData"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/liqpay/regular_payment":{"post":{"description":"Set regular payment params","operationId":"incust.controllers.business.liqpay_regular_payment","parameters":[{"description":"regular payment object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LiqPayRegularPaymentData"}}],"responses":{"200":{"description":"Regular payment info","schema":{"$ref":"#/definitions/BusinessAutoPayParams"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/paypro/create_payment_new":{"post":{"description":"Return order reference","operationId":"incust.controllers.business.paypro_create_payment_new","parameters":[{"description":"payment object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PayProOrderRequestData"}}],"responses":{"200":{"description":"digest and order reference info","schema":{"$ref":"#/definitions/PayProOrderData"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/regular_payment":{"delete":{"description":"Clear current regular payment params","operationId":"incust.controllers.business.business_regular_payment_delete","responses":{"200":{"description":"Regular Payment info","schema":{"$ref":"#/definitions/BusinessAutoPayParams"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"get":{"description":"Get current regular payment params","operationId":"incust.controllers.business.business_regular_payment_get","responses":{"200":{"description":"Regular Payment info","schema":{"$ref":"#/definitions/BusinessAutoPayParams"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/role_based_model":{"patch":{"description":"Set Business role based model state","operationId":"incust.controllers.business.business_role_based_model_set","parameters":[{"description":"Business role based model data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessRoleBasedModel"}}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/settings":{"get":{"description":"Return Business additional settings","operationId":"incust.controllers.business.settings","responses":{"200":{"description":"Business settings data","schema":{"$ref":"#/definitions/BusinessSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Change Business additional settings","operationId":"incust.controllers.business.settings_patch","parameters":[{"description":"Business additional settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessSettings"}}],"responses":{"200":{"description":"Business settings data","schema":{"$ref":"#/definitions/BusinessSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/business/settings/messages/providers/{message_type}":{"delete":{"description":"Change Business additional settings","operationId":"incust.controllers.business.settings_messages_custom_provider_delete","parameters":[{"description":"Message channel type","enum":["sms","push","viber","email","incust-chatbot","external-system"],"in":"path","name":"message_type","required":true,"type":"string"}],"responses":{"200":{"description":"Business custom message service provider settings","schema":{"$ref":"#/definitions/MessageCustomServiceProvider"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]},"get":{"description":"Return Business custom message service provider settings for message type","operationId":"incust.controllers.business.settings_messages_custom_provider_get","parameters":[{"description":"Message channel type","enum":["sms","push","viber","email","incust-chatbot","external-system"],"in":"path","name":"message_type","required":true,"type":"string"}],"responses":{"200":{"description":"Business custom message service provider settings","schema":{"$ref":"#/definitions/MessageCustomServiceProvider"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Change Business additional settings","operationId":"incust.controllers.business.settings_messages_custom_provider_set","parameters":[{"description":"Message channel type","enum":["sms","push","viber","email","incust-chatbot","external-system"],"in":"path","name":"message_type","required":true,"type":"string"},{"description":"Business custom message service provider settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/MessageCustomServiceProvider"}}],"responses":{"200":{"description":"Business custom message service provider settings","schema":{"$ref":"#/definitions/MessageCustomServiceProvider"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/business/settings/notifications":{"get":{"description":"Return Business notification settings","operationId":"incust.controllers.business.business_notifications_settings","responses":{"200":{"description":"Business notifications settings","schema":{"$ref":"#/definitions/NotificationsSettingsBusiness"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Set Business notification settings","operationId":"incust.controllers.business.business_notifications_settings_set","parameters":[{"description":"Business notifications settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/NotificationsSettingsBusiness"}}],"responses":{"200":{"description":"Business notifications settings","schema":{"$ref":"#/definitions/NotificationsSettingsBusiness"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/settings/photo":{"delete":{"description":"Delete/Clear business photo.","operationId":"incust.controllers.business.business_photo_delete","responses":{"200":{"description":"Business settings data","schema":{"$ref":"#/definitions/BusinessSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set business photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.business.business_photo_store","parameters":[{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Business settings data","schema":{"$ref":"#/definitions/BusinessSettings"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/business/sms_tariff":{"get":{"description":"Return info above sms tarifs","operationId":"incust.controllers.business.sms_tariff_details","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Users count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Country code","in":"query","name":"country","required":false,"type":"string"}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]}},"/business/special_account":{"get":{"description":"Return special accounts list","operationId":"incust.controllers.account.special_accounts","parameters":[{"default":"retail","description":"Scope of accounts","enum":["retail","corporate","all"],"in":"query","name":"scope","required":false,"type":"string"}],"responses":{"200":{"description":"Special Accounts list data","schema":{"$ref":"#/definitions/SpecialAccountsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Special Account"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.data_viewer"}]},"post":{"description":"Add special account","operationId":"incust.controllers.account.special_account_add","parameters":[{"description":"Account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SpecialAccount"}}],"responses":{"200":{"description":"Special Account data","schema":{"$ref":"#/definitions/SpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Special Account"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"}]}},"/business/special_account/{account_id}":{"get":{"description":"Return special account","operationId":"incust.controllers.account.special_account","parameters":[{"description":"Account id","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Special Account data","schema":{"$ref":"#/definitions/SpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Special Account"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.data_viewer"}]},"patch":{"description":"Modify special account data","operationId":"incust.controllers.account.special_account_edit","parameters":[{"description":"Account id","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SpecialAccount"}}],"responses":{"200":{"description":"Special Account data","schema":{"$ref":"#/definitions/SpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Special Account"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"}]}},"/business/special_account/{account_id}/goods":{"get":{"description":"Return special account available goods list","operationId":"incust.controllers.account.special_account_goods","parameters":[{"description":"Account id","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Special Account"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.data_viewer"}]}},"/business/special_account/{account_id}/loyalty/{loyalty_id}/customers":{"get":{"description":"Customer special accounts list","operationId":"incust.controllers.account.special_account_customer_accounts","parameters":[{"description":"Account id","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty id","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Rows count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Account extended filtering (null - filtering disabled)","in":"query","name":"account_extended","required":false,"type":"boolean","x-nullable":true},{"description":"Account credit type filtering (null - filtering disabled)","enum":["debit","credit","credit-unlimited"],"in":"query","name":"account_credit_type","required":false,"type":"string","x-nullable":true},{"description":"Account credit limit greater than or equal (null - filtering disabled)","format":"float","in":"query","name":"credit_limit_gte","required":false,"type":"number","x-nullable":true},{"description":"Account credit limit less than or equal (null - filtering disabled)","format":"float","in":"query","name":"credit_limit_lte","required":false,"type":"number","x-nullable":true},{"description":"Account balance (amount + credit limit) greater than or equal (null - filtering disabled)","format":"float","in":"query","name":"balance_gte","required":false,"type":"number","x-nullable":true},{"description":"Account balance (amount + credit limit) less than or equal (null - filtering disabled)","format":"float","in":"query","name":"balance_lte","required":false,"type":"number","x-nullable":true},{"description":"Account amount greater than or equal (null - filtering disabled)","format":"float","in":"query","name":"amount_gte","required":false,"type":"number","x-nullable":true},{"description":"Account amount less than or equal (null - filtering disabled)","format":"float","in":"query","name":"amount_lte","required":false,"type":"number","x-nullable":true}],"responses":{"200":{"description":"Customer special accounts list","schema":{"$ref":"#/definitions/CustomerSpecialAccountsListPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Special Account"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer_account.data_viewer"}]},"patch":{"description":"Add or set special account for customer","operationId":"incust.controllers.account.special_account_customer_account_set","parameters":[{"description":"Account id","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty id","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Add new customer only if user already exists","in":"query","name":"existing_user_only","required":false,"type":"boolean"},{"description":"Cusctomer special account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerSpecialAccount"}}],"responses":{"200":{"description":"Customer special account data","schema":{"$ref":"#/definitions/CustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Special Account"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer_account.manager"}]}},"/business/stripe/base_payment_info":{"get":{"description":"Get Stripe base payment info","operationId":"incust.controllers.business.stripe_base_payment_info","responses":{"200":{"description":"Base checkout info","schema":{"$ref":"#/definitions/StripePaymentInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/stripe/create_payment_by_saved":{"post":{"description":"Create Stripe payment by saved card","operationId":"incust.controllers.business.stripe_create_payment_by_saved","parameters":[{"description":"Customer access type","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/StripeBusinessPaymentSavedInitialData"}}],"responses":{"200":{"description":"Payment Data object","schema":{"$ref":"#/definitions/StripeBusinessPaymentData"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/stripe/create_payment_new":{"post":{"description":"Create new Stripe payment","operationId":"incust.controllers.business.stripe_create_payment_new","parameters":[{"description":"Customer access type","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/StripeBusinessPaymentNewInitialData"}}],"responses":{"200":{"description":"Payment Data object","schema":{"$ref":"#/definitions/StripeBusinessPaymentData"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/tariff_change_to_base":{"patch":{"description":"Change trial tariff plan to its base","operationId":"incust.controllers.business.tariff_change_to_base","responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/tariff_details":{"get":{"description":"Return info above tariff","operationId":"incust.controllers.business.tariff_details","parameters":[{"description":"Report period","format":"date","in":"query","name":"date","type":"string"}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/BusinessTariffDetails"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]}},"/business/tariff_details/billing/{billing_operation_id}":{"get":{"description":"Return info about billing operation","operationId":"incust.controllers.business.tariff_details_billing_operation_get","parameters":[{"description":"Operation id","format":"uuid","in":"path","name":"billing_operation_id","required":true,"type":"string"}],"responses":{"200":{"description":"Billing operation data","schema":{"$ref":"#/definitions/BusinessBillingDetails"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]}},"/business/tariff_set":{"patch":{"description":"Set new tariff plan","operationId":"incust.controllers.business.business_set_tariff","parameters":[{"in":"body","name":"data","schema":{"$ref":"#/definitions/TariffSetRequestData"}}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/tariffs_available":{"get":{"description":"List of available tariff plans","operationId":"incust.controllers.business.business_available_tariffs","parameters":[{"default":"upgrade","description":"Tariff plans type","enum":["upgrade","downgrade"],"in":"query","name":"tariff_type","required":false,"type":"string"}],"responses":{"200":{"description":"Available Tariff Plans array","schema":{"$ref":"#/definitions/TariffList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/business/user/avatar":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set business user avatar. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.business_user.business_user_store_avatar","parameters":[{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/BusinessUserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"forbidden":["api-key","payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/change_password":{"post":{"description":"Change business user password","operationId":"incust.controllers.business_user.change_password","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"properties":{"password":{"description":"Password","minLength":4,"type":"string"}},"required":["password"],"type":"object"}}],"responses":{"200":{"description":"Authentication TOKEN data","schema":{"$ref":"#/definitions/BusinessAuthToken"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/confirm_email/{email_token}":{"get":{"description":"Confirm mail","operationId":"incust.controllers.business_user.confirm_email","parameters":[{"description":"Protected data","in":"path","name":"email_token","required":true,"type":"string"}],"responses":{"200":{"description":"Email info","schema":{"$ref":"#/definitions/EmailRecord"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"]}},"/business/user/email/change":{"post":{"description":"Change business user primary email (login)","operationId":"incust.controllers.business_user.change_primary_email","parameters":[{"description":"New Email","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"202":{"description":"Send email with pin code for verification","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/email/change/pre":{"post":{"description":"Change business user primary email (login) pre-processing","operationId":"incust.controllers.business_user.change_primary_email_pre_processing","parameters":[{"description":"New Email","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/email/validate":{"post":{"description":"Check email for correctness and uniqueness","operationId":"incust.controllers.business_user.validate_email","parameters":[{"description":"Email for validation","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierValidationRequestObject"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/email/verify":{"post":{"description":"Check email for correctness and uniqueness and verify","operationId":"incust.controllers.business_user.verify_email","parameters":[{"description":"Email for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Verified email","schema":{"$ref":"#/definitions/IdentifierVerifiedObject"}},"202":{"description":"Sent email with pin code for verification","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/email/verify/pre":{"post":{"description":"Check email for correctness and uniqueness and verify pre-processing","operationId":"incust.controllers.business_user.verify_email_pre_processing","parameters":[{"description":"Email for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/external_id/change":{"post":{"description":"Change business user external ID","operationId":"incust.controllers.business_user.change_primary_external_id","parameters":[{"description":"New external ID","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"202":{"description":"Send message with pin code for verification","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/external_id/change/pre":{"post":{"description":"Change business user external ID pre-processing","operationId":"incust.controllers.business_user.change_primary_external_id_pre_processing","parameters":[{"description":"New external ID","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/external_id/validate":{"post":{"description":"Check external ID for uniqueness","operationId":"incust.controllers.business_user.validate_external_id","parameters":[{"description":"External ID number for validation","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierValidationRequestObject"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/external_id/verify":{"post":{"description":"Check external ID for uniqueness and verify","operationId":"incust.controllers.business_user.verify_external_id","parameters":[{"description":"External ID number for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Verified external ID number","schema":{"$ref":"#/definitions/IdentifierVerifiedObject"}},"202":{"description":"Sent message with pin code for verification","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/external_id/verify/pre":{"post":{"description":"Check external ID for uniqueness and verify pre-processing","operationId":"incust.controllers.business_user.verify_external_id_pre_processing","parameters":[{"description":"External ID number for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/incust_support":{"post":{"description":"Make e-mail for inCust support","operationId":"incust.controllers.business_user.incust_support","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"properties":{"subject":{"description":"Subject of email","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/business/user/language":{"get":{"description":"Return business user language","operationId":"incust.controllers.business_user.business_user_language_get","responses":{"200":{"description":"Language data","schema":{"$ref":"#/definitions/BusinessUserLanguage"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"forbidden":["api-key","payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Change and return modifyed business user language","operationId":"incust.controllers.business_user.business_user_language_patch","parameters":[{"description":"Language data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessUserLanguage"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/BusinessUserLanguage"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"forbidden":["api-key","payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/phone/change":{"post":{"description":"Change business user primary phone","operationId":"incust.controllers.business_user.change_primary_phone","parameters":[{"description":"New Phone number","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"202":{"description":"Send email with pin code for verification","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/phone/change/pre":{"post":{"description":"Change business user primary phone pre-processing","operationId":"incust.controllers.business_user.change_primary_phone_pre_processing","parameters":[{"description":"New Phone number","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PrimaryIdentifierChangeObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/phone/validate":{"post":{"description":"Check phone for correctness and uniqueness","operationId":"incust.controllers.business_user.validate_phone","parameters":[{"description":"Phone number for validation","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierValidationRequestObject"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/phone/verify":{"post":{"description":"Check phone for correctness and uniqueness and verify","operationId":"incust.controllers.business_user.verify_phone","parameters":[{"description":"Phone number for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Verified phone number","schema":{"$ref":"#/definitions/IdentifierVerifiedObject"}},"202":{"description":"Sent sms with pin code for verification","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/phone/verify/pre":{"post":{"description":"Check phone for correctness and uniqueness and verify pre-processing","operationId":"incust.controllers.business_user.verify_phone_pre_processing","parameters":[{"description":"Phone number for verification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierVerificationRequestObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/PreProcessingResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/profile":{"get":{"description":"Return business user profile","operationId":"incust.controllers.business_user.business_user_profile_get","responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/BusinessUserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"forbidden":["api-key","payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Change and return modifyed business user profile","operationId":"incust.controllers.business_user.business_user_profile_patch","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessUserProfile"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/BusinessUserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"forbidden":["api-key","payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/user/request_confirm_email/{email}":{"get":{"description":"Request confirm  mail","operationId":"incust.controllers.business_user.request_confirm_email","parameters":[{"description":"User email","in":"path","name":"email","required":true,"type":"string"}],"responses":{"200":{"description":"Information message","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business User Account"],"x-application-access-scope-restriction":{"allowed":["security"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/viber_tariff":{"get":{"description":"Return info above viber tarifs","operationId":"incust.controllers.business.viber_tariff_details","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Users count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Country code","in":"query","name":"country","required":false,"type":"string"}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]}},"/business/wayforpay/create_payment_new":{"post":{"description":"Return digest and order reference","operationId":"incust.controllers.business.wayforpay_create_payment_new","parameters":[{"description":"payment object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/WayForPayDigestRequestData"}}],"responses":{"200":{"description":"digest and order reference info","schema":{"$ref":"#/definitions/WayForPayDigestData"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/wayforpay/regular_payment":{"post":{"description":"Set regular payment params","operationId":"incust.controllers.business.wayforpay_regular_payment","parameters":[{"description":"regular payment object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/WayForPayRegularPaymentData"}}],"responses":{"200":{"description":"Regular payment info","schema":{"$ref":"#/definitions/BusinessAutoPayParams"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business External Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/business/white_label/applications":{"get":{"description":"Return list of white label applications available for business","operationId":"incust.controllers.business.white_label_apps","responses":{"200":{"description":"White Label list","schema":{"$ref":"#/definitions/WhiteLabelApps"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]}},"/cards/category_assign":{"post":{"description":"Set card category to user account.","operationId":"incust.controllers.customer_category.category_assign_user","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"category_id":{"description":"Category ID","type":"string"},"loyalty_id":{"description":"Loyalty ID","type":"string"}},"required":["category_id","loyalty_id"],"type":"object"}}],"responses":{"200":{"description":"Operation result","schema":{"$ref":"#/definitions/OperationResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/corporate_customers":{"get":{"description":"Return corporate customers list of business","operationId":"incust.controllers.corporate_customer.customers","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"default":"all","description":"Filter by suspended flag","enum":["all","yes","no"],"in":"query","name":"suspended","required":false,"type":"string"},{"description":"Filter by primary email ID (matching criteria)","in":"query","name":"email","required":false,"type":"string"},{"description":"Filter by category_id ('none' - customers without category)","in":"query","name":"category_id","required":false,"type":"string","x-nullable":true},{"description":"Filter by search string (contains criteria) in main text fields (name, company name, coontacts, etc)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"email","description":"Sort field name","enum":["email","name","company_name","country","post_code","region","city","address","comment","suspended"],"in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Corporate customers array","schema":{"properties":{"data":{"description":"Corporate cusctomers list","items":{"$ref":"#/definitions/CorporateCustomer"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total customers count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"post":{"description":"Add new corporate customer","operationId":"incust.controllers.corporate_customer.customer_add","parameters":[{"description":"Customer data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomer"}}],"responses":{"200":{"description":"Corporate customer data","schema":{"$ref":"#/definitions/CorporateCustomer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/categories":{"get":{"description":"Return corporate customers categories list","operationId":"incust.controllers.corporate_customer.categories","responses":{"200":{"description":"Corporate customer categories data","schema":{"$ref":"#/definitions/CorporateCustomerCategoriesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"post":{"description":"Add corporate customer category","operationId":"incust.controllers.corporate_customer.category_add","parameters":[{"description":"Card category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerCategory"}}],"responses":{"200":{"description":"Card category data","schema":{"$ref":"#/definitions/CorporateCustomerCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/categories/assign":{"post":{"description":"Change corporate customers category","operationId":"incust.controllers.corporate_customer.category_assign_corporate_customers","parameters":[{"description":"Corporate customers list","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerCategoryAssign"}}],"responses":{"200":{"description":"Operation result","schema":{"$ref":"#/definitions/OperationResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/categories/{category_id}":{"get":{"description":"Return corporate customers category info","operationId":"incust.controllers.corporate_customer.category","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"}],"responses":{"200":{"description":"Corporate customer categories data","schema":{"$ref":"#/definitions/CorporateCustomerCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Change corporate customers category","operationId":"incust.controllers.corporate_customer.category_patch","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Corporate customer categories data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerCategory"}}],"responses":{"200":{"description":"Corporate customer categories data","schema":{"$ref":"#/definitions/CorporateCustomerCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/categories/{category_id}/special_accounts/{account_id}/price_options":{"get":{"description":"Return list of price options for category special account","operationId":"incust.controllers.corporate_customer.category_special_account_price_options_list","parameters":[{"description":"Corporate customer category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods price options","schema":{"$ref":"#/definitions/CorporateCustomerCategoryAccountPriceOptionList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"post":{"description":"Add goods item price option for category special account","operationId":"incust.controllers.corporate_customer.category_special_account_price_option_add","parameters":[{"description":"Corporate customer category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Goods item price option object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerCategoryAccountPriceOption"}}],"responses":{"200":{"description":"Added goods item price option object","schema":{"$ref":"#/definitions/CorporateCustomerCategoryAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/categories/{category_id}/special_accounts/{account_id}/price_options/{item_id}":{"delete":{"description":"Delete goods item price option for category special account","operationId":"incust.controllers.corporate_customer.category_special_account_price_option_delete","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods price options","schema":{"$ref":"#/definitions/CorporateCustomerCategoryAccountPriceOptionList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]},"get":{"description":"Get goods item price option for category special account","operationId":"incust.controllers.corporate_customer.category_special_account_price_option_get","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods item price option object","schema":{"$ref":"#/definitions/CorporateCustomerCategoryAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify goods item price option for category special account","operationId":"incust.controllers.corporate_customer.category_special_account_price_option_edit","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"},{"description":"Goods item price option object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerCategoryAccountPriceOption"}}],"responses":{"200":{"description":"Goods item price option object","schema":{"$ref":"#/definitions/CorporateCustomerCategoryAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/categories/{category_id}/special_accounts/{account_id}/taxes":{"delete":{"description":"Reset tax options for special account","operationId":"incust.controllers.corporate_customer.category_special_account_taxes_reset","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]},"get":{"description":"Return list of tax options for category special account","operationId":"incust.controllers.corporate_customer.category_special_account_taxes","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/TaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify and return list of tax options for special account","operationId":"incust.controllers.corporate_customer.category_special_account_taxes_edit","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Array of taxes","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TaxOptionsList"}}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/TaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/categories/{category_id}/special_accounts/{account_id}/taxes/items":{"delete":{"description":"Reset items tax options for special account","operationId":"incust.controllers.corporate_customer.category_special_account_taxes_items_reset","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]},"get":{"description":"Return list of items tax options for special account","operationId":"incust.controllers.corporate_customer.category_special_account_taxes_items","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Item Loyalty Id filter (if needed)","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true},{"default":false,"description":"Return only active items objects (if needed)","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Item category Id filter (if needed). For root category used 'root' value.","format":"uuid","in":"query","name":"item_category_id","required":false,"type":"string","x-nullable":true},{"description":"Item search by code, cointains criteria (if needed)","in":"query","name":"code","required":false,"type":"string","x-nullable":true},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/ItemsTaxOptionsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify items tax options for special account","operationId":"incust.controllers.corporate_customer.category_special_account_taxes_items_edit","parameters":[{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Array of taxes","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ItemsTaxOptionsList"}}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/ItemsTaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/customers_bulk_ids":{"get":{"description":"Get corporate customers ID for bulk operations","operationId":"incust.controllers.corporate_customer.customers_bulk_ids","parameters":[{"default":"all","description":"Filter by suspended flag","enum":["all","yes","no"],"in":"query","name":"suspended","required":false,"type":"string"},{"description":"Filter by primary email ID (matching criteria)","in":"query","name":"email","required":false,"type":"string"},{"description":"Filter by category_id ('none' - customers without category)","in":"query","name":"category_id","required":false,"type":"string","x-nullable":true},{"description":"Filter by search string (contains criteria) in main text fields (name, company name, coontacts, etc)","in":"query","name":"search_text","required":false,"type":"string"}],"responses":{"200":{"description":"Customer IDs","schema":{"$ref":"#/definitions/ObjectIds"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]}},"/corporate_customers/questionnaires/fields":{"get":{"description":"Return corporate customers default questionnaire fields","operationId":"incust.controllers.corporate_customer.default_questionnaire_fields","responses":{"200":{"description":"Array of fields","schema":{"items":{"$ref":"#/definitions/QuestionnaireField"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Save default questionnaire fields orders","operationId":"incust.controllers.corporate_customer.default_questionnaire_field_save_orders","parameters":[{"description":"Fields Id array","in":"body","name":"data","required":true,"schema":{"items":{"description":"Field ID","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Array of fields","schema":{"items":{"$ref":"#/definitions/QuestionnaireField"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]},"post":{"description":"Add new default questionnaire field","operationId":"incust.controllers.corporate_customer.default_questionnaire_field_add","parameters":[{"description":"Field data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/QuestionnaireField"}}],"responses":{"201":{"description":"Field data","schema":{"$ref":"#/definitions/QuestionnaireField"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/questionnaires/fields/{field_id}":{"delete":{"description":"Delete default questionnaire field","operationId":"incust.controllers.corporate_customer.default_questionnaire_field_del","parameters":[{"description":"Field ID","in":"path","name":"field_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of fields","schema":{"items":{"$ref":"#/definitions/QuestionnaireField"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]},"get":{"description":"Return default questionnaire field info","operationId":"incust.controllers.corporate_customer.default_questionnaire_field_get","parameters":[{"description":"Field ID","format":"uuid","in":"path","name":"field_id","required":true,"type":"string"}],"responses":{"200":{"description":"Field data","schema":{"$ref":"#/definitions/QuestionnaireField"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify default questionnaire field info","operationId":"incust.controllers.corporate_customer.default_questionnaire_field_edit","parameters":[{"description":"Field ID","in":"path","name":"field_id","required":true,"type":"string"},{"description":"Field data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/QuestionnaireField"}}],"responses":{"200":{"description":"Field data","schema":{"$ref":"#/definitions/QuestionnaireField"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}":{"get":{"description":"Return corporate customer info","operationId":"incust.controllers.corporate_customer.customer_get","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"}],"responses":{"200":{"description":"Corporate customer data","schema":{"$ref":"#/definitions/CorporateCustomer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify corporate customer","operationId":"incust.controllers.corporate_customer.customer_edit","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomer"}}],"responses":{"200":{"description":"Corporate customer data","schema":{"$ref":"#/definitions/CorporateCustomer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts":{"get":{"description":"Return corporate customer special accounts","operationId":"incust.controllers.corporate_customer.customer_special_accounts","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"}],"responses":{"200":{"description":"Corporate customers special accounts array","schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccountsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"post":{"description":"Add special account for corporate customer","operationId":"incust.controllers.corporate_customer.customer_special_account_add","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate cusctomer special account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"}}],"responses":{"200":{"description":"Corporate customer special account data","schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}":{"get":{"description":"Return special account for corporate customer","operationId":"incust.controllers.corporate_customer.customer_special_account_get","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Corporate customer special account data","schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify special account for corporate customer","operationId":"incust.controllers.corporate_customer.customer_special_account_edit","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Corporate cusctomer special account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"}}],"responses":{"200":{"description":"Corporate customer special account data","schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}/adjust":{"post":{"description":"Adjust (refill or write-offs) special account for corporate customer","operationId":"incust.controllers.transaction.corporate_customer_special_account_adjust","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Refill data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateSpecialAccountOperationObject"}}],"responses":{"200":{"description":"Corporate customer special account data","schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}/goods":{"get":{"description":"Return special account available goods list for corporate customer","operationId":"incust.controllers.corporate_customer.customer_special_account_goods_list","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}/price_options":{"get":{"description":"Return list of price options for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_price_options_list","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods price options","schema":{"$ref":"#/definitions/CorporateCustomerAccountPriceOptionList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"post":{"description":"Add goods item price option for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_price_option_add","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Goods item price option object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerAccountPriceOption"}}],"responses":{"200":{"description":"Added goods item price option object","schema":{"$ref":"#/definitions/CorporateCustomerAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}/price_options/{item_id}":{"delete":{"description":"Delete goods item price option for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_price_option_delete","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods price options","schema":{"$ref":"#/definitions/CorporateCustomerAccountPriceOptionList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]},"get":{"description":"Get goods item price option for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_price_option_get","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods item price option object","schema":{"$ref":"#/definitions/CorporateCustomerAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify goods item price option for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_price_option_edit","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"},{"description":"Goods item price option object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateCustomerAccountPriceOption"}}],"responses":{"200":{"description":"Goods item price option object","schema":{"$ref":"#/definitions/CorporateCustomerAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}/refill":{"post":{"description":"Refill special account for corporate customer","operationId":"incust.controllers.transaction.corporate_customer_special_account_refill","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Refill data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateSpecialAccountOperationObject"}}],"responses":{"200":{"description":"Corporate customer special account data","schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}/taxes":{"delete":{"description":"Reset tax options for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_taxes_reset","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]},"get":{"description":"Return list of tax options for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_taxes","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/TaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify and return list of tax options for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_taxes_edit","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Array of taxes","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TaxOptionsList"}}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/TaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}/taxes/items":{"delete":{"description":"Reset items tax options for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_taxes_items_reset","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]},"get":{"description":"Return list of items tax options for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_taxes_items","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Item Loyalty Id filter (if needed)","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true},{"default":false,"description":"Return only active items objects (if needed)","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Item category Id filter (if needed). For root category used 'root' value.","format":"uuid","in":"query","name":"item_category_id","required":false,"type":"string","x-nullable":true},{"description":"Item search by code, cointains criteria (if needed)","in":"query","name":"code","required":false,"type":"string","x-nullable":true},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/ItemsTaxOptionsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.data_viewer"}]},"patch":{"description":"Modify items tax options for special account","operationId":"incust.controllers.corporate_customer.customer_special_account_taxes_items_edit","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Array of taxes","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ItemsTaxOptionsList"}}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/ItemsTaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/corporate_customers/{customer_id}/special_accounts/{account_id}/write_offs":{"post":{"description":"Write-offs special account for corporate customer","operationId":"incust.controllers.transaction.corporate_customer_special_account_write_off","parameters":[{"description":"Corporate customer ID","format":"uuid","in":"path","name":"customer_id","required":true,"type":"string"},{"description":"Corporate customer special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Refill data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateSpecialAccountOperationObject"}}],"responses":{"200":{"description":"Corporate customer special account data","schema":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.corporate_customer.manager"}]}},"/coupons":{"post":{"description":"Return all coupons list","operationId":"incust.controllers.coupon.coupons_all","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponsListRequestData"}}],"responses":{"200":{"description":"Coupons array","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]}},"/coupons/batch/{batch_id}":{"get":{"description":"Return coupon batch object","operationId":"incust.controllers.coupon.batch","parameters":[{"description":"Coupon batch ID","in":"path","name":"batch_id","required":true,"type":"string"}],"responses":{"200":{"description":"Coupon batch data","schema":{"$ref":"#/definitions/CouponBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]},"patch":{"description":"Change exist coupon batch info","operationId":"incust.controllers.coupon.batch_edit","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Coupon batch data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponBatch"}}],"responses":{"200":{"description":"Coupon batch data","schema":{"$ref":"#/definitions/CouponBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/aliases":{"get":{"description":"Return batch aliases list","operationId":"incust.controllers.coupon.batch_aliases_get","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Filter by code","in":"query","name":"code","required":false,"type":"string"},{"default":false,"description":"Return only active aliases","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":false,"description":"Return only minimal info of aliases","in":"query","name":"minimal_info","required":false,"type":"boolean"}],"responses":{"200":{"description":"Aliases array","schema":{"$ref":"#/definitions/CouponBatchAliases"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]}},"/coupons/batch/{batch_id}/aliases/add":{"post":{"description":"Create aliases and return created aliases list","operationId":"incust.controllers.coupon.batch_aliases_create","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Create aliases data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponBatchAliasesCreateData"}}],"responses":{"200":{"description":"Aliases array","schema":{"$ref":"#/definitions/CouponBatchAliases"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/aliases/modify":{"post":{"description":"Modify batch aliases and return modified aliases list","operationId":"incust.controllers.coupon.batch_aliases_modify","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Modify aliases data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponBatchAliasesModifyData"}}],"responses":{"200":{"description":"Aliases array","schema":{"$ref":"#/definitions/CouponBatchAliases"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/cancel":{"get":{"description":"Coupon batch cancel","operationId":"incust.controllers.coupon.batch_cancel","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"default":false,"description":"Count of coupons for emission","in":"query","name":"cancel_coupons","required":false,"type":"boolean"}],"responses":{"200":{"description":"Coupon batch data","schema":{"$ref":"#/definitions/CouponBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/coupons/cancel":{"get":{"description":"Coupon batch cancel","operationId":"incust.controllers.coupon.batch_coupons_cancel","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"}],"responses":{"200":{"description":"Coupon batch data","schema":{"$ref":"#/definitions/CouponBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/coupons/send":{"post":{"description":"Send (emit if needed) batch coupons to the customers","operationId":"incust.controllers.coupon.send_batch_coupons_to_customers","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponsSendOperationObject"}}],"responses":{"200":{"description":"Coupon data","schema":{"$ref":"#/definitions/Coupon"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/emission":{"get":{"description":"Coupon emission and return emitted coupons list","operationId":"incust.controllers.coupon.batch_emission","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"default":1,"description":"Count of coupons for emission","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Coupons array","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/external_codes":{"get":{"description":"Return external coupon batch external codes list","operationId":"incust.controllers.coupon.batch_external_codes_get","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":0,"description":"Count of codes on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"External codes array","schema":{"items":{"$ref":"#/definitions/CouponBatchExtCode"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/external_codes/add":{"post":{"description":"Add external codes for coupon batch and return list of external codes","operationId":"incust.controllers.coupon.batch_external_codes_add","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"List of external codes","in":"body","name":"data","required":true,"schema":{"items":{"description":"External code","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Operation result summary","schema":{"$ref":"#/definitions/CouponBatchExtCodeResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/external_codes/delete":{"post":{"description":"Delete external codes for coupon batch and return list of external codes","operationId":"incust.controllers.coupon.batch_external_codes_delete","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"List of external codes","in":"body","name":"data","required":true,"schema":{"items":{"description":"External code","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Operation result summary","schema":{"$ref":"#/definitions/CouponBatchExtCodeResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/links":{"get":{"description":"Return batch links list","operationId":"incust.controllers.coupon.batch_links_get","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"}],"responses":{"200":{"description":"Links array","schema":{"$ref":"#/definitions/CouponBatchLinks"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]},"patch":{"description":"Update batch links list","operationId":"incust.controllers.coupon.batch_links_set","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Links array","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponBatchLinks"}}],"responses":{"200":{"description":"Links array","schema":{"$ref":"#/definitions/CouponBatchLinks"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batch/{batch_id}/photo":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set coupon batch photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.coupon.store_photo","parameters":[{"description":"Coupon batch ID.","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Coupon batch data","schema":{"$ref":"#/definitions/CouponBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batches":{"get":{"description":"Return all coupon batches list","operationId":"incust.controllers.coupon.batches_all","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Coupon batch Loyalty ID filter (all loyalties if not exists or null)","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true},{"default":false,"description":"Return only active batches","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Coupon batch tupe filter (all types if not exists or null)","enum":["check-modifier","certificate","external","cross-business"],"in":"query","name":"batch_type","required":false,"type":"string","x-nullable":true},{"description":"Coupon batch code filter (all batches if not exists or null)","in":"query","name":"code","required":false,"type":"string","x-nullable":true},{"description":"Coupon batch title filter (contains criteria, all batches if not exists or null)","in":"query","name":"title","required":false,"type":"string","x-nullable":true},{"description":"Coupon batch created date and time filter from in RFC3339","format":"date-time","in":"query","name":"created_from","required":false,"type":"string","x-nullable":true},{"description":"Coupon batch created date and time filter to in RFC3339","format":"date-time","in":"query","name":"created_to","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Batches array","schema":{"$ref":"#/definitions/CouponBatchesPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]},"post":{"description":"Add new coupon batch. ID Loyalty used from post data","operationId":"incust.controllers.coupon.batch_add","parameters":[{"description":"Coupon batch data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponBatch"}}],"responses":{"201":{"description":"Coupon batch data","schema":{"$ref":"#/definitions/CouponBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/batches/aliases":{"post":{"description":"Return all batch aliases list","operationId":"incust.controllers.coupon.batches_aliases_get","parameters":[{"description":"Filter data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponBatchAliasesListRequestData"}}],"responses":{"200":{"description":"Aliases array","schema":{"$ref":"#/definitions/CouponBatchAliasesPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]}},"/coupons/batches/aliases/customers_bulk_ids":{"post":{"description":"Return list of batch aliases's customer users ids","operationId":"incust.controllers.coupon.batches_aliases_customers_bulk_ids","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponBatchAliasesListRequestData"}}],"responses":{"200":{"description":"Customer user id array","schema":{"$ref":"#/definitions/UserIDs"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]}},"/coupons/batches/aliases/{alias_id}":{"get":{"description":"Return batch alias info","operationId":"incust.controllers.coupon.batch_alias_get","parameters":[{"description":"Alias ID","in":"path","name":"alias_id","required":true,"type":"string"}],"responses":{"200":{"description":"Aliases info","schema":{"$ref":"#/definitions/CouponBatchAlias"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]},"patch":{"description":"Modify batch alias data","operationId":"incust.controllers.coupon.batch_alias_set","parameters":[{"description":"Alias ID","in":"path","name":"alias_id","required":true,"type":"string"},{"description":"Alias data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponBatchAlias"}}],"responses":{"200":{"description":"Aliases info","schema":{"$ref":"#/definitions/CouponBatchAlias"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/coupon/{code}":{"get":{"description":"Coupon info","operationId":"incust.controllers.coupon.coupon_info","parameters":[{"description":"Coupon CODE","in":"path","name":"code","required":true,"type":"string"}],"responses":{"200":{"description":"Coupon data","schema":{"$ref":"#/definitions/Coupon"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/coupon/{code}/html":{"get":{"description":"Coupon info HTML","operationId":"incust.controllers.coupon.coupon_info_html","parameters":[{"description":"Coupon CODE","in":"path","name":"code","required":true,"type":"string"},{"description":"Output language","in":"query","name":"lang","required":false,"type":"string"}],"produces":["text/html"],"responses":{"200":{"description":"Coupon html page"},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/coupon/{coupon_id}/cancel":{"get":{"description":"Coupon cancel","operationId":"incust.controllers.coupon.coupon_cancel","parameters":[{"description":"Coupon ID","in":"path","name":"coupon_id","required":true,"type":"string"}],"responses":{"200":{"description":"Coupon data","schema":{"$ref":"#/definitions/Coupon"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/coupons/customers_bulk_ids":{"post":{"description":"Return list of coupon's customer users ids","operationId":"incust.controllers.coupon.coupons_customers_bulk_ids","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponsListRequestData"}}],"responses":{"200":{"description":"Cusomer user IDs","schema":{"$ref":"#/definitions/UserIDs"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]}},"/coupons/exchange":{"get":{"description":"Exchange of coupons batches list","operationId":"incust.controllers.coupon.coupon_exchange_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Batches count in page","in":"query","name":"count","required":false,"type":"integer"},{"default":true,"description":"Filter by business country","in":"query","name":"same_country","required":false,"type":"boolean"}],"responses":{"200":{"description":"Coupons batch array","schema":{"$ref":"#/definitions/CouponBatchesPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/customer":{"get":{"description":"Find customer and return customer info","operationId":"incust.controllers.customer.customer_find","parameters":[{"description":"Loyalty ID","in":"query","name":"loyalty_id","required":true,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":true,"type":"string"},{"default":false,"description":"Lite version of data (exclude bonuses, special accounts, transactions info and etc)","in":"query","name":"lite","required":false,"type":"boolean"},{"default":false,"description":"Include bonuses, special accounts info when LITE used","in":"query","name":"customer_info","required":false,"type":"boolean"}],"responses":{"200":{"description":"Users data","schema":{"items":{"$ref":"#/definitions/CustomerInfo"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]},"patch":{"description":"Change cusomers info","operationId":"incust.controllers.customer.customer_edit","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerInfo"}}],"responses":{"200":{"description":"Users data","schema":{"items":{"$ref":"#/definitions/CustomerInfo"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]},"post":{"description":"Add new customer","operationId":"incust.controllers.customer.customer_new","parameters":[{"default":false,"description":"Add new customer only if user already exists","in":"query","name":"existing_user_only","required":false,"type":"boolean"},{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerInfo"}}],"responses":{"200":{"description":"Users data","schema":{"items":{"$ref":"#/definitions/CustomerInfo"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/access":{"patch":{"description":"Change cusomers access type","operationId":"incust.controllers.customer.customers_access","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerAccessAssign"}}],"responses":{"200":{"description":"Operation result","schema":{"$ref":"#/definitions/OperationResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/consent":{"post":{"description":"Add customer consent","operationId":"incust.controllers.customer.customer_consent_set","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"properties":{"consent":{"description":"User consent","type":"string"},"loyalty_id":{"description":"Loyalty ID","type":"string"},"user_id":{"description":"User phone","type":"string"}},"required":["loyalty_id","user_id","consent"],"type":"object"}}],"responses":{"200":{"description":"Users data","schema":{"items":{"$ref":"#/definitions/UserProfile"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/customers_bulk_ids":{"post":{"description":"Get customers ID for bulk operations","operationId":"incust.controllers.customer.customers_bulk_ids","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"properties":{"loyalty_id":{"description":"Loyalty ID","type":"string"}},"required":["loyalty_id"],"type":"object"}}],"responses":{"200":{"description":"Customer IDs","schema":{"$ref":"#/definitions/ObjectIds"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/customer/field":{"get":{"description":"Return additional customer fields","operationId":"incust.controllers.customer.customer_fields","responses":{"200":{"description":"Array of fields","schema":{"$ref":"#/definitions/CustomerFieldsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]},"patch":{"description":"Save fields orders","operationId":"incust.controllers.customer.customer_fields_save_orders","parameters":[{"description":"Fields Id array","in":"body","name":"data","required":true,"schema":{"items":{"description":"Field ID","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Array of fields","schema":{"$ref":"#/definitions/CustomerFieldsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]},"post":{"description":"Add new customer field","operationId":"incust.controllers.customer.customer_field_post","parameters":[{"description":"Business data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerField"}}],"responses":{"201":{"description":"Field data","schema":{"$ref":"#/definitions/CustomerField"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/field/{field_id}":{"delete":{"description":"Delete customer field","operationId":"incust.controllers.customer.customer_field_del","parameters":[{"description":"Field ID","in":"path","name":"field_id","required":true,"type":"string"}],"responses":{"200":{"description":"Business data"},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]},"patch":{"description":"Return additional customer field info","operationId":"incust.controllers.customer.customer_field_patch","parameters":[{"description":"Field ID","in":"path","name":"field_id","required":true,"type":"string"},{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerField"}}],"responses":{"200":{"description":"Cusomer field data","schema":{"$ref":"#/definitions/CustomerField"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/customer/import":{"post":{"description":"Import customers","operationId":"incust.controllers.customer.import_customers","parameters":[{"description":"Customers data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ImportCustomersData"}}],"responses":{"201":{"description":"Field data","schema":{"$ref":"#/definitions/ImportCustomersResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/import/preferences":{"get":{"description":"Return preferences for customers import","operationId":"incust.controllers.customer.import_customers_preferences","responses":{"200":{"description":"Preferences","schema":{"properties":{"primary_id_type":{"enum":["phone","email","external-id"],"type":"string"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/{user_id}":{"get":{"description":"Return customer info","operationId":"incust.controllers.customer.customer","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Loyalty ID","in":"query","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Lite version of data (exclude bonuses, special accounts, transactions info and etc)","in":"query","name":"lite","required":false,"type":"boolean"},{"default":false,"description":"Include bonuses, special accounts info when LITE used","in":"query","name":"customer_info","required":false,"type":"boolean"}],"responses":{"200":{"description":"Users data","schema":{"items":{"$ref":"#/definitions/CustomerInfo"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/customer/{user_id}/bonuses":{"get":{"description":"Return customers bonus points list","operationId":"incust.controllers.customer.customer_bonuses","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"default":false,"description":"Return detailing available permanent bonuses","in":"query","name":"permanent_bonuses_detailing","required":false,"type":"boolean"},{"default":false,"description":"Return detailing available promotional bonuses","in":"query","name":"promotion_bonuses_detailing","required":false,"type":"boolean"},{"default":true,"description":"Return only activated (ready for use) bonuses in detailing","in":"query","name":"activated_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"Customers bonus points array","schema":{"$ref":"#/definitions/CustomerBonusesAccounts"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/customer/{user_id}/bonuses/{currency}/adjust":{"post":{"description":"Adjust (refill or write-offs) bonuses for customer","operationId":"incust.controllers.transaction.customer_bonuses_adjust","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Adjust data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBonusesOperationObject"}}],"responses":{"200":{"description":"Customers bonus points data","schema":{"$ref":"#/definitions/CustomerBonusesAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/{user_id}/bonuses/{currency}/refill":{"post":{"description":"Refill bonuses for customer","operationId":"incust.controllers.transaction.customer_bonuses_refill","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Top-up data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBonusesOperationObject"}}],"responses":{"200":{"description":"Customers bonus points data","schema":{"$ref":"#/definitions/CustomerBonusesAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/{user_id}/bonuses/{currency}/write_offs":{"post":{"description":"Write-offs bonuses for customer","operationId":"incust.controllers.transaction.customer_bonuses_write_off","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Write-off data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBonusesOperationObject"}}],"responses":{"200":{"description":"Customers bonus points data","schema":{"$ref":"#/definitions/CustomerBonusesAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/{user_id}/external_forms":{"get":{"description":"Return external forms filled by customer","operationId":"incust.controllers.external_form.customer_external_forms_filled_list","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":true,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Business count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string","x-nullable":true},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string","x-nullable":true},{"description":"Filter by user signed flag","in":"query","name":"signed","required":false,"type":"boolean","x-nullable":true},{"description":"Filter by form type","enum":["tax"],"in":"query","name":"form_type","required":false,"type":"string","x-nullable":true},{"description":"Search by form title (contains criteria)","in":"query","name":"title","required":false,"type":"string","x-nullable":true},{"default":"created","description":"Sorting field name","enum":["id","created","external_form_id","title","type","user_id","user_email","user_phone","user_external_id","user_name"],"in":"query","name":"sort","required":false,"type":"string","x-nullable":true},{"default":"desc","description":"Sorting order","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"External Forms filled by customer list","schema":{"$ref":"#/definitions/UserExternalFormsPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/customer/{user_id}/special_accounts":{"get":{"description":"Return customers special accounts list","operationId":"incust.controllers.customer.customer_special_accounts","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customers special accounts array","schema":{"$ref":"#/definitions/CustomerSpecialAccounts"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]},"post":{"description":"Add special account for customer","operationId":"incust.controllers.customer.customer_special_account_add","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Cusctomer special account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerSpecialAccount"}}],"responses":{"200":{"description":"Customer special account data","schema":{"$ref":"#/definitions/CustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/{user_id}/special_accounts/{account_id}":{"get":{"description":"Return customers special account","operationId":"incust.controllers.customer.customer_special_account_get","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Customer account Id","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customer special account data","schema":{"$ref":"#/definitions/CustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]},"patch":{"description":"Modify special account for customer","operationId":"incust.controllers.customer.customer_special_account_edit","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Customer account Id","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Cusctomer special account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerSpecialAccount"}}],"responses":{"200":{"description":"Customer special account data","schema":{"$ref":"#/definitions/CustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/{user_id}/special_accounts/{account_id}/adjust":{"post":{"description":"Adjust (refill or write-offs) special account for customer","operationId":"incust.controllers.transaction.customer_special_account_adjust","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Customer account Id","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Adjust data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerSpecialAccountOperationObject"}}],"responses":{"200":{"description":"Customer special account data","schema":{"$ref":"#/definitions/CustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/{user_id}/special_accounts/{account_id}/goods":{"get":{"description":"Return special account available goods list for customer","operationId":"incust.controllers.customer.customer_special_account_goods_list","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Customer account Id","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer_account.manager"},{"restriction":{},"role":"businessdashboard.customer_account.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/customer/{user_id}/special_accounts/{account_id}/refill":{"post":{"description":"Refill special account for customer","operationId":"incust.controllers.transaction.customer_special_account_refill","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Customer account Id","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Top-up data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerSpecialAccountOperationObject"}}],"responses":{"200":{"description":"Customer special account data","schema":{"$ref":"#/definitions/CustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer/{user_id}/special_accounts/{account_id}/write_offs":{"post":{"description":"Write-offs special account for customer","operationId":"incust.controllers.transaction.customer_special_account_write_off","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"Customer account Id","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Write-off data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerSpecialAccountOperationObject"}}],"responses":{"200":{"description":"Customer special account data","schema":{"$ref":"#/definitions/CustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/customer_feedback/feedbacks":{"get":{"description":"Return customer feedbacks","operationId":"incust.controllers.customer_feedback.customer_feedbacks","parameters":[{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"description":"Feedback source ID","format":"uuid","in":"query","name":"feedback_source_id","required":false,"type":"string"},{"description":"User ID","format":"uuid","in":"query","name":"user_id","required":false,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"default":"none","description":"Optional sort by rating","enum":["none","asc","desc"],"in":"query","name":"sort_by_rating","required":false,"type":"string"}],"responses":{"200":{"description":"Feedbacks data array","schema":{"items":{"$ref":"#/definitions/CustomerFeedback"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/customer_feedback/feedbacks/{feedback_id}":{"delete":{"description":"Remove customer feedback","operationId":"incust.controllers.customer_feedback.customer_feedback_del","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get customer feedback info","operationId":"incust.controllers.customer_feedback.customer_feedback_get","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/customer_feedback/feedbacks/{feedback_id}/attachments/{attachment_id}":{"get":{"description":"Customer feedback attachment file get","operationId":"incust.controllers.customer_feedback.customer_feedback_attachment_get","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"},{"description":"Attachment ID","format":"uuid","in":"path","name":"attachment_id","required":true,"type":"string"}],"produces":["image/*","audio/*","video/*"],"responses":{"200":{"description":"Attachment file"},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/customer_feedback/feedbacks/{feedback_id}/readed":{"patch":{"description":"Mark customer feedback as readed/unreaded","operationId":"incust.controllers.customer_feedback.customer_feedback_readed","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"readed":{"description":"Feedback readed flag","enum":[0,1],"type":"integer"}},"required":["readed"],"type":"object"}}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/customer_feedback/loyalty/{loyalty_id}/feedback_sources":{"get":{"description":"Return feedback sources","operationId":"incust.controllers.customer_feedback.feedback_sources","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Feedback sources data array","schema":{"items":{"$ref":"#/definitions/FeedbackSource"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add feedback source","operationId":"incust.controllers.customer_feedback.feedback_source_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Feedback source data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FeedbackSource"}}],"responses":{"200":{"description":"Feedback source data","schema":{"$ref":"#/definitions/FeedbackSource"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/customer_feedback/loyalty/{loyalty_id}/feedback_sources/{feedback_source_id}":{"get":{"description":"Return feedback source data","operationId":"incust.controllers.customer_feedback.feedback_source_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Feedback source ID","format":"uuid","in":"path","name":"feedback_source_id","required":true,"type":"string"}],"responses":{"200":{"description":"Feedback source data","schema":{"$ref":"#/definitions/FeedbackSource"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change feedback source","operationId":"incust.controllers.customer_feedback.feedback_source_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Feedback source ID","format":"uuid","in":"path","name":"feedback_source_id","required":true,"type":"string"},{"description":"Feedback source data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FeedbackSource"}}],"responses":{"200":{"description":"Feedback source data","schema":{"$ref":"#/definitions/FeedbackSource"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/customer_feedback/loyalty/{loyalty_id}/settings":{"get":{"description":"Return loyalty customer feedback settings","operationId":"incust.controllers.customer_feedback.loyalty_settings","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty customer feedback settings","schema":{"$ref":"#/definitions/LoyaltyCustomerFeedbackSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify loyalty customer feedback settings","operationId":"incust.controllers.customer_feedback.loyalty_settings_edit","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Loyalty customer feedback settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyCustomerFeedbackSettings"}}],"responses":{"200":{"description":"Loyalty customer feedback settings","schema":{"$ref":"#/definitions/LoyaltyCustomerFeedbackSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/customer_feedback/pos/{pos_id}/settings":{"get":{"description":"Return pos customer feedback settings","operationId":"incust.controllers.customer_feedback.pos_settings","parameters":[{"description":"POS ID","in":"path","name":"pos_id","required":true,"type":"string"}],"responses":{"200":{"description":"POS customer feedback settings","schema":{"$ref":"#/definitions/PosCustomerFeedbackSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify POS customer feedback settings","operationId":"incust.controllers.customer_feedback.pos_settings_edit","parameters":[{"description":"POS ID","in":"path","name":"pos_id","required":true,"type":"string"},{"description":"POS customer feedback settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PosCustomerFeedbackSettings"}}],"responses":{"200":{"description":"POS customer feedback settings","schema":{"$ref":"#/definitions/PosCustomerFeedbackSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/customer_feedback/terminal/{terminal_id}/settings":{"get":{"description":"Return terminal customer feedback settings","operationId":"incust.controllers.customer_feedback.terminal_settings","parameters":[{"description":"POS ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal customer feedback settings","schema":{"$ref":"#/definitions/TerminalCustomerFeedbackSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify terminal customer feedback settings","operationId":"incust.controllers.customer_feedback.terminal_settings_edit","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Terminal customer feedback settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PosCustomerFeedbackSettings"}}],"responses":{"200":{"description":"POS customer feedback settings","schema":{"$ref":"#/definitions/PosCustomerFeedbackSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/customers":{"post":{"description":"Return customers list of business or loyalty","operationId":"incust.controllers.customer.customers","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomersListRequestData"}}],"responses":{"200":{"description":"Users data","schema":{"$ref":"#/definitions/CustomersListPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/customers/{user_id}/user_profile":{"get":{"description":"Return customer user profile","operationId":"incust.controllers.customer.customer_user_profile","parameters":[{"description":"User Id","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"}],"responses":{"200":{"description":"Users profile","schema":{"items":{"$ref":"#/definitions/UserProfile"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Retail Customers"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/embedded/additional_costs":{"get":{"description":"Return additional costs for embedded list","operationId":"incust.controllers.prices.additional_costs_list_embedded","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"}],"responses":{"200":{"description":"Array of additional costs objects","schema":{"$ref":"#/definitions/AdditionalCostsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/card_categories":{"get":{"description":"Return loyalty card categories for embedded list","operationId":"incust.controllers.customer_category.card_categories_embedded","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Card categories data","schema":{"$ref":"#/definitions/CardCategoriesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/corporate_customers/categories":{"get":{"description":"Return corporate customers categories for embedded list","operationId":"incust.controllers.corporate_customer.categories_embedded","parameters":[{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Corporate categories data","schema":{"$ref":"#/definitions/CorporateCustomerCategoriesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/coupons/batches":{"get":{"description":"Return coupon batches for embedded list","operationId":"incust.controllers.coupon.coupon_batches_list_embedded","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Coupon batch tupe filter (all types if not exists or null)","enum":["check-modifier","certificate","external","cross-business"],"in":"query","name":"batch_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Batches array","schema":{"$ref":"#/definitions/CouponBatchesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/currencies":{"get":{"description":"Return list currencies for embedded lists","operationId":"incust.controllers.business.currencies_list_embedded","parameters":[{"description":"Unique identifier of loyalty","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"default":false,"description":"Include goods prices currencies","in":"query","name":"goods_prices_currencies","required":false,"type":"boolean"}],"responses":{"200":{"description":"Array of business customers","schema":{"$ref":"#/definitions/Currencies"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/goods":{"get":{"description":"Return list of goods for embedded list","operationId":"incust.controllers.goods.goods_list_embedded","parameters":[{"description":"Loyalty unique id","in":"query","name":"loyalty_id","required":false,"type":"string"},{"description":"Terminal unique id","in":"query","name":"terminal_id","required":false,"type":"string"},{"description":"Goods category unique id or 'root'","in":"query","name":"category_id","required":false,"type":"string"},{"description":"Expression","in":"query","name":"search_text","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/loyalties":{"get":{"description":"Return loyalties for embedded list","operationId":"incust.controllers.loyalty.loyalties_list_embedded","parameters":[{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Array of loyalties objects","schema":{"$ref":"#/definitions/LoyaltiesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/loyalty_rules":{"get":{"description":"Return loyalty rules for embedded list","operationId":"incust.controllers.loyalty_rule.rules_embedded","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"default":"all","description":"Scope of rules","enum":["all","retail","corporate"],"in":"query","name":"scope","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Loyalty rules data","schema":{"$ref":"#/definitions/LoyaltyRuleList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/news":{"get":{"description":"Return news for embedded list","operationId":"incust.controllers.news.news_list_embedded","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"description":"Pos ID","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":false,"description":"Return only actual news","in":"query","name":"only_actual","required":false,"type":"boolean"},{"default":false,"description":"Sort by priority","in":"query","name":"sort_by_priority","required":false,"type":"boolean"}],"responses":{"200":{"description":"News array","schema":{"$ref":"#/definitions/NewsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/pos":{"get":{"description":"Return pos for embedded list","operationId":"incust.controllers.pos.pos_list_embedded","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":"all","description":"Pos type filter if need","enum":["all","pos","road-tanker","online-store"],"in":"query","name":"pos_type","required":false,"type":"string"},{"default":false,"description":"Sort by priority","in":"query","name":"sort_by_priority","required":false,"type":"boolean"}],"responses":{"200":{"description":"Array of pos objects","schema":{"$ref":"#/definitions/PosList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/special_accounts":{"get":{"description":"Return special accounts for embedded list","operationId":"incust.controllers.account.special_accounts_list_embedded","parameters":[{"default":"all","description":"Scope of accounts","enum":["retail","corporate","all"],"in":"query","name":"scope","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/SpecialAccountsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/staff":{"get":{"description":"Return list of Staff for embedded lists","operationId":"incust.controllers.business_staff.staff_list_embedded","parameters":[{"description":"Filter by terminal Id (if needed)","format":"uuid","in":"query","name":"terminal_id","required":false,"type":"string"},{"default":"all","description":"Filter by suspended flag","enum":["all","yes","no"],"in":"query","name":"suspended","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (name, comment, phone, email)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"name","description":"Sort field name","enum":["id","name","comment","phone","email"],"in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Staff array","schema":{"$ref":"#/definitions/BusinessStaffList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/taxes":{"get":{"description":"Return taxes for embedded list","operationId":"incust.controllers.prices.taxes_list_embedded","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"description":"Tax classification filter (if needed)","enum":["base-tax","sales-tax"],"in":"query","name":"classification","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Array of tax objects","schema":{"$ref":"#/definitions/TaxesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/embedded/terminals":{"get":{"description":"Return terminals for embedded list","operationId":"incust.controllers.terminal.terminals_list_embedded","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"description":"POS ID","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Array of terminals objects","schema":{"$ref":"#/definitions/TerminalsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Embedded Lists and Objects"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[]}},"/equipment/{loyalty_id}/controllers":{"get":{"description":"Return equipment controllers","operationId":"incust.controllers.equipment.controllers","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Filter by Terminal Id","format":"uuid","in":"query","name":"terminal_id","required":false,"type":"string"}],"responses":{"200":{"description":"Equipment controllers data array","schema":{"$ref":"#/definitions/EquipmentControllerList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add equipment controller","operationId":"incust.controllers.equipment.controller_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Equipment controller data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/EquipmentController"}}],"responses":{"200":{"description":"Equipment controller data","schema":{"$ref":"#/definitions/EquipmentController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/equipment/{loyalty_id}/controllers/{controller_id}":{"get":{"description":"Return equipment controller","operationId":"incust.controllers.equipment.controller_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"}],"responses":{"200":{"description":"Equipment controller data","schema":{"$ref":"#/definitions/EquipmentController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change equipment controller","operationId":"incust.controllers.equipment.controller_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Equipment controller data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/EquipmentController"}}],"responses":{"200":{"description":"Equipment controller data","schema":{"$ref":"#/definitions/EquipmentController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/equipment/{loyalty_id}/controllers/{controller_id}/equipments":{"get":{"description":"Return equipment controller end user equipments","operationId":"incust.controllers.equipment.controller_equipments","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Equipments data","schema":{"$ref":"#/definitions/EquipmentControllerEquipmentsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add equipment for controller","operationId":"incust.controllers.equipment.controller_equipment_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Equipment data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/EquipmentControllerEquipment"}}],"responses":{"200":{"description":"Equipment data","schema":{"$ref":"#/definitions/EquipmentControllerEquipment"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/equipment/{loyalty_id}/controllers/{controller_id}/equipments/{equipment_id}":{"get":{"description":"Return equipment info","operationId":"incust.controllers.equipment.controller_equipment_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Equipment ID","format":"uuid","in":"path","name":"equipment_id","required":true,"type":"string"}],"responses":{"200":{"description":"Equipment data","schema":{"$ref":"#/definitions/EquipmentControllerEquipment"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change equipment data","operationId":"incust.controllers.equipment.controller_equipment_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Equipment ID","format":"uuid","in":"path","name":"equipment_id","required":true,"type":"string"},{"description":"Equipment data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/EquipmentControllerEquipment"}}],"responses":{"200":{"description":"Equipment data","schema":{"$ref":"#/definitions/EquipmentControllerEquipment"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/evs/usage":{"get":{"description":"Return list of usage external verification system","operationId":"incust.controllers.external_verification_service.requests_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Messages count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Loyalty ID","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true},{"description":"Verified object (phone number, etc) which has been verified (search by contains)","in":"query","name":"verified_object","required":false,"type":"string"},{"description":"User identifier (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string"},{"default":"processed","description":"Sorted field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"desc","description":"Sort order","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"List of external verification service usage","schema":{"$ref":"#/definitions/EvsUsagePaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Verification System"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/external_data_access":{"get":{"description":"Return list of business data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_business_list","responses":{"200":{"description":"List of business data access from external system","schema":{"$ref":"#/definitions/BusinessExternalDataAccessList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"post":{"description":"Add business data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_business_add","parameters":[{"description":"Loyalty data access from external system","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessExternalDataAccess"}}],"responses":{"200":{"description":"Business data access from external system","schema":{"$ref":"#/definitions/BusinessExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/external_data_access/scopes":{"get":{"description":"Return scope list by object type for data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_scope_list","parameters":[{"description":"Type of user identifier","enum":["business","loyalty","pos","terminal","fuel-controller"],"in":"query","name":"object_type","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel scope list for data access from external system","schema":{"$ref":"#/definitions/ExternalDataAccessScopeList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/external_data_access/{access_id}":{"delete":{"description":"Delete business data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_business_delete","parameters":[{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"get":{"description":"Return business data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_business_get","parameters":[{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"}],"responses":{"200":{"description":"Business data access from external system","schema":{"$ref":"#/definitions/BusinessExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"patch":{"description":"Modify business data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_business_set","parameters":[{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"},{"description":"Business data access from external system","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessExternalDataAccess"}}],"responses":{"200":{"description":"Business data access from external system","schema":{"$ref":"#/definitions/BusinessExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/external_forms/filled":{"get":{"description":"Return external forms filled by customers","operationId":"incust.controllers.external_form.customers_external_forms_filled_list","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":true,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Business count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string","x-nullable":true},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string","x-nullable":true},{"description":"Filter by user signed flag","in":"query","name":"signed","required":false,"type":"boolean","x-nullable":true},{"description":"Filter by form type","enum":["tax"],"in":"query","name":"form_type","required":false,"type":"string","x-nullable":true},{"description":"Search by form title (contains criteria)","in":"query","name":"title","required":false,"type":"string","x-nullable":true},{"default":"created","description":"Sorting field name","enum":["id","created","external_form_id","title","type","user_id","user_email","user_phone","user_external_id","user_name"],"in":"query","name":"sort","required":false,"type":"string","x-nullable":true},{"default":"desc","description":"Sorting order","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"External Forms filled list","schema":{"$ref":"#/definitions/UserExternalFormsPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/external_forms/filled/{filled_form_id}":{"delete":{"description":"Remove external form filled by customer","operationId":"incust.controllers.external_form.customer_external_form_filled_delete","parameters":[{"description":"Filled form ID","format":"uuid","in":"path","name":"filled_form_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]},"get":{"description":"Return external form filled by customer","operationId":"incust.controllers.external_form.customer_external_form_filled_get","parameters":[{"description":"Filled form ID","format":"uuid","in":"path","name":"filled_form_id","required":true,"type":"string"}],"responses":{"200":{"description":"External Form filled by customer","schema":{"$ref":"#/definitions/UserExternalForm"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/external_forms/forms":{"get":{"description":"Return external forms list","operationId":"incust.controllers.external_form.external_forms_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Business count in page","in":"query","name":"count","required":false,"type":"integer"},{"default":false,"description":"Filter by active forms","in":"query","name":"only_active","required":false,"type":"boolean","x-nullable":true},{"description":"Filter by form type","enum":["tax"],"in":"query","name":"form_type","required":false,"type":"string","x-nullable":true},{"description":"Search by form title (contains criteria)","in":"query","name":"title","required":false,"type":"string","x-nullable":true},{"description":"Search by country ISO code (match criteria)","in":"query","name":"country","required":false,"type":"string","x-nullable":true},{"default":"title","description":"Sorting field name","in":"query","name":"sort","required":false,"type":"string","x-nullable":true},{"default":"asc","description":"Sorting order","in":"query","name":"order","required":false,"type":"string","x-nullable":true},{"description":"Loyalty ID (for rule existance flag only)","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"External forms paginated list","schema":{"$ref":"#/definitions/ExternalFormsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/external_forms/forms/{form_id}":{"get":{"description":"Get external form","operationId":"incust.controllers.external_form.external_form_get","parameters":[{"description":"Form Id","format":"uuid","in":"path","name":"form_id","required":true,"type":"string"},{"description":"Loyalty ID (for rule existance flag only)","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"External form data","schema":{"$ref":"#/definitions/ExternalForm"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers":{"get":{"description":"Return fuel controllers","operationId":"incust.controllers.fuel.controllers","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Filter by POS Id","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string"}],"responses":{"200":{"description":"Fuel controllers data array","schema":{"$ref":"#/definitions/FuelControllersList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add fuel controller","operationId":"incust.controllers.fuel.controller_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FuelController"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}":{"get":{"description":"Return fuel controller","operationId":"incust.controllers.fuel.controller_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change fuel controller","operationId":"incust.controllers.fuel.controller_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel controller data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FuelController"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/external_data_access":{"get":{"description":"Return list of fuel controller data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_fuel_controller_list","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"}],"responses":{"200":{"description":"List of fuel controller data access from external system","schema":{"$ref":"#/definitions/FuelControllerExternalDataAccessList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"post":{"description":"Add fuel controller data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_fuel_controller_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel controller data access from external system","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FuelControllerExternalDataAccess"}}],"responses":{"200":{"description":"Fuel controller data access from external system","schema":{"$ref":"#/definitions/FuelControllerExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/external_data_access/{access_id}":{"delete":{"description":"Delete fuel controller data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_fuel_controller_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"get":{"description":"Return fuel controller data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_fuel_controller_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data access from external system","schema":{"$ref":"#/definitions/FuelControllerExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"patch":{"description":"Modify fuel controller data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_fuel_controller_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"},{"description":"Fuel controller data access from external system","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FuelControllerExternalDataAccess"}}],"responses":{"200":{"description":"Fuel controller data access from external system","schema":{"$ref":"#/definitions/FuelControllerExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/gps":{"get":{"description":"Return fuel controller gps data by period","operationId":"incust.controllers.fuel.controller_get_gps_data","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Rows count in page","in":"query","name":"count","required":false,"type":"integer"},{"default":false,"description":"Reverse order (from latest to oldest)","in":"query","name":"reverse","required":false,"type":"boolean"},{"default":false,"description":"Valid only GPS data","in":"query","name":"valid_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"Fuel controller GPS data","schema":{"properties":{"data":{"$ref":"#/definitions/FuelControllerGpsDataList","description":"GPS data"},"summary":{"properties":{"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/gps/date":{"get":{"description":"Return fuel controller gps data on specific date","operationId":"incust.controllers.fuel.controller_get_gps_data_on_date","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date","required":false,"type":"string"}],"responses":{"200":{"description":"Fuel controller GPS data","schema":{"$ref":"#/definitions/FuelControllerGpsData"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/gps/route":{"get":{"description":"Return fuel controller gps route data by period","operationId":"incust.controllers.fuel.controller_get_gps_route_data","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"default":true,"description":"Suppress stops in result route data","in":"query","name":"suppress_stops","required":false,"type":"boolean"}],"responses":{"200":{"description":"Fuel controller GPS data","schema":{"properties":{"data":{"$ref":"#/definitions/FuelControllerGpsDataList","description":"GPS data"},"summary":{"properties":{"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/grades":{"get":{"description":"Return grades for specify controller","operationId":"incust.controllers.fuel.controller_grades_list","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"}],"responses":{"200":{"description":"Grades data","schema":{"$ref":"#/definitions/FuelGradesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/grades/{grade_id}/average_costs/date":{"get":{"description":"Return average costs for specific grade based on cost per deliveries","operationId":"incust.controllers.fuel.controller_grade_average_cost_by_date","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Grade ID","format":"uuid","in":"path","name":"grade_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date","required":false,"type":"string"}],"responses":{"200":{"description":"Fuel delivery data","schema":{"$ref":"#/definitions/GradeFuelDelivery"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/grades/{grade_id}/average_costs/deliveries":{"delete":{"description":"Delete deliveries for specific grade","operationId":"incust.controllers.fuel.controller_grade_average_costs_deliveries_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Grade ID","format":"uuid","in":"path","name":"grade_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"List of fuel deliveries data","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/GradeFuelDeliveriesList"},"x-nullable":true}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return list of deliveries with average costs for specific grade","operationId":"incust.controllers.fuel.controller_grade_average_costs_deliveries","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Grade ID","format":"uuid","in":"path","name":"grade_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"}],"responses":{"200":{"description":"List of fuel deliveries data","schema":{"$ref":"#/definitions/GradeFuelDeliveriesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change existing or add new deliveries for specific grade","operationId":"incust.controllers.fuel.controller_grade_average_costs_deliveries_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Grade ID","format":"uuid","in":"path","name":"grade_id","required":true,"type":"string"},{"description":"List of fuel deliveries data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/GradeFuelDeliveriesList"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/grades/{grade_id}/volume":{"get":{"description":"Return summary tanks volume for specific grade on specific date","operationId":"incust.controllers.fuel.controller_grade_tanks_volume","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Grade ID","format":"uuid","in":"path","name":"grade_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date","required":false,"type":"string"}],"responses":{"200":{"description":"Summary tanks volume for specific grade data","schema":{"$ref":"#/definitions/GradeSummaryVolume"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/nozzles/{nozzle_id}/grade":{"delete":{"description":"Remove grade for pump nozzle","operationId":"incust.controllers.fuel.nozzle_grade_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel pump nozzle ID","format":"uuid","in":"path","name":"nozzle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"description":"Set grade for pump nozzle","operationId":"incust.controllers.fuel.nozzle_grade_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel pump nozzle ID","format":"uuid","in":"path","name":"nozzle_id","required":true,"type":"string"},{"description":"Grade data","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Grade ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/nozzles/{nozzle_id}/tank":{"delete":{"description":"Remove tank for pump nozzle","operationId":"incust.controllers.fuel.nozzle_tank_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel pump nozzle ID","format":"uuid","in":"path","name":"nozzle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"description":"Set tank for pump nozzle","operationId":"incust.controllers.fuel.nozzle_tank_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel pump nozzle ID","format":"uuid","in":"path","name":"nozzle_id","required":true,"type":"string"},{"description":"Tank data","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Tank ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/pumps/{pump_id}/terminal":{"delete":{"description":"Remove terminal for fuel pump","operationId":"incust.controllers.fuel.pump_terminal_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel pump ID","format":"uuid","in":"path","name":"pump_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"description":"Set terminal for fuel pump","operationId":"incust.controllers.fuel.pump_terminal_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel pump ID","format":"uuid","in":"path","name":"pump_id","required":true,"type":"string"},{"description":"Terminal data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Terminal"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/pumps/{pump_id}/terminals":{"get":{"description":"Get additional terminals for fuel pump","operationId":"incust.controllers.fuel.pump_terminals_additional_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel pump ID","format":"uuid","in":"path","name":"pump_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel pump additional Terminals list","schema":{"$ref":"#/definitions/TerminalsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set additional terminals for fuel pump","operationId":"incust.controllers.fuel.pump_terminals_additional_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel pump ID","format":"uuid","in":"path","name":"pump_id","required":true,"type":"string"},{"description":"Terminals list","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalsList"}}],"responses":{"200":{"description":"Fuel pump additional Terminals list","schema":{"$ref":"#/definitions/TerminalsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/tanks/measurements":{"get":{"description":"Return fuel controller tanks/probes measurements data by period","operationId":"incust.controllers.fuel.controller_get_probes_measurements_data","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Rows count in page","in":"query","name":"count","required":false,"type":"integer"},{"default":false,"description":"Reverse order (from latest to oldest)","in":"query","name":"reverse","required":false,"type":"boolean"},{"default":false,"description":"Include/Exclude alarms information","in":"query","name":"alarms","required":false,"type":"boolean"},{"default":false,"description":"Include/Exclude tank information","in":"query","name":"tank","required":false,"type":"boolean"},{"description":"Filter by tank if needed","format":"uuid","in":"query","name":"tank_id","required":false,"type":"string"},{"description":"Fields in result set (json array [\"processed\",\"alarms\",\"tank\",\"temperature\"]) or all model fields (if not present)","in":"query","items":{"type":"string"},"name":"fields","required":false,"type":"array"}],"responses":{"200":{"description":"Fuel controller tank/probe measurements data","schema":{"properties":{"data":{"$ref":"#/definitions/ProbeMeasurementsList","description":"Tank/probe measurements data"},"summary":{"properties":{"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/tanks/measurements/date":{"get":{"description":"Return fuel controller tanks/probes measurements data on specific date","operationId":"incust.controllers.fuel.controller_get_probes_measurements_data_on_date","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date","required":false,"type":"string"},{"description":"Filter by tank if needed","format":"uuid","in":"query","name":"tank_id","required":false,"type":"string"}],"responses":{"200":{"description":"Fuel controller tank/probe measurements data","schema":{"$ref":"#/definitions/ProbeMeasurementsList","description":"Tank/probe measurements data"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/fuel/{loyalty_id}/controllers/{controller_id}/tanks/{tank_id}/grade":{"delete":{"description":"Remove grade for fuel tank","operationId":"incust.controllers.fuel.tank_grade_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel tank ID","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"description":"Set grade for fuel tank","operationId":"incust.controllers.fuel.tank_grade_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Fuel controller ID","format":"uuid","in":"path","name":"controller_id","required":true,"type":"string"},{"description":"Fuel tank ID","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"},{"description":"Grade data","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Grade ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/gift_cards":{"get":{"description":"Return all Return all gift cards list","operationId":"incust.controllers.gift_card.gift_cards_all","parameters":[{"default":"","description":"Loyalty ID","in":"query","name":"loyalty","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Count in page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Gift cards array","schema":{"items":{"$ref":"#/definitions/GiftCard"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Gift Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]},"post":{"description":"Add new gift card. ID Loyalty used from post data","operationId":"incust.controllers.gift_card.gift_card_add","parameters":[{"description":"Gift card data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/GiftCard"}}],"responses":{"201":{"description":"Gift card data","schema":{"$ref":"#/definitions/GiftCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Gift Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/gift_cards/coupons":{"post":{"description":"Return all coupons from gift cards list","operationId":"incust.controllers.gift_card.gift_cards_coupons_all","parameters":[{"description":"Request data","in":"body","name":"data","required":true,"schema":{"properties":{"count":{"default":20,"description":"Count in page","type":"integer"},"gift_card_id":{"description":"Gift Card ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"page":{"default":1,"description":"List page number","type":"integer"},"sort_field":{"description":"Sort field","enum":["gift_card_id","code","emission_dt","cancel_dt","redeem_dt","user_id","deleted_by_customer","status"],"type":"string"},"sort_order":{"description":"Sort order","enum":["asc","desc"],"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Coupons array","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Gift Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]}},"/gift_cards/info/{code}":{"get":{"description":"Gift Card info","operationId":"incust.controllers.gift_card.gift_card_info","parameters":[{"description":"Gift Card CODE","in":"path","name":"code","required":true,"type":"string"}],"responses":{"200":{"description":"Gift Card data","schema":{"$ref":"#/definitions/GiftCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Gift Cards"]}},"/gift_cards/info/{code}/html":{"get":{"description":"Gift Card info HTML","operationId":"incust.controllers.gift_card.gift_card_info_html","parameters":[{"description":"Gift Card CODE","in":"path","name":"code","required":true,"type":"string"},{"description":"Output language","in":"query","name":"lang","required":false,"type":"string"}],"produces":["text/html"],"responses":{"200":{"description":"Gift Card html page"},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Gift Cards"]}},"/gift_cards/{gift_card_id}":{"get":{"description":"Return gift card object","operationId":"incust.controllers.gift_card.gift_card","parameters":[{"description":"Gift card ID","in":"path","name":"gift_card_id","required":true,"type":"string"}],"responses":{"200":{"description":"Gift card  data","schema":{"$ref":"#/definitions/GiftCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Gift Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.coupon.manager"},{"restriction":{},"role":"businessdashboard.coupon.data_viewer"}]},"patch":{"description":"Change exist gift card info","operationId":"incust.controllers.gift_card.gift_card_edit","parameters":[{"description":"Gift card ID.","in":"path","name":"gift_card_id","required":true,"type":"string"},{"description":"Gift card data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/GiftCard"}}],"responses":{"200":{"description":"Gift card data","schema":{"$ref":"#/definitions/GiftCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Gift Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/gift_cards/{gift_card_id}/photo":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set gift card photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.gift_card.store_photo","parameters":[{"description":"Gift card ID.","in":"path","name":"gift_card_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"tags":["Gift Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.coupon.manager"}]}},"/goods":{"post":{"description":"Add new goods","operationId":"incust.controllers.goods.goods_add","parameters":[{"description":"Data of new goods","in":"body","name":"data","schema":{"$ref":"#/definitions/Goods"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/goods/categories/{loyalty_id}":{"get":{"description":"Return goods categories as tree","operationId":"incust.controllers.goods.categories","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Card categories data","schema":{"items":{"$ref":"#/definitions/GoodsCategory"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify goods categories orders","operationId":"incust.controllers.goods.categories_edit","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/GoodsCategories"}}],"responses":{"200":{"description":"Loyalty data","schema":{"items":{"$ref":"#/definitions/GoodsCategory"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"description":"Add goods category","operationId":"incust.controllers.goods.category_add","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/GoodsCategory"}}],"responses":{"200":{"description":"Goods categories data","schema":{"$ref":"#/definitions/GoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/goods/category/{category_id}":{"get":{"description":"Return goods category","operationId":"incust.controllers.goods.category","parameters":[{"description":"Category ID","in":"path","name":"category_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods category data","schema":{"$ref":"#/definitions/GoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Edit goods category","operationId":"incust.controllers.goods.category_edit","parameters":[{"description":"Calegory ID","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/GoodsCategory"}}],"responses":{"200":{"description":"Goods categories data","schema":{"$ref":"#/definitions/GoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/goods/category/{category_id}/photo":{"delete":{"description":"Delete/Clear goods category photo","operationId":"incust.controllers.goods.delete_category_photo","parameters":[{"description":"Category ID.","in":"path","name":"category_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods categories data","schema":{"$ref":"#/definitions/GoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set category photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.goods.store_category_photo","parameters":[{"description":"Category ID.","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Goods categories data","schema":{"$ref":"#/definitions/GoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/goods/in_business":{"get":{"description":"Return list of goods","operationId":"incust.controllers.goods.goods_in_business","parameters":[{"description":"Expression","in":"query","name":"search_text","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/goods/in_category/{loyalty_id}":{"get":{"description":"Return list of goods","operationId":"incust.controllers.goods.goods_in_category","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Category ID","in":"query","name":"category","required":false,"type":"string"},{"description":"Return goods for root category only. Default True","in":"query","name":"only_root","required":false,"type":"boolean"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Edit goods sorting","operationId":"incust.controllers.goods.goods_in_category_order","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Goods data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ObjectIds"}},{"description":"Goods category ID","in":"query","name":"category","required":false,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/goods/in_loyalty/{loyalty_id}":{"get":{"description":"Return list of goods","operationId":"incust.controllers.goods.goods_in_loyalty","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Users count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Expression","in":"query","name":"search_text","required":false,"type":"string"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/GoodsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/goods/service_types":{"get":{"description":"Return list of available goods service types","operationId":"incust.controllers.goods.goods_service_types","responses":{"200":{"description":"Service types data","schema":{"items":{"description":"Service type","properties":{"title":{"description":"type title","type":"string"},"type":{"description":"type identifier","type":"string"}},"type":"object"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/goods/{goods_id}":{"get":{"description":"Return goods","operationId":"incust.controllers.goods.goods","parameters":[{"description":"Goods ID","in":"path","name":"goods_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Edit goods","operationId":"incust.controllers.goods.goods_edit","parameters":[{"description":"Goods ID","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Goods data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Goods"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/goods/{goods_id}/additional_image":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set goods additional image. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.goods.store_goods_additional_image","parameters":[{"description":"Goods ID.","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/goods/{goods_id}/additional_image/{image_id}":{"delete":{"description":"Delete goods additional image.","operationId":"incust.controllers.goods.delete_goods_additional_image","parameters":[{"description":"Goods ID.","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Additional image ID.","in":"path","name":"image_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/goods/{goods_id}/photo":{"delete":{"description":"Delete/Clear goods photo","operationId":"incust.controllers.goods.delete_goods_photo","parameters":[{"description":"Goods ID.","in":"path","name":"goods_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set goods photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.goods.store_goods_photo","parameters":[{"description":"Goods ID.","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loans":{"get":{"description":"Return list of loans","operationId":"incust.controllers.loan.loans_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Created date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Created date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"default":"created","description":"Sorted field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"desc","description":"Sort order","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"},{"description":"Loyalty ID (null for disable filtering)","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true},{"description":"Loan status (null for disable filtering)","enum":["created","approved","declined","declined-first-installment","issued","canceled","partially-repaid","repaid"],"in":"query","name":"status","required":false,"type":"string","x-nullable":true},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals) (null for disable filtering)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier (null for disable filtering)","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Loans List","schema":{"$ref":"#/definitions/LoansPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add new loan","operationId":"incust.controllers.loan.loan_add","parameters":[{"description":"Loan data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Loan"}}],"responses":{"201":{"description":"Loan data","schema":{"$ref":"#/definitions/Loan"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loans/loyalty/{loyalty_id}/settings":{"get":{"description":"Return loans Loyalty settings","operationId":"incust.controllers.loan.loans_loyalty_settings_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loans Loyalty Settings","schema":{"$ref":"#/definitions/LoansLoyaltySettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set and return loans Loyalty settings","operationId":"incust.controllers.loan.loans_loyalty_settings_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Loans Loyalty Settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoansLoyaltySettings"}}],"responses":{"200":{"description":"Loans Loyalty Settings","schema":{"$ref":"#/definitions/LoansLoyaltySettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loans/{loan_id}":{"get":{"description":"Loan information get","operationId":"incust.controllers.loan.loan_get","parameters":[{"description":"Loan ID","format":"uuid","in":"path","name":"loan_id","required":true,"type":"string"}],"responses":{"201":{"description":"Loan data","schema":{"$ref":"#/definitions/Loan"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loans/{loan_id}/approved":{"post":{"description":"Loan approved","operationId":"incust.controllers.loan.loan_approved","parameters":[{"description":"Loan ID","format":"uuid","in":"path","name":"loan_id","required":true,"type":"string"},{"description":"Loan approve operation data","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/LoanOperationRequestData"}}],"responses":{"201":{"description":"Loan data","schema":{"$ref":"#/definitions/Loan"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loans/{loan_id}/declined":{"post":{"description":"Loan declined","operationId":"incust.controllers.loan.loan_declined","parameters":[{"description":"Loan ID","format":"uuid","in":"path","name":"loan_id","required":true,"type":"string"},{"description":"Loan approve operation data","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/LoanOperationRequestData"}}],"responses":{"201":{"description":"Loan data","schema":{"$ref":"#/definitions/Loan"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loans/{loan_id}/installment_payments":{"get":{"description":"Loan installment payments get","operationId":"incust.controllers.loan.loan_installment_payments_get","parameters":[{"description":"Loan ID","format":"uuid","in":"path","name":"loan_id","required":true,"type":"string"}],"responses":{"201":{"description":"Loan Installments data","schema":{"$ref":"#/definitions/LoanInstallmentPayments"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loans/{loan_id}/installment_payments/{installment_payment_id}":{"get":{"description":"Loan installment payment info get","operationId":"incust.controllers.loan.loan_installment_payment_get","parameters":[{"description":"Loan ID","format":"uuid","in":"path","name":"loan_id","required":true,"type":"string"},{"description":"Installment payment ID","format":"uuid","in":"path","name":"installment_payment_id","required":true,"type":"string"}],"responses":{"201":{"description":"Loan Installment data","schema":{"$ref":"#/definitions/LoanInstallmentPayment"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loans/{loan_id}/installment_payments/{installment_payment_id}/make":{"post":{"description":"Loan installment payment process","operationId":"incust.controllers.loan.loan_installment_payment_make","parameters":[{"description":"Loan ID","format":"uuid","in":"path","name":"loan_id","required":true,"type":"string"},{"description":"Installment payment ID","format":"uuid","in":"path","name":"installment_payment_id","required":true,"type":"string"},{"description":"Loan installment payment operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoanInstallmentPaymentOperationRequestData"}}],"responses":{"201":{"description":"Loan Installment data","schema":{"$ref":"#/definitions/LoanInstallmentPayment"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loans/{loan_id}/repaid":{"post":{"description":"Loan repaid","operationId":"incust.controllers.loan.loan_repaid","parameters":[{"description":"Loan ID","format":"uuid","in":"path","name":"loan_id","required":true,"type":"string"},{"description":"Loan approve operation data","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/LoanOperationRequestData"}}],"responses":{"201":{"description":"Loan data","schema":{"$ref":"#/definitions/Loan"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty":{"get":{"description":"Return list of loyalty","operationId":"incust.controllers.loyalty.loyalty_all","responses":{"200":{"description":"Loyalties array","schema":{"items":{"$ref":"#/definitions/Loyalty"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add new loyalty","operationId":"incust.controllers.loyalty.loyalty_post","parameters":[{"description":"Loyalty data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyMultilingual"}}],"responses":{"201":{"description":"Loyalty data","schema":{"$ref":"#/definitions/LoyaltyMultilingual"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/delivery":{"post":{"description":"Add new delivery","operationId":"incust.controllers.loyalty.delivery_add","parameters":[{"description":"Post delivery data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyDeliveryType"}}],"responses":{"200":{"description":"Loyalty delivery type data","schema":{"$ref":"#/definitions/LoyaltyDeliveryType"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Online Store"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/delivery/{delivery_type_id}":{"get":{"description":"Get delivery type","operationId":"incust.controllers.loyalty.delivery","parameters":[{"description":"Delivery type ID.","in":"path","name":"delivery_type_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty online store data","schema":{"$ref":"#/definitions/LoyaltyDeliveryType"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Online Store"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Edit delivery type","operationId":"incust.controllers.loyalty.delivery_edit","parameters":[{"description":"Delivery type ID.","in":"path","name":"delivery_type_id","required":true,"type":"string"},{"description":"Post delivery data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyDeliveryType"}}],"responses":{"200":{"description":"Loyalty online store data","schema":{"$ref":"#/definitions/LoyaltyDeliveryType"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Online Store"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/referral_program/info/{code}":{"get":{"description":"Loyalty Referral Program info","operationId":"incust.controllers.loyalty.referral_program_info","parameters":[{"description":"Referral Program CODE","in":"path","name":"code","required":true,"type":"string"}],"responses":{"200":{"description":"Referral Program data","schema":{"$ref":"#/definitions/LoyaltyReferralProgramPublic"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Referral Program"]}},"/loyalty/referral_program/info/{code}/html":{"get":{"description":"Loyalty Referral Program info HTML","operationId":"incust.controllers.loyalty.referral_program_info_html","parameters":[{"description":"Referral Program CODE","in":"path","name":"code","required":true,"type":"string"},{"description":"Output language","in":"query","name":"lang","required":false,"type":"string"}],"produces":["text/html"],"responses":{"200":{"description":"Referral Program html page"},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Referral Program"]}},"/loyalty/{loyalty_id}":{"get":{"description":"Return loyalty info","operationId":"incust.controllers.loyalty.loyalty","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty data","schema":{"$ref":"#/definitions/LoyaltyMultilingual"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change exist loyalty","operationId":"incust.controllers.loyalty.loyalty_patch","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyMultilingual"}}],"responses":{"200":{"description":"Loyalty data","schema":{"$ref":"#/definitions/LoyaltyMultilingual"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/additional_costs":{"get":{"description":"Return list of additional costs","operationId":"incust.controllers.prices.additional_costs","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of additional cost objects","schema":{"$ref":"#/definitions/AdditionalCostsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add additional cost","operationId":"incust.controllers.prices.additional_cost_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Additional cost data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/AdditionalCost"}}],"responses":{"200":{"description":"Additional cost data object","schema":{"$ref":"#/definitions/AdditionalCost"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/additional_costs/summary":{"get":{"description":"Return additional costs summary report","operationId":"incust.controllers.prices.additional_costs_report_summary","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Filter by Pos ID (match)","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string","x-nullable":true},{"description":"Date filter from in RFC3339","format":"date","in":"query","name":"date_from","required":false,"type":"string","x-nullable":true},{"description":"Date filter to from in RFC3339","format":"date","in":"query","name":"date_to","required":false,"type":"string","x-nullable":true},{"description":"Additional cost ID (match)","format":"uuid","in":"query","name":"additional_cost_id","required":false,"type":"string","x-nullable":true},{"description":"Filter by Additional cost Code (match)","in":"query","name":"additional_cost_code","required":false,"type":"string","x-nullable":true},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by match)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate customer Id if need (search by match)","format":"uuid","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Additional costs summary report data object","schema":{"$ref":"#/definitions/AdditionalCostsSummaryReport"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/additional_costs/summary/items":{"get":{"description":"Return additional costs by items summary report","operationId":"incust.controllers.prices.additional_costs_report_items_summary","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Filter by Pos ID (match)","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string","x-nullable":true},{"description":"Date filter from in RFC3339","format":"date","in":"query","name":"date_from","required":false,"type":"string","x-nullable":true},{"description":"Date filter to from in RFC3339","format":"date","in":"query","name":"date_to","required":false,"type":"string","x-nullable":true},{"description":"Additional cost ID (match)","format":"uuid","in":"query","name":"additional_cost_id","required":false,"type":"string","x-nullable":true},{"description":"Filter by Additional cost Code (match)","in":"query","name":"additional_cost_code","required":false,"type":"string","x-nullable":true},{"description":"Filter by Loyalty Item ID (match)","format":"uuid","in":"query","name":"item_id","required":false,"type":"string","x-nullable":true},{"description":"Filter by Item Code (match)","in":"query","name":"item_code","required":false,"type":"string","x-nullable":true},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by match)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate customer Id if need (search by match)","format":"uuid","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Additional costs summary report data object","schema":{"$ref":"#/definitions/AdditionalCostsSummaryReport"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/additional_costs/{additional_cost_id}":{"delete":{"description":"Delete additional cost","operationId":"incust.controllers.prices.additional_cost_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Additional cost ID","format":"uuid","in":"path","name":"additional_cost_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of additional cost objects","schema":{"$ref":"#/definitions/AdditionalCostsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get additional cost info","operationId":"incust.controllers.prices.additional_cost_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Additional cost ID","format":"uuid","in":"path","name":"additional_cost_id","required":true,"type":"string"}],"responses":{"200":{"description":"Additional cost data object","schema":{"$ref":"#/definitions/AdditionalCost"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify additional cost info","operationId":"incust.controllers.prices.additional_cost_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Additional cost ID","format":"uuid","in":"path","name":"additional_cost_id","required":true,"type":"string"},{"description":"Additional cost data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/AdditionalCost"}}],"responses":{"200":{"description":"Additional cost data object","schema":{"$ref":"#/definitions/AdditionalCost"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/additional_services":{"get":{"description":"Return list of additional services","operationId":"incust.controllers.additional_services.additional_services_get_request","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of additional services objects","schema":{"$ref":"#/definitions/ExtendedAdditionalServicesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Additional Services"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add additional service","operationId":"incust.controllers.additional_services.additional_service_add_request","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Additional service data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ExtendedAdditionalService"}}],"responses":{"200":{"description":"Additional service data object","schema":{"$ref":"#/definitions/ExtendedAdditionalService"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Additional Services"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/additional_services/{additional_service_id}":{"delete":{"description":"Delete additional service","operationId":"incust.controllers.additional_services.additional_service_delete_request","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Additional service ID","format":"uuid","in":"path","name":"additional_service_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of additional services objects","schema":{"$ref":"#/definitions/ExtendedAdditionalServicesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Additional Services"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get additional service info","operationId":"incust.controllers.additional_services.additional_service_get_request","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Additional service ID","format":"uuid","in":"path","name":"additional_service_id","required":true,"type":"string"}],"responses":{"200":{"description":"Additional service data object","schema":{"$ref":"#/definitions/ExtendedAdditionalService"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Additional Services"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify additional service data","operationId":"incust.controllers.additional_services.additional_service_edit_request","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Additional service ID","format":"uuid","in":"path","name":"additional_service_id","required":true,"type":"string"},{"description":"Additional service data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ExtendedAdditionalService"}}],"responses":{"200":{"description":"Additional service data object","schema":{"$ref":"#/definitions/ExtendedAdditionalService"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Additional Services"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories":{"get":{"description":"Return loyalty card categories list","operationId":"incust.controllers.customer_category.card_categories","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Card categories data","schema":{"$ref":"#/definitions/CardCategoriesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add card category","operationId":"incust.controllers.customer_category.card_category_add","parameters":[{"description":"Loyalty ID.","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Card category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CardCategory"}}],"responses":{"200":{"description":"Card category data","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}":{"get":{"description":"Return loyalty card category info","operationId":"incust.controllers.customer_category.card_category","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"}],"responses":{"200":{"description":"Card categories data","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change loyalty card category","operationId":"incust.controllers.customer_category.card_category_patch","parameters":[{"description":"Loyalty ID.","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Card category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CardCategory"}}],"responses":{"200":{"description":"Card category data","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/currencies/{currency}/price_options":{"get":{"description":"Return list of price options for category by currency","operationId":"incust.controllers.customer_category.card_category_currency_price_options_list","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods price options","schema":{"$ref":"#/definitions/CustomerCategoryCurrencyPriceOptionList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add goods item price option for category currency","operationId":"incust.controllers.customer_category.card_category_currency_price_option_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Goods item price option object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerCategoryCurrencyPriceOption"}}],"responses":{"200":{"description":"Added goods item price option object","schema":{"$ref":"#/definitions/CustomerCategoryCurrencyPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/currencies/{currency}/price_options/{item_id}":{"delete":{"description":"Delete goods item price option for category currency","operationId":"incust.controllers.customer_category.card_category_currency_price_option_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods price options","schema":{"$ref":"#/definitions/CustomerCategoryCurrencyPriceOptionList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get goods item price option for category currency","operationId":"incust.controllers.customer_category.card_category_currency_price_option_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods item price option object","schema":{"$ref":"#/definitions/CustomerCategoryCurrencyPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify goods item price option for currency","operationId":"incust.controllers.customer_category.card_category_currency_price_option_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"},{"description":"Goods item price option object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerCategoryCurrencyPriceOption"}}],"responses":{"200":{"description":"Goods item price option object","schema":{"$ref":"#/definitions/CustomerCategoryCurrencyPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/currencies/{currency}/taxes":{"delete":{"description":"Reset tax options for currency","operationId":"incust.controllers.customer_category.card_category_currency_taxes_reset","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return list of tax options for category currency","operationId":"incust.controllers.customer_category.card_category_currency_taxes_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/TaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify and return list of tax options for currency","operationId":"incust.controllers.customer_category.card_category_currency_taxes_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Array of taxes","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TaxOptionsList"}}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/TaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/currencies/{currency}/taxes/items":{"delete":{"description":"Reset items tax options for special account","operationId":"incust.controllers.customer_category.card_category_currency_taxes_items_reset","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return list of tax options for category special account by items","operationId":"incust.controllers.customer_category.card_category_currency_taxes_items_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"default":false,"description":"Return only active items objects (if needed)","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Item category Id filter (if needed). For root category used 'root' value.","format":"uuid","in":"query","name":"item_category_id","required":false,"type":"string","x-nullable":true},{"description":"Item search by code, cointains criteria (if needed)","in":"query","name":"code","required":false,"type":"string","x-nullable":true},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Paginated list of taxes","schema":{"$ref":"#/definitions/ItemsTaxOptionsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify items tax options for special account","operationId":"incust.controllers.customer_category.card_category_currency_taxes_items_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"Array of taxes","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ItemsTaxOptionsList"}}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/ItemsTaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/image":{"delete":{"description":"Clear loyalty card category image","operationId":"incust.controllers.customer_category.card_category_delete_image","parameters":[{"description":"Loyalty ID.","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"}],"responses":{"200":{"description":"Card category data","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set loyalty card category image. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.customer_category.card_category_store_image","parameters":[{"description":"Loyalty ID.","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Card category data","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/special_accounts/{account_id}/price_options":{"get":{"description":"Return list of price options for category by special account","operationId":"incust.controllers.customer_category.card_category_special_account_price_options_list","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods price options","schema":{"$ref":"#/definitions/CustomerCategoryAccountPriceOptionList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add goods item price option for category special account","operationId":"incust.controllers.customer_category.card_category_special_account_price_option_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Goods item price option object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerCategoryAccountPriceOption"}}],"responses":{"200":{"description":"Added goods item price option object","schema":{"$ref":"#/definitions/CustomerCategoryAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/special_accounts/{account_id}/price_options/{item_id}":{"delete":{"description":"Delete goods item price option for category special account","operationId":"incust.controllers.customer_category.card_category_special_account_price_option_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods price options","schema":{"$ref":"#/definitions/CustomerCategoryAccountPriceOptionList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get goods item price option for category special account","operationId":"incust.controllers.customer_category.card_category_special_account_price_option_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods item price option object","schema":{"$ref":"#/definitions/CustomerCategoryAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify goods item price option for category special account","operationId":"incust.controllers.customer_category.card_category_special_account_price_option_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"},{"description":"Goods item price option object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerCategoryAccountPriceOption"}}],"responses":{"200":{"description":"Goods item price option object","schema":{"$ref":"#/definitions/CustomerCategoryAccountPriceOption"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/special_accounts/{account_id}/taxes":{"delete":{"description":"Reset tax options for special account","operationId":"incust.controllers.customer_category.card_category_special_account_taxes_reset","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return list of tax options for category special account","operationId":"incust.controllers.customer_category.card_category_special_account_taxes_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/TaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify and return list of tax options for special account","operationId":"incust.controllers.customer_category.card_category_special_account_taxes_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Array of taxes","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TaxOptionsList"}}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/TaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories/{category_id}/special_accounts/{account_id}/taxes/items":{"delete":{"description":"Reset items tax options for special account","operationId":"incust.controllers.customer_category.card_category_special_account_taxes_items_reset","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return list of tax options for category special account by items","operationId":"incust.controllers.customer_category.card_category_special_account_taxes_items_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"default":false,"description":"Return only active items objects (if needed)","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Item category Id filter (if needed). For root category used 'root' value.","format":"uuid","in":"query","name":"item_category_id","required":false,"type":"string","x-nullable":true},{"description":"Item search by code, cointains criteria (if needed)","in":"query","name":"code","required":false,"type":"string","x-nullable":true},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Paginated list of taxes","schema":{"$ref":"#/definitions/ItemsTaxOptionsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify items tax options for special account","operationId":"incust.controllers.customer_category.card_category_special_account_taxes_items_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Special account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Array of taxes","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ItemsTaxOptionsList"}}],"responses":{"200":{"description":"Array of taxes","schema":{"$ref":"#/definitions/ItemsTaxOptionsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories_rules":{"get":{"description":"Return all rules for card categories in loyalty","operationId":"incust.controllers.loyalty_rule.card_categories_rules","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Rules data","schema":{"items":{"$ref":"#/definitions/LoyaltyCardCategoriesRule"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card category"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add rule for card categories in loyalty","operationId":"incust.controllers.loyalty_rule.card_categories_rule_add","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyCardCategoriesRule"}}],"responses":{"200":{"description":"Card category data","schema":{"$ref":"#/definitions/LoyaltyCardCategoriesRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card category"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories_rules/{rule_id}":{"get":{"description":"Return rule for card categories info","operationId":"incust.controllers.loyalty_rule.card_categories_rule_get","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"}],"responses":{"200":{"description":"Card category data","schema":{"$ref":"#/definitions/LoyaltyCardCategoriesRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card category"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify rule for card categories","operationId":"incust.controllers.loyalty_rule.card_categories_rule_edit","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"},{"description":"Rule data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyCardCategoriesRule"}}],"responses":{"200":{"description":"Card category data","schema":{"$ref":"#/definitions/LoyaltyCardCategoriesRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card category"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/card_categories_settings":{"get":{"description":"Return loyalty card categories settings","operationId":"incust.controllers.customer_category.card_categories_settings","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Card categories settings data","schema":{"$ref":"#/definitions/LoyaltyCardCategoriesSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify loyalty card categories settings","operationId":"incust.controllers.customer_category.card_categories_settings_edit","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Card categories settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyCardCategoriesSettings"}}],"responses":{"200":{"description":"Card categories settings data","schema":{"$ref":"#/definitions/LoyaltyCardCategoriesSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Card Categories"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/customers_messages":{"get":{"description":"Return list of loyalty to customers messages","operationId":"incust.controllers.loyalty_messages.to_customers_messages","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Messages group ID","in":"query","name":"group_id","required":false,"type":"string"}],"responses":{"200":{"description":"Loyalty to customers messages data","schema":{"$ref":"#/definitions/LoyaltyCustomersMessagesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Save messages and return list of loyalty to customers messages","operationId":"incust.controllers.loyalty_messages.to_customers_messages_save","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Loyalty to customers messages data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyCustomersMessagesList"}}],"responses":{"200":{"description":"Loyalty to customers messages data","schema":{"$ref":"#/definitions/LoyaltyCustomersMessagesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/customers_messages/template_test":{"post":{"description":"Test template and render example","operationId":"incust.controllers.loyalty_messages.to_customers_messages_template_test","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Template data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyCustomersMessageTemplateTestRequestData"}}],"responses":{"200":{"description":"Rendered template data","schema":{"$ref":"#/definitions/LoyaltyCustomersMessageTemplateTestResponseData"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/customers_messages_groups":{"get":{"description":"Return list of loyalty to customers messages groups","operationId":"incust.controllers.loyalty_messages.to_customers_messages_groups","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty to customers messages groups data","schema":{"$ref":"#/definitions/LoyaltyCustomersMessagesGroupList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/customers_messages_values":{"get":{"description":"Return list of loyalty to customers messages values","operationId":"incust.controllers.loyalty_messages.to_customers_messages_values","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty to customers messages values data","schema":{"$ref":"#/definitions/LoyaltyCustomersMessagesValuesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/deliveries":{"get":{"description":"Return list of loyalty delivery types","operationId":"incust.controllers.loyalty.deliveries","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Delivery types array","schema":{"items":{"$ref":"#/definitions/LoyaltyDeliveryType"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Online Store"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/external_data_access":{"get":{"description":"Return list of loyalty data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_loyalty_list","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"List of loyalty data access from external system","schema":{"$ref":"#/definitions/LoyaltyExternalDataAccessList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"post":{"description":"Add loyalty data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_loyalty_add","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Loyalty data access from external system","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyExternalDataAccess"}}],"responses":{"200":{"description":"Loyalty data access from external system","schema":{"$ref":"#/definitions/LoyaltyExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/loyalty/{loyalty_id}/external_data_access/{access_id}":{"delete":{"description":"Delete loyalty data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_loyalty_delete","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"get":{"description":"Return loyalty data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_loyalty_get","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty data access from external system","schema":{"$ref":"#/definitions/LoyaltyExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]},"patch":{"description":"Modify loyalty data access from external system","operationId":"incust.controllers.external_data_access.external_data_access_loyalty_set","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"},{"description":"Loyalty data access from external system","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyExternalDataAccess"}}],"responses":{"200":{"description":"Loyalty data access from external system","schema":{"$ref":"#/definitions/LoyaltyExternalDataAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Data Access"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/loyalty/{loyalty_id}/external_forms/rules":{"get":{"description":"Return all rules for external forms in loyalty","operationId":"incust.controllers.external_form.loyalty_external_forms_rules_list","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Filter only active rules","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Rules data","schema":{"$ref":"#/definitions/LoyaltyExternalFormsRules"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add rule for external form in loyalty","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_add","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyExternalFormsRule"}}],"responses":{"200":{"description":"Rule data","schema":{"$ref":"#/definitions/LoyaltyExternalFormsRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/external_forms/rules/{rule_id}":{"delete":{"description":"Delete rule for external form in loyalty","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_delete","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return rule for external form in loyalty","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_get","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"}],"responses":{"200":{"description":"Rule data","schema":{"$ref":"#/definitions/LoyaltyExternalFormsRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify rule for external form in loyalty","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_edit","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"},{"description":"Rule data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyExternalFormsRule"}}],"responses":{"200":{"description":"Rule data","schema":{"$ref":"#/definitions/LoyaltyExternalFormsRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/external_forms/rules/{rule_id}/conditions":{"get":{"description":"Return external form rule conditions list","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_conditions_list","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"}],"responses":{"200":{"description":"Rule conditions data","schema":{"$ref":"#/definitions/LoyaltyExternalFormsRuleConditions"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add external form rule condition","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_condition_add","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"},{"description":"Rule condition data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyExternalFormsRuleCondition"}}],"responses":{"200":{"description":"Rule condition data","schema":{"$ref":"#/definitions/LoyaltyExternalFormsRuleCondition"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/external_forms/rules/{rule_id}/conditions/{condition_id}":{"delete":{"description":"Delete external form rule condition","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_condition_delete","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"},{"description":"Condition ID","in":"path","name":"condition_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return external form rule condition info","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_condition_get","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"},{"description":"Condition ID","in":"path","name":"condition_id","required":true,"type":"string"}],"responses":{"200":{"description":"Rule condition data","schema":{"$ref":"#/definitions/LoyaltyExternalFormsRuleCondition"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify external form rule condition","operationId":"incust.controllers.external_form.loyalty_external_forms_rule_condition_edit","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"},{"description":"Condition ID","in":"path","name":"condition_id","required":true,"type":"string"},{"description":"Rule condition data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyExternalFormsRuleCondition"}}],"responses":{"200":{"description":"Rule condition data","schema":{"$ref":"#/definitions/LoyaltyExternalFormsRuleCondition"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/online_store":{"get":{"description":"Return loyalty online store","operationId":"incust.controllers.loyalty.online_store","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty online store data","schema":{"$ref":"#/definitions/LoyaltyOnlineStore"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Online Store"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify loyalty online store","operationId":"incust.controllers.loyalty.online_store_edit","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Post online store data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyOnlineStore"}}],"responses":{"200":{"description":"Loyalty online store data","schema":{"$ref":"#/definitions/LoyaltyOnlineStore"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Online Store"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/photo":{"delete":{"description":"Delete/Clear loyalty photo.","operationId":"incust.controllers.loyalty.delete_photo","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty data","schema":{"$ref":"#/definitions/LoyaltyMultilingual"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set loyalty photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.loyalty.store_photo","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"tags":["Loyalty"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/pkpass/settings":{"get":{"description":"Return loyalty pkpass settings","operationId":"incust.controllers.loyalty.pkpass_settings_get","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty pkpass settings data","schema":{"$ref":"#/definitions/LoyaltyPkPassSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty PKPASS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify loyalty pkpass settings","operationId":"incust.controllers.loyalty.pkpass_settings_edit","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Loyalty pkpass settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyPkPassSettings"}}],"responses":{"200":{"description":"Loyalty pkpass settings data","schema":{"$ref":"#/definitions/LoyaltyPkPassSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty PKPASS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/pos":{"get":{"description":"Return list of Point of sales (POS) assigned with loyalty id","operationId":"incust.controllers.pos.pos_in_loyalty_get","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":"all","description":"Pos type filter if need","enum":["all","pos","road-tanker","online-store"],"in":"query","name":"pos_type","required":false,"type":"string"},{"default":false,"description":"Sort by priority","in":"query","name":"sort_by_priority","required":false,"type":"boolean"}],"responses":{"200":{"description":"POS array","schema":{"items":{"$ref":"#/definitions/POS"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups":{"get":{"description":"Return list of price groups","operationId":"incust.controllers.prices.price_groups","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Currency ISO code filtering (if needed)","in":"query","name":"currency","required":false,"type":"string"}],"responses":{"200":{"description":"Array of price groups objects","schema":{"items":{"$ref":"#/definitions/PriceGroup"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add price group","operationId":"incust.controllers.prices.price_group_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PriceGroup"}}],"responses":{"200":{"description":"Price group data object","schema":{"$ref":"#/definitions/PriceGroup"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/price_groups/matrix/axes":{"get":{"description":"Return matrix axes data","operationId":"incust.controllers.prices.price_group_matrix_axes","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Matrix axes data","schema":{"$ref":"#/definitions/PriceGroupMatrixAxes"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/matrix/master_prices":{"get":{"description":"Return matrix of goods items with last entered master price data","operationId":"incust.controllers.prices.price_group_matrix_master_prices","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Price group items master price data objects by price groups array","schema":{"items":{"$ref":"#/definitions/PriceGroupMatrixValues"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/matrix/prices":{"get":{"description":"Return matrix of goods items with calculated prices for a given date and time","operationId":"incust.controllers.prices.price_group_matrix_prices_by_date","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Date and time for which price calculated","format":"date-time","in":"query","name":"calculating_datetime","required":false,"type":"string"}],"responses":{"200":{"description":"Price group items master price data objects by price groups array","schema":{"items":{"$ref":"#/definitions/PriceGroupMatrixValues"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/matrix/tax_rates":{"get":{"description":"Return matrix of goods items with tax rates data","operationId":"incust.controllers.prices.price_group_matrix_tax_rates","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Price group items tax rates data objects by price groups array","schema":{"items":{"$ref":"#/definitions/PriceGroupMatrixValues"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}":{"delete":{"description":"Delete price group","operationId":"incust.controllers.prices.price_group_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of price groups objects","schema":{"items":{"$ref":"#/definitions/PriceGroup"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get price group info","operationId":"incust.controllers.prices.price_group_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"}],"responses":{"200":{"description":"Price group data object","schema":{"$ref":"#/definitions/PriceGroup"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify price group info","operationId":"incust.controllers.prices.price_group_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Price group data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PriceGroup"}}],"responses":{"200":{"description":"Price group data object","schema":{"$ref":"#/definitions/PriceGroup"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/controllers/fuel":{"get":{"description":"Return list of fuel controllers related to price group","operationId":"incust.controllers.prices.price_group_fuel_controllers","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Fuel controllers data","schema":{"$ref":"#/definitions/FuelControllersList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/goods":{"get":{"description":"Return list of loyalty goods with price group relation","operationId":"incust.controllers.prices.price_group_goods","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Search by text","in":"query","name":"search_text","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":"all","description":"Return goods by exists in group attribute.","enum":["all","in-group","not-in-group"],"in":"query","name":"existence_type","required":false,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/items":{"delete":{"description":"Delete goods items from price group","operationId":"incust.controllers.prices.price_group_items_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Price group items data object array","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PriceGroupItemsList"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return list of goods items in the price group","operationId":"incust.controllers.prices.price_group_items","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Item category Id filter (if needed). For root category used 'root' value.","format":"uuid","in":"query","name":"item_category_id","required":false,"type":"string"},{"default":false,"description":"Exclude items without price (null priced items)","in":"query","name":"exclude_without_price","required":false,"type":"boolean"},{"default":false,"description":"Return last entered master price object","in":"query","name":"include_master_price","required":false,"type":"boolean"},{"default":false,"description":"Return master price change history","in":"query","name":"include_master_price_history","required":false,"type":"boolean"},{"default":false,"description":"Return tax rates objects","in":"query","name":"include_tax_rates","required":false,"type":"boolean"},{"default":false,"description":"Return item calculated prices for a given date and time","in":"query","name":"include_prices","required":false,"type":"boolean"},{"description":"Date and time for which price calculated","format":"date-time","in":"query","name":"calculating_datetime","required":false,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Price group item data object array","schema":{"$ref":"#/definitions/PriceGroupItemsListPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify goods item in the price group","operationId":"incust.controllers.prices.price_group_items_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Price group items data object array","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PriceGroupItemsList"}}],"responses":{"200":{"description":"Added price group item data objects array","schema":{"$ref":"#/definitions/PriceGroupItemsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"description":"Add goods items to the price group","operationId":"incust.controllers.prices.price_group_items_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Price group items data object array","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PriceGroupItemsList"}}],"responses":{"200":{"description":"Added price group item data objects array","schema":{"$ref":"#/definitions/PriceGroupItemsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/items/{item_id}":{"delete":{"description":"Delete goods item from price group","operationId":"incust.controllers.prices.price_group_item_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get goods item's price group options","operationId":"incust.controllers.prices.price_group_item_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Price group item data object","schema":{"$ref":"#/definitions/PriceGroupItem"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify goods item in the price group","operationId":"incust.controllers.prices.price_group_item_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"},{"description":"Price group item data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PriceGroupItem"}}],"responses":{"200":{"description":"Price group item data object","schema":{"$ref":"#/definitions/PriceGroupItem"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/items/{item_id}/master_prices":{"get":{"description":"Get goods item's master price change history","operationId":"incust.controllers.prices.price_group_item_master_price_history","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Master price objects array","schema":{"items":{"$ref":"#/definitions/PriceGroupMasterPrice"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/items/{item_id}/master_prices/{master_price_id}":{"delete":{"description":"Delete goods item's master price","operationId":"incust.controllers.prices.price_group_item_master_price_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"},{"description":"Master price ID","format":"uuid","in":"path","name":"master_price_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/items/{item_id}/prices":{"get":{"description":"Get goods item's calculated prices for a given date and time","operationId":"incust.controllers.prices.price_group_item_prices_by_date","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Loyalty item ID","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"},{"description":"Date and time for which price calculated","format":"date-time","in":"query","name":"calculating_datetime","required":false,"type":"string"}],"responses":{"200":{"description":"Prices object","schema":{"$ref":"#/definitions/PriceGroupPrices"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/master_prices":{"get":{"description":"Return list of goods items with last entered master price","operationId":"incust.controllers.prices.price_group_items_master_prices","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"}],"responses":{"200":{"description":"Price group items master price data objects array","schema":{"items":{"$ref":"#/definitions/PriceGroupItem"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/tax_rates":{"get":{"description":"Return list of goods items with tax rates","operationId":"incust.controllers.prices.price_group_items_tax_rates","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"}],"responses":{"200":{"description":"Price group items tax rates data objects array","schema":{"items":{"$ref":"#/definitions/PriceGroupItem"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/taxes":{"get":{"description":"Get price group taxes list","operationId":"incust.controllers.prices.price_group_taxes_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"}],"responses":{"200":{"description":"Price group taxes data object array","schema":{"items":{"$ref":"#/definitions/PriceGroupTax"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set price group taxes list","operationId":"incust.controllers.prices.price_group_taxes_set","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"description":"Price group taxes data object array","in":"body","name":"data","schema":{"items":{"$ref":"#/definitions/PriceGroupTax"},"type":"array"}}],"responses":{"200":{"description":"Price group taxes data object array","schema":{"items":{"$ref":"#/definitions/PriceGroupTax"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/price_groups/{price_group_id}/terminals":{"get":{"description":"Return list of terminals related to price group","operationId":"incust.controllers.prices.price_group_terminals","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Price group ID","format":"uuid","in":"path","name":"price_group_id","required":true,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Terminals data","schema":{"$ref":"#/definitions/TerminalsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/referral_program":{"get":{"description":"Return loyalty referral program","operationId":"incust.controllers.loyalty.referral_program","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty referral program data","schema":{"$ref":"#/definitions/LoyaltyReferralProgram"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Referral Program"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify loyalty referral program","operationId":"incust.controllers.loyalty.referral_program_edit","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Post referral program data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyReferralProgram"}}],"responses":{"200":{"description":"Loyalty referral program","schema":{"$ref":"#/definitions/LoyaltyReferralProgram"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Referral Program"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/referral_program/referral_logo":{"delete":{"description":"Delete loyalty referral program logo for referral","operationId":"incust.controllers.loyalty.referral_program_referral_logo_delete","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty referral program","schema":{"$ref":"#/definitions/LoyaltyReferralProgram"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Referral Program"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set loyalty referral program logo for referral. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.loyalty.referral_program_referral_logo_set","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Loyalty referral program","schema":{"$ref":"#/definitions/LoyaltyReferralProgram"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Referral Program"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/referral_program/referrer_logo":{"delete":{"description":"Delete loyalty referral program logo for referrer","operationId":"incust.controllers.loyalty.referral_program_referrer_logo_delete","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty referral program","schema":{"$ref":"#/definitions/LoyaltyReferralProgram"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Referral Program"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set loyalty referral program logo for referrer. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.loyalty.referral_program_referrer_logo_set","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Loyalty referral program","schema":{"$ref":"#/definitions/LoyaltyReferralProgram"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Referral Program"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/rules":{"get":{"description":"Return all rules in loyalty","operationId":"incust.controllers.loyalty_rule.rules","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":"all","description":"Scope of rules","enum":["all","retail","corporate"],"in":"query","name":"scope","required":false,"type":"string"}],"responses":{"200":{"description":"Loyalty rules data","schema":{"$ref":"#/definitions/LoyaltyRuleList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Rule"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add rule in loyalty","operationId":"incust.controllers.loyalty_rule.rule_add","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyRule"}}],"responses":{"200":{"description":"Card categories data","schema":{"$ref":"#/definitions/LoyaltyRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Rule"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/rules/settings":{"get":{"description":"Return loyalty rules settings","operationId":"incust.controllers.loyalty_rule.rules_settings","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Rules settings data","schema":{"$ref":"#/definitions/LoyaltyRulesSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Rule"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify loyalty rules settings","operationId":"incust.controllers.loyalty_rule.rules_settings_edit","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rules settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyRulesSettings"}}],"responses":{"200":{"description":"Rules settings data","schema":{"$ref":"#/definitions/LoyaltyRulesSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Rule"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/rules/{rule_id}":{"get":{"description":"Return rule settings","operationId":"incust.controllers.loyalty_rule.rule_get","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty rule data","schema":{"$ref":"#/definitions/LoyaltyRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Rule"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify loyalty rule settings","operationId":"incust.controllers.loyalty_rule.rule_edit","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Rule ID","in":"path","name":"rule_id","required":true,"type":"string"},{"description":"Rule data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyRule"}}],"responses":{"200":{"description":"Loyalty rule data","schema":{"$ref":"#/definitions/LoyaltyRule"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Rule"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/settings":{"get":{"description":"Return loyalty settings","operationId":"incust.controllers.loyalty.settings","parameters":[{"description":"Loyalty ID","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty settings data","schema":{"$ref":"#/definitions/LoyaltySettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify loyalty settings","operationId":"incust.controllers.loyalty.settings_edit","parameters":[{"description":"Loyalty ID.","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltySettings"}}],"responses":{"200":{"description":"Loyalty settings data","schema":{"$ref":"#/definitions/LoyaltySettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/taxes":{"get":{"description":"Return list of taxes","operationId":"incust.controllers.prices.taxes","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Tax classification filter (if needed)","enum":["base-tax","sales-tax"],"in":"query","name":"classification","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Array of tax objects","schema":{"$ref":"#/definitions/TaxesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add tax","operationId":"incust.controllers.prices.tax_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Tax data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tax"}}],"responses":{"200":{"description":"Tax data object","schema":{"$ref":"#/definitions/Tax"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/loyalty/{loyalty_id}/taxes/summary":{"get":{"description":"Return taxes summary report","operationId":"incust.controllers.prices.taxes_report_summary","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Filter by Pos ID (match)","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string","x-nullable":true},{"description":"Date filter from in RFC3339","format":"date","in":"query","name":"date_from","required":false,"type":"string","x-nullable":true},{"description":"Date filter to from in RFC3339","format":"date","in":"query","name":"date_to","required":false,"type":"string","x-nullable":true},{"description":"Filter by Tax Classification ('base-tax' like excise, fee, duty, etc; 'sales-tax' like vat, gst, etc)","enum":["base-tax","sales-tax"],"in":"query","name":"tax_classification","required":false,"type":"string","x-nullable":true},{"description":"Filter by Tax ID (match)","format":"uuid","in":"query","name":"tax_id","required":false,"type":"string","x-nullable":true},{"description":"Filter by Tax Code (match)","in":"query","name":"tax_code","required":false,"type":"string","x-nullable":true},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by match)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate customer Id if need (search by match)","format":"uuid","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Taxes summary report data object","schema":{"$ref":"#/definitions/TaxesSummaryReport"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/taxes/summary/items":{"get":{"description":"Return taxes by items summary report","operationId":"incust.controllers.prices.taxes_report_items_summary","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Filter by Pos ID (match)","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string","x-nullable":true},{"description":"Date filter from in RFC3339","format":"date","in":"query","name":"date_from","required":false,"type":"string","x-nullable":true},{"description":"Date filter to from in RFC3339","format":"date","in":"query","name":"date_to","required":false,"type":"string","x-nullable":true},{"description":"Filter by Tax Classification ('base-tax' like excise, fee, duty, etc; 'sales-tax' like vat, gst, etc)","enum":["base-tax","sales-tax"],"in":"query","name":"tax_classification","required":false,"type":"string","x-nullable":true},{"description":"Filter by Tax ID (match)","format":"uuid","in":"query","name":"tax_id","required":false,"type":"string","x-nullable":true},{"description":"Filter by Tax Code (match)","in":"query","name":"tax_code","required":false,"type":"string","x-nullable":true},{"description":"Filter by Loyalty Item ID (match)","format":"uuid","in":"query","name":"item_id","required":false,"type":"string","x-nullable":true},{"description":"Filter by Item Code (match)","in":"query","name":"item_code","required":false,"type":"string","x-nullable":true},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by match)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate customer Id if need (search by match)","format":"uuid","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Taxes summary report data object","schema":{"$ref":"#/definitions/TaxesSummaryReport"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/loyalty/{loyalty_id}/taxes/{tax_id}":{"delete":{"description":"Delete tax","operationId":"incust.controllers.prices.tax_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Tax ID","format":"uuid","in":"path","name":"tax_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of tax objects","schema":{"$ref":"#/definitions/TaxesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get tax info","operationId":"incust.controllers.prices.tax_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Tax ID","format":"uuid","in":"path","name":"tax_id","required":true,"type":"string"}],"responses":{"200":{"description":"Tax data object","schema":{"$ref":"#/definitions/Tax"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify tax info","operationId":"incust.controllers.prices.tax_edit","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Tax ID","format":"uuid","in":"path","name":"tax_id","required":true,"type":"string"},{"description":"Tax data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tax"}}],"responses":{"200":{"description":"Tax data object","schema":{"$ref":"#/definitions/Tax"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/message":{"get":{"description":"Return all business message","operationId":"incust.controllers.message.messages","parameters":[{"default":"","description":"Loyalty ID","in":"query","name":"loyalty","required":false,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Messages count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"User or destination phone if need","in":"query","name":"phone","required":false,"type":"string"},{"description":"User or destination email if need","in":"query","name":"email","required":false,"type":"string"},{"description":"User or destination external id if need","in":"query","name":"external_id","required":false,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string"},{"description":"Message type","enum":["sms","push","viber","email","incust-messenger","incust-chatbot","external-system","pkpass-message"],"in":"query","name":"message_type","required":false,"type":"string"},{"description":"Message source type","enum":["system","business","user"],"in":"query","name":"src_type","required":false,"type":"string"},{"description":"Message status","enum":["wait","sent","delivered","error","rejected","replied"],"in":"query","name":"status","required":false,"type":"string"},{"description":"Message readed status","in":"query","name":"readed","required":false,"type":"boolean","x-nullable":true},{"description":"Message support","in":"query","name":"support","required":false,"type":"boolean","x-nullable":true},{"description":"Sored field name and order","in":"query","name":"sort","required":false,"type":"string"}],"responses":{"200":{"description":"Messages data list","schema":{"$ref":"#/definitions/MessagesPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.customer.manager"},{"restriction":{},"role":"businessdashboard.customer.data_viewer"}]}},"/message/notification/news/send":{"post":{"description":"Send notification message above news","operationId":"incust.controllers.message.send_notification_news","parameters":[{"description":"Notification data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/NewsMessageSendRequest"}}],"responses":{"200":{"description":"Message data","schema":{"items":{"$ref":"#/definitions/Message"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/message/send":{"post":{"description":"Send marketing message to users","operationId":"incust.controllers.message.send","parameters":[{"description":"Message data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/MessageSendRequest"}}],"responses":{"200":{"description":"Message data","schema":{"items":{"$ref":"#/definitions/Message"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/message/send/cost":{"post":{"description":"Marketing message cost","operationId":"incust.controllers.message.send_cost","parameters":[{"description":"Message data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/MessageSendRequest"}}],"responses":{"200":{"description":"Message data","schema":{"items":{"$ref":"#/definitions/Message"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/message/system":{"post":{"description":"Message from business to system","operationId":"incust.controllers.message.system","parameters":[{"description":"Message data","in":"body","name":"data","required":true,"schema":{"properties":{"message":{"description":"Message text","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Transactions data","schema":{"items":{"$ref":"#/definitions/Message"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/message/{message_id}/readed":{"patch":{"description":"Mark meage as readed","operationId":"incust.controllers.message.readed","parameters":[{"description":"Original/source message Id","in":"path","name":"message_id","required":true,"type":"string"}],"responses":{"200":{"description":"Transactions data","schema":{"items":{"$ref":"#/definitions/Message"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/message/{message_id}/reply":{"post":{"description":"Reply business-user to user","operationId":"incust.controllers.message.reply","parameters":[{"description":"Original/source message Id","in":"path","name":"message_id","required":true,"type":"string"},{"description":"Message data","in":"body","name":"data","required":true,"schema":{"properties":{"message":{"description":"Reply text","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Transactions data","schema":{"items":{"$ref":"#/definitions/Message"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Messages"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/news":{"get":{"description":"Return all news list","operationId":"incust.controllers.news.news_all","parameters":[{"description":"Loyalty ID filter if needed - DEPRECATED","in":"query","name":"loyalty","required":false,"type":"string"},{"description":"Pos ID filter if needed - DEPRECATED","in":"query","name":"pos","required":false,"type":"string"},{"description":"Loyalty ID filter if needed","in":"query","name":"loyalty_id","required":false,"type":"string"},{"description":"Pos ID filter if needed","in":"query","name":"pos_id","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"News count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"True if need show all languages","in":"query","name":"ext","required":false,"type":"boolean"},{"description":"Date actuality filter","format":"date","in":"query","name":"actual_date","required":false,"type":"string"},{"default":false,"description":"Sort by priority","in":"query","name":"sort_by_priority","required":false,"type":"boolean"}],"responses":{"200":{"description":"News array","schema":{"$ref":"#/definitions/NewsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["News"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add new News. ID Loyalty used from post data","operationId":"incust.controllers.news.news_post","parameters":[{"description":"News data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/News"}}],"responses":{"201":{"description":"News data","schema":{"$ref":"#/definitions/News"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["News"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/news/{news_id}":{"get":{"description":"Return News object","operationId":"incust.controllers.news.news","parameters":[{"description":"News ID","in":"path","name":"news_id","required":true,"type":"string"}],"responses":{"200":{"description":"News data","schema":{"$ref":"#/definitions/News"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["News"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change exist News info","operationId":"incust.controllers.news.news_patch","parameters":[{"description":"News ID.","in":"path","name":"news_id","required":true,"type":"string"},{"description":"News data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/News"}}],"responses":{"200":{"description":"News data","schema":{"$ref":"#/definitions/News"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["News"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/news/{news_id}/photo":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set News photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.news.store_photo","parameters":[{"description":"News ID.","in":"path","name":"news_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"tags":["News"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/orders":{"get":{"description":"Return online orders list","operationId":"incust.controllers.order.online_orders","parameters":[{"default":"","description":"Loyalty ID","in":"query","name":"loyalty","required":false,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Orders count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Order type filtering if needed","enum":["all","online-store","fuel-taxi"],"in":"query","name":"order_type","required":false,"type":"string"},{"description":"Order number if need","in":"query","name":"number","required":false,"type":"string"},{"description":"Order status","enum":["all","created","inprocess","delivered","canceled"],"in":"query","name":"status","required":false,"type":"string"},{"description":"Order paid status","enum":["all","yes","no"],"in":"query","name":"paid","required":false,"type":"string"},{"description":"Sorting field name and order","in":"query","name":"sort","required":false,"type":"string"},{"description":"User phone if need (search by contains)","in":"query","name":"user_phone","required":false,"type":"string"},{"description":"User email if need (search by contains)","in":"query","name":"user_email","required":false,"type":"string"},{"description":"User external id if need (search by contains)","in":"query","name":"user_external_id","required":false,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string"}],"responses":{"200":{"description":"Orders array","schema":{"$ref":"#/definitions/OrderListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store Orders"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.transaction.manager"},{"restriction":{},"role":"businessdashboard.transaction.data_viewer"}]}},"/orders/{order_id}":{"get":{"description":"Return online order info","operationId":"incust.controllers.order.online_order_get","parameters":[{"description":"Order ID.","in":"path","name":"order_id","required":true,"type":"string"}],"responses":{"200":{"description":"Orders object","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store Orders"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.transaction.manager"},{"restriction":{},"role":"businessdashboard.transaction.data_viewer"}]},"patch":{"description":"Set online order status and return order info","operationId":"incust.controllers.order.online_order_status_patch","parameters":[{"description":"Order ID.","in":"path","name":"order_id","required":true,"type":"string"},{"description":"Order status","in":"body","name":"data","required":true,"schema":{"properties":{"delivered":{"description":"Delivered time. Date and time to from in RFC3339","format":"date-time","type":"string"},"status":{"description":"Status","enum":["canceled","delivered","inprocess"],"type":"string"}},"required":["status"],"type":"object"}}],"responses":{"200":{"description":"Orders object","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store Orders"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.transaction.manager"}]}},"/pos":{"get":{"description":"Return all list of Point of sales (POS)","operationId":"incust.controllers.pos.pos_all","parameters":[{"default":"all","description":"Pos type filter if need","enum":["all","pos","road-tanker","online-store"],"in":"query","name":"pos_type","required":false,"type":"string"},{"default":false,"description":"Sort by priority","in":"query","name":"sort_by_priority","required":false,"type":"boolean"}],"responses":{"200":{"description":"POS array","schema":{"items":{"$ref":"#/definitions/POS"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add new Point of sales. ID Loyalty used from post data","operationId":"incust.controllers.pos.pos_post","parameters":[{"description":"POS data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/POS"}}],"responses":{"201":{"description":"Loyalty data","schema":{"$ref":"#/definitions/POS"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/pos/{pos_id}":{"get":{"description":"Return Point of sales info","operationId":"incust.controllers.pos.pos","parameters":[{"description":"Point Of Sales ID","in":"path","name":"pos_id","required":true,"type":"string"}],"responses":{"200":{"description":"POS data","schema":{"$ref":"#/definitions/POS"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change exist POS info","operationId":"incust.controllers.pos.pos_patch","parameters":[{"description":"POS ID.","in":"path","name":"pos_id","required":true,"type":"string"},{"description":"POS data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/POS"}}],"responses":{"200":{"description":"Point of sales data","schema":{"$ref":"#/definitions/POS"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/pos/{pos_id}/online_store":{"get":{"description":"Return POS online store info","operationId":"incust.controllers.pos.pos_online_store_get","parameters":[{"description":"POS ID.","in":"path","name":"pos_id","required":true,"type":"string"}],"responses":{"200":{"description":"POS online store data","schema":{"$ref":"#/definitions/PosOnlineStore"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify POS online store info","operationId":"incust.controllers.pos.pos_online_store_edit","parameters":[{"description":"POS ID.","in":"path","name":"pos_id","required":true,"type":"string"},{"description":"POS online store data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PosOnlineStore"}}],"responses":{"200":{"description":"POS online store data","schema":{"$ref":"#/definitions/PosOnlineStore"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/pos/{pos_id}/photo":{"delete":{"description":"Delete/Clear POS photo","operationId":"incust.controllers.pos.delete_photo","parameters":[{"description":"POS ID.","in":"path","name":"pos_id","required":true,"type":"string"}],"responses":{"200":{"description":"POS data","schema":{"$ref":"#/definitions/POS"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set POS photo. Allowed ContentType (image/jpeg, image/png)","operationId":"incust.controllers.pos.store_photo","parameters":[{"description":"POS ID.","in":"path","name":"pos_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/pos/{pos_id}/references":{"get":{"description":"Get referenced POS data","operationId":"incust.controllers.pos.referenced_pos_get","parameters":[{"description":"POS ID.","in":"path","name":"pos_id","required":true,"type":"string"}],"responses":{"200":{"description":"Referenced POS data","schema":{"$ref":"#/definitions/ReferencedPosContainer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set referenced POS data","operationId":"incust.controllers.pos.referenced_pos_set","parameters":[{"description":"POS ID.","in":"path","name":"pos_id","required":true,"type":"string"},{"description":"Referenced POS data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ReferencedPosContainer"}}],"responses":{"200":{"description":"Referenced POS data","schema":{"$ref":"#/definitions/ReferencedPosContainer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/pos/{pos_id}/terminals":{"get":{"description":"Return list of Terminals assigned with point of sales ID","operationId":"incust.controllers.terminal.terminal_in_pos_get","parameters":[{"description":"Point of sales ID.","in":"path","name":"pos_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminals array","schema":{"$ref":"#/definitions/TerminalsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{"fields":{"forbidden":["password","api_key"]}},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{"fields":{"forbidden":["password","api_key"]}},"role":"businessdashboard.loyalty.data_viewer"}]}},"/reseller/businesses":{"get":{"description":"Return orders list","operationId":"incust.controllers.business.reseller_businesses_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Orders count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Search string","in":"query","name":"search","type":"string"},{"default":"business_title","description":"Sorting field name","in":"query","name":"sort_field","required":false,"type":"string"},{"default":"asc","description":"Sorting order","in":"query","name":"sort_order","required":false,"type":"string"}],"responses":{"200":{"description":"Orders array","schema":{"properties":{"data":{"description":"Businesses list","items":{"$ref":"#/definitions/Business"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total orders count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Reseller"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/reseller/businesses/{business_id}/refill":{"post":{"description":"Delete pos for tourist card service scope","operationId":"incust.controllers.business.reseller_businesses_refill","parameters":[{"description":"Business ID.","in":"path","name":"business_id","required":true,"type":"string"},{"description":"Refill account data","in":"body","name":"data","required":true,"schema":{"properties":{"amount":{"description":"Operation amount","format":"float","type":"number"}},"required":["amount"],"type":"object"}}],"responses":{"200":{"description":"Business data","schema":{"$ref":"#/definitions/Business"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Reseller"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/routes/terminal":{"get":{"description":"Return list of Routes for Terminals","operationId":"incust.controllers.route.route_terminal_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Route date filtering","format":"date","in":"query","name":"date","required":false,"type":"string"},{"description":"terminal Id filtering","format":"uuid","in":"query","name":"terminal_id","required":false,"type":"string"},{"default":"all","description":"Filter by active flag","enum":["all","yes","no"],"in":"query","name":"active","required":false,"type":"string"},{"default":"date","description":"Sort field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"desc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Route for Terminal data object array","schema":{"properties":{"data":{"description":"Route for Terminal list","items":{"$ref":"#/definitions/RouteTerminal"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add route for Terminal","operationId":"incust.controllers.route.route_terminal_add","parameters":[{"description":"Route for Terminal data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/RouteTerminal"}}],"responses":{"200":{"description":"Route for Terminal data object","schema":{"$ref":"#/definitions/RouteTerminal"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/routes/terminal/{route_id}":{"get":{"description":"Return Route for Terminal Info","operationId":"incust.controllers.route.route_terminal_get","parameters":[{"description":"Route Id","format":"uuid","in":"path","name":"route_id","required":true,"type":"string"}],"responses":{"200":{"description":"Route for Terminal data object","schema":{"$ref":"#/definitions/RouteTerminal"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify Route for Terminal data","operationId":"incust.controllers.route.route_terminal_edit","parameters":[{"description":"Route Id","format":"uuid","in":"path","name":"route_id","required":true,"type":"string"},{"description":"Route for Terminal data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/RouteTerminal"}}],"responses":{"200":{"description":"Route for Terminal data object","schema":{"$ref":"#/definitions/RouteTerminal"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/routes/terminal/{route_id}/operations":{"get":{"description":"Return Route operations list","operationId":"incust.controllers.route.route_operations_list","parameters":[{"description":"Route Id","format":"uuid","in":"path","name":"route_id","required":true,"type":"string"}],"responses":{"200":{"description":"Route operations data array","schema":{"items":{"$ref":"#/definitions/RouteOperation"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add operations to Route","operationId":"incust.controllers.route.route_operations_add","parameters":[{"description":"Route Id","format":"uuid","in":"path","name":"route_id","required":true,"type":"string"},{"description":"Route operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/RouteOperation"}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/routes/terminal/{route_id}/operations/{operation_id}":{"get":{"description":"Return Route operation data","operationId":"incust.controllers.route.route_operations_get","parameters":[{"description":"Route Id","format":"uuid","in":"path","name":"route_id","required":true,"type":"string"},{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify Route operation data","operationId":"incust.controllers.route.route_operations_edit","parameters":[{"description":"Route Id","format":"uuid","in":"path","name":"route_id","required":true,"type":"string"},{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"},{"description":"Route operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/RouteOperation"}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/staff":{"get":{"description":"Return list of Staff","operationId":"incust.controllers.business_staff.staff_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Filter by terminal Id (if needed)","format":"uuid","in":"query","name":"terminal_id","required":false,"type":"string"},{"default":"all","description":"Filter by suspended flag","enum":["all","yes","no"],"in":"query","name":"suspended","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (name, comment, phone, email)","in":"query","name":"search_text","required":false,"type":"string"},{"description":"Filter by auth code (matching criteria)","in":"query","name":"auth_code","required":false,"type":"string"},{"default":"name","description":"Sort field name","enum":["id","created","name","comment","phone","email","auth_code","suspended"],"in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Staff array","schema":{"$ref":"#/definitions/BusinessStaffPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Staff"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{"fields":{"forbidden":["data.auth_code"]}},"role":"businessdashboard.business.manager"}]},"post":{"description":"Add new staff","operationId":"incust.controllers.business_staff.staff_add","parameters":[{"description":"Staff data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessStaff"}}],"responses":{"200":{"description":"Business staff data","schema":{"$ref":"#/definitions/BusinessStaff"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Staff"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/staff/{staff_id}":{"get":{"description":"Return Staff data","operationId":"incust.controllers.business_staff.staff_get","parameters":[{"description":"Staff Id","format":"uuid","in":"path","name":"staff_id","required":true,"type":"string"}],"responses":{"200":{"description":"Business staff data","schema":{"$ref":"#/definitions/BusinessStaff"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Staff"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{"fields":{"forbidden":["auth_code"]}},"role":"businessdashboard.business.manager"}]},"patch":{"description":"Modify staff data","operationId":"incust.controllers.business_staff.staff_edit","parameters":[{"description":"Staff Id","format":"uuid","in":"path","name":"staff_id","required":true,"type":"string"},{"description":"Staff data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessStaff"}}],"responses":{"200":{"description":"Business staff data","schema":{"$ref":"#/definitions/BusinessStaff"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business Staff"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"}]}},"/tanks/linked":{"get":{"description":"Return list of Tanks linked to the Business","operationId":"incust.controllers.tank.tanks_linked_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Owner Id filtering","format":"uuid","in":"query","name":"owner_id","required":false,"type":"string"},{"description":"Owner type filtering","enum":["customer","corporate-customer"],"in":"query","name":"owner_type","required":false,"type":"string"},{"description":"Code filtering (matching criteria)","in":"query","name":"code","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (code, title, address, product_title)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"all","description":"Filter by active flag","enum":["all","yes","no"],"in":"query","name":"active","required":false,"type":"string"},{"description":"Goods code filtering (matching criteria)","in":"query","name":"goods_code","required":false,"type":"string"},{"default":"title","description":"Sort field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Linked Tanks array","schema":{"properties":{"data":{"description":"Tanks list","items":{"$ref":"#/definitions/Tank"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add new link to tank","operationId":"incust.controllers.tank.tanks_linked_add","parameters":[{"description":"Linked tank data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tank"}}],"responses":{"200":{"description":"Linked tank data","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/tanks/linked/{tank_id}":{"delete":{"description":"Return linked Tank info","operationId":"incust.controllers.tank.tanks_linked_delete","parameters":[{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return linked Tank info","operationId":"incust.controllers.tank.tanks_linked_get","parameters":[{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"}],"responses":{"200":{"description":"Linked tank data","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify link to Tank","operationId":"incust.controllers.tank.tanks_linked_modify","parameters":[{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"},{"description":"Linked tank data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tank"}}],"responses":{"200":{"description":"Linked tank data","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/tanks/owner/{owner_id}":{"get":{"description":"Return list of Tanks for owner","operationId":"incust.controllers.tank.tanks_by_owner_list","parameters":[{"description":"Owner Id","format":"uuid","in":"path","name":"owner_id","required":true,"type":"string"},{"description":"Code filtering (matching criteria)","in":"query","name":"code","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (code, title, address, product_title)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"all","description":"Filter by active flag","enum":["all","yes","no"],"in":"query","name":"active","required":false,"type":"string"},{"default":"title","description":"Sort field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Tanks data object array","schema":{"items":{"$ref":"#/definitions/Tank"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add Tank for owner","operationId":"incust.controllers.tank.tank_by_owner_add","parameters":[{"description":"Owner Id","format":"uuid","in":"path","name":"owner_id","required":true,"type":"string"},{"description":"Tanks data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tank"}}],"responses":{"200":{"description":"Tanks data object","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/tanks/owner/{owner_id}/{tank_id}":{"get":{"description":"Get Tank for owner","operationId":"incust.controllers.tank.tank_by_owner_get","parameters":[{"description":"Owner Id","format":"uuid","in":"path","name":"owner_id","required":true,"type":"string"},{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"}],"responses":{"200":{"description":"Tanks data object","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify Tank for owner","operationId":"incust.controllers.tank.tank_by_owner_edit","parameters":[{"description":"Owner Id","format":"uuid","in":"path","name":"owner_id","required":true,"type":"string"},{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"},{"description":"Tanks data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tank"}}],"responses":{"200":{"description":"Tanks data object","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal":{"get":{"description":"Return list of Terminals assigned with point of sales id","operationId":"incust.controllers.terminal.terminals","responses":{"200":{"description":"Terminals array","schema":{"$ref":"#/definitions/TerminalsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{"fields":{"forbidden":["password","api_key"]}},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{"fields":{"forbidden":["password","api_key"]}},"role":"businessdashboard.loyalty.data_viewer"}]},"post":{"description":"Add new Terminal. ID of Point of sales (POS) used from post data","operationId":"incust.controllers.terminal.terminal_post","parameters":[{"description":"Terminal data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Terminal"}}],"responses":{"201":{"description":"Terminal data","schema":{"$ref":"#/definitions/Terminal"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}":{"get":{"description":"Return Terminal info","operationId":"incust.controllers.terminal.terminal","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal data","schema":{"$ref":"#/definitions/Terminal"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{"fields":{"forbidden":["password","api_key"]}},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{"fields":{"forbidden":["password","api_key"]}},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Change exist Terminal info","operationId":"incust.controllers.terminal.terminal_patch","parameters":[{"description":"Terminal ID.","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Terminal data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Terminal"}}],"responses":{"200":{"description":"Terminal data","schema":{"$ref":"#/definitions/Terminal"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/additional_costs":{"get":{"description":"Get terminal additional costs list","operationId":"incust.controllers.terminal.terminal_additional_costs_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Additional cost data object array","schema":{"items":{"$ref":"#/definitions/TerminalAdditionalCost"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set terminal additional costs list","operationId":"incust.controllers.terminal.terminal_additional_costs_set","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Additional cost data object array","in":"body","name":"data","schema":{"items":{"$ref":"#/definitions/TerminalAdditionalCost"},"type":"array"}}],"responses":{"200":{"description":"Additional cost data object array","schema":{"items":{"$ref":"#/definitions/TerminalAdditionalCost"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/additional_costs/items":{"get":{"description":"Return list of terminal additional costs for goods items","operationId":"incust.controllers.terminal.terminal_additional_costs_by_items_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"default":false,"description":"Return only active items objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Item category Id filter (if needed). For root category used 'root' value.","format":"uuid","in":"query","name":"item_category_id","required":false,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Additional cost item data object array","schema":{"properties":{"data":{"description":"Additional cost items list","items":{"$ref":"#/definitions/TerminalAdditionalCostsItem"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify additional costs for items and return list of terminal additional costs for goods items","operationId":"incust.controllers.terminal.terminal_additional_costs_by_items_edit","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Additional cost item data object array","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/TerminalAdditionalCostsItem"},"type":"array"}}],"responses":{"200":{"description":"Additional cost item data object array","schema":{"items":{"$ref":"#/definitions/TerminalAdditionalCostsItem"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/additional_costs/items/{item_id}":{"get":{"description":"Return additional costs for goods item","operationId":"incust.controllers.terminal.terminal_additional_costs_by_item_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Item Id","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"}],"responses":{"200":{"description":"Additional cost item data object","schema":{"$ref":"#/definitions/TerminalAdditionalCostsItem"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Modify additional costs for goods item","operationId":"incust.controllers.terminal.terminal_additional_costs_by_item_edit","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Item Id","format":"uuid","in":"path","name":"item_id","required":true,"type":"string"},{"description":"Additional cost item data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalAdditionalCostsItem"}}],"responses":{"200":{"description":"Additional cost item data object","schema":{"$ref":"#/definitions/TerminalAdditionalCostsItem"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/events/statuses":{"get":{"description":"Return list of terminal event status items","operationId":"incust.controllers.terminal.terminal_events_status_items_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Remote address (remote IP) filter if needed","in":"query","name":"remote_addr","required":false,"type":"string"},{"default":"processed","description":"Sorting field name","enum":["processed","status"],"in":"query","name":"sort","required":false,"type":"string"},{"default":"desc","description":"Sorting order","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Event status item data object array","schema":{"$ref":"#/definitions/EventStatusList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/terminal/{terminal_id}/generate_ibeacon":{"get":{"description":"Generate ibeacon for terminal and return Terminal info","operationId":"incust.controllers.terminal.generate_ibeacon","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal data","schema":{"$ref":"#/definitions/Terminal"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/goods":{"get":{"description":"Return goods items list for terminal","operationId":"incust.controllers.terminal.terminal_get_goods_for_terminal","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"default":1,"description":"Return available prices by scope (not only base) in fuel info (0/1)","enum":[0,1],"in":"query","name":"prices_values","required":false,"type":"integer"},{"default":"all","description":"Scope for return available prices (not only base) in fuel info","enum":["all","applicable","minimal"],"in":"query","name":"prices_values_scope","required":false,"type":"string"},{"default":1,"description":"Return taxes for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"taxes_values","required":false,"type":"integer"},{"default":1,"description":"Return margins for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"margins_values","required":false,"type":"integer"},{"description":"Category ID","in":"query","name":"category","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in fields (title, code, barcode)","in":"query","name":"search","required":false,"type":"string"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"},{"description":"Count limit (for search option default 10 else default null - no limits)","in":"query","name":"limit","required":false,"type":"integer","x-nullable":true},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate Customer Id","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true},{"default":true,"description":"Include price explain data","in":"query","name":"price_explain","required":false,"type":"boolean"},{"default":false,"description":"Include account customers data","in":"query","name":"customers_account_info","required":false,"type":"boolean"},{"default":false,"description":"Include account customers limits data (only if customers_account_info is true)","in":"query","name":"customers_account_info_extended","required":false,"type":"boolean"}],"responses":{"200":{"description":"Goods objects data list","schema":{"$ref":"#/definitions/GoodsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/terminal/{terminal_id}/goods/paginated":{"get":{"description":"Return goods items paginated list for terminal","operationId":"incust.controllers.terminal.terminal_get_goods_for_terminal_paginated","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"default":1,"description":"Return available prices by scope (not only base) in fuel info (0/1)","enum":[0,1],"in":"query","name":"prices_values","required":false,"type":"integer"},{"default":"all","description":"Scope for return available prices (not only base) in fuel info","enum":["all","applicable","minimal"],"in":"query","name":"prices_values_scope","required":false,"type":"string"},{"default":1,"description":"Return taxes for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"taxes_values","required":false,"type":"integer"},{"default":1,"description":"Return margins for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"margins_values","required":false,"type":"integer"},{"description":"Category ID","in":"query","name":"category","required":false,"type":"string"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"},{"default":1,"description":"Page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Page data rows number","in":"query","name":"count","required":false,"type":"integer"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate Customer Id","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true},{"default":true,"description":"Include price explain data","in":"query","name":"price_explain","required":false,"type":"boolean"},{"default":false,"description":"Include account customers data","in":"query","name":"customers_account_info","required":false,"type":"boolean"},{"default":false,"description":"Include account customers limits data (only if customers_account_info is true)","in":"query","name":"customers_account_info_extended","required":false,"type":"boolean"}],"responses":{"200":{"description":"Goods objects data list","schema":{"$ref":"#/definitions/GoodsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/terminal/{terminal_id}/notifications/settings":{"get":{"description":"Return notifications settings for Terminal","operationId":"incust.controllers.terminal.terminal_notifications_settings_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Notifications settings data","schema":{"$ref":"#/definitions/TerminalNotificationsSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set notifications settings for Terminal","operationId":"incust.controllers.terminal.terminal_notifications_settings_set","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Notifications settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalNotificationsSettings"},"x-nullable":true}],"responses":{"200":{"description":"Notifications settings data","schema":{"$ref":"#/definitions/TerminalNotificationsSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/settings/application":{"get":{"description":"Return Terminal settings for application","operationId":"incust.controllers.terminal.terminal_settings_application_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Application settings","schema":{"$ref":"#/definitions/TerminalApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set and return Terminal settings for application","operationId":"incust.controllers.terminal.terminal_settings_application_set","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Application settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalApplicationSettings"}}],"responses":{"200":{"description":"Application settings","schema":{"$ref":"#/definitions/TerminalApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/settings/external_devices/amp":{"get":{"description":"Return Terminal AMP settings","operationId":"incust.controllers.terminal.terminal_settings_external_devices_amp_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal AMP settings","schema":{"$ref":"#/definitions/TerminalExternalAmpSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set Terminal AMP settings","operationId":"incust.controllers.terminal.terminal_settings_external_devices_amp_set","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Terminal AMP settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalExternalAmpSettings"}}],"responses":{"200":{"description":"Terminal AMP settings","schema":{"$ref":"#/definitions/TerminalExternalAmpSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/settings/external_devices/pax":{"get":{"description":"Return Terminal PAX settings","operationId":"incust.controllers.terminal.terminal_settings_external_devices_pax_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal PAX settings","schema":{"$ref":"#/definitions/TerminalExternalPaxSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set Terminal PAX settings","operationId":"incust.controllers.terminal.terminal_settings_external_devices_pax_set","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Terminal PAX settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalExternalPaxSettings"}}],"responses":{"200":{"description":"Terminal PAX settings","schema":{"$ref":"#/definitions/TerminalExternalPaxSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/settings/external_devices/stripe":{"get":{"description":"Return Terminal Stripe settings","operationId":"incust.controllers.terminal.terminal_settings_external_devices_stripe_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal Stripe settings","schema":{"$ref":"#/definitions/TerminalExternalStripeSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set Terminal Stripe settings","operationId":"incust.controllers.terminal.terminal_settings_external_devices_stripe_set","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Terminal Stripe settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalExternalStripeSettings"}}],"responses":{"200":{"description":"Terminal Stripe settings","schema":{"$ref":"#/definitions/TerminalExternalStripeSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/settings/external_devices/stripe/location":{"delete":{"description":"Clear Terminal Stripe Location","operationId":"incust.controllers.terminal.terminal_settings_external_devices_stripe_location_clear","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal Stripe Location settings","schema":{"$ref":"#/definitions/TerminalExternalStripeLocation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Return Terminal Stripe Location settings","operationId":"incust.controllers.terminal.terminal_settings_external_devices_stripe_location_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal Stripe Location settings","schema":{"$ref":"#/definitions/TerminalExternalStripeLocation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set Terminal Stripe Location settings","operationId":"incust.controllers.terminal.terminal_settings_external_devices_stripe_location_set","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Terminal Stripe Location settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalExternalStripeLocation"}}],"responses":{"200":{"description":"Terminal Stripe Location settings","schema":{"$ref":"#/definitions/TerminalExternalStripeLocation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/settings/poster":{"get":{"description":"Return Poster settings for Terminal","operationId":"incust.controllers.terminal.terminal_poster_settings_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Poster settings data","schema":{"$ref":"#/definitions/PosterTerminalSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]},"patch":{"description":"Set Poster settings for Terminal","operationId":"incust.controllers.terminal.terminal_poster_settings_set","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Poster settings data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PosterTerminalSettings"},"x-nullable":true}],"responses":{"200":{"description":"Poster settings data","schema":{"$ref":"#/definitions/PosterTerminalSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/settings/poster/applications":{"get":{"description":"Return list of available Poster applications","operationId":"incust.controllers.terminal.terminal_available_poster_applications_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Poster applications list","schema":{"$ref":"#/definitions/PosterApplicationsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"}]}},"/terminal/{terminal_id}/staff":{"delete":{"description":"Delete business staff who get access","operationId":"incust.controllers.terminal.terminal_business_staff_delete","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Business staff data object array","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessStaffList"}}],"responses":{"200":{"description":"Business staff data object array","schema":{"$ref":"#/definitions/BusinessStaffList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"get":{"description":"Get list of business staff who get access","operationId":"incust.controllers.terminal.terminal_business_staff_get","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Business staff data object array","schema":{"$ref":"#/definitions/BusinessStaffList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]},"post":{"description":"Add business staff who get access","operationId":"incust.controllers.terminal.terminal_business_staff_add","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Business staff data object array","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessStaffList"}}],"responses":{"200":{"description":"Business staff data object array","schema":{"$ref":"#/definitions/BusinessStaffList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/terminal/{terminal_id}/update_apikey":{"get":{"description":"Generate new api key and return Terminal info","operationId":"incust.controllers.terminal.update_apikey","parameters":[{"description":"Terminal ID","in":"path","name":"terminal_id","required":true,"type":"string"}],"responses":{"200":{"description":"Terminal data","schema":{"$ref":"#/definitions/Terminal"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Terminal"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"}]}},"/tour_cards/accounts":{"get":{"description":"Return all tourist cards accounts list","operationId":"incust.controllers.tour_card.accounts_all","parameters":[{"default":false,"description":"Return only active object","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Accounts array","schema":{"items":{"$ref":"#/definitions/TourCardAccount"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"post":{"description":"Add new tourist card account","operationId":"incust.controllers.tour_card.account_add","parameters":[{"description":"Account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardAccount"}}],"responses":{"201":{"description":"Account data","schema":{"$ref":"#/definitions/TourCardAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/accounts/{account_id}":{"get":{"description":"Return tourist card account object","operationId":"incust.controllers.tour_card.account","parameters":[{"description":"Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Account data","schema":{"$ref":"#/definitions/TourCardAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Change tourist card account","operationId":"incust.controllers.tour_card.account_edit","parameters":[{"description":"Account ID.","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardCategory"}}],"responses":{"200":{"description":"Account data","schema":{"$ref":"#/definitions/TourCardAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/batches":{"get":{"description":"Return all tourist cards batches list","operationId":"incust.controllers.tour_card.batches_all","parameters":[{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Count in page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Batches array","schema":{"items":{"$ref":"#/definitions/TourCardBatch"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"post":{"description":"Add new tourist card batch","operationId":"incust.controllers.tour_card.batch_add","parameters":[{"description":"Batch data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardBatch"}}],"responses":{"201":{"description":"Batch data","schema":{"$ref":"#/definitions/TourCardBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/batches/{batch_id}":{"get":{"description":"Return tourist card batch object","operationId":"incust.controllers.tour_card.batch","parameters":[{"description":"Batch ID","format":"uuid","in":"path","name":"batch_id","required":true,"type":"string"}],"responses":{"200":{"description":"Service data","schema":{"$ref":"#/definitions/TourCardBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Change tourist card batch","operationId":"incust.controllers.tour_card.batch_edit","parameters":[{"description":"Batch ID.","format":"uuid","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Batch data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardBatch"}}],"responses":{"200":{"description":"Batch data","schema":{"$ref":"#/definitions/TourCardBatch"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/batches/{batch_id}/codes":{"get":{"description":"Return tourist card batch codes list","operationId":"incust.controllers.tour_card.batch_codes_get","parameters":[{"description":"Batch ID.","format":"uuid","in":"path","name":"batch_id","required":true,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":0,"description":"Count of codes on page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Codes array","schema":{"items":{"$ref":"#/definitions/TourCardBatchCode"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]}},"/tour_cards/batches/{batch_id}/codes/add":{"post":{"description":"Add codes for tourist card batch","operationId":"incust.controllers.tour_card.batch_codes_add","parameters":[{"description":"Batch ID.","format":"uuid","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"List of codes","in":"body","name":"data","required":true,"schema":{"items":{"description":"Code","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Operation result summary","schema":{"properties":{"operation_result":{"description":"Operation result summary","properties":{"processed":{"description":"Processed codes count","type":"integer"},"skipped":{"description":"Skipped codes count","type":"integer"},"unique":{"description":"Unique codes count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/batches/{batch_id}/codes/delete":{"post":{"description":"Delete codes for tourist card batch","operationId":"incust.controllers.tour_card.batch_codes_delete","parameters":[{"description":"Batch ID.","format":"uuid","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"List of codes","in":"body","name":"data","required":true,"schema":{"items":{"description":"Code","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Operation result summary","schema":{"properties":{"operation_result":{"description":"Operation result summary","properties":{"processed":{"description":"Processed codes count","type":"integer"},"skipped":{"description":"Skipped codes count","type":"integer"},"unique":{"description":"Unique codes count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/batches/{batch_id}/emit":{"post":{"description":"Tourist card emission and return emitted cards list","operationId":"incust.controllers.tour_card.batch_emission","parameters":[{"description":"Coupon batch ID.","format":"uuid","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Emission data","in":"body","name":"data","required":true,"schema":{"properties":{"activate":{"description":"Activate card","enum":[0,1],"type":"integer"},"count":{"default":1,"description":"Count of cards for emission","type":"integer"},"referral_code":{"description":"Partner referral code","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Emitted cards list","schema":{"items":{"$ref":"#/definitions/TourCard"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/batches/{batch_id}/photo":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set tourist card batch photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.tour_card.batch_store_photo","parameters":[{"description":"Batch ID.","format":"uuid","in":"path","name":"batch_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/cards":{"get":{"description":"Return all tourist cards list","operationId":"incust.controllers.tour_card.cards_all","parameters":[{"description":"Filter by Batch ID","format":"uuid","in":"query","name":"batch_id","type":"string"},{"description":"Filter by activated status","enum":[0,1],"in":"query","name":"active","type":"integer"},{"description":"Filter by canceled status","enum":[0,1],"in":"query","name":"canceled","type":"integer"},{"default":1,"description":"List page number","in":"query","name":"page","type":"integer"},{"default":20,"description":"Count in page","in":"query","name":"count","type":"integer"},{"default":"batch_id","description":"Sort field","enum":["batch_id","code","emitted_dt","activated_dt","expire_dt","batch_id","user_id","referral_code"],"in":"query","name":"sort_field","type":"string"},{"default":"asc","description":"Sort order","enum":["asc","desc"],"in":"query","name":"sort_order","type":"string"}],"responses":{"200":{"description":"Cards array","schema":{"items":{"$ref":"#/definitions/TourCard"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]}},"/tour_cards/cards/{card_id}/cancel":{"get":{"description":"Tourist card cancel","operationId":"incust.controllers.tour_card.card_cancel","parameters":[{"description":"Card ID","format":"uuid","in":"path","name":"card_id","required":true,"type":"string"}],"responses":{"200":{"description":"Card data","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/services":{"get":{"description":"Return all tourist cards services list","operationId":"incust.controllers.tour_card.services_all","parameters":[{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Services array","schema":{"items":{"$ref":"#/definitions/TourCardService"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"post":{"description":"Add new tourist card service","operationId":"incust.controllers.tour_card.service_add","parameters":[{"description":"Service data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardService"}}],"responses":{"201":{"description":"Service data","schema":{"$ref":"#/definitions/TourCardService"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/services/categories":{"get":{"description":"Return all tourist cards service categories list","operationId":"incust.controllers.tour_card.service_categories_all","parameters":[{"default":false,"description":"Return only active categories","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"categories array","schema":{"items":{"$ref":"#/definitions/TourCardCategory"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"post":{"description":"Add new tourist card service category","operationId":"incust.controllers.tour_card.service_category_add","parameters":[{"description":"Service Category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardCategory"}}],"responses":{"201":{"description":"Service Category data","schema":{"$ref":"#/definitions/TourCardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/services/categories/{category_id}":{"get":{"description":"Return tourist card service category object","operationId":"incust.controllers.tour_card.service_category","parameters":[{"description":"Service Category ID","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"}],"responses":{"200":{"description":"Service Category data","schema":{"$ref":"#/definitions/TourCardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Change tourist card service category","operationId":"incust.controllers.tour_card.service_category_edit","parameters":[{"description":"Service Category ID.","format":"uuid","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Service Category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardCategory"}}],"responses":{"200":{"description":"Service Category data","schema":{"$ref":"#/definitions/TourCardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/services/{service_id}":{"get":{"description":"Return tourist card service object","operationId":"incust.controllers.tour_card.service","parameters":[{"description":"Service ID","format":"uuid","in":"path","name":"service_id","required":true,"type":"string"}],"responses":{"200":{"description":"Service data","schema":{"$ref":"#/definitions/TourCardService"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"patch":{"description":"Change tourist card service","operationId":"incust.controllers.tour_card.service_edit","parameters":[{"description":"Service ID.","format":"uuid","in":"path","name":"service_id","required":true,"type":"string"},{"description":"Service data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardService"}}],"responses":{"200":{"description":"Service data","schema":{"$ref":"#/definitions/TourCardService"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/services/{service_id}/photo":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set tourist card service photo. Alloved ContentType (image/jpeg, image/png)","operationId":"incust.controllers.tour_card.service_store_photo","parameters":[{"description":"Service ID.","format":"uuid","in":"path","name":"service_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/services/{service_id}/pos":{"get":{"description":"Return tourist card service pos scope","operationId":"incust.controllers.tour_card.service_pos","parameters":[{"description":"Service ID","format":"uuid","in":"path","name":"service_id","required":true,"type":"string"},{"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"description":"Count of codes on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"}],"responses":{"200":{"description":"Pos array","schema":{"items":{"$ref":"#/definitions/POS"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"}]},"post":{"description":"Check pos in list? add and delete pos for tourist card service scope","operationId":"incust.controllers.tour_card.service_pos_change","parameters":[{"description":"Service ID.","in":"path","name":"service_id","required":true,"type":"string"},{"description":"Pos array","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/POS"},"type":"array"}}],"responses":{"200":{"description":"Pos array","schema":{"items":{"$ref":"#/definitions/POS"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/services/{service_id}/pos/add":{"post":{"description":"Add pos for tourist card service scope","operationId":"incust.controllers.tour_card.service_pos_add","parameters":[{"description":"Service ID.","in":"path","name":"service_id","required":true,"type":"string"},{"description":"List of POS Id","in":"body","name":"data","required":true,"schema":{"items":{"description":"POS Id","format":"uuid","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Operation result summary","schema":{"properties":{"operation_result":{"description":"Operation result summary","properties":{"processed":{"description":"Processed pos count","type":"integer"},"skipped":{"description":"Skipped codes count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/tour_cards/services/{service_id}/pos/delete":{"post":{"description":"Delete pos for tourist card service scope","operationId":"incust.controllers.tour_card.service_pos_delete","parameters":[{"description":"Service ID.","in":"path","name":"service_id","required":true,"type":"string"},{"description":"List of POS Id","in":"body","name":"data","required":true,"schema":{"items":{"description":"POS Id","format":"uuid","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Operation result summary","schema":{"properties":{"operation_result":{"description":"Operation result summary","properties":{"processed":{"description":"Processed pos count","type":"integer"},"skipped":{"description":"Skipped codes count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"}]}},"/transactions":{"get":{"description":"Return transactions list","operationId":"incust.controllers.transaction.transactions","parameters":[{"default":"","description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty","required":false,"type":"string"},{"default":"","description":"Point of sales ID","format":"uuid","in":"query","name":"pos","required":false,"type":"string"},{"default":"","description":"Terminal ID","format":"uuid","in":"query","name":"terminal","required":false,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count in page","in":"query","name":"count","required":false,"type":"integer"},{"default":false,"description":"Do not calculate totals values","in":"query","name":"skip_totals","required":false,"type":"boolean"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Transactions type if need","enum":["all","reserve","authorize-payment","sale","bonus-add","special-account-refill","coupon-sale","bonus-write-offs","special-account-write-offs"],"in":"query","name":"transaction_type","required":false,"type":"string"},{"description":"Transactions by canceled flag","in":"query","name":"canceled","required":false,"type":"boolean"},{"description":"Business Staff ID (search for if need)","in":"query","name":"business_staff_id","required":false,"type":"string"},{"description":"User phone if need (search by contains)","in":"query","name":"user_phone","required":false,"type":"string"},{"description":"User email if need (search by contains)","in":"query","name":"user_email","required":false,"type":"string"},{"description":"User external id if need (search by contains)","in":"query","name":"user_external_id","required":false,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string"},{"description":"Corporate customer email if need (search by contains)","in":"query","name":"corporate_customer_email","required":false,"type":"string"},{"description":"Corporate customer Id if need","format":"uuid","in":"query","name":"corporate_customer_id","required":false,"type":"string"},{"description":"Transaction comment if need","in":"query","name":"comment","required":false,"type":"string"},{"description":"Terminal ID generated temporary code","format":"uuid","in":"query","name":"sc_terminal","required":false,"type":"string"},{"description":"Temporary code if need (search by match)","in":"query","name":"sc_code","required":false,"type":"string"},{"collectionFormat":"csv","description":"Transaction items array if need","in":"query","items":{"type":"string"},"name":"items","required":false,"type":"array"},{"default":"all","description":"Payment type if need","enum":["all","money","account"],"in":"query","name":"payment_type","required":false,"type":"string"},{"default":"all","description":"Customers type if need","enum":["all","retail","corporate"],"in":"query","name":"customer_type","required":false,"type":"string"},{"description":"Special account ID if need","format":"uuid","in":"query","name":"special_account","required":false,"type":"string"},{"description":"Instance of customer special account ID if need","format":"uuid","in":"query","name":"customer_special_account","required":false,"type":"string"},{"description":"Instance of corporate customer special account ID if need","format":"uuid","in":"query","name":"corporate_customer_special_account","required":false,"type":"string"},{"description":"Vehicle ID if need","in":"query","name":"vehicle_id","required":false,"type":"string"},{"description":"Staff ID if need","format":"uuid","in":"query","name":"corporate_staff_id","required":false,"type":"string"},{"description":"Staff comment if need (search by contains)","in":"query","name":"corporate_staff_comment","required":false,"type":"string"},{"description":"Position ID if need","format":"uuid","in":"query","name":"corporate_position_id","required":false,"type":"string"},{"description":"Position title if need (search by contains)","in":"query","name":"corporate_position_title","required":false,"type":"string"},{"description":"Corporate Vehicle/inventory unique Id if need","in":"query","name":"corporate_vehicle_id","required":false,"type":"string"},{"description":"Sorting field name and order","in":"query","name":"sort","required":false,"type":"string"},{"default":false,"description":"Detalized (split rows) by stock (return transactions with stock only)","in":"query","name":"by_stock","required":false,"type":"boolean"},{"default":false,"description":"Include temporary code (stuard code) info","in":"query","name":"include_sc_info","required":false,"type":"boolean"},{"default":false,"description":"Include check vehicle id info","in":"query","name":"include_vehicle_id","required":false,"type":"boolean"},{"default":false,"description":"Include check odometer info","in":"query","name":"include_odometer","required":false,"type":"boolean"},{"default":false,"description":"Include corporate staff and position info","in":"query","name":"include_corporate_staff","required":false,"type":"boolean"},{"default":false,"description":"Include corporate vehicle/inventory info","in":"query","name":"include_corporate_vehicle","required":false,"type":"boolean"},{"default":false,"description":"Include customer questionnaire","in":"query","name":"include_questionnaire","required":false,"type":"boolean"},{"default":false,"description":"Include customer additional cards list","in":"query","name":"include_customer_additional_cards","required":false,"type":"boolean"},{"default":false,"description":"Include taxes applied to the transaction / transaction item","in":"query","name":"include_taxes","required":false,"type":"boolean"},{"default":false,"description":"Include additional costs (margins) applied to the transaction / transaction item","in":"query","name":"include_margins","required":false,"type":"boolean"},{"default":false,"description":"Include fuel delivery average costs (only for by_stock is true)","in":"query","name":"include_fuel_delivery_average_costs","required":false,"type":"boolean"},{"default":false,"description":"Include transaction errors info","in":"query","name":"transaction_errors","required":false,"type":"boolean"},{"default":false,"description":"Minimize summary info (only total rows count)","in":"query","name":"minimize_totals","required":false,"type":"boolean"}],"responses":{"200":{"description":"Transactions data","schema":{"$ref":"#/definitions/TransactionsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.transaction.manager"},{"restriction":{},"role":"businessdashboard.transaction.data_viewer"}]}},"/transactions/bonuses/add":{"post":{"description":"Add bonuses to user account","operationId":"incust.controllers.transaction.bonuses_add","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BonusesOperationObject"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/transactions/bonuses/adjust":{"post":{"description":"Adjust (refill or write-offs) bonuses on user account","operationId":"incust.controllers.transaction.bonuses_adjust","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BonusesOperationObject"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/transactions/bonuses/write_offs":{"post":{"description":"Write-offs bonuses from user account","operationId":"incust.controllers.transaction.bonuses_write_off","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BonusesOperationObject"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/transactions/cancel":{"post":{"description":"Cancel transaction","operationId":"incust.controllers.transaction.transaction_cancel","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"properties":{"comment":{"description":"Comment","type":"string"},"transaction_id":{"description":"Canceled transaction ID","format":"uuid","type":"string"}},"required":["transaction_id"],"type":"object"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.transaction.manager"}]}},"/transactions/finalize":{"post":{"description":"Finalize reserved transaction","operationId":"incust.controllers.transaction.transaction_finalize","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FinalizeCheck"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.transaction.manager"}]}},"/transactions/special_account/adjust":{"post":{"description":"Adjust (refill or write-offs) user special account","operationId":"incust.controllers.transaction.special_account_adjust","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SpecialAccountOperationObject"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/transactions/special_account/refill":{"post":{"description":"Refill user special account","operationId":"incust.controllers.transaction.special_account_refill","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SpecialAccountOperationObject"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/transactions/special_account/write_offs":{"post":{"description":"Write-offs user special account","operationId":"incust.controllers.transaction.special_account_write_off","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SpecialAccountOperationObject"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.customer.manager"}]}},"/transactions/{transaction_id}/check":{"get":{"description":"Return transaction check","operationId":"incust.controllers.transaction.transaction_check","parameters":[{"description":"Transaction id","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Check data","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.transaction.manager"},{"restriction":{},"role":"businessdashboard.transaction.data_viewer"}]}},"/transactions/{transaction_id}/order":{"get":{"description":"Return transaction order","operationId":"incust.controllers.transaction.transaction_order","parameters":[{"description":"Transaction id","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Order data","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.transaction.manager"},{"restriction":{},"role":"businessdashboard.transaction.data_viewer"}]}},"/transactions/{transaction_id}/receipt":{"get":{"description":"Return transaction receipt","operationId":"incust.controllers.transaction.transaction_receipt","parameters":[{"description":"Transaction id","in":"path","name":"transaction_id","required":true,"type":"string"},{"default":"business","description":"Template type","enum":["business","customer"],"in":"query","name":"template_type","required":false,"type":"string"}],"responses":{"200":{"description":"Receipt data","schema":{"$ref":"#/definitions/TransactionReceipt"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{},"x-application-role-based-restriction":[{"restriction":{},"role":"businessdashboard.business.administrator"},{"restriction":{},"role":"businessdashboard.business.manager"},{"restriction":{},"role":"businessdashboard.business.data_viewer"},{"restriction":{},"role":"businessdashboard.loyalty.manager"},{"restriction":{},"role":"businessdashboard.loyalty.data_viewer"},{"restriction":{},"role":"businessdashboard.transaction.manager"},{"restriction":{},"role":"businessdashboard.transaction.data_viewer"}]}}},"produces":["application/json"],"schemes":["https","http"],"securityDefinitions":{"bearer":{"in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"incust.auth.apikey_auth"}},"swagger":"2.0"}