{"basePath":"/v1/client","consumes":["application/json"],"definitions":{"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"},"AccountsRec":{"properties":{"account_id":{"description":"Customer special account ID","format":"uuid","type":"string","x-nullable":true},"amount":{"description":"On hand amount","format":"double","type":"number","x-nullable":true},"available_amount":{"description":"Amount of funds on the account available for using (null if unlimited)","format":"float","type":"number","x-nullable":true},"balance":{"description":"balance","format":"float","type":"number","x-nullable":true},"credit_limit":{"description":"Credit limit","format":"float","type":"number","x-nullable":true},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit_type","x-nullable":true},"currency":{"description":"Currency ISO code (optional)","type":"string","x-nullable":true},"currency_name":{"description":"Currency name","type":"string","x-nullable":true},"extended":{"description":"Account extended flag","enum":[0,1],"type":"integer","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"List of goods codes that can be paid from this account","x-nullable":true},"id":{"type":"string","x-nullable":true},"limits":{"$ref":"#/definitions/AccountLimits","description":"Access limits (optional, only for extended accounts only)","x-nullable":true},"odometer":{"$ref":"#/definitions/DataRequiredType","description":"Odometer value needed flag (optional, only for extended accounts only)","x-nullable":true},"security_code":{"description":"Additional PIN-code for access to the account exists (optional, only for extended accounts only)","enum":[0,1],"type":"integer","x-nullable":true},"title":{"type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Type of account","x-nullable":true},"unconfirmed_redeem_amount":{"description":"Amount that can be redeemed from the account without confirmation (optional)","format":"double","type":"number","x-nullable":true}},"type":"object"},"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"},"ApplicationSettings":{"properties":{"support_news_priority":{"description":"Support news priority","enum":[0,1],"type":"integer"},"support_pos_priority":{"description":"Support pos priority","enum":[0,1],"type":"integer"}},"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"},"Beacon":{"properties":{"major":{"type":"integer"},"minor":{"type":"integer"},"uuid":{"description":"Proximity UUID","format":"uuid","type":"string"}},"type":"object"},"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"},"BonusPointsTransferFundsRequest":{"properties":{"amount":{"description":"Operation amount","format":"float","type":"number"},"currency":{"description":"Currency ISO code","type":"string"},"recipient_id":{"description":"Recipient of funds User identifier (phone number, email, external identifier)","type":"string"},"recipient_id_type":{"description":"Type of recipient user identity (optional)","enum":["phone","email","external-id","qr"],"type":"string","x-nullable":true}},"required":["currency","amount","recipient_id"],"type":"object"},"BonusesRec":{"properties":{"bonuses_amount":{"description":"Total bonuses amount","format":"float","type":"number"},"currency":{"description":"Сurrency code","type":"string"},"currency_name":{"type":"string"},"id":{"type":"string"},"permanent_bonuses_amount":{"description":"Permanent bonuses amount","format":"float","type":"number"},"temporary_bonuses_amount":{"description":"Temporary bonuses amount","format":"float","type":"number"},"title":{"description":"Bonus account title (optional)","type":"string"}},"type":"object"},"CardCategory":{"description":"Card category","properties":{"id":{"description":"Card category ID","format":"uuid","type":"string"},"image":{"description":"URL of batch image","type":"string"},"title":{"description":"Card category title","type":"string"},"type":{"description":"Category type (readonly)","enum":["base","custom"],"type":"string"}},"type":"object"},"CardInfo":{"properties":{"bonuses_added_amount":{"format":"double","type":"number"},"bonuses_amount":{"format":"double","type":"number"},"bonuses_redeemed_amount":{"format":"double","type":"number"},"permanent_bonuses_amount":{"format":"double","type":"number"},"saved_amount":{"format":"double","type":"number"},"temporary_bonuses_amount":{"format":"double","type":"number"}},"type":"object"},"CardRecord":{"description":"Customer card record","properties":{"code":{"description":"Card code","type":"string"},"id":{"description":"Card id","format":"uuid","type":"string"},"photo":{"description":"Url of loyalty photo","type":"string"},"scope":{"description":"Card scope","enum":["all","business","loyalty"],"type":"string"},"title":{"description":"Card title, depends of scope (Loyalty name or Platform name)","type":"string"}},"type":"object"},"ChatbotChannels":{"enum":["facebook","telegram","viber","wawebproxy","wabcloud"],"type":"string"},"ChatbotTokenData":{"properties":{"channel":{"$ref":"#/definitions/ChatbotChannels","description":"Type of token channel"},"expire":{"description":"Date of token expire","format":"date","type":"string"},"token":{"description":"Chatbot token","type":"string"}},"required":["token","channel"],"type":"object"},"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"},"ClientReferralProgramCodeInfo":{"properties":{"code":{"description":"Referral code","type":"string"},"loyalty":{"$ref":"#/definitions/Loyalty"},"referrer_user":{"$ref":"#/definitions/RefferalProgramReferrerUser"}},"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"},"CorporateCustomerAccountInfo":{"description":"Corporate customer","properties":{"active":{"description":"Account active flag","enum":[0,1],"type":"integer"},"corporate_customer":{"$ref":"#/definitions/CorporateCustomerInfo","description":"Corporate customer info"},"id":{"description":"Corporate customer special account ID","format":"uuid","type":"string"},"special_account":{"$ref":"#/definitions/AccountsRec","description":"Special account info"}},"type":"object"},"CorporateCustomerInfo":{"description":"Corporate customer","properties":{"corporate_user":{"$ref":"#/definitions/CorporateUserInfo","description":"Corporate user info"},"id":{"description":"Corporate customer ID","format":"uuid","type":"string"},"suspended":{"description":"Customer suspended flag","enum":[0,1],"type":"integer"}},"type":"object"},"CorporateCustomerSpecialAccountAccess":{"properties":{"available_amount":{"description":"Amount of funds on the account available for using (null if unlimited)","format":"float","type":"number","x-nullable":true},"corporate_customer_special_account":{"$ref":"#/definitions/CorporateCustomerAccountInfo","description":"Corporate customer special account info"},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods filter","x-nullable":true},"id":{"description":"Access ID","format":"uuid","type":"string"},"limits":{"$ref":"#/definitions/CorporateAccountAccessLimits","description":"Access limits"},"odometer":{"$ref":"#/definitions/DataRequiredType","description":"Odometer value needed flag"},"security_code":{"description":"Additional PIN-code for access to the account exists","enum":[0,1],"type":"integer"},"vehicle_id":{"$ref":"#/definitions/DataRequiredType","description":"Vehicle ID needed flag"}},"type":"object"},"CorporateUserInfo":{"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"},"Coupon":{"properties":{"activity_id":{"description":"Activity ID (optional, check only)","format":"uuid","type":"string","x-nullable":true},"applicable":{"description":"Coupon check applicable for check (optional, check only)","type":"boolean","x-nullable":true},"batch":{"$ref":"#/definitions/CouponBatch","description":"Batch info (optional)","x-nullable":true},"business_code":{"description":"Business code","type":"string","x-nullable":true},"charge_amount":{"description":"Coupon certificate type refill amount (optional)","format":"double","type":"number","x-nullable":true},"charge_bonuses_currency":{"description":"currency (optional)","type":"string","x-nullable":true},"charge_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},"charge_promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireTypeBase","description":"Promotional bonuses expiration value type (optional)","x-nullable":true},"charge_promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire (optional)","type":"integer","x-nullable":true},"charge_special_account_currency":{"description":"Special account currency (optional)","type":"string","x-nullable":true},"charge_special_account_id":{"description":"Special account ID (optional)","format":"uuid","type":"string","x-nullable":true},"charge_special_account_title":{"description":"Special account title (optional)","type":"string","x-nullable":true},"charge_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Coupon certificate type refill object (optional)","x-nullable":true},"code":{"description":"Coupon code","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},"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},"emission_dt":{"description":"Date emission of coupon","format":"datetime","type":"string","x-nullable":true},"error":{"description":"Coupon check implementation error (optional, 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","type":"string","x-nullable":true},"external_code_visibility_type":{"$ref":"#/definitions/CouponExternalCodeVisibilityType","description":"External code visibility type","x-nullable":true},"id":{"description":"Unique id of coupon","format":"uuid","type":"string","x-nullable":true},"image":{"format":"url","type":"string","x-nullable":true},"locked":{"description":"Coupon locked by transaction process (optional)","type":"boolean","x-nullable":true},"loyalty":{"$ref":"#/definitions/Loyalty","description":"Loyalty info (optional)","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},"recommendation_fee_amount":{"description":"Recommendation fee amount","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 (optional)","format":"uuid","type":"string","x-nullable":true},"recommendation_fee_coupon_batch_title":{"description":"Recommendation fee Batch TITLE (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 (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","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}},"type":"object"},"CouponBatch":{"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_code":{"description":"Business code","type":"string","x-nullable":true},"code":{"description":"Coupon batch code","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},"description":{"description":"Coupons batch description","type":"string","x-nullable":true},"emission_period_begin":{"description":"Date of emission begins","format":"date","type":"string","x-nullable":true},"emission_period_end":{"description":"Date of emission ends","format":"date","type":"string","x-nullable":true},"external_code_visibility_type":{"description":"External code visibility type","enum":["always-open","on-redeem"],"type":"string","x-nullable":true},"id":{"description":"Unique id of coupon batch","format":"uuid","type":"string","x-nullable":true},"image":{"description":"Coupon batch image URL (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, same as description)","type":"string","x-nullable":true},"public_title":{"description":"Coupons batch public title (optional, same as title)","type":"string","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 (optional)","format":"uuid","type":"string","x-nullable":true},"recommendation_fee_coupon_batch_title":{"description":"Recommendation fee Batch TITLE (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":"Recommendation fee special account Id (optional)","format":"uuid","type":"string","x-nullable":true},"recommendation_fee_special_account_title":{"description":"Recommendation fee special account title (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","enum":[0,1],"type":"integer","x-nullable":true},"share_allowed":{"description":"Coupons share allowed for customer","enum":[0,1],"type":"integer","x-nullable":true},"title":{"description":"Coupons batch title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/CouponType","description":"Type of coupon","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"},"CouponBatchAliasesPaginated":{"properties":{"data":{"$ref":"#/definitions/CouponBatchAliases"},"summary":{"$ref":"#/definitions/CouponBatchAliasesSummary"}},"type":"object"},"CouponBatchAliasesSummary":{"properties":{"total_rows_count":{"type":"integer"}},"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"},"CouponCode":{"properties":{"code":{"description":"Coupon code","type":"string","x-nullable":true},"type":{"default":"other","description":"Type of code","enum":["coupon","coupon-batch","gift-card","other"],"format":"string"}},"required":["code"],"type":"object"},"CouponExternalCodeVisibilityType":{"enum":["always-open","on-redeem"],"type":"string"},"CouponProcessingStatus":{"enum":["pending","processed","error"],"type":"string"},"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"},"CouponsAddedResponse":{"properties":{"code":{"description":"Message code","format":"int32","type":"integer"},"coupons":{"$ref":"#/definitions/ObjectIds"},"message":{"description":"Message description","type":"string"}},"type":"object"},"CustomerAccess":{"properties":{"access_type":{"$ref":"#/definitions/CustomerAccessType","description":"Access type"}},"type":"object"},"CustomerAccessType":{"enum":["full-bonuses-access","add-bonuses-only","waiting-for-confirmation","in-black-list"],"type":"string"},"CustomerAccountTransferFundsRequest":{"properties":{"amount":{"description":"Operation amount","format":"float","type":"number"},"recipient_id":{"description":"Recipient of funds User identifier (phone number, email, external identifier)","type":"string"},"recipient_id_type":{"description":"Type of recipient user identity (optional)","enum":["phone","email","external-id","qr"],"type":"string","x-nullable":true},"special_account_id":{"description":"Special Account ID","format":"uuid","type":"string","x-nullable":true}},"required":["special_account_id","amount","recipient_id"],"type":"object"},"CustomerCart":{"properties":{"accounts":{"description":"Special account info","items":{"$ref":"#/definitions/AccountsRec"},"type":"array"},"bonuses":{"description":"The basic bonuses","items":{"$ref":"#/definitions/BonusesRec"},"type":"array"},"check":{"$ref":"#/definitions/Check","description":"Check object"},"corporate_special_accounts_access":{"description":"List of access to the corporate customer special accounts","items":{"$ref":"#/definitions/CorporateCustomerSpecialAccountAccess"},"type":"array"},"coupons":{"description":"Coupons info","items":{"$ref":"#/definitions/Coupon"},"type":"array"},"shipping":{"$ref":"#/definitions/Shipping","description":"Check object"}},"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"},"id":{"description":"Feedback ID","format":"uuid","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"mobile_initiated":{"default":false,"description":"Feedback is generated by selecting a POS in the list and leaving feedback for it (optional)","type":"boolean"},"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"},"CustomerFeedbackSettings":{"properties":{"active":{"description":"Feedback source active flag","enum":[0,1],"type":"integer"},"allow_attach_file_for_unauthorized_customer":{"description":"Allow unauthorized customers attach files to feedback","enum":[0,1],"type":"integer"},"allow_rating_for_unauthorized_customer":{"description":"Allow unauthorized customers leave ratings","enum":[0,1],"type":"integer"},"allow_review_for_unauthorized_customer":{"description":"Allow unauthorized customers leave reviews","enum":[0,1],"type":"integer"},"allowed":{"description":"Allow leave ratings/reviews","enum":["none","authorized-users-only","all-users"],"type":"string"},"feedback_invitation_text":{"description":"Text displayed for customers as invitation","type":"string"},"feedback_per_customer_limit":{"description":"Maximum allowable number of ratings/reviews from the customer to one feedback source (0 is unlimited).","type":"integer"},"feedback_source":{"$ref":"#/definitions/FeedbackSource","description":"Feedback source ID"}},"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"},"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},"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}},"required":["amount"],"type":"object"},"CustomerWallet":{"items":{"$ref":"#/definitions/CustomerWalletItem"},"type":"array"},"CustomerWalletItem":{"properties":{"accounts":{"items":{"$ref":"#/definitions/AccountsRec"},"type":"array","x-nullable":true},"bonuses":{"items":{"$ref":"#/definitions/BonusesRec"},"type":"array","x-nullable":true},"coupons":{"items":{"$ref":"#/definitions/Coupon"},"type":"array","x-nullable":true},"description":{"description":"Wallet item base description","type":"string","x-nullable":true},"favorite":{"description":"Wallet item in favorites (for Loyalty only)","type":"boolean","x-nullable":true},"id":{"description":"Wallet item base (business/Loyalty) ID","format":"uuid","type":"string","x-nullable":true},"loyalties":{"description":"Loyalties (only for type is 'business')","items":{"$ref":"#/definitions/Loyalty"},"type":"array","x-nullable":true},"photos":{"description":"Logos","items":{"$ref":"#/definitions/ImageObject"},"type":"array","x-nullable":true},"title":{"description":"Wallet item base title","type":"string","x-nullable":true},"type":{"description":"Wallet item type","enum":["business","loyalty"],"type":"string","x-nullable":true}},"type":"object"},"DataRequiredType":{"enum":["no","yes","possible"],"type":"string"},"DeliveryType":{"properties":{"additional_customer_info":{"description":"Additional customer info","type":"string"},"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"},"price":{"$ref":"#/definitions/ThresholdsValues","description":"Price values depends of thresholds"},"title":{"description":"Title","type":"string"}},"type":"object"},"EmailsList":{"items":{"description":"Email","type":"string"},"type":"array"},"EquipmentControllerStatus":{"enum":["created","connection-failed","available","unavailable"],"type":"string"},"EquipmentControllerType":{"enum":["plc-modicon-m241"],"type":"string"},"EquipmentRec":{"properties":{"available":{"description":"Is available available for operations (optional)","type":"boolean","x-nullable":true},"controller_status":{"$ref":"#/definitions/EquipmentControllerStatus","description":"Controller status","x-nullable":true},"id":{"description":"Equipment ID","format":"uuid","type":"string","x-nullable":true},"monitor_working_status":{"description":"Is monitoring of working equipment status turned on","type":"boolean","x-nullable":true},"terminal":{"$ref":"#/definitions/TerminalSettings","description":"Terminal settings data (optional)","x-nullable":true},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Equipment Title","format":"uuid","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/EquipmentType","description":"Equipment type","x-nullable":true}},"type":"object"},"EquipmentRecList":{"items":{"$ref":"#/definitions/EquipmentRec"},"type":"array"},"EquipmentType":{"enum":["car-wash"],"type":"string"},"ExternalBankCardsEDCTypes":{"enum":["auto","credit","debit","gift"],"type":"string"},"ExternalCheckIdScope":{"enum":["system","business","loyalty","pos","terminal"],"type":"string"},"FavoriteObjectAction":{"properties":{"object_id":{"description":"Object ID","format":"uuid","type":"string"},"object_type":{"description":"Object type","enum":["coupon","news","pos","loyalty"],"type":"string"}},"type":"object"},"FeedbackSource":{"properties":{"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"},"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":{"description":"Text displayed for customers as invitation","type":"string"},"loyalty":{"$ref":"#/definitions/Loyalty"},"title":{"description":"Title","type":"string"}},"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"},"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"},"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"},"FuelFillingType":{"enum":["amount","volume"],"type":"string"},"FuelPumpNozzleRec":{"properties":{"code":{"description":"Nozzle fuel grade code","type":"string"},"goods":{"$ref":"#/definitions/Goods","description":"Nozzle linked goods data"},"id":{"description":"Nozzle ID","format":"uuid","type":"string"},"internal_id":{"description":"Internal nozzle ID / Nozzle number","type":"string"},"tank_id":{"description":"Tank Id (optional)","type":"string"},"up":{"description":"Nozzle taken up","type":"boolean"}},"type":"object"},"FuelPumpRec":{"properties":{"available":{"description":"Is available available for operations","type":"boolean"},"id":{"description":"Pump ID","format":"uuid","type":"string"},"internal_id":{"description":"Internal pump ID / Pump number","type":"string"},"nozzles":{"description":"Nozzles info","items":{"$ref":"#/definitions/FuelPumpNozzleRec"},"type":"array"},"status":{"description":"Pump status","enum":["idle","filling","end-of-transaction","offline"],"type":"string"},"status_description":{"description":"Pump status description","type":"string"},"terminal_id":{"description":"Linked terminal ID","format":"uuid","type":"string"}},"type":"object"},"FuelRec":{"properties":{"configuration":{"$ref":"#/definitions/FuelControllerConfiguration","description":"Controller configuration"},"configuration_reading_status":{"description":"Configuration reading status (read only)","enum":["connection-not-configured","ready-to-read","success","fail"],"type":"string"},"configuration_updated":{"description":"Controller configuration last updated time","format":"date-time","type":"string"},"id":{"description":"Controller ID","format":"uuid","type":"string"},"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","items":{"$ref":"#/definitions/FuelPumpRec"},"type":"array"},"skip_pumps_in_selection":{"description":"Skip pumps when selecting fuel for filling","enum":[0,1],"type":"integer"}},"type":"object"},"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":{"business_code":{"description":"Business code","type":"string","x-nullable":true},"code":{"description":"Gift Card code","type":"string","x-nullable":true},"description":{"description":"Gift Card Description","type":"string","x-nullable":true},"id":{"description":"Unique id of Gift Card","format":"uuid","type":"string","x-nullable":true},"image":{"description":"URL of Gift Card image (optional)","format":"url","type":"string","x-nullable":true},"loyalty":{"$ref":"#/definitions/Loyalty","description":"Loyalty info (optional)","x-nullable":true},"loyalty_id":{"description":"Loyalty emission id","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Gift Card Title","type":"string","x-nullable":true}},"type":"object"},"Goods":{"properties":{"additional_images":{"$ref":"#/definitions/ImageObjectsList","description":"Goods additional images","x-nullable":true},"barcode":{"description":"Goods barcode","type":"string","x-nullable":true},"code":{"description":"Goods code","type":"string","x-nullable":true},"color":{"description":"Color","type":"integer","x-nullable":true},"currency":{"description":"Price currency","type":"string","x-nullable":true},"description":{"description":"Description","type":"string","x-nullable":true},"id":{"description":"Goods ID","format":"uuid","type":"string","x-nullable":true},"image":{"$ref":"#/definitions/ImageObject","description":"Main goods image","x-nullable":true},"margins":{"$ref":"#/definitions/PriceMargins","description":"Price margins (optional)","x-nullable":true},"parent_code":{"description":"Parent category code (optional)","type":"string","x-nullable":true},"parent_id":{"description":"Parent category ID","format":"uuid","type":"string","x-nullable":true},"parent_title":{"description":"Parent category Title","type":"string","x-nullable":true},"preconfigured_values":{"description":"Pre-configured values with amount or totals","items":{"$ref":"#/definitions/PreConfiguredValues"},"type":"array","x-nullable":true},"preset_recommnded_values_only":{"description":"Only preset recommended values allowed","enum":[0,1],"type":"integer","x-nullable":true},"price":{"description":"Googs price","format":"float","type":"number","x-nullable":true},"price_decimal_digits":{"description":"Number of decimal digits in price value (optional)","type":"integer","x-nullable":true},"prices":{"description":"Price values","items":{"$ref":"#/definitions/GoodsPrice"},"type":"array","x-nullable":true},"service_types":{"$ref":"#/definitions/StringValuesList","description":"Service types of goods","x-nullable":true},"taxes":{"$ref":"#/definitions/PriceTaxes","description":"Price taxes (optional)","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true},"unit":{"description":"Unit","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},"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"},"GoodsCategory":{"properties":{"code":{"description":"Category code","type":"string"},"color":{"description":"Color","type":"integer"},"description":{"description":"Category description","type":"string"},"id":{"description":"Category ID","format":"uuid","type":"string"},"image":{"$ref":"#/definitions/ImageObject","description":"Category image"},"link":{"description":"Category link","type":"string"},"parent_id":{"description":"Parent category ID","format":"uuid","type":"string"},"parent_title":{"description":"Parent category Title","type":"string"},"title":{"description":"Title","type":"string"}},"type":"object"},"GoodsCodes":{"items":{"description":"goods code","type":"string"},"type":"array"},"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"},"IdTitle":{"properties":{"id":{"description":"ID","type":"integer"},"title":{"description":"Title of news","type":"string"}},"type":"object"},"IdType":{"enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"type":"string"},"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"},"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"},"LiqPayIntegrationTypes":{"items":{"enum":["checkout","widget"],"type":"string"},"type":"array"},"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"},"LoansPaginatedList":{"properties":{"data":{"$ref":"#/definitions/LoansList"},"summary":{"$ref":"#/definitions/LoansSummary"}},"type":"object"},"LoansSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"Loyalty":{"properties":{"accounts":{"items":{"$ref":"#/definitions/AccountsRec"},"type":"array"},"additional_services":{"description":"Additional services (optional)","items":{"$ref":"#/definitions/AdditionalService"},"type":"array","x-nullable":true},"bonuses":{"items":{"$ref":"#/definitions/BonusesRec"},"type":"array"},"card_category":{"$ref":"#/definitions/CardCategory"},"cards":{"items":{"$ref":"#/definitions/CardRecord"},"type":"array"},"categories":{"description":"Categories","items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array"},"corporate_special_accounts_access":{"description":"List of access to the corporate customer special accounts","items":{"$ref":"#/definitions/CorporateCustomerSpecialAccountAccess"},"type":"array"},"coupons":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"},"customer_access":{"$ref":"#/definitions/CustomerAccess"},"customer_feedback_settings":{"$ref":"#/definitions/CustomerFeedbackSettings"},"description":{"type":"string","x-nullable":true},"favorite":{"type":"boolean"},"id":{"description":"Loyalty ID","format":"uuid","type":"string"},"legal_info":{"description":"Loyalty legal info","type":"string"},"links":{"$ref":"#/definitions/LoyaltyCategory","x-nullable":true},"loyalty_bonuses_settings":{"$ref":"#/definitions/LoyaltyBonusesSettings","description":"Loyalty bonuses and discount settings (optional)"},"news":{"$ref":"#/definitions/NewsList","description":"News list","x-nullable":true},"online_store":{"$ref":"#/definitions/OnlineStore"},"payment_systems_availability":{"$ref":"#/definitions/PaymentSystemsRec","description":"Payment system availability","x-nullable":true},"photos":{"$ref":"#/definitions/ImageObjectsList"},"pos":{"description":"Points of sale","items":{"$ref":"#/definitions/Pos"},"type":"array","x-nullable":true},"privacy_policy_url":{"description":"Loyalty privacy policy link","type":"string"},"public_description":{"description":"Loyalty public description (same as description)","type":"string","x-nullable":true},"public_title":{"description":"Loyalty public title (same as title)","type":"string","x-nullable":true},"referral_program":{"$ref":"#/definitions/ReferralProgram"},"title":{"type":"string","x-nullable":true}},"type":"object"},"LoyaltyBonusesSettings":{"description":"Loyalty bonuses and discount settings","properties":{"bonus_payment_limit":{"description":"Limit bonus points redeem in percentage of check amount","format":"float","type":"number"},"bonus_payment_settings_source":{"description":"Bonus points payment settings source (optional)","enum":["loyalty","card-category"],"type":"string","x-nullable":true},"bonus_payment_type":{"description":"Bonus points redeem type (only full check amount, partial check amount, partial check amount rounded to the nearest whole number)","enum":["full-check","partial","partial-rounded"],"type":"string"},"unconfirmed_bonus_payment_amount":{"description":"Limit bonus points redeem amount without PIN confirmation","format":"float","type":"number"},"unconfirmed_discount_amount":{"description":"Limit discount amount without PIN confirmation","format":"float","type":"number"}},"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"},"LoyaltyCustomer":{"description":"Loyalty customer data","properties":{"access_type":{"$ref":"#/definitions/CustomerAccessType","description":"Access type"},"loyalty_id":{"description":"Loyalty id","format":"uuid","type":"string"}},"type":"object"},"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"},"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"},"LoyaltyRuleScope":{"enum":["retail","corporate"],"type":"string"},"LoyaltySettings":{"description":"Loyalty settings","properties":{"customer_feedback_settings":{"$ref":"#/definitions/CustomerFeedbackSettings"},"loyalty_bonuses_settings":{"$ref":"#/definitions/LoyaltyBonusesSettings","description":"Loyalty bonuses and discount settings"},"online_store":{"$ref":"#/definitions/OnlineStore"},"referral_program":{"$ref":"#/definitions/ReferralProgram"}},"type":"object"},"Message":{"properties":{"attachment":{"description":"Attachment type","enum":["image","coupon","news","payment","feedback-source","online-store-order"],"type":"string"},"coupon":{"$ref":"#/definitions/Coupon"},"created":{"description":"News date","format":"date-time","type":"string"},"dst_loyalty":{"$ref":"#/definitions/Loyalty"},"dst_type":{"enum":["system","business","user"],"type":"string"},"feedback_source":{"$ref":"#/definitions/FeedbackSource"},"id":{"description":"Message ID","format":"uuid","type":"string"},"message":{"description":"Message body","type":"string"},"news":{"$ref":"#/definitions/News"},"order":{"$ref":"#/definitions/Order"},"outcome":{"type":"boolean"},"payment":{"$ref":"#/definitions/PaymentInfo"},"readed":{"enum":[0,1],"type":"integer"},"src_loyalty":{"$ref":"#/definitions/Loyalty"},"src_type":{"enum":["system","business","user"],"type":"string"},"title":{"description":"Subject of message","type":"string"},"type":{"enum":["sms","push","viber","email","incust-messenger","incust-chatbot","external-system","pkpass-message"],"type":"string"}},"type":"object"},"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"},"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"},"MobileAppPaymentSettingsScope":{"enum":["platform","business","loyalty","pos"],"type":"string"},"MobileAppWalletType":{"enum":["ipay","stripe","4bill","eway","flutterwave","global-payments","wave"],"type":"string"},"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":{"category_title":{"description":"Category title","type":"string"},"coupon_batches":{"items":{"$ref":"#/definitions/CouponBatch"},"type":"array"},"created":{"description":"News date","format":"date-time","type":"string"},"description":{"description":"Description news","type":"string"},"description_extended":{"description":"Extended description of news","type":"string"},"id":{"description":"News ID","format":"uuid","type":"string"},"link":{"description":"Url of news","type":"string"},"loyalty":{"$ref":"#/definitions/Loyalty"},"photo":{"description":"Url of news photo","type":"string"},"pos":{"$ref":"#/definitions/Pos"},"priority":{"default":0,"description":"News priority(0 - the greatest one)","type":"integer"},"row_offset":{"description":"Record row offset","type":"integer"},"title":{"description":"Title of news","type":"string"},"type":{"description":"Type of news","enum":["text","html","link"],"type":"string"}},"type":"object"},"NewsCategory":{"properties":{"id":{"description":"News category ID","format":"uuid","type":"string"},"news":{"$ref":"#/definitions/NewsList","description":"News list"},"title":{"description":"Title of news category","type":"string"}},"type":"object"},"NewsList":{"items":{"$ref":"#/definitions/News"},"type":"array"},"ObjectIds":{"items":{"description":"Object ID","format":"uuid","type":"string"},"type":"array"},"OdometerUnitType":{"enum":["K","M","H"],"type":"string"},"OnlineStore":{"properties":{"active":{"description":"Object active flag","enum":[0,1],"type":"integer"},"additional_customer_info":{"description":"Additional customer info (optional)","type":"string"},"cart_expire_days":{"description":"Users cart expire period in days (optional)","type":"integer"},"order_type":{"description":"Order type used in schema","enum":["online-store","fuel-taxi"],"type":"string"},"payment_type":{"default":"none","description":"Payment in store (optional)","enum":["none","bonuses","possible","required"],"type":"string"},"pos_level_store":{"$ref":"#/definitions/PosOnlineStore","description":"Online store parameters for Pos with online-store type (optional)"},"pos_level_stores_exists":{"description":"Loyalty has active Pos with online-store type","enum":[0,1],"type":"integer"},"terminal_id":{"description":"Terminal ID (optional)","format":"uuid","type":"string"},"title":{"description":"Title (optional)","type":"string"}},"type":"object"},"Order":{"properties":{"cancel_allowed":{"description":"Is Order cancellation allowed (readonly)","type":"boolean","x-nullable":true},"check":{"$ref":"#/definitions/Check","description":"Check object"},"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 (required for order type 'fuel-taxi')"},"id":{"description":"Order ID","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"number":{"description":"Order number","type":"string","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},"processing":{"$ref":"#/definitions/OrderProcessingInfo","description":"Order processing info","x-nullable":true},"shipping":{"$ref":"#/definitions/Shipping","description":"Shipping object (required for order type 'online-store')"},"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}},"required":["payment_method","check"],"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"},"OrderProcessingInfo":{"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},"estimated_delivery":{"description":"Estimated delivery date and time","format":"date-time","type":"string","x-nullable":true},"status":{"description":"Order status","enum":["pending","shipping","customer-assistance-needed"],"type":"string","x-nullable":true},"tracking":{"description":"Tracking info","properties":{"datetime":{"format":"date-time","type":"string","x-nullable":true},"latitude":{"format":"float","type":"number","x-nullable":true},"longitude":{"format":"float","type":"number","x-nullable":true},"source":{"type":"string","x-nullable":true}},"type":"object","x-nullable":true}},"type":"object"},"OrdersListResult":{"properties":{"orders":{"description":"Orders list","items":{"$ref":"#/definitions/Order"},"type":"array"},"total":{"description":"Total orders count","type":"integer"}},"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"},"PaymentCardManage":{"properties":{"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"cards":{"$ref":"#/definitions/ObjectIds","description":"Cards id's array (for 'carddelete' action only)","x-nullable":true},"integration_type":{"description":"Integration type used for payment(optional, for 'cardadd' action on stripe only)","enum":["checkout","elements"],"type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"pos_id":{"description":"Pos ID","format":"uuid","type":"string","x-nullable":true},"redirect_cancel_url":{"description":"Redirect URL if operation canceled (for 'cardadd' action only)","type":"string"},"redirect_fail_url":{"description":"Redirect URL if operation failed (for 'cardadd' action only)","type":"string"},"redirect_success_url":{"description":"Redirect URL if operation successful (for 'cardadd' action only)","type":"string"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"PaymentCardManageResult":{"properties":{"error":{"description":"Error text","type":"string"},"process_params":{"properties":{"client_secret":{"description":"One time client operation token (for stripe only)","type":"string"},"integration_type":{"description":"Integration type used for operation (for stripe only)","enum":["checkout","elements"],"type":"string"},"setup_external_id":{"description":"Setup intent ID (for stripe only)","type":"string"}},"type":"object"},"type":{"description":"Object type","enum":["status","url"],"type":"string"},"value":{"description":"Object value","type":"string"}},"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"},"PaymentInfo":{"description":"Payment status details","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","x-nullable":true},"change":{"description":"Payment change (optional, only for 'cash' type)","format":"float","type":"number"},"currency":{"description":"currency","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},"loyalty":{"$ref":"#/definitions/Loyalty","description":"Loyalty info (optional)","x-nullable":true},"mobileapp":{"$ref":"#/definitions/MobileAppInfo","description":"mobile-app payment type info","x-nullable":true},"pos":{"$ref":"#/definitions/Pos","description":"Pos 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},"terminal":{"$ref":"#/definitions/Terminal","description":"Terminal info (optional)","x-nullable":true},"transaction":{"$ref":"#/definitions/Transaction","description":"payment transaction info (optional)","x-nullable":true},"type":{"$ref":"#/definitions/PaymentType","description":"Wallet type","x-nullable":true}},"type":"object"},"PaymentInitData":{"properties":{"amount":{"description":"Payment amount","format":"float","type":"number"},"auto_finalize_parent_transaction":{"default":true,"description":"Automaticaly finalize transactions when payment completed successfuly","type":"boolean"},"card_id":{"description":"Card Id","format":"uuid","type":"string"},"card_password":{"description":"Card password","type":"string"},"id":{"description":"Payment Id","format":"uuid","type":"string"},"integration_type":{"description":"Integration type used for payment (for Stripe only)","enum":["checkout","elements"],"type":"string"},"redirect_cancel_url":{"description":"Redirect URL if payment canceled","type":"string"},"redirect_fail_url":{"description":"Redirect URL if payment failed","type":"string"},"redirect_success_url":{"description":"Redirect URL if payment successful","type":"string"},"save_for_future_use":{"description":"Save card for future use (for Stripe only)","type":"boolean"}},"required":["id","card_id","amount"],"type":"object"},"PaymentStatus":{"description":"Payment status details","properties":{"amount":{"description":"To pay amount (optional)","format":"float","type":"number","x-nullable":true},"card_details_required":{"description":"Card details required for payment (for stripe only)","type":"boolean"},"client_secret":{"description":"One time client operation token (for stripe only)","type":"string"},"currency":{"description":"Currency ISO code","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},"error":{"description":"Payment error (optional)","type":"string","x-nullable":true},"id":{"description":"Payment Id","format":"uuid","type":"string"},"integration_type":{"description":"Integration type used for payment (for stripe only)","enum":["checkout","elements"],"type":"string"},"invoice":{"description":"Payment amount","format":"float","type":"number","x-nullable":true},"payment_external_id":{"description":"External system payment identifier (optional, for stripe, 4bill, eway only)","type":"string"},"payment_processing_url":{"description":"External system payment processing URL (optional, for 4bill, eway, stripe/checkout only)","type":"string"},"secure":{"description":"Secure type","enum":["none","otp","3ds"],"type":"string","x-nullable":true},"status":{"description":"Operation status","enum":["inprocess","success","fail","confirmation","verification","registered","canceled","error","authorized","unknown"],"type":"string","x-nullable":true},"type":{"$ref":"#/definitions/MobileAppWalletType","description":"Wallet type","x-nullable":true}},"type":"object"},"PaymentSystemsRec":{"properties":{"mobile_app":{"$ref":"#/definitions/StringValuesList","description":"Mobile app available payment systems"},"mobile_app_available":{"description":"Mobile app payments availability flag","type":"boolean"}},"type":"object"},"PaymentType":{"enum":["cash","bank-card","bank-card-external","mobile-app","special-account"],"type":"string"},"PaymentWallet":{"description":"Wallet details","properties":{"add_card_by_payment":{"description":"Wallet support add card by payment (optional)","type":"boolean"},"add_card_stand_alone":{"description":"Wallet support add card stand-alone operation (optional)","type":"boolean"},"apple_pay_allowed":{"description":"Wallet payment by ApplePay allowed (optional)","type":"boolean"},"authorize_payment_allowed":{"description":"Wallet authorize payment (hold funds and later capture) allowed (optional)","type":"boolean"},"cards":{"description":"Wallet cards (optional)","items":{"$ref":"#/definitions/PaymentWalletCards"},"type":"array"},"country":{"description":"Country ISO code","type":"string"},"customer_country_required":{"description":"Operation required customer country (optional)","type":"boolean"},"customer_email_required":{"description":"Operation required customer email (optional)","type":"boolean"},"customer_fee":{"$ref":"#/definitions/PaymentWalletFee","description":"Payment system customers fee"},"customer_name_required":{"description":"Operation required customer name (optional)","type":"boolean"},"customer_phone_required":{"description":"Operation required customer phone (optional)","type":"boolean"},"google_pay_allowed":{"description":"Wallet payment by GooglePay allowed (optional)","type":"boolean"},"integration_types":{"$ref":"#/definitions/StripeIntegrationTypes","description":"Supported integration types (optional)"},"loyalty":{"$ref":"#/definitions/Loyalty","description":"Loyalty info (optional, only for split_by_loyalties is true case)"},"minimal_amount":{"$ref":"#/definitions/PaymentWalletMinimalAmount","description":"Payment system customers manamum amount (optional)"},"pkey":{"description":"Publick Key (optional)","type":"string"},"settings_possibility_scopes":{"description":"Settings availability scopes","items":{"$ref":"#/definitions/MobileAppPaymentSettingsScope"},"type":"array"},"split_by_loyalties":{"description":"Split wallet by loyalties (optional, not for splitted wallets)","type":"boolean"},"status":{"description":"Wallet status (optional)","enum":["notexists","invite","exists","error"],"type":"string"},"type":{"$ref":"#/definitions/MobileAppWalletType","description":"Wallet type (optional, not for splitted wallets)"},"wallets":{"description":"Wallet by Loyalties (optional, only for split_by_loyalties is true case)","items":{"$ref":"#/definitions/PaymentWallet"},"type":"array"}},"type":"object"},"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"},"PaymentWalletCards":{"description":"Wallet Caerd Info","properties":{"alias":{"description":"Card alias (optional)","type":"string"},"billing_details":{"$ref":"#/definitions/PaymentWalletCardBillingDetails","description":"Card billing details (optional)"},"brand":{"description":"Card brand (optional)","type":"string"},"default":{"description":"Card is default","type":"boolean"},"external_id":{"description":"Card external id (optional)","type":"string"},"funding":{"description":"Card funding type (optional)","type":"string"},"id":{"description":"Card Id","format":"uuid","type":"string"},"integration_types":{"$ref":"#/definitions/StripeIntegrationTypes","description":"Integration type used for card (optional)"},"is_corporate":{"description":"Card corporate flag (optional)","enum":[0,1],"type":"integer"},"is_expired":{"description":"Card expired flag (optional)","enum":[0,1],"type":"integer"},"mask":{"description":"Card masked PAN","type":"string"},"password":{"description":"Password required for using","type":"boolean"},"payment_type":{"description":"Card payment type (optional)","enum":["card"],"type":"string"}},"type":"object"},"PaymentWalletFee":{"properties":{"exist":{"description":"Fee exists (greater than zero)","type":"boolean"},"fee":{"$ref":"#/definitions/PaymentWalletFeeDetail","description":"Fee details"}},"type":"object"},"PaymentWalletFeeDetail":{"properties":{"fixed":{"description":"Fixed amount of fee","format":"float","type":"number"},"percentage":{"description":"Percentage from payment amount part of fee","format":"float","type":"number"}},"required":["fixed","percentage"],"type":"object"},"PaymentWalletMinimalAmount":{"properties":{"amount":{"description":"Minimal amount value","format":"float","type":"number"},"currency":{"description":"Minimal amount currency","type":"string"},"exist":{"description":"Minimal amount exist (greater than zero)","type":"boolean"}},"type":"object"},"PhoneNumber":{"properties":{"number":{"description":"Phone number","type":"string"}},"type":"object"},"PhoneNumbersList":{"items":{"$ref":"#/definitions/PhoneNumber"},"type":"array"},"Pos":{"description":"Point of sale","properties":{"accounts":{"description":"Special account info","items":{"$ref":"#/definitions/AccountsRec"},"type":"array","x-nullable":true},"additional_services":{"description":"Additional services (optional)","items":{"$ref":"#/definitions/AdditionalService"},"type":"array","x-nullable":true},"additional_services_required":{"description":"Is additional services required","enum":[0,1],"type":"integer"},"addresses":{"description":"Address of sale point","type":"string","x-nullable":true},"bonuses":{"description":"The basic bonuses","items":{"$ref":"#/definitions/BonusesRec"},"type":"array","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","x-nullable":true},"corporate_special_accounts_access":{"description":"List of access to the corporate customer special accounts","items":{"$ref":"#/definitions/CorporateCustomerSpecialAccountAccess"},"type":"array","x-nullable":true},"country":{"description":"Country code","type":"string","x-nullable":true},"coupons":{"description":"Coupons info","items":{"$ref":"#/definitions/Coupon"},"type":"array","x-nullable":true},"description":{"description":"Point of sale public description","type":"string","x-nullable":true},"equipments":{"$ref":"#/definitions/EquipmentRecList","description":"Equipments data (optional)","x-nullable":true},"favorite":{"description":"Country code","type":"boolean","x-nullable":true},"fuel":{"$ref":"#/definitions/FuelRec","description":"Fuel data (optional)","x-nullable":true},"id":{"description":"Point of sales ID","format":"uuid","type":"string"},"latitude":{"description":"GEO Latitude","format":"double","type":"number","x-nullable":true},"legal_info":{"description":"Loyalty legal info","type":"string","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyCategory","x-nullable":true},"longitude":{"description":"GEO Longitude","format":"double","type":"number","x-nullable":true},"loyalty_bonuses_settings":{"$ref":"#/definitions/LoyaltyBonusesSettings","description":"Loyalty bonuses and discount settings (optional)"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"maximum_service_distance":{"description":"Maximum service distance in km (0 - unlimited)","type":"integer"},"online_store":{"$ref":"#/definitions/OnlineStore","x-nullable":true},"payment_systems_availability":{"$ref":"#/definitions/PaymentSystemsRec","description":"Payment system availability","x-nullable":true},"phones":{"$ref":"#/definitions/PhoneNumbersList","description":"Phones of sale point","x-nullable":true},"photos":{"items":{"$ref":"#/definitions/ImageObject"},"type":"array","x-nullable":true},"privacy_policy_url":{"description":"Loyalty privacy policy link","type":"string","x-nullable":true},"public_description":{"description":"Point of sale public description (same as description)","type":"string","x-nullable":true},"public_title":{"description":"Point of sale public title (same as title)","type":"string","x-nullable":true},"referral_program":{"$ref":"#/definitions/ReferralProgram","x-nullable":true},"time_zone":{"description":"Time zone","type":"string","x-nullable":true},"title":{"description":"Point of sale public title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/PosType","description":"Pos type","x-nullable":true}},"type":"object"},"PosBonuses":{"properties":{"accounts":{"description":"Special account info","items":{"$ref":"#/definitions/AccountsRec"},"type":"array"},"bonuses":{"description":"The basic bonuses","items":{"$ref":"#/definitions/BonusesRec"},"type":"array"},"corporate_special_accounts_access":{"description":"List of access to the corporate customer special accounts","items":{"$ref":"#/definitions/CorporateCustomerSpecialAccountAccess"},"type":"array"},"coupons":{"description":"Coupons info","items":{"$ref":"#/definitions/Coupon"},"type":"array"},"id":{"description":"Point of sales ID","format":"uuid","type":"string"}},"type":"object"},"PosCatalogPublicationState":{"enum":["none","requested","rejected","allowed"],"type":"string"},"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},"PosEquipments":{"properties":{"equipments":{"$ref":"#/definitions/EquipmentRecList","description":"Equipments data"},"id":{"description":"Point of sales ID","format":"uuid","type":"string"}},"type":"object"},"PosFuel":{"properties":{"fuel":{"$ref":"#/definitions/FuelRec","description":"Fuel controller data"},"id":{"description":"Point of sales ID","format":"uuid","type":"string"}},"type":"object"},"PosOnlineStore":{"properties":{"active":{"description":"Online store active flag","enum":[0,1],"type":"integer"},"cart_expire_days":{"description":"Users cart expire period in days","type":"integer"},"order_type":{"description":"Order type used in schema","enum":["online-store","fuel-taxi"],"type":"string"},"payment_type":{"description":"Payment in store","enum":["none","bonuses","possible","required"],"type":"string"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"transaction_type":{"description":"Transaction type used in schema","enum":["sale","reserve","authorize-payment"],"type":"string"}},"type":"object"},"PosType":{"enum":["pos","road-tanker","online-store"],"type":"string"},"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"},"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"},"PriceMargins":{"properties":{"terminal_additional_costs":{"description":"Terminal additional costs detailing","items":{"$ref":"#/definitions/PriceExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"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"},"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"},"PurchaseOrder":{"properties":{"admin_email":{"description":"Email for error notification","type":"string"},"available_items":{"description":"Available items count for emission  (Only for Response data)","type":"integer"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"callback_url":{"description":"URL for payment system callback (Only for Response data on create request)","type":"string"},"comment":{"description":"Comment","type":"string"},"created":{"description":"Created order time","format":"date-time","type":"string"},"currency":{"description":"Сurrency code","type":"string"},"email":{"description":"Customer Email","type":"string"},"emitted_items":{"description":"Emitted items (Only for Response data)","items":{"$ref":"#/definitions/PurchaseOrderEmittedItems"},"type":"array"},"id":{"description":"Order ID","format":"uuid","type":"string"},"item_amount":{"description":"Ordered item amount","format":"float","type":"number"},"item_code":{"description":"Ordered item external code","type":"string"},"item_id":{"description":"Ordered item ID","format":"uuid","type":"string"},"item_price":{"description":"Ordered item price","format":"float","type":"number"},"item_quantity":{"description":"Ordered item quantity","type":"integer"},"item_type":{"description":"Ordered item type","enum":["coupon","prepaid-card"],"type":"string"},"language":{"description":"Notification language","type":"string"},"notify":{"description":"Notify customer","enum":[0,1],"type":"integer"},"payment_type":{"description":"Payment type","enum":["wayforpay"],"type":"string"},"phone":{"description":"Customer phone","type":"string"},"processed":{"description":"Payment processed time","format":"date-time","type":"string"},"referral_code":{"description":"Referral code","type":"string"},"sent":{"description":"Notification sent time","format":"date-time","type":"string"},"status":{"description":"Order status","enum":["created","completed","canceled","failed"],"type":"string"},"wallet":{"description":"Add emitted items to the customer wallet","enum":[0,1],"type":"integer"}},"required":["business_id","payment_type","currency","notify","item_type","item_id","item_price","item_quantity","item_amount"],"type":"object"},"PurchaseOrderEmittedItems":{"properties":{"code":{"description":"Item code","type":"string"},"id":{"description":"Item ID","format":"uuid","type":"string"},"type":{"description":"Item type","enum":["coupon","prepaid-card"],"type":"string"}},"type":"object"},"PushPlatforms":{"enum":["android","ios","windows"],"type":"string"},"PushTokenData":{"properties":{"expire":{"description":"Date of token expire","format":"date","type":"string"},"platform":{"$ref":"#/definitions/PushPlatforms","description":"Type of mobile device / mobile client platform ('android', 'ios', 'windows')"},"token":{"description":"Push token","type":"string"}},"required":["token","platform"],"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"},"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"},"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"},"RewardGrantPeriodType":{"enum":["day","month"],"type":"string"},"RewardValueType":{"enum":["check-percentage","fixed-amount"],"type":"string"},"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/DeliveryType","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"},"SortDirection":{"enum":["asc","desc"],"type":"string"},"SpecialAccount":{"properties":{"active":{"description":"Active flag (optional)","enum":[0,1],"type":"integer","x-nullable":true},"corporate":{"description":"Corporate accoiunt flag (optional)","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":"Currency ISO code","type":"string","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods (optional)","x-nullable":true},"id":{"description":"Field id","type":"string","x-nullable":true},"public_title":{"description":"Title to show (optional)","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 (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"},"SpecialAccountOperationType":{"enum":["special-account-refill","special-account-write-offs","special-account-adjustment"],"type":"string"},"SpecialAccountType":{"enum":["money","goods","punches"],"type":"string"},"StringValuesList":{"items":{"description":"Value","type":"string"},"type":"array"},"StripeIntegrationTypes":{"items":{"enum":["checkout","elements"],"type":"string"},"type":"array"},"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"},"TemporaryCode":{"properties":{"code":{"description":"Temporary code","type":"string"},"redeem_allowed":{"description":"Allowed redeem bonuses or special account flag","type":"boolean"}},"type":"object"},"Terminal":{"description":"Terminal","properties":{"id":{"description":"Terminal ID","format":"uuid","type":"string"}},"type":"object"},"TerminalCustomerFeedbackSettings":{"properties":{"active":{"default":0,"description":"Feedback system active flag","enum":[0,1],"type":"integer"},"feedback_source":{"$ref":"#/definitions/FeedbackSource"},"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"},"transaction_feedback_message_send":{"description":"Send invitation to ratings/reviews in mobile app when finalioze transaction","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"},"TerminalSettings":{"description":"Terminal settings","properties":{"currency":{"description":"Currency ISO code","type":"string"},"customer_feedback_settings":{"$ref":"#/definitions/TerminalCustomerFeedbackSettings"},"goods_preset_recommnded_values_only":{"description":"Only preset recommended values allowed","enum":[0,1],"type":"integer"},"id":{"description":"Terminal Id","format":"uuid","type":"string"},"loyalty":{"$ref":"#/definitions/Loyalty","description":"Loyalty information"},"loyalty_bonuses_settings":{"$ref":"#/definitions/LoyaltyBonusesSettings","description":"Loyalty bonuses and discount settings"},"mobile_app_payment_amount_free":{"description":"Mobile app payment of an arbitrary amount allowed","enum":[0,1],"type":"integer"},"pos":{"$ref":"#/definitions/Pos","description":"Pos information"},"vehicle_fuel_settings":{"$ref":"#/definitions/TerminalVehicleFuelSettings","description":"Settings for vehicles and refuels (readonly)","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":{"description":"Odometer measuremen units selection type","enum":["kilometer","mile","hour","selected-by-customer","set-by-volume-unit"],"type":"string","x-nullable":true}},"type":"object"},"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":{"accounts":{"description":"Card accounts","items":{"$ref":"#/definitions/TourCardAccount"},"type":"array"},"activated_dt":{"description":"Card activated datetime","format":"date-time","type":"string"},"active":{"description":"Active flag","enum":[0,1],"type":"integer"},"code":{"description":"CODE","type":"string"},"expire_dt":{"description":"Card expire datetime","format":"date-time","type":"string"},"id":{"description":"Card ID","format":"uuid","type":"string"},"public_description":{"description":"public description","type":"string"},"public_title":{"description":"public title","type":"string"},"services":{"description":"Card services","items":{"$ref":"#/definitions/TourCardService"},"type":"array"},"valid":{"description":"Card validity flag","enum":[0,1],"type":"integer"}},"type":"object"},"TourCardAccount":{"properties":{"amount":{"description":"Account amount","format":"float","type":"number"},"id":{"description":"Account ID","format":"uuid","type":"string"},"precision":{"description":"Account precision","enum":["integer","two-decimal-places","three-decimal-places"],"type":"string"},"public_title":{"description":"public title","type":"string"}},"type":"object"},"TourCardCategory":{"properties":{"id":{"description":"Category ID","format":"uuid","type":"string"},"public_title":{"description":"public title","type":"string"}},"type":"object"},"TourCardService":{"properties":{"available_amount":{"description":"Available sevice account amount","format":"float","type":"number","x-nullable":true},"available_now":{"description":"Service availability flag","enum":[0,1],"type":"integer"},"available_times":{"description":"Number of times available for use","format":"float","type":"number"},"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"},"public_description":{"description":"Public description","type":"string"},"public_title":{"description":"Public 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"},"used_times":{"description":"Number of service usage by customer","type":"integer"}},"type":"object"},"Transaction":{"properties":{"amount":{"format":"double","type":"number","x-nullable":true},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"amount_to_pay":{"format":"double","type":"number","x-nullable":true},"bonuses_added":{"format":"double","type":"number","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer","x-nullable":true},"bonuses_on_account":{"format":"double","type":"number","x-nullable":true},"bonuses_redeemed":{"format":"double","type":"number","x-nullable":true},"canceled":{"description":"Transaction canceled","type":"boolean","x-nullable":true},"cancelled":{"description":"Transaction canceled","enum":[0,1],"type":"integer","x-nullable":true},"check":{"$ref":"#/definitions/Check","description":"Transaction check (optional)"},"corporate_customer_email":{"description":"Corporate customer email","type":"string","x-nullable":true},"corporate_customer_name":{"description":"Corporate customer name","type":"string","x-nullable":true},"currency":{"description":"Currency ISO code (if transaction payment 'currency')","type":"string","x-nullable":true},"description":{"description":"POS description","type":"string","x-nullable":true},"discount_amount":{"description":"Transaction discount amount","format":"double","type":"number","x-nullable":true},"errors":{"description":"Errors list","items":{"$ref":"#/definitions/TransactionErrors"},"type":"array","x-nullable":true},"finalize_transaction_id":{"description":"Finalize Transaction ID","format":"uuid","type":"string","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","x-nullable":true},"is_finalized":{"description":"Transaction finalized","type":"boolean","x-nullable":true},"items":{"description":"Transaction items (payment info only)","items":{"$ref":"#/definitions/TransactionItem"},"type":"array","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},"processed":{"description":"Transaction UTC processed date-time","format":"date-time","type":"string","x-nullable":true},"processed_local":{"description":"Transaction local (by POS time zone) processed date-time","format":"date-time","type":"string","x-nullable":true},"services":{"$ref":"#/definitions/CheckServices","description":"Transaction services (payment info only)","x-nullable":true},"services_amount":{"format":"float","type":"number","x-nullable":true},"shipping_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","x-nullable":true},"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","x-nullable":true},"title":{"description":"POS title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/TransactionType","description":"Transaction type","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"},"TransactionItem":{"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},"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_price":{"description":"Goods item price calculated by rules (for list with stock)","format":"double","type":"number","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},"goods_item_info":{"$ref":"#/definitions/Goods","description":"Goods info (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},"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},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer","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"},"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"},"TransactionResponse":{"properties":{"data":{"items":{"$ref":"#/definitions/Transaction"},"type":"array"},"summary":{"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_shipping_amount":{"format":"double","type":"number"},"total_summary_amount":{"format":"double","type":"number"}},"type":"object"}},"type":"object"},"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"},"TransferFundsResponse":{"properties":{"charge_transaction":{"$ref":"#/definitions/Transaction","description":"Funds add transaction object","x-nullable":true},"write_off_transaction":{"$ref":"#/definitions/Transaction","description":"Funds write-offs transaction object","x-nullable":true}},"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"},"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"}},"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"},"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"},"WeekDaysList":{"items":{"description":"Day of week","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"type":"string"},"type":"array"}},"info":{"description":"API for inCust Client  \n\n\n### Methods\n`GET`: \t\tRetrieve resources  \n`POST`:\t\tCrete resources  \n`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":{"/after_login":{"post":{"description":"After user loged in system notification method","operationId":"incust.controllers.client.client.after_login","parameters":[{"description":"Application data","in":"body","name":"data","required":true,"schema":{"type":"object"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["System"]}},"/beacon":{"get":{"description":"Return beacons list","operationId":"incust.controllers.client.client.beacon_list","responses":{"200":{"description":"List a beacons","schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Beacon"]},"post":{"description":"Process on find beacons","operationId":"incust.controllers.client.client.beacon_find","parameters":[{"description":"List of beacons","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/Beacon"},"type":"array"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Beacon"]}},"/card_info":{"get":{"description":"Возвращает общую (вне зависимости от бизнеса, валюты и т.д.) информацию по карточке покупателя","operationId":"incust.controllers.client.client.card_info","responses":{"200":{"description":"Card Info","schema":{"$ref":"#/definitions/CardInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["CardInfo"]}},"/cards":{"get":{"description":"Return customer cards","operationId":"incust.controllers.client.client.customer_cards","responses":{"200":{"description":"Customer cards array","schema":{"items":{"$ref":"#/definitions/CardRecord"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Cards"]}},"/chatbot_token":{"delete":{"description":"Delete chatbot token","operationId":"incust.controllers.client.client.chatbot_token_del","parameters":[{"description":"Chatbot token","in":"query","name":"token","required":true,"type":"string"},{"description":"Type of token channel","enum":["facebook","telegram","viber","wawebproxy","wabcloud"],"in":"query","name":"channel","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Chatbot"]},"post":{"description":"Register new chatbot token","operationId":"incust.controllers.client.client.chatbot_token_set","parameters":[{"description":"Chatbot token data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ChatbotTokenData"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Chatbot"]}},"/check/authorize_payment/{terminal_id}":{"post":{"description":"Authorize payment by check data","operationId":"incust.controllers.client.client.check_authorize_payment","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount"]}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/cancel/{terminal_id}":{"post":{"description":"Cancel transaction","operationId":"incust.controllers.client.client.check_cancel","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Transaction object","in":"body","name":"data","required":true,"schema":{"properties":{"comment":{"description":"Comment","type":"string"},"id":{"description":"Transaction Id","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/confirm/{terminal_id}":{"post":{"description":"Make transaction by check data with finalization","operationId":"incust.controllers.client.client.check_confirm","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount"]}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/finalize/{terminal_id}":{"post":{"description":"Finalize transaction","operationId":"incust.controllers.client.client.check_finalize","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Transaction object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FinalizeCheck"}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/make/{terminal_id}":{"post":{"description":"Process check data, modify and confirm check - implement loyalty rules","operationId":"incust.controllers.client.client.check_make","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check"}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/make/{terminal_id}/{rules_type}":{"post":{"description":"Process check data, modify and confirm check - implement loyalty rules by selected type","operationId":"incust.controllers.client.client.check_make_by_rules","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Process check rules type","enum":["by-all-rules","by-charge-only-rules","without-rules"],"in":"path","name":"rules_type","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check"}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/process/{terminal_id}":{"post":{"description":"Process check data, modify check - implement loyalty rules","operationId":"incust.controllers.client.client.check_process","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check"}}],"responses":{"200":{"description":"Check object","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/process/{terminal_id}/{rules_type}":{"post":{"description":"Process check data, modify check - implement loyalty rules by selected type","operationId":"incust.controllers.client.client.check_process_by_rules","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Process check rules type","enum":["by-all-rules","by-charge-only-rules","without-rules"],"in":"path","name":"rules_type","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check"}}],"responses":{"200":{"description":"Check object","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/reserve/{terminal_id}":{"post":{"description":"Reserve by check data","operationId":"incust.controllers.client.client.check_reserve","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount"]}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/check/write/{terminal_id}":{"post":{"description":"Make transaction by check data without finalization","operationId":"incust.controllers.client.client.check_write","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount"]}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/coupon/{coupon_id}":{"delete":{"description":"Delete coupon","operationId":"incust.controllers.client.client.coupon_delete","parameters":[{"description":"Coupon ID","format":"uuid","in":"path","name":"coupon_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupon"]},"get":{"description":"Returns coupon","operationId":"incust.controllers.client.client.coupon_get","parameters":[{"description":"Coupon ID","format":"uuid","in":"path","name":"coupon_id","required":true,"type":"string"}],"responses":{"200":{"description":"List of coupons","schema":{"$ref":"#/definitions/Coupon"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupon"]}},"/coupon/{coupon_id}/redeem":{"get":{"description":"Redeem coupon","operationId":"incust.controllers.client.client.coupon_client_redeem","parameters":[{"description":"Coupon ID","format":"uuid","in":"path","name":"coupon_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupon"]}},"/coupon/{coupon_id}/share":{"get":{"description":"Returns coupon share CODE","operationId":"incust.controllers.client.client.coupon_client_share","parameters":[{"description":"Coupon ID","format":"uuid","in":"path","name":"coupon_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupon"]}},"/coupons":{"get":{"description":"Returns list of coupons","operationId":"incust.controllers.client.client.coupons_list","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty","type":"string"},{"collectionFormat":"csv","description":"Coupon IDs","in":"query","items":{"format":"uuid","type":"string"},"name":"ids","type":"array"}],"responses":{"200":{"description":"List of coupons","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupon"]},"post":{"description":"Take Code of coupon, coupons batch or gift card and add coupons to the wallet","operationId":"incust.controllers.client.client.coupon_client_add","parameters":[{"description":"Coupon add data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponCode"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/CouponsAddedResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupon"]}},"/coupons/coupon/{code}":{"get":{"description":"Coupon info","operationId":"incust.controllers.client.client.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":["Coupon"]}},"/customer_feedback/feedback_sources/{source_id}":{"get":{"description":"Return feedback source information","operationId":"incust.controllers.client.client.customer_feedback_source","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"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"]}},"/customer_feedback/feedbacks":{"get":{"description":"Return customer feedbacks","operationId":"incust.controllers.client.client.customer_feedbacks","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_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"}],"responses":{"200":{"description":"Feedbacks data array","schema":{"items":{"$ref":"#/definitions/CustomerFeedback"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"]},"post":{"description":"Post/add customer feedback","operationId":"incust.controllers.client.client.customer_feedback_add","parameters":[{"description":"Feedback data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerFeedback"}}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"]}},"/customer_feedback/feedbacks/{feedback_id}":{"delete":{"description":"Remove customer feedback","operationId":"incust.controllers.client.client.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"]},"get":{"description":"Return customer feedback data","operationId":"incust.controllers.client.client.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"]},"patch":{"description":"Modify customer feedback","operationId":"incust.controllers.client.client.customer_feedback_edit","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"},{"description":"Feedback data object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerFeedback"}}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"]}},"/customer_feedback/feedbacks/{feedback_id}/attachments/picture":{"post":{"consumes":["image/*"],"description":"Customer feedback add attachment image file","operationId":"incust.controllers.client.client.customer_feedback_attachments_picture_add","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"]}},"/customer_feedback/feedbacks/{feedback_id}/attachments/video":{"post":{"consumes":["video/*"],"description":"Customer feedback add attachment video file","operationId":"incust.controllers.client.client.customer_feedback_attachments_video_add","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"]}},"/customer_feedback/feedbacks/{feedback_id}/attachments/voice":{"post":{"consumes":["audio/*"],"description":"Customer feedback add attachment audio file","operationId":"incust.controllers.client.client.customer_feedback_attachments_voice_add","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"]}},"/customer_feedback/feedbacks/{feedback_id}/attachments/{attachment_id}":{"delete":{"description":"Customer feedback attachment file delete","operationId":"incust.controllers.client.client.customer_feedback_attachment_delete","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"}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"]},"get":{"description":"Customer feedback attachment file get","operationId":"incust.controllers.client.client.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"]}},"/customer_feedback/feedbacks/{feedback_id}/complete":{"post":{"description":"Complete customer feedback","operationId":"incust.controllers.client.client.customer_feedback_complete","parameters":[{"description":"Feedback ID","format":"uuid","in":"path","name":"feedback_id","required":true,"type":"string"},{"description":"Command details","in":"body","name":"data","required":true,"schema":{"properties":{"commit":{"default":true,"description":"Publish feedback and notify business (only for add feedback operation)","type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"Feedback data object","schema":{"$ref":"#/definitions/CustomerFeedback"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer feedback"]}},"/equipment/{equipment_id}/info":{"get":{"description":"Returns equipment data","operationId":"incust.controllers.client.client.equipment_info","parameters":[{"description":"Equipment ID","format":"uuid","in":"path","name":"equipment_id","required":true,"type":"string"},{"default":0,"description":"Return bonuses and accounts info (0/1)","enum":[0,1],"in":"query","name":"bonuses","required":false,"type":"integer"},{"default":0,"description":"Return coupons info (0/1)","enum":[0,1],"in":"query","name":"coupons","required":false,"type":"integer"},{"default":0,"description":"Return card categories info (0/1)","enum":[0,1],"in":"query","name":"card_categories","required":false,"type":"integer"}],"responses":{"200":{"description":"Equipment data","schema":{"$ref":"#/definitions/EquipmentRec"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/favorite":{"delete":{"description":"Remove object from favorite","operationId":"incust.controllers.client.client.favorite_delele","parameters":[{"description":"Favorite object data","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/FavoriteObjectAction"},"x-nullable":true}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Favorite"]},"post":{"description":"Add object to favorite","operationId":"incust.controllers.client.client.favorite_add","parameters":[{"description":"Favorite object data","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/FavoriteObjectAction"},"x-nullable":true}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Favorite"]}},"/gift_cards/card/{code}":{"get":{"description":"Gift Card info","operationId":"incust.controllers.client.client.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 Card"]}},"/goods/categories/{loyalty_id}":{"get":{"description":"Return list of goods categories available in online store","operationId":"incust.controllers.client.client.get_goods_categories_items","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Parent category ID or 'root' for root level categories. If parameter is not set return ALL categories.","format":"uuid","in":"query","name":"parent_id","required":false,"type":"string"}],"responses":{"200":{"description":"Goods category data array","schema":{"items":{"$ref":"#/definitions/GoodsCategory"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/goods/{loyalty_id}":{"get":{"description":"Return list of goods available in online store","operationId":"incust.controllers.client.client.get_goods_items","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Parent category ID or 'root' for root level items. If parameter is not set return ALL goods items.","format":"uuid","in":"query","name":"parent_id","required":false,"type":"string"},{"default":false,"description":"Include account customers data in prices","in":"query","name":"price_customers_account_info","required":false,"type":"boolean"},{"default":false,"description":"Include account customers limits data (only if price_customers_account_info is true)","in":"query","name":"price_customers_account_info_extended","required":false,"type":"boolean"}],"responses":{"200":{"description":"Goods data array","schema":{"items":{"$ref":"#/definitions/Goods"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/jobs/active":{"get":{"description":"Get not finished yet (active) jobs info","operationId":"incust.controllers.client.client.active_job_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"}],"responses":{"200":{"description":"Job objects array","schema":{"$ref":"#/definitions/JobsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Jobs"]}},"/jobs/transaction/{transaction_id}":{"get":{"description":"Get transaction jobs list","operationId":"incust.controllers.client.client.jobs_by_transaction","parameters":[{"description":"Transaction ID","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Job objects array","schema":{"$ref":"#/definitions/JobsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Jobs"]},"post":{"description":"Add job for transaction","operationId":"incust.controllers.client.client.jobs_by_transaction_add","parameters":[{"description":"Transaction ID","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Job object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Job"}}],"responses":{"200":{"description":"Job object","schema":{"$ref":"#/definitions/Job"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Jobs"]}},"/jobs/{job_id}":{"get":{"description":"Get job info","operationId":"incust.controllers.client.client.job_get","parameters":[{"description":"Job ID","format":"uuid","in":"path","name":"job_id","required":true,"type":"string"}],"responses":{"200":{"description":"Job object","schema":{"$ref":"#/definitions/Job"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Jobs"]}},"/jobs/{job_id}/start":{"post":{"description":"Job start","operationId":"incust.controllers.client.client.job_start","parameters":[{"description":"Job ID","format":"uuid","in":"path","name":"job_id","required":true,"type":"string"},{"description":"Command details","in":"body","name":"data","required":true,"schema":{"properties":{"comment":{"description":"Comment","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Job object","schema":{"$ref":"#/definitions/Job"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Jobs"]}},"/jobs/{job_id}/stop":{"post":{"description":"Job stop","operationId":"incust.controllers.client.client.job_stop","parameters":[{"description":"Job ID","format":"uuid","in":"path","name":"job_id","required":true,"type":"string"},{"description":"Command details","in":"body","name":"data","required":true,"schema":{"properties":{"comment":{"description":"Comment","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Job object","schema":{"$ref":"#/definitions/Job"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Jobs"]}},"/loans":{"get":{"description":"Return a list of the user’s loans","operationId":"incust.controllers.client.client.user_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":"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}],"responses":{"200":{"description":"Loans List","schema":{"$ref":"#/definitions/LoansPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"]}},"/loans/{loan_id}":{"get":{"description":"Return loan info","operationId":"incust.controllers.client.client.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"]}},"/loans/{loan_id}/installment_payments/{installment_payment_id}/make":{"post":{"description":"Loan installment payment process","operationId":"incust.controllers.client.client.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 data","schema":{"$ref":"#/definitions/Loan"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loans"]}},"/loyalty":{"get":{"description":"Return all list of Loyalties","operationId":"incust.controllers.client.client.loyalties_list","parameters":[{"description":"Client latitude","format":"double","in":"query","name":"latitude","required":false,"type":"number"},{"description":"Client longitude","format":"double","in":"query","name":"longitude","required":false,"type":"number"},{"description":"Search string","in":"query","name":"q","required":false,"type":"string"},{"description":"Filter by favorite (0/1)","enum":[0,1],"in":"query","name":"favorite","type":"integer"},{"description":"Filter by recent (0/1)","enum":[0,1],"in":"query","name":"recent","required":false,"type":"integer"},{"description":"Category ID","in":"query","name":"category","required":false,"type":"integer"},{"default":0,"description":"Return online store info (0/1)","enum":[0,1],"in":"query","name":"online_store","required":false,"type":"integer"},{"default":0,"description":"Return referral program info (0/1)","enum":[0,1],"in":"query","name":"referral_program","required":false,"type":"integer"},{"default":"full","description":"Scope for return referral program info","enum":["full","active-status-only"],"in":"query","name":"referral_program_info_scope","required":false,"type":"string"},{"default":0,"description":"Return additional services info (0/1)","enum":[0,1],"in":"query","name":"additional_services","required":false,"type":"integer"},{"default":0,"description":"Return payment systems availability info (0/1)","enum":[0,1],"in":"query","name":"payment_systems_availability","required":false,"type":"integer"},{"default":"list","description":"Scope for return payment systems availability info","enum":["list","status"],"in":"query","name":"payment_systems_availability_scope","required":false,"type":"string"},{"default":100,"description":"Result rows limit","in":"query","name":"limit","required":false,"type":"integer"},{"default":0,"description":"Result start row offset","in":"query","name":"from_row_offset","required":false,"type":"integer"}],"responses":{"200":{"description":"Loyalty array","schema":{"items":{"$ref":"#/definitions/Loyalty"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/referral_program/invitation/{code}":{"get":{"description":"Return invite loyalty referral program code info","operationId":"incust.controllers.client.client.referral_program_invitation_info","parameters":[{"description":"referral program code","in":"path","name":"code","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty referral program code info object","schema":{"$ref":"#/definitions/ClientReferralProgramCodeInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]},"post":{"description":"Loyalty referral program code invitation accept or reject","operationId":"incust.controllers.client.client.referral_program_invitation","parameters":[{"description":"referral program code","in":"path","name":"code","required":true,"type":"string"},{"description":"Code and action data","in":"body","name":"data","required":true,"schema":{"properties":{"action":{"description":"action type","enum":["accept","reject"],"type":"string"}},"required":["action"],"type":"object"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}":{"get":{"description":"Loyalty for client by ID","operationId":"incust.controllers.client.client.loyalty","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Client latitude","format":"double","in":"query","name":"latitude","type":"number"},{"description":"Client longitude","format":"double","in":"query","name":"longitude","type":"number"},{"default":0,"description":"Return limited pos list","in":"query","name":"pos","required":false,"type":"integer"},{"default":0,"description":"Return limited online store pos (warehouse) list","in":"query","name":"online_stores","required":false,"type":"integer"},{"default":0,"description":"Return limited road tanker pos list","in":"query","name":"road_tankers","required":false,"type":"integer"},{"default":0,"description":"Return bonuses and accounts info (0/1)","enum":[0,1],"in":"query","name":"bonuses","required":false,"type":"integer"},{"default":0,"description":"Return coupons info (0/1)","enum":[0,1],"in":"query","name":"coupons","required":false,"type":"integer"},{"default":0,"description":"Return cards info (0/1)","enum":[0,1],"in":"query","name":"cards","required":false,"type":"integer"},{"default":0,"description":"Return customer access type info (0/1)","enum":[0,1],"in":"query","name":"customer_access","required":false,"type":"integer"},{"default":0,"description":"Return card categories info (0/1)","enum":[0,1],"in":"query","name":"card_categories","required":false,"type":"integer"},{"default":0,"description":"Return news list (0/1)","enum":[0,1],"in":"query","name":"news","required":false,"type":"integer"},{"default":0,"description":"Sort POS by priority (0/1)","enum":[0,1],"in":"query","name":"sort_by_priority","required":false,"type":"integer"}],"responses":{"200":{"description":"Loyalty object","schema":{"$ref":"#/definitions/Loyalty"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/cart":{"delete":{"description":"Clear user's cart","operationId":"incust.controllers.client.client.user_cart_delete","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customer cart object","schema":{"$ref":"#/definitions/CustomerCart"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]},"get":{"description":"Get user's cart","operationId":"incust.controllers.client.client.user_cart_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customer cart object","schema":{"$ref":"#/definitions/CustomerCart"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]},"post":{"description":"Modify user's cart","operationId":"incust.controllers.client.client.user_cart_modify","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Customer cart object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerCart"}}],"responses":{"200":{"description":"Customer cart object","schema":{"$ref":"#/definitions/CustomerCart"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/loyalty/{loyalty_id}/customers/add":{"get":{"description":"Add customer to the loyalty","operationId":"incust.controllers.client.client.loyalty_customer_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customer data","schema":{"$ref":"#/definitions/LoyaltyCustomer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/customers/benefits/transfer/accounts":{"post":{"description":"Transfer account funds to another customer","operationId":"incust.controllers.client.client.loyalty_customer_funds_transfer_accounts","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Transfer data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerAccountTransferFundsRequest"}}],"responses":{"200":{"description":"Transfer data","schema":{"$ref":"#/definitions/TransferFundsResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/customers/benefits/transfer/bonuses":{"post":{"description":"Transfer bonus points to another customer","operationId":"incust.controllers.client.client.loyalty_customer_funds_transfer_bonuses","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Transfer data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BonusPointsTransferFundsRequest"}}],"responses":{"200":{"description":"Transfer data","schema":{"$ref":"#/definitions/TransferFundsResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/customers/cards":{"get":{"description":"Return loyalty customer cards","operationId":"incust.controllers.client.client.loyalty_customer_cards","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customer cards array","schema":{"items":{"$ref":"#/definitions/CardRecord"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]},"post":{"description":"Add loyalty customer card","operationId":"incust.controllers.client.client.loyalty_customer_card_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Card code","in":"body","name":"data","required":true,"schema":{"properties":{"code":{"description":"Card code","type":"string"}},"required":["code"],"type":"object"}}],"responses":{"200":{"description":"Customer cards array","schema":{"items":{"$ref":"#/definitions/CardRecord"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/customers/temporary_code/generate":{"get":{"description":"Generate temporary code like loginpad/stuward program","operationId":"incust.controllers.client.client.loyalty_customer_generate_temporary_code","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Allowed redeem bonuses or special account flag","in":"query","name":"redeem_allowed","required":false,"type":"boolean"}],"responses":{"200":{"description":"Generated temporary code","schema":{"$ref":"#/definitions/TemporaryCode"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/deliveries":{"get":{"description":"Return loyalty deliveries list","operationId":"incust.controllers.client.client.loyalty_deliveries_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Delivery types array","schema":{"items":{"$ref":"#/definitions/DeliveryType"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/loyalty/{loyalty_id}/external_forms/{external_form_id}":{"get":{"description":"Return external form template (prefilled or no) for user","operationId":"incust.controllers.client.client.loyalty_external_form_for_user_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"External form ID","format":"uuid","in":"path","name":"external_form_id","required":true,"type":"string"},{"default":true,"description":"Return prefilled (based on last filled form if exists) form","in":"query","name":"prefilled","required":false,"type":"boolean","x-nullable":true}],"responses":{"200":{"description":"User external form template info","schema":{"$ref":"#/definitions/UserExternalForm"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"]},"post":{"description":"Add user filled external form","operationId":"incust.controllers.client.client.loyalty_external_form_for_user_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"External form Id","format":"uuid","in":"path","name":"external_form_id","required":true,"type":"string"},{"description":"Filled form data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserExternalForm"}}],"responses":{"200":{"description":"User external form info","schema":{"$ref":"#/definitions/UserExternalForm"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["External Forms"]}},"/loyalty/{loyalty_id}/referral_program/chain":{"get":{"description":"Return loyalty referral program referral chain","operationId":"incust.controllers.client.client.referral_program_chain","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"default":false,"description":"Include rewards in result","in":"query","name":"rewards","required":false,"type":"boolean"}],"responses":{"200":{"description":"Loyalty referral program chain info","schema":{"$ref":"#/definitions/ReferralProgramChain"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/referral_program/code":{"get":{"description":"Emit and return loyalty referral program code","operationId":"incust.controllers.client.client.referral_program_code_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty referral program code object","schema":{"$ref":"#/definitions/ReferralProgramCode"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/referral_program/referrer":{"get":{"description":"Return loyalty referral program referrer user info (if exists)","operationId":"incust.controllers.client.client.referral_program_referrer_user","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty referral program referrer user info","schema":{"$ref":"#/definitions/RefferalProgramReferrerUser"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/referral_program/summary":{"get":{"description":"Return loyalty referral program summary information","operationId":"incust.controllers.client.client.referral_program_summary","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty referral program summary info","schema":{"$ref":"#/definitions/ReferralProgramSummary"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/loyalty/{loyalty_id}/settings":{"get":{"description":"Loyalty settings by ID","operationId":"incust.controllers.client.client.loyalty_settings","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Loyalty settings object","schema":{"$ref":"#/definitions/LoyaltySettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty"]}},"/message":{"get":{"description":"Messages for client","operationId":"incust.controllers.client.client.messages","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Messages count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Type of attachment filter","enum":["image","coupon","news","payment","feedback-source","online-store-order"],"in":"query","name":"attachment_type","required":false,"type":"string"}],"responses":{"200":{"description":"Messages array","schema":{"items":{"$ref":"#/definitions/Message"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Message"]},"patch":{"description":"Set message read status for all user messages","operationId":"incust.controllers.client.client.all_messages_read_set","responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Message"]},"post":{"description":"Send message","operationId":"incust.controllers.client.client.message_send","parameters":[{"description":"Message data","in":"body","name":"data","required":true,"schema":{"properties":{"message":{"description":"Body of message","type":"string"},"to":{"description":"Loyalty id","format":"uuid","type":"string"}},"required":["message"],"type":"object"}}],"responses":{"200":{"description":"Message object","schema":{"$ref":"#/definitions/Message"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Message"]}},"/message/unread_count":{"get":{"description":"Count of unreaded messages for client","operationId":"incust.controllers.client.client.messages_unread_count","responses":{"200":{"description":"Count in code","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Message"]}},"/message/{message_id}":{"delete":{"description":"Delete message","operationId":"incust.controllers.client.client.message_delete","parameters":[{"description":"Message ID","format":"uuid","in":"path","name":"message_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Message"]},"get":{"description":"Messages for client by ID","operationId":"incust.controllers.client.client.message","parameters":[{"description":"Message ID","format":"uuid","in":"path","name":"message_id","required":true,"type":"string"}],"responses":{"200":{"description":"Message object","schema":{"$ref":"#/definitions/Message"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Message"]},"patch":{"description":"Set message read status","operationId":"incust.controllers.client.client.message_read_set","parameters":[{"description":"Message ID","format":"uuid","in":"path","name":"message_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Message"]}},"/news":{"get":{"description":"Return news list","operationId":"incust.controllers.client.client.news_list","parameters":[{"format":"double","in":"query","name":"latitude","type":"number"},{"format":"double","in":"query","name":"longitude","type":"number"},{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"default":200,"description":"Result rows limit","in":"query","name":"limit","required":false,"type":"integer"},{"default":0,"description":"Result start row offset","in":"query","name":"from_row_offset","required":false,"type":"integer"},{"default":0,"description":"Sort News by priority (0/1)","enum":[0,1],"in":"query","name":"sort_by_priority","required":false,"type":"integer"}],"responses":{"200":{"description":"News objects list","schema":{"$ref":"#/definitions/NewsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["News"]}},"/news/{news_id}":{"get":{"description":"Return news by id","operationId":"incust.controllers.client.client.news","parameters":[{"description":"News ID","format":"uuid","in":"path","name":"news_id","required":true,"type":"string"}],"responses":{"200":{"description":"News object","schema":{"$ref":"#/definitions/News"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["News"]}},"/online_store/loyalty/{loyalty_id}/orders":{"get":{"description":"Get customers orders list","operationId":"incust.controllers.client.client.online_store_loyalty_orders_get","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Order type filtering if needed","enum":["all","online-store","fuel-taxi"],"in":"query","name":"order_type","required":false,"type":"string","x-nullable":true},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Messages count in page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Orders list with summary","schema":{"$ref":"#/definitions/OrdersListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]},"post":{"description":"Add customer order","operationId":"incust.controllers.client.client.online_store_loyalty_order_add","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Customer order object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Order"}}],"responses":{"200":{"description":"Customer order object","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/online_store/orders":{"get":{"description":"Get customers orders list","operationId":"incust.controllers.client.client.online_store_orders_get","parameters":[{"description":"Order type filtering if needed","enum":["all","online-store","fuel-taxi"],"in":"query","name":"order_type","required":false,"type":"string","x-nullable":true},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Messages count in page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Orders list with summary","schema":{"$ref":"#/definitions/OrdersListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/online_store/orders/{order_id}":{"get":{"description":"Get customers order","operationId":"incust.controllers.client.client.online_store_order_get","parameters":[{"description":"Order ID","format":"uuid","in":"path","name":"order_id","required":true,"type":"string"},{"default":false,"description":"Get only processing info","in":"query","name":"processing_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"Customer order object","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/online_store/orders/{order_id}/cancel":{"post":{"description":"Cancel customers order","operationId":"incust.controllers.client.client.online_store_order_cancel","parameters":[{"description":"Order ID","format":"uuid","in":"path","name":"order_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customer order object","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/online_store/pos/{pos_id}/orders":{"get":{"description":"Get customers orders list","operationId":"incust.controllers.client.client.online_store_pos_orders_get","parameters":[{"description":"Pos ID","format":"uuid","in":"path","name":"pos_id","required":true,"type":"string"},{"description":"Order type filtering if needed","enum":["all","online-store","fuel-taxi"],"in":"query","name":"order_type","required":false,"type":"string","x-nullable":true},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Messages count in page","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Orders list with summary","schema":{"$ref":"#/definitions/OrdersListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]},"post":{"description":"Add customer order","operationId":"incust.controllers.client.client.online_store_pos_order_add","parameters":[{"description":"Pos ID","format":"uuid","in":"path","name":"pos_id","required":true,"type":"string"},{"description":"Customer order object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Order"}}],"responses":{"200":{"description":"Customer order object","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/orders/create":{"post":{"description":"Create purchase order","operationId":"incust.controllers.client.client.create_order","parameters":[{"description":"Purchase order object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PurchaseOrder"}}],"responses":{"200":{"description":"Purchase order object","schema":{"$ref":"#/definitions/PurchaseOrder"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Purchase Order"]}},"/orders/{business_id}/{order_id}":{"get":{"description":"Get purchase order","operationId":"incust.controllers.client.client.get_order","parameters":[{"description":"Business ID","format":"uuid","in":"path","name":"business_id","required":true,"type":"string"},{"description":"Purchase order ID","format":"uuid","in":"path","name":"order_id","required":true,"type":"string"}],"responses":{"200":{"description":"Purchase order object","schema":{"$ref":"#/definitions/PurchaseOrder"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Purchase Order"]}},"/pkpass/loyalty/{loyalty_id}/customers/card/{card_id}/generate":{"get":{"description":"Generate and return .pkpass for loyalty customers card","operationId":"incust.controllers.client.client.pkpass_loyalty_customers_card_generate","parameters":[{"description":"Loyalty ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Customers card ID","format":"uuid","in":"path","name":"card_id","required":true,"type":"string"}],"produces":["application/vnd.apple.pkpass"],"responses":{"201":{"description":".pkpass file"},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Pkpass"]}},"/pmt/info/terminal/{terminal_id}":{"get":{"description":"Returns information about a mobile-app type payment that needs to be processed, by terminal","operationId":"incust.controllers.client.client.payment_info_by_terminal","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"default":true,"description":"Include transaction info","in":"query","name":"transaction_info","required":false,"type":"boolean","x-nullable":true},{"default":true,"description":"Include goods item info","in":"query","name":"goods_item_info","required":false,"type":"boolean","x-nullable":true}],"responses":{"200":{"description":"Payment info","schema":{"$ref":"#/definitions/PaymentInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/pmt/info/transaction/{transaction_id}":{"get":{"description":"Returns information about a mobile-app type payment that needs to be processed, by transaction","operationId":"incust.controllers.client.client.payment_info_by_transaction","parameters":[{"description":"Transaction ID","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"default":true,"description":"Include transaction info","in":"query","name":"transaction_info","required":false,"type":"boolean","x-nullable":true},{"default":true,"description":"Include goods item info","in":"query","name":"goods_item_info","required":false,"type":"boolean","x-nullable":true}],"responses":{"200":{"description":"Payment info","schema":{"$ref":"#/definitions/PaymentInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/pmt/info/{payment_id}":{"get":{"description":"Returns payment info","operationId":"incust.controllers.client.client.payment_info","parameters":[{"description":"Payment ID","format":"uuid","in":"path","name":"payment_id","required":true,"type":"string"},{"default":true,"description":"Include transaction info","in":"query","name":"transaction_info","required":false,"type":"boolean","x-nullable":true},{"default":true,"description":"Include goods item info","in":"query","name":"goods_item_info","required":false,"type":"boolean","x-nullable":true}],"responses":{"200":{"description":"Payment info","schema":{"$ref":"#/definitions/PaymentInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/pmt/payments/transaction/{transaction_id}":{"get":{"description":"Returns information about all payments by transaction","operationId":"incust.controllers.client.client.payments_by_transactions","parameters":[{"description":"Transaction ID","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"default":true,"description":"Include transaction info","in":"query","name":"transaction_info","required":false,"type":"boolean","x-nullable":true},{"default":true,"description":"Include goods item info","in":"query","name":"goods_item_info","required":false,"type":"boolean","x-nullable":true}],"responses":{"200":{"description":"Payment info","schema":{"items":{"$ref":"#/definitions/PaymentInfo"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/pmt/wallet":{"get":{"description":"Returns mobile payment wallet","operationId":"incust.controllers.client.client.payment_wallet","parameters":[{"description":"Unique identifier of business","format":"uuid","in":"query","name":"business_id","required":false,"type":"string","x-nullable":true},{"description":"Unique identifier of loyalty","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true},{"description":"Unique identifier of POS","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string","x-nullable":true},{"description":"Unique identifier of Terminal","format":"uuid","in":"query","name":"terminal_id","required":false,"type":"string","x-nullable":true},{"description":"Currency","in":"query","name":"currency","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Mobile payment wallets","schema":{"items":{"$ref":"#/definitions/PaymentWallet"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/pmt/wallet/cardpassword/{action}":{"post":{"description":"Сard password managements for payment wallet","operationId":"incust.controllers.client.client.payment_wallet_card_password","parameters":[{"description":"Action type","enum":["set","reset"],"in":"path","name":"action","required":true,"type":"string"},{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"properties":{"cards":{"description":"Cards id's array","items":{"format":"uuid","type":"string"},"type":"array"},"otppassword":{"description":"OTP password","type":"string"},"password":{"description":"Card password","type":"string"}},"required":["cards"],"type":"object"}}],"responses":{"200":{"description":"Response status","schema":{"properties":{"status":{"description":"Operation status","enum":["success","fail"],"type":"string"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet/payment":{"post":{"description":"Payment from wallet","operationId":"incust.controllers.client.client.payment_wallet_payment","parameters":[{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PaymentInitData"}}],"responses":{"200":{"description":"Response status","schema":{"$ref":"#/definitions/PaymentStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet/payment/otp":{"post":{"description":"OTP verification for payment from wallet","operationId":"incust.controllers.client.client.payment_wallet_payment_otp","parameters":[{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Payment Id","format":"uuid","type":"string"},"otp_password":{"description":"Otp password","type":"string"}},"required":["id","otp_password"],"type":"object"}}],"responses":{"200":{"description":"Response status","schema":{"$ref":"#/definitions/PaymentStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet/payment/status":{"post":{"description":"Request of status for payment from wallet","operationId":"incust.controllers.client.client.payment_wallet_payment_status","parameters":[{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Payment Id","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"Response status","schema":{"$ref":"#/definitions/PaymentStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet/payment/{referrer}":{"post":{"description":"Payment from wallet","operationId":"incust.controllers.client.client.payment_wallet_payment_ex","parameters":[{"description":"Referrer","in":"path","name":"referrer","required":true,"type":"string"},{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PaymentInitData"}}],"responses":{"200":{"description":"Response status","schema":{"$ref":"#/definitions/PaymentStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet/{wallet_type}":{"get":{"description":"Returns mobile payment wallet by type","operationId":"incust.controllers.client.client.payment_wallet_by_type","parameters":[{"description":"Type of payment wallet","enum":["ipay","stripe","4bill","eway","flutterwave","global-payments","wave"],"in":"path","name":"wallet_type","required":true,"type":"string"},{"description":"Unique identifier of business","format":"uuid","in":"query","name":"business_id","required":false,"type":"string","x-nullable":true},{"description":"Unique identifier of loyalty","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string","x-nullable":true},{"description":"Unique identifier of POS","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string","x-nullable":true},{"description":"Unique identifier of Terminal","format":"uuid","in":"query","name":"terminal_id","required":false,"type":"string","x-nullable":true},{"description":"Currency","in":"query","name":"currency","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Mobile payment wallet","schema":{"$ref":"#/definitions/PaymentWallet"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/pmt/wallet/{wallet_type}/{action}":{"post":{"description":"Manage payment wallet","operationId":"incust.controllers.client.client.payment_wallet_manage_w_data","parameters":[{"description":"Type of payment wallet","enum":["ipay","stripe","4bill","eway","flutterwave","global-payments","wave"],"in":"path","name":"wallet_type","required":true,"type":"string"},{"description":"Action type","enum":["register","invite","cardadd","carddelete"],"in":"path","name":"action","required":true,"type":"string"},{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PaymentCardManage"}}],"responses":{"200":{"description":"Response object (URL or status)","schema":{"$ref":"#/definitions/PaymentCardManageResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet/{wallet_type}/{action}/{referrer}":{"post":{"description":"Manage payment wallet","operationId":"incust.controllers.client.client.payment_wallet_manage_w_data_ex","parameters":[{"description":"Type of payment wallet","enum":["ipay","stripe","4bill","eway","flutterwave","global-payments","wave"],"in":"path","name":"wallet_type","required":true,"type":"string"},{"description":"Action type","enum":["register","invite","cardadd","carddelete"],"in":"path","name":"action","required":true,"type":"string"},{"description":"Referrer","in":"path","name":"referrer","required":true,"type":"string"},{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PaymentCardManage"}}],"responses":{"200":{"description":"Response object (URL or status)","schema":{"$ref":"#/definitions/PaymentCardManageResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pos":{"get":{"description":"Return all list of Point of sales (POS)","operationId":"incust.controllers.client.client.pos","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty","required":false,"type":"string"},{"description":"Client latitude","format":"double","in":"query","name":"latitude","required":false,"type":"number"},{"description":"Client longitude","format":"double","in":"query","name":"longitude","required":false,"type":"number"},{"default":"offline","description":"Pos type filter if need","enum":["all","offline","pos","road-tanker","online-store"],"in":"query","name":"pos_type","required":false,"type":"string"},{"description":"Online store order type (only with pos_type eq 'online-store')","enum":["online-store","fuel-taxi"],"in":"query","name":"online_store_order_type","required":false,"type":"string"},{"description":"Search string","in":"query","name":"q","required":false,"type":"string"},{"description":"Filter by favorite (0/1)","enum":[0,1],"in":"query","name":"favorite","type":"integer"},{"description":"Filter by recent (0/1)","enum":[0,1],"in":"query","name":"recent","required":false,"type":"integer"},{"description":"Category ID","in":"query","name":"category","required":false,"type":"integer"},{"default":0,"description":"Filter only with geolocation (0/1)","enum":[0,1],"in":"query","name":"only_with_location","required":false,"type":"integer"},{"default":0,"description":"Filter by radius in Km (0 - without filtering)","format":"float","in":"query","name":"radius","required":false,"type":"number"},{"default":1,"description":"Return online store info (0/1)","enum":[0,1],"in":"query","name":"online_store","required":false,"type":"integer"},{"default":1,"description":"Return referral program info (0/1)","enum":[0,1],"in":"query","name":"referral_program","required":false,"type":"integer"},{"default":"full","description":"Scope for return referral program info","enum":["full","active-status-only"],"in":"query","name":"referral_program_info_scope","required":false,"type":"string"},{"default":1,"description":"Return additional services info (0/1)","enum":[0,1],"in":"query","name":"additional_services","required":false,"type":"integer"},{"default":0,"description":"Return payment systems availability info (0/1)","enum":[0,1],"in":"query","name":"payment_systems_availability","required":false,"type":"integer"},{"default":"list","description":"Scope for return payment systems availability info","enum":["list","status"],"in":"query","name":"payment_systems_availability_scope","required":false,"type":"string"},{"default":0,"description":"Return fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info","required":false,"type":"integer"},{"default":1,"description":"Return recommended values presets in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_recommended_values_presets","required":false,"type":"integer"},{"default":1,"description":"Return available prices by scope (not only base) in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_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":"fuel_info_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":"fuel_info_taxes_values","required":false,"type":"integer"},{"default":1,"description":"Return margins for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_margins_values","required":false,"type":"integer"},{"default":0,"description":"Return equipments info (0/1)","enum":[0,1],"in":"query","name":"equipments_info","required":false,"type":"integer"},{"default":100,"description":"Result rows limit","in":"query","name":"limit","required":false,"type":"integer"},{"default":0,"description":"Result start row offset","in":"query","name":"from_row_offset","required":false,"type":"integer"},{"default":0,"description":"Sort POS by priority (0/1)","enum":[0,1],"in":"query","name":"sort_by_priority","required":false,"type":"integer"}],"responses":{"200":{"description":"POS array","schema":{"items":{"$ref":"#/definitions/Pos"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"]}},"/pos/{pos_id}":{"get":{"description":"Return Point of sales (POS)","operationId":"incust.controllers.client.client.pos_detail","parameters":[{"description":"Point of sales ID","format":"uuid","in":"path","name":"pos_id","required":true,"type":"string"},{"default":0,"description":"Return bonuses and accounts info (0/1)","enum":[0,1],"in":"query","name":"bonuses","required":false,"type":"integer"},{"default":0,"description":"Return coupons info (0/1)","enum":[0,1],"in":"query","name":"coupons","required":false,"type":"integer"},{"default":0,"description":"Return card categories info (0/1)","enum":[0,1],"in":"query","name":"card_categories","required":false,"type":"integer"},{"default":0,"description":"Return fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info","required":false,"type":"integer"},{"default":1,"description":"Return recommended values presets in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_recommended_values_presets","required":false,"type":"integer"},{"default":1,"description":"Return available prices by scope (not only base) in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_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":"fuel_info_prices_values_scope","required":false,"type":"string"},{"default":0,"description":"Include account customers data in prices (0/1)","enum":[0,1],"in":"query","name":"fuel_info_price_customers_account_info","required":false,"type":"integer"},{"default":0,"description":"Include account customers limits data (only if fuel_info_price_customers_account_info is 1)","enum":[0,1],"in":"query","name":"fuel_info_price_customers_account_info_extended","required":false,"type":"integer"},{"default":1,"description":"Return taxes for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_taxes_values","required":false,"type":"integer"},{"default":1,"description":"Return margins for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_margins_values","required":false,"type":"integer"},{"default":0,"description":"Return equipments info (0/1)","enum":[0,1],"in":"query","name":"equipments_info","required":false,"type":"integer"}],"responses":{"200":{"description":"POS object","schema":{"$ref":"#/definitions/Pos"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"]}},"/pos/{pos_id}/bonuses":{"get":{"description":"Return bonuses for Point of sales (POS)","operationId":"incust.controllers.client.client.pos_bonuses","parameters":[{"description":"Point of sales ID","format":"uuid","in":"path","name":"pos_id","required":true,"type":"string"}],"responses":{"200":{"description":"POS object","schema":{"$ref":"#/definitions/PosBonuses"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"]}},"/pos/{pos_id}/equipments":{"get":{"description":"Return equipments of Point of sales (POS)","operationId":"incust.controllers.client.client.pos_equipments","parameters":[{"description":"Point of sales ID","format":"uuid","in":"path","name":"pos_id","required":true,"type":"string"}],"responses":{"200":{"description":"POS object","schema":{"$ref":"#/definitions/PosEquipments"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"]}},"/pos/{pos_id}/fuel":{"get":{"description":"Return fuel controller of Point of sales (POS)","operationId":"incust.controllers.client.client.pos_fuel","parameters":[{"description":"Point of sales ID","format":"uuid","in":"path","name":"pos_id","required":true,"type":"string"},{"default":1,"description":"Return recommended values presets in fuel info (0/1)","enum":[0,1],"in":"query","name":"recommended_values_presets","required":false,"type":"integer"},{"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":0,"description":"Include account customers data in prices (0/1)","enum":[0,1],"in":"query","name":"price_customers_account_info","required":false,"type":"integer"},{"default":0,"description":"Include account customers limits data (only if price_customers_account_info is 1)","enum":[0,1],"in":"query","name":"price_customers_account_info_extended","required":false,"type":"integer"},{"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"}],"responses":{"200":{"description":"POS object","schema":{"$ref":"#/definitions/PosFuel"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"]}},"/pos/{pos_id}/news":{"get":{"description":"Return news for Point of sales (POS)","operationId":"incust.controllers.client.client.pos_news","parameters":[{"description":"Point of sales ID","format":"uuid","in":"path","name":"pos_id","required":true,"type":"string"},{"default":0,"description":"Sort News by priority (0/1)","enum":[0,1],"in":"query","name":"sort_by_priority","required":false,"type":"integer"}],"responses":{"200":{"description":"News list","schema":{"items":{"$ref":"#/definitions/NewsCategory"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["POS"]}},"/push_token":{"delete":{"description":"Delete push token","operationId":"incust.controllers.client.client.push_token_del","parameters":[{"description":"Push FCM token","in":"query","name":"token","required":true,"type":"string"},{"description":"Type of mobile device mobile client platform ('android', 'ios', 'windows')","enum":["android","ios","windows"],"in":"query","name":"platform","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Push"]},"post":{"description":"Register new push token","operationId":"incust.controllers.client.client.push_token_set","parameters":[{"description":"Push token data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PushTokenData"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Push"]}},"/qrcode":{"post":{"description":"Take Code from client","operationId":"incust.controllers.client.client.qrcode_post","parameters":[{"description":"QRCode data","in":"body","name":"data","required":true,"schema":{"properties":{"code":{"description":"Code sring","type":"string"},"type":{"default":"other","description":"Type of code","enum":["coupon","coupon-batch","gift-card","other"],"format":"string"}},"required":["code"],"type":"object"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["QrCode"]}},"/settings":{"get":{"description":"Application settings","operationId":"incust.controllers.client.client.application_settings","responses":{"200":{"description":"Loyalty settings object","schema":{"$ref":"#/definitions/ApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["System"]}},"/special_accounts/{account_id}/refill":{"post":{"description":"Special Account refill without finalization","operationId":"incust.controllers.client.client.special_account_refill","parameters":[{"description":"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/CustomerSpecialAccountOperationObject"}}],"responses":{"200":{"description":"Refill transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/special_accounts/{account_id}/refill/preview":{"post":{"description":"Special Account refill preview","operationId":"incust.controllers.client.client.special_account_refill_preview","parameters":[{"description":"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/CustomerSpecialAccountOperationObject"}}],"responses":{"200":{"description":"Refill data","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/terminal/{terminal_id}/goods":{"get":{"description":"Return goods item for terminal","operationId":"incust.controllers.client.client.get_goods_for_terminal","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"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":false,"description":"Return only online-store available goods.","in":"query","name":"online_store_available_only","required":false,"type":"boolean"},{"default":true,"description":"Return fuel info","in":"query","name":"fuel_info","required":false,"type":"boolean"},{"default":false,"description":"Include account customers data in prices","in":"query","name":"price_customers_account_info","required":false,"type":"boolean"},{"default":false,"description":"Include account customers limits data (only if price_customers_account_info is true)","in":"query","name":"price_customers_account_info_extended","required":false,"type":"boolean"}],"responses":{"200":{"description":"Goods data","schema":{"items":{"$ref":"#/definitions/Goods"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"]}},"/terminal/{terminal_id}/goods/{code}":{"get":{"description":"Return goods item","operationId":"incust.controllers.client.client.get_goods_item","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"description":"Good code","in":"path","name":"code","required":true,"type":"string"},{"default":true,"description":"Return fuel info","in":"query","name":"fuel_info","required":false,"type":"boolean"},{"default":false,"description":"Include account customers data in prices","in":"query","name":"price_customers_account_info","required":false,"type":"boolean"},{"default":false,"description":"Include account customers limits data (only if price_customers_account_info is true)","in":"query","name":"price_customers_account_info_extended","required":false,"type":"boolean"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"]}},"/terminal/{terminal_id}/settings":{"get":{"description":"Returns terminal settings","operationId":"incust.controllers.client.client.terminal_settings","parameters":[{"description":"Terminal ID","format":"uuid","in":"path","name":"terminal_id","required":true,"type":"string"},{"default":0,"description":"Return bonuses and accounts info (0/1)","enum":[0,1],"in":"query","name":"bonuses","required":false,"type":"integer"},{"default":0,"description":"Return coupons info (0/1)","enum":[0,1],"in":"query","name":"coupons","required":false,"type":"integer"},{"default":0,"description":"Return card categories info (0/1)","enum":[0,1],"in":"query","name":"card_categories","required":false,"type":"integer"},{"default":0,"description":"Return fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info","required":false,"type":"integer"},{"default":1,"description":"Return recommended values presets in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_recommended_values_presets","required":false,"type":"integer"},{"default":1,"description":"Return available prices by scope (not only base) in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_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":"fuel_info_prices_values_scope","required":false,"type":"string"},{"default":0,"description":"Include account customers data in prices (0/1)","enum":[0,1],"in":"query","name":"fuel_info_price_customers_account_info","required":false,"type":"integer"},{"default":0,"description":"Include account customers limits data (only if fuel_info_price_customers_account_info is 1)","enum":[0,1],"in":"query","name":"fuel_info_price_customers_account_info_extended","required":false,"type":"integer"},{"default":1,"description":"Return taxes for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_taxes_values","required":false,"type":"integer"},{"default":1,"description":"Return margins for price in fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info_margins_values","required":false,"type":"integer"},{"default":0,"description":"Return equipments info (0/1)","enum":[0,1],"in":"query","name":"equipments_info","required":false,"type":"integer"}],"responses":{"200":{"description":"Terminal settings","schema":{"$ref":"#/definitions/TerminalSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check"]}},"/tour_card/cards":{"get":{"description":"Return tourist cards list","operationId":"incust.controllers.client.client.tour_cards_list","responses":{"200":{"description":"Tourist card object array","schema":{"items":{"$ref":"#/definitions/TourCard"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/cards/{code}":{"get":{"description":"Return tourist card info","operationId":"incust.controllers.client.client.tour_card_info","parameters":[{"description":"Tourist card code","in":"path","name":"code","required":true,"type":"string"}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/cards/{id}/add":{"get":{"description":"Add tourist card for user and return tourist card info","operationId":"incust.controllers.client.client.tour_card_add","parameters":[{"description":"Tourist card ID","format":"uuid","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/cards/{id}/delete":{"get":{"description":"Delete tourist card for user and return tourist card info","operationId":"incust.controllers.client.client.tour_card_delete","parameters":[{"description":"Tourist card ID","format":"uuid","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/transactions":{"get":{"description":"Return transactions list","operationId":"incust.controllers.client.client.transactions","parameters":[{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty","type":"string"},{"description":"List page number","in":"query","name":"page","type":"integer"},{"description":"Transactions count in page","in":"query","name":"count","type":"integer"},{"default":false,"description":"Do not calculate totals values","in":"query","name":"skip_totals","required":false,"type":"boolean"}],"responses":{"200":{"description":"Transaction response object","schema":{"$ref":"#/definitions/TransactionResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"]}},"/transactions/{transaction_id}":{"get":{"description":"Return transaction information","operationId":"incust.controllers.client.client.get_transaction","parameters":[{"description":"Transaction ID","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"]}},"/transactions/{transaction_id}/receipt":{"get":{"description":"Return transaction receipt","operationId":"incust.controllers.client.client.get_transaction_receipt","parameters":[{"description":"Transaction ID","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/TransactionReceipt"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"]}},"/wallet":{"get":{"description":"Client wallet","operationId":"incust.controllers.client.client.wallet","parameters":[{"default":false,"description":"Group wallet objects by Businesses (default grouping by Loyalties)","in":"query","name":"group_by_business","required":false,"type":"boolean"},{"default":false,"description":"Force group wallet objects by Loyalties (ignoring Business wallet group by settings)","in":"query","name":"force_by_loyalty","required":false,"type":"boolean"}],"responses":{"200":{"description":"Wallet data","schema":{"$ref":"#/definitions/CustomerWallet"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Wallet"]}}},"produces":["application/json"],"schemes":["https","http"],"securityDefinitions":{"bearer":{"in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"incust.auth.apikey_auth"}},"swagger":"2.0"}