{"basePath":"/v1/term","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"},"AdditionalService":{"properties":{"code":{"description":"Service code","type":"string","x-nullable":true},"cost":{"$ref":"#/definitions/AdditionalServiceCostList","description":"Service cost","x-nullable":true},"default":{"description":"Service is default","enum":[0,1],"type":"integer","x-nullable":true},"id":{"description":"Additional service ID","format":"uuid","type":"string","x-nullable":true},"public_description":{"description":"Service description","type":"string","x-nullable":true},"public_title":{"description":"Service title","type":"string","x-nullable":true},"sort_order":{"description":"Sort order weight","type":"integer"},"type":{"$ref":"#/definitions/AdditionalServiceType","description":"Service type","x-nullable":true}},"type":"object"},"AdditionalServiceCost":{"properties":{"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"min_value":{"description":"Minimal value","format":"float","type":"number","x-nullable":true},"values":{"$ref":"#/definitions/AdditionalServiceCostValueList","description":"Threshold values","x-nullable":true}},"type":"object"},"AdditionalServiceCostList":{"items":{"$ref":"#/definitions/AdditionalServiceCost"},"type":"array"},"AdditionalServiceCostType":{"enum":["amount","percentage","multiplier"],"type":"string"},"AdditionalServiceCostValue":{"properties":{"threshold":{"description":"Threshold","format":"float","type":"number","x-nullable":true},"type":{"$ref":"#/definitions/AdditionalServiceCostType","description":"Value type","x-nullable":true},"value":{"description":"Value","format":"float","type":"number","x-nullable":true}},"type":"object"},"AdditionalServiceCostValueList":{"items":{"$ref":"#/definitions/AdditionalServiceCostValue"},"type":"array"},"AdditionalServiceType":{"enum":["delivery","commission","tip"],"type":"string"},"AllTypeCustomer":{"properties":{"email":{"description":"Customer email","type":"string"},"external_id":{"description":"Customer external id (if supported)","type":"string"},"id":{"description":"Customer Id","type":"string"},"name":{"description":"Customer name","type":"string"},"phone":{"description":"Customer phone number","type":"string"},"type":{"description":"Customer type","enum":["customer","corporate-customer"],"type":"string"}},"type":"object"},"BankCardExternalInfo":{"properties":{"edc_card_type":{"$ref":"#/definitions/ExternalBankCardsEDCTypes","description":"Bank card EDC Type type (depends on payment system type)","x-nullable":true},"id":{"description":"Payment Id","format":"uuid","type":"string","x-nullable":true},"status":{"$ref":"#/definitions/BankCardExternalPaymentStatus","description":"Payment status","x-nullable":true},"type":{"$ref":"#/definitions/CustomerPaymentSystemType","description":"Payment system type (depends on payment type)","x-nullable":true}},"type":"object"},"BankCardExternalPaymentOperationType":{"enum":["purchase","authorize","completion","refund","cancel"],"type":"string"},"BankCardExternalPaymentStatus":{"enum":["inprocess","success","fail","canceled","error","authorized"],"type":"string"},"BankCardExternalPaymentSystemType":{"enum":["amp","pax"],"type":"string"},"BankCardExternalPaymentUnitOperationStatus":{"enum":["inprocess","success","fail"],"type":"string"},"BankCardExternalPaymentUnitOperationType":{"enum":["connect","card-transactions","mag-reader","mag-reader-result","welcome-screen"],"type":"string"},"BenefitsChargeTypeBase":{"enum":["regular-bonuses","promotional-bonuses","special-account"],"type":"string"},"BenefitsChargeTypeBaseNone":{"enum":["none","regular-bonuses","promotional-bonuses","special-account"],"type":"string"},"BenefitsChargeTypeExtended":{"enum":["none","regular-bonuses","promotional-bonuses","special-account","coupon"],"type":"string"},"BenefitsPriceType":{"enum":["bonuses","special-account"],"type":"string"},"BenefitsTopUpReferenceObjectType":{"enum":["loyalty-rule","external-system"],"type":"string"},"BillingInfo":{"properties":{"address":{"description":"Address (depends on the payment system)","type":"object"},"email":{"description":"Email","type":"string"},"name":{"description":"Name","type":"string"},"phone":{"description":"Phone number","type":"string"}},"type":"object"},"BonusAccountOperationType":{"enum":["bonus-add","bonus-write-offs","bonus-adjustment"],"type":"string"},"BonusAdded":{"properties":{"activity_id":{"description":"Activity ID (optional, check only)","format":"uuid","type":"string","x-nullable":true},"amount":{"description":"Added bonuses amount","format":"float","type":"number"},"expire":{"description":"Added bonuses expire datetime (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"object_id":{"description":"Reference object ID, up to 36 chars (optional)","maxLength":36,"type":"string","x-nullable":true},"object_type":{"$ref":"#/definitions/BenefitsTopUpReferenceObjectType","description":"Reference object type (optional)","x-nullable":true},"starting":{"description":"Added bonuses starting datetime (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true}},"required":["amount"],"type":"object"},"BusinessStaff":{"properties":{"comment":{"description":"Comment (optional)","type":"string","x-nullable":true},"email":{"description":"Email (optional)","type":"string","x-nullable":true},"id":{"description":"Staff id","format":"uuid","type":"string","x-nullable":true},"name":{"description":"Name","type":"string","x-nullable":true},"phone":{"description":"Phone (optional)","type":"string","x-nullable":true},"token":{"description":"Token for next authorization requests (optional, only for sign-in method)","type":"string"}},"type":"object"},"CardCategoriesList":{"items":{"$ref":"#/definitions/CardCategory"},"type":"array"},"CardCategory":{"description":"Card category","properties":{"extended_settings":{"$ref":"#/definitions/CardCategoryExtendedSettings","description":"Extended settings for Category (optional)","x-nullable":true},"id":{"description":"Card category ID","format":"uuid","type":"string"},"image":{"description":"URL of batch image","type":"string","x-nullable":true},"show_to_customers":{"description":"Show category to customers","enum":[0,1],"type":"integer","x-nullable":true},"title":{"description":"Card category title","type":"string","x-nullable":true},"type":{"description":"Category type (readonly)","enum":["base","custom"],"type":"string","x-nullable":true},"weight":{"description":"Category weight","type":"integer","x-nullable":true}},"required":["id"],"type":"object"},"CardCategoryExtendedSettings":{"properties":{"bonus_payment_limit":{"description":"Limit bonus points redeem in percentage of check amount","format":"float","type":"number","x-nullable":true},"bonus_payment_settings_source":{"description":"Bonus points payment settings source (optional)","enum":["loyalty","card-category"],"type":"string","x-nullable":true},"bonus_payment_type":{"description":"Type of payment by bonus points","enum":["full-check","partial","partial-rounded"],"type":"string","x-nullable":true}},"type":"object"},"CardInfo":{"properties":{"bonuses":{"$ref":"#/definitions/CustomerBonusesAccounts","description":"Bonuses by currency ISO code list"},"corporate_special_accounts_access":{"description":"List of access to the corporate customer special accounts","items":{"$ref":"#/definitions/CorporateCustomerSpecialAccountAccess"},"type":"array"},"coupons":{"$ref":"#/definitions/CustomerCoupons","description":"Сoupons list"},"customer":{"$ref":"#/definitions/CustomerInfo","description":"Customer info"},"identification":{"$ref":"#/definitions/UserIdentifiers","description":"Customer identifiers"},"rate_info":{"$ref":"#/definitions/CustomerRateInfo","description":"Customer rate info"},"specials":{"$ref":"#/definitions/CustomerSpecialAccounts"},"tourist_cards":{"description":"Tourist (Prepaid) Cards list","items":{"$ref":"#/definitions/TourCard"},"type":"array"}},"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"},"ConsentConfirmation":{"properties":{"code":{"description":"Confirmation code (for types pin, email)","type":"string"},"comment":{"description":"Comment","type":"string"},"confirmation":{"description":"Confirmation type","enum":["pin","email","interface","business"],"type":"string"}},"required":["confirmation"],"type":"object"},"ConsentInfo":{"properties":{"comment":{"description":"Comment","type":"string"},"confirmation":{"description":"Confirmation type","enum":["pin","email","interface","business"],"type":"string"},"processed":{"description":"Consent registered date and time","format":"date-time","type":"string"},"request":{"description":"Request data","type":"object"},"type":{"description":"Registration type","enum":["business-registration","customer-registration","business-customer-import","terminal-customer-registration"],"type":"string"}},"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"},"CorporateCustomerCardInfo":{"properties":{"corporate_special_accounts":{"description":"List of access to the corporate customer special accounts","items":{"$ref":"#/definitions/CorporateCustomerSpecialAccount"},"type":"array"},"customer":{"$ref":"#/definitions/CorporateCustomerInfo","description":"Corporate customer info"}},"type":"object"},"CorporateCustomerInfo":{"description":"Corporate customer","properties":{"corporate_user":{"description":"Corporate user info","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"},"id":{"description":"Corporate customer ID","format":"uuid","type":"string"},"name":{"description":"Corporate customer name","format":"uuid","type":"string"},"suspended":{"description":"Customer suspended flag","enum":[0,1],"type":"integer"}},"type":"object"},"CorporateCustomerSpecialAccount":{"description":"Corporate customer special account info","properties":{"active":{"description":"Account active flag","enum":[0,1],"type":"integer"},"available_amount":{"description":"Amount of funds on the account available for using (null if unlimited)","format":"float","type":"number","x-nullable":true},"corporate_customer":{"$ref":"#/definitions/CorporateCustomerInfo","description":"Corporate customer info (optional)"},"credit_limit":{"description":"Credit limit (for 'credit' account type)","format":"float","type":"number"},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type"},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods filter","x-nullable":true},"id":{"description":"Corporate customer special account ID","format":"uuid","type":"string"},"limits":{"$ref":"#/definitions/AccountLimits","description":"Access limits","x-nullable":true},"special_account":{"$ref":"#/definitions/SpecialAccount","description":"Special account info"}},"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/CorporateCustomerSpecialAccount","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"},"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},"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, check only)","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},"gift_card_id":{"description":"Gift Card ID (optional)","format":"uuid","type":"string","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_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},"redeem_dt":{"description":"Coupon redeemed datetime (optional)","format":"date-time","type":"string"},"redeem_result_transaction_id":{"description":"Coupon redeemed result transaction Id (optional)","format":"uuid","type":"string","x-nullable":true},"redeemed_transaction_id":{"description":"Transaction Id in which a coupon was redeemed (optional)","format":"uuid","type":"string","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"},"CouponAddedResult":{"properties":{"codes":{"items":{"$ref":"#/definitions/CouponCode"},"type":"array"},"coupons":{"description":"Applicable coupons list","items":{"$ref":"#/definitions/Coupon"},"type":"array"},"message":{"description":"Message string","type":"string"},"nonvalid_coupons":{"description":"Non-valid coupons list","items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"type":"object"},"CouponBatch":{"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},"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 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},"id":{"description":"Unique id of coupon batch","format":"uuid","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},"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 (optional)","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},"use_unique_coupon_code":{"description":"Is coupon in this batch use own unique CODE","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"CouponBatchAlias":{"properties":{"active":{"description":"Alias active flag","enum":[0,1],"type":"integer","x-nullable":true},"batch_id":{"description":"Batch ID (optional)","format":"uuid","type":"string","x-nullable":true},"code":{"description":"Alias CODE","type":"string","x-nullable":true},"created":{"description":"Alias created datetime (optional)","format":"date-time","type":"string","x-nullable":true},"emission_per_customer_limit":{"description":"Alias emission coupon limit quantity per user (zero if no limits) (optional)","type":"integer","x-nullable":true},"emission_quantity_limit":{"description":"Alias emission coupon limit quantity (zero if no limits) (optional)","format":"int64","type":"integer","x-nullable":true},"emitted_coupons_quantity":{"description":"Alias emitted coupon quantity (readonly) (optional)","format":"int64","type":"integer","x-nullable":true},"expire_date":{"description":"Value of coupon expire date (optional)","format":"date","type":"string","x-nullable":true},"expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Coupon expiration value type (optional)","x-nullable":true},"expire_value":{"description":"Value of coupon expire (optional)","type":"integer","x-nullable":true},"id":{"description":"Alias ID (optional)","format":"uuid","type":"string","x-nullable":true},"user_email":{"format":"Customer user email (optional)","type":"string"},"user_external_id":{"format":"Customer user external id (if platform support) (optional)","type":"string"},"user_id":{"description":"User ID (optional)","format":"uuid","type":"string","x-nullable":true},"user_name":{"description":"User Name (optional)","format":"uuid","type":"string","x-nullable":true},"user_phone":{"format":"Customer user phone (optional)","type":"string"}},"type":"object"},"CouponBatchAliases":{"items":{"$ref":"#/definitions/CouponBatchAlias"},"type":"array"},"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},"emit_anyway":{"default":false,"description":"Emit new coupon, don`t reuse not redeemed coupon (optional, request only)","type":"boolean","x-nullable":true},"error":{"description":"Error string (optional, readonly)","type":"string","x-nullable":true},"error_code":{"description":"Error code (optional, readonly)","type":"integer","x-nullable":true},"valid":{"description":"Is code of coupon valid (optional, readonly)","type":"boolean","x-nullable":true}},"required":["code"],"type":"object"},"CouponExternalCodeVisibilityType":{"enum":["always-open","on-redeem"],"type":"string"},"CouponProcessingStatus":{"enum":["pending","processed","error"],"type":"string"},"CouponRequest":{"properties":{"code":{"description":"Coupon code","type":"string"},"external_code":{"description":"Coupon external code","type":"string"},"id":{"description":"Coupon unique ID","format":"uuid","type":"string"}},"type":"object"},"CouponStatus":{"enum":["open","redeemed","cancelled"],"type":"string"},"CouponType":{"enum":["check-modifier","certificate","external"],"type":"string"},"CouponTypeExtended":{"enum":["check-modifier","certificate","external","cross-business"],"type":"string"},"Customer":{"properties":{"birth_date":{"description":"User birth date","format":"date","type":"string","x-nullable":true},"country":{"description":"User country ISO code","type":"string","x-nullable":true},"gender":{"$ref":"#/definitions/UserGender","description":"User gender","x-nullable":true},"id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"identification":{"$ref":"#/definitions/UserIdentifiers"},"language":{"description":"User language ISO code","type":"string","x-nullable":true},"name":{"description":"User name","type":"string","x-nullable":true}},"required":["identification"],"type":"object"},"CustomerAccess":{"properties":{"access_type":{"$ref":"#/definitions/CustomerAccessType"}},"required":["access_type"],"type":"object"},"CustomerAccessType":{"enum":["full-bonuses-access","add-bonuses-only","waiting-for-confirmation","in-black-list"],"type":"string"},"CustomerBenefitsAdjustOperationData":{"properties":{"amount":{"description":"Amount credited benefits","format":"float","type":"number"},"comment":{"description":"Comment","type":"string"},"corporate_customer_id":{"description":"Corporate Customer ID (optional)","format":"uuid","type":"string","x-nullable":true},"currency":{"description":"Bonus points currency ISO string","type":"string"},"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"},"id_type":{"$ref":"#/definitions/IdType"},"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"},"promotional_bonuses_starting_date":{"description":"Value of promotional bonuses starting date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string"},"skip_message":{"default":false,"description":"Skip notifications","type":"boolean","x-nullable":true},"special_account_id":{"description":"Special account ID","format":"uuid","type":"string"},"type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Benefit type"}},"required":["type","amount"],"type":"object"},"CustomerBenefitsTopUpOperationData":{"properties":{"amount":{"description":"Amount credited benefits","format":"float","type":"number"},"comment":{"description":"Comment","type":"string"},"corporate_customer_id":{"description":"Corporate Customer ID (optional)","format":"uuid","type":"string","x-nullable":true},"currency":{"description":"Bonus points currency ISO string","type":"string"},"expire":{"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},"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"},"id_type":{"$ref":"#/definitions/IdType"},"promotional_bonuses_expire_date":{"description":"Alias of expire field (DEPRECATED)","format":"date","type":"string","x-nullable":true},"promotional_bonuses_starting_date":{"description":"Alias of starting field (DEPRECATED)","format":"date","type":"string","x-nullable":true},"skip_message":{"default":false,"description":"Skip notifications","type":"boolean","x-nullable":true},"special_account_id":{"description":"Special account ID","format":"uuid","type":"string"},"starting":{"description":"Value of bonuses starting date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Benefit type"}},"required":["type","amount"],"type":"object"},"CustomerBenefitsWriteOffOperationData":{"properties":{"amount":{"description":"Amount credited benefits","format":"float","type":"number"},"check_services":{"$ref":"#/definitions/CheckServices","description":"Services added on check (optional, for 'special-account' type only)","x-nullable":true},"comment":{"description":"Comment","type":"string"},"corporate_customer_id":{"description":"Corporate Customer ID (optional)","format":"uuid","type":"string","x-nullable":true},"currency":{"description":"Bonus points currency ISO string","type":"string"},"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"},"id_type":{"$ref":"#/definitions/IdType"},"skip_message":{"default":false,"description":"Skip notifications","type":"boolean","x-nullable":true},"special_account_id":{"description":"Special account ID","format":"uuid","type":"string"},"type":{"$ref":"#/definitions/BenefitsPriceType","description":"Benefit type"}},"required":["type","amount"],"type":"object"},"CustomerBonusesAccount":{"properties":{"bonuses_added":{"description":"Total bonuses added on account (optional)","format":"float","type":"number","x-nullable":true},"bonuses_amount":{"description":"Total activated bonuses amount on account (ready for use)","format":"float","type":"number","x-nullable":true},"bonuses_redeemed":{"description":"Total bonuses redeemed from account (optional)","format":"float","type":"number","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"currency_name":{"description":"Currensy name","type":"string","x-nullable":true},"deferred_bonuses_amount":{"description":"Total not activated yet bonuses amount on account (optional)","format":"float","type":"number","x-nullable":true},"deferred_permanent_bonuses_amount":{"description":"Amount of not activated yet permanent bonuses on account (optional)","format":"float","type":"number","x-nullable":true},"deferred_promotion_bonuses_amount":{"description":"Amount of not activated yet promotional bonuses on account (optional)","format":"float","type":"number","x-nullable":true},"deferred_temporary_bonuses_amount":{"description":"Alias of deferred_promotion_bonuses_amount","format":"float","type":"number","x-nullable":true},"permanent_bonuses_added":{"description":"Permanent bonuses added on account (optional)","format":"float","type":"number","x-nullable":true},"permanent_bonuses_amount":{"description":"Amount of activated permanent bonuses on account (ready for use)","format":"float","type":"number","x-nullable":true},"permanent_bonuses_detailing":{"description":"Detailing of available permanent bonus points (optional)","items":{"$ref":"#/definitions/CustomerBonusesAccountActivity"},"type":"array"},"permanent_bonuses_redeemed":{"description":"Permanent bonuses redeemed from account (optional)","format":"float","type":"number","x-nullable":true},"promotion_bonuses_added":{"description":"Promotional bonuses added on account (optional)","format":"float","type":"number","x-nullable":true},"promotion_bonuses_amount":{"description":"Amount of activated promotional bonuses on account (ready for use)","format":"float","type":"number","x-nullable":true},"promotion_bonuses_detailing":{"description":"Detailing of available promotional bonus points (optional)","items":{"$ref":"#/definitions/CustomerBonusesAccountActivity"},"type":"array"},"promotion_bonuses_redeemed":{"description":"Promotional bonuses redeemed from account (optional)","format":"float","type":"number","x-nullable":true},"temporary_bonuses_amount":{"description":"Alias of promotion_bonuses_amount","format":"float","type":"number","x-nullable":true}},"type":"object"},"CustomerBonusesAccountActivity":{"properties":{"activated":{"description":"Bonuses are ready for use","type":"boolean","x-nullable":true},"available_amount":{"description":"Available bonus points amount","format":"float","type":"number","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"expired":{"description":"Date of bonuses expiration (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date-time","type":"string","x-nullable":true},"processed":{"description":"Bonus points added date and time","format":"date-time","type":"string","x-nullable":true},"starting":{"description":"Date of bonuses activation (date from which bonuses are ready for use) (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date-time","type":"string","x-nullable":true},"transaction_id":{"description":"Unique Id of the transaction that added bonuses","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"CustomerBonusesAccounts":{"description":"Bonuses by currency ISO code list","items":{"$ref":"#/definitions/CustomerBonusesAccount"},"type":"array"},"CustomerCoupons":{"description":"Сoupons list","items":{"$ref":"#/definitions/Coupon"},"type":"array"},"CustomerFeedbackPrintOnCheck":{"enum":["none","qr-code","url","all"],"type":"string"},"CustomerFeedbackSettings":{"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"},"CustomerField":{"properties":{"description":{"description":"Some help for user","type":"string"},"dictionary_values":{"$ref":"#/definitions/StringValuesList","description":"Dictionary values","x-nullable":true},"id":{"description":"Field id","format":"uuid","type":"string"},"sort_order":{"description":"Sort order weight","type":"integer"},"type":{"description":"Field type","enum":["string","integer","money","date","dictionary"],"type":"string"},"value":{"description":"Field Value (optional)","type":"string"},"value_field_name":{"description":"Field value key name","type":"string"},"value_prettified":{"description":"Prettified Field Value (optional)"}},"required":["type","description"],"type":"object"},"CustomerFieldsList":{"items":{"$ref":"#/definitions/CustomerField"},"type":"array"},"CustomerInfo":{"description":"Customer data","properties":{"access_type":{"$ref":"#/definitions/CustomerAccessType","description":"Access type"},"avatar":{"description":"User avatar url","type":"string"},"card_category":{"$ref":"#/definitions/CardCategory"},"created":{"description":"Created customer date and time","format":"date-time","type":"string"},"have_mobileapp_token":{"description":"User has mobileapp tokens (use mobileapp)","type":"boolean"},"id":{"description":"Customer ID","format":"uuid","type":"string"},"last_sale_date":{"description":"Customer last sale date","format":"date-time","type":"string"},"new":{"description":"User is new for loyalty","enum":[0,1],"type":"integer"},"show_questionnaire":{"description":"Show questionnaire flag","enum":[0,1],"type":"integer"},"user_birth_date":{"description":"Customer user birthdate","type":"string"},"user_consent_exist":{"description":"User consent exists flag","type":"boolean"},"user_created":{"description":"Created user date and time","format":"date-time","type":"string"},"user_email":{"format":"Customer user email","type":"string"},"user_external_id":{"format":"Customer user external id (if platform support)","type":"string"},"user_gender":{"$ref":"#/definitions/UserGender"},"user_name":{"description":"Public Customer user Name","type":"string"},"user_phone":{"format":"Customer user phone","type":"string"},"user_status":{"$ref":"#/definitions/UserStatus","description":"User status"}},"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"},"CustomerQuestionnaireRequest":{"properties":{"customer":{"properties":{"user_birth_date":{"description":"Customer user birth date","type":"string","x-nullable":true},"user_gender":{"$ref":"#/definitions/UserGender","description":"Customer user gender","x-nullable":true},"user_name":{"description":"Customer user Public Name","type":"string","x-nullable":true}},"type":"object"},"fields":{"description":"Customer fields value","type":"object","x-nullable":true}},"type":"object"},"CustomerQuestionnaireResponse":{"properties":{"customer":{"properties":{"user_birth_date":{"description":"Customer user birth date","type":"string","x-nullable":true},"user_birth_date_change_allowed":{"description":"Customer user birthdate changing allowed (readonly, optional)","type":"boolean","x-nullable":true},"user_gender":{"$ref":"#/definitions/UserGender","description":"Customer user gender","x-nullable":true},"user_gender_change_allowed":{"description":"Customer user gender changing allowed (readonly, optional)","type":"boolean","x-nullable":true},"user_name":{"description":"Customer user Public Name","type":"string","x-nullable":true},"user_name_change_allowed":{"description":"Customer user Public Name changing allowed (readonly, optional)","type":"boolean","x-nullable":true}},"type":"object"},"fields":{"$ref":"#/definitions/CustomerFieldsList","description":"Customer fields with value"}},"type":"object"},"CustomerRateInfo":{"description":"Turnover data","properties":{"currency":{"description":"Currency ISO code","type":"string"},"turnover":{"description":"turnover amount","format":"float","type":"number"}},"type":"object"},"CustomerSpecialAccount":{"properties":{"amount":{"description":"On hand amount","format":"float","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},"customer_special_account_id":{"description":"Customer special account ID","format":"uuid","type":"string","x-nullable":true},"extended":{"description":"Account extended flag","enum":[0,1],"type":"integer","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods filter (optional, only for extended accounts)","x-nullable":true},"id":{"description":"Special account ID","format":"uuid","type":"string","x-nullable":true},"limits":{"$ref":"#/definitions/AccountLimits","description":"Access limits (optional, only for extended accounts)","x-nullable":true},"odometer":{"$ref":"#/definitions/DataRequiredType","description":"Odometer value needed flag (optional, only for extended accounts)","x-nullable":true},"redeem_amount":{"description":"Write-off from account amout (optional)","format":"float","type":"number","x-nullable":true},"refill_amount":{"description":"Total refill account amount (optional)","format":"float","type":"number","x-nullable":true},"security_code":{"description":"Additional PIN-code for access to the account exists (optional, only for extended accounts)","enum":[0,1],"type":"integer","x-nullable":true},"special_account":{"$ref":"#/definitions/SpecialAccount","description":"Special account info","x-nullable":true},"title":{"description":"Special account title","type":"string","x-nullable":true}},"type":"object"},"CustomerSpecialAccounts":{"description":"Customer special accounts list","items":{"$ref":"#/definitions/CustomerSpecialAccount"},"type":"array"},"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"},"DisplayCustomer":{"properties":{"cardotppassword":{"description":"customer cardotppassword","type":"string"},"id":{"description":"customer phone or qrcode","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"},"EquipmentJobsRec":{"properties":{"current":{"$ref":"#/definitions/Job","description":"Current job info"},"pending":{"$ref":"#/definitions/JobsList","description":"List of pending jobs"},"recent":{"$ref":"#/definitions/EquipmentRecentJobsRec","description":"List of last finished jobs"}},"type":"object"},"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},"jobs":{"$ref":"#/definitions/EquipmentJobsRec","description":"Jobs info (optional)","x-nullable":true},"monitor_working_status":{"description":"Is monitoring of working equipment status turned on","type":"boolean","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"},"EquipmentRecentJobsRec":{"properties":{"finalize_failed":{"$ref":"#/definitions/JobsList","description":"List of all finished and linked with transaction but not finalized jobs"},"finalized":{"$ref":"#/definitions/JobsList","description":"List of last 10 finished and linked with transaction and finalized jobs"},"not_processed":{"$ref":"#/definitions/JobsList","description":"List of all finished and not linked with transaction jobs"},"processed":{"$ref":"#/definitions/JobsList","description":"List of all finished and linked with transaction but not finalized jobs"}},"type":"object"},"EquipmentType":{"enum":["car-wash"],"type":"string"},"EventStatus":{"properties":{"business_staff":{"$ref":"#/definitions/BusinessStaff","description":"Business Staff Info (readonly)"},"id":{"description":"Event Id (readonly)","type":"string","x-nullable":true},"processed":{"description":"Event UTC processed date-time (readonly)","format":"date-time","type":"string","x-nullable":true},"status":{"$ref":"#/definitions/TerminalEventStatusCode","description":"Event Status","x-nullable":true}},"type":"object"},"ExternalBankCardsEDCTypes":{"enum":["auto","credit","debit","gift"],"type":"string"},"ExternalCheckIdScope":{"enum":["system","business","loyalty","pos","terminal"],"type":"string"},"FeedbackSource":{"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"},"FinalizeCheck":{"properties":{"comment":{"description":"Comment","type":"string"},"id":{"description":"Transaction Id (optional, not used if the identifier is passed in the path)","format":"uuid","type":"string"},"transaction_id":{"description":"Alias to id","format":"uuid","type":"string"}},"type":"object"},"FuelController":{"properties":{"actual_gps_data":{"$ref":"#/definitions/FuelControllerGpsData","description":"Actual GPS coordinates","x-nullable":true},"configuration":{"$ref":"#/definitions/FuelControllerConfiguration","description":"Controller configuration (depends on controller, only for detailed view, not for list)","x-nullable":true},"configuration_reading_status":{"description":"Configuration reading status (read only)","enum":["connection-not-configured","ready-to-read","success","fail"],"type":"string","x-nullable":true},"configuration_updated":{"description":"Controller configuration last updated time","format":"date-time","type":"string","x-nullable":true},"delete_tank_grade_link_by_zero":{"description":"Break Tank to Grade link if received zero volume product (only if used manual Tank to Grade link)","enum":[0,1],"type":"integer","x-nullable":true},"grades":{"description":"Grades info (only for detailed view, not for list)","items":{"$ref":"#/definitions/FuelGradeRec"},"type":"array","x-nullable":true},"id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"manual_pump_nozzle_grade_link":{"description":"Use manual Pump Nozzle to Grade link","enum":[0,1],"type":"integer","x-nullable":true},"manual_pump_nozzle_tank_link":{"description":"Use manual Pump Nozzle to Tank link","enum":[0,1],"type":"integer","x-nullable":true},"manual_tank_grade_link":{"description":"Use manual Tank to Grade link","enum":[0,1],"type":"integer","x-nullable":true},"nozzles":{"description":"Pump nozzles info (only for detailed view, not for list)","items":{"$ref":"#/definitions/FuelNozzleRec"},"type":"array","x-nullable":true},"pump_authorize_type":{"description":"Pump authorize type","enum":["amount","volume"],"type":"string","x-nullable":true},"pumps":{"description":"Pumps info (only for detailed view, not for list)","items":{"$ref":"#/definitions/FuelPumpRec"},"type":"array","x-nullable":true},"skip_pumps_in_selection":{"description":"Skip pumps when selecting fuel for filling","enum":[0,1],"type":"integer","x-nullable":true},"tanks":{"$ref":"#/definitions/FuelTankList","description":"Tanks info (only for detailed view, not for list)","x-nullable":true}},"type":"object"},"FuelControllerCommunicationSettings":{"properties":{"admin_interface_url":{"description":"Controller URL","type":"string","x-nullable":true},"password":{"description":"Password","type":"string","x-nullable":true},"url":{"description":"Controller URL","type":"string","x-nullable":true},"user":{"description":"User name","type":"string","x-nullable":true}},"type":"object"},"FuelControllerConfiguration":{"properties":{"decimal_digits":{"$ref":"#/definitions/FuelControllerConfigurationDecimalDigits","description":"Controller decimal digits configuration","x-nullable":true},"measurement_units":{"$ref":"#/definitions/FuelControllerConfigurationMeasurementUnits","x-nullable":true}},"type":"object"},"FuelControllerConfigurationDecimalDigits":{"properties":{"amount":{"description":"Number of decimal digits in amount value","type":"integer"},"price":{"description":"Number of decimal digits in price value","type":"integer"},"volume":{"description":"Number of decimal digits in volume value","type":"integer"}},"type":"object"},"FuelControllerConfigurationMeasurementUnits":{"properties":{"volume":{"$ref":"#/definitions/FuelControllerVolumeMeasurementUnit","description":"Volume measurement unit","x-nullable":true}},"type":"object"},"FuelControllerConfigurationReadingStatus":{"enum":["connection-not-configured","ready-to-read","success","fail"],"type":"string"},"FuelControllerGpsData":{"properties":{"controller_id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"heading":{"description":"Heading value in degrees","format":"float","type":"number","x-nullable":true},"latitude":{"description":"Latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"live":{"description":"GPS data live (from GPS module on controller) flag","type":"boolean","x-nullable":true},"longitude":{"description":"Longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"metadata":{"$ref":"#/definitions/GpsDataMetadata","description":"Metadata (optional)","x-nullable":true},"processed":{"description":"GPS data time (UTC)","format":"date-time","type":"string","x-nullable":true},"speed":{"description":"Speed over ground in kilometers per hour","format":"float","type":"number","x-nullable":true},"valid":{"description":"Flag of validity data","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"FuelControllerGpsDataList":{"items":{"$ref":"#/definitions/FuelControllerGpsData"},"type":"array"},"FuelControllerPriceControlScheme":{"enum":["none","price-from-system","price-from-controller"],"type":"string"},"FuelControllerPumpAuthorizeConfirmation":{"enum":["selected-nozzle-up","without-nozzle-confirmation"],"type":"string"},"FuelControllerType":{"enum":["pts-2"],"type":"string"},"FuelControllerVolumeMeasurementUnit":{"enum":["L","G"],"type":"string"},"FuelFillingType":{"enum":["amount","volume"],"type":"string"},"FuelGrade":{"properties":{"average_cost":{"$ref":"#/definitions/GradeFuelDelivery","description":"Last actual average cost of fuel by deliveries (optional)","x-nullable":true},"code":{"description":"Grade code","type":"string","x-nullable":true},"id":{"description":"Grade ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal grade ID","type":"string","x-nullable":true},"price":{"description":"Grade price","format":"float","type":"number","x-nullable":true},"price_decimal_digits":{"description":"Number of decimal digits in price value","type":"integer","x-nullable":true}},"type":"object"},"FuelGradeRec":{"description":"Grade data","properties":{"code":{"description":"Grade code","type":"string"},"id":{"description":"Grade ID","format":"uuid","type":"string"},"internal_id":{"description":"Internal grade ID","type":"string"}},"type":"object"},"FuelGradesList":{"items":{"$ref":"#/definitions/FuelGrade"},"type":"array"},"FuelNozzleRec":{"description":"Nozzle data","properties":{"code":{"description":"Nozzle fuel grade code","type":"string","x-nullable":true},"goods":{"$ref":"#/definitions/Goods","description":"Nozzle linked goods data (optional)","x-nullable":true},"grade_id":{"description":"Grade Id (optional)","type":"string","x-nullable":true},"id":{"description":"Nozzle ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal nozzle ID / Nozzle number","type":"string","x-nullable":true},"pump_id":{"description":"Pump Id (optional)","type":"string","x-nullable":true},"tank_id":{"description":"Tank Id (optional)","type":"string","x-nullable":true},"up":{"description":"Nozzle taken up (optional)","type":"boolean","x-nullable":true}},"type":"object"},"FuelPump":{"properties":{"additional_terminals":{"$ref":"#/definitions/FuelPumpTerminalList","description":"Linked additional terminals (optional)","x-nullable":true},"id":{"description":"Pump ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal pump ID / Pump number","type":"string","x-nullable":true},"terminal":{"$ref":"#/definitions/FuelPumpTerminal","description":"Linked main terminal (optional)","x-nullable":true},"terminal_id":{"description":"Linked main terminal ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"FuelPumpJobsRec":{"properties":{"current":{"$ref":"#/definitions/Job","description":"Current job info"},"pending":{"$ref":"#/definitions/JobsList","description":"List of pending jobs"},"recent":{"$ref":"#/definitions/FuelPumpRecentJobsRec","description":"List of last finished jobs"}},"type":"object"},"FuelPumpNozzle":{"properties":{"code":{"description":"Grade code (optional)","type":"string","x-nullable":true},"grade_id":{"description":"Grade ID","format":"uuid","type":"string","x-nullable":true},"id":{"description":"Nozzle ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal pump nozzle ID / Pump nozzle number","type":"string","x-nullable":true},"pump_id":{"description":"Pump ID","format":"uuid","type":"string","x-nullable":true},"tank_id":{"description":"Tank ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"FuelPumpNozzleList":{"items":{"$ref":"#/definitions/FuelPumpNozzle"},"type":"array"},"FuelPumpRec":{"properties":{"available":{"description":"Is available available for operations (optional)","type":"boolean","x-nullable":true},"id":{"description":"Pump ID","format":"uuid","type":"string","x-nullable":true},"internal_id":{"description":"Internal pump ID / Pump number","type":"string","x-nullable":true},"jobs":{"$ref":"#/definitions/FuelPumpJobsRec","description":"Jobs info (optional)","x-nullable":true},"nozzles":{"description":"Nozzles info (optional)","items":{"$ref":"#/definitions/FuelNozzleRec"},"type":"array","x-nullable":true},"sounds":{"$ref":"#/definitions/FuelPumpSoundsRec","description":"Sounds alarm","x-nullable":true},"status":{"description":"Pump status (optional)","enum":["idle","filling","end-of-transaction","offline"],"type":"string","x-nullable":true},"status_description":{"description":"Pump status description (optional)","type":"string","x-nullable":true},"terminal_id":{"description":"Linked terminal ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"FuelPumpRecentJobsRec":{"properties":{"finalize_failed":{"$ref":"#/definitions/JobsList","description":"List of all finished and linked with transaction but not finalized jobs"},"finalized":{"$ref":"#/definitions/JobsList","description":"List of last 10 finished and linked with transaction and finalized jobs"},"not_processed":{"$ref":"#/definitions/JobsList","description":"List of all finished and not linked with transaction jobs"},"processed":{"$ref":"#/definitions/JobsList","description":"List of all finished and linked with transaction but not finalized jobs"}},"type":"object"},"FuelPumpSoundsRec":{"properties":{"nozzle_up_sound":{"description":"Nozzle up","type":"boolean","x-nullable":true}},"type":"object"},"FuelPumpTerminal":{"properties":{"active":{"default":1,"description":"Terminal is active flag","enum":[0,1],"type":"integer"},"currency":{"description":"Currensy ISO code","type":"string"},"id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"last_event_status":{"$ref":"#/definitions/FuelPumpTerminalEventStatus","description":"Last event status","x-nullable":true},"login":{"description":"Terminal login (optional)","type":"string"},"title":{"description":"Terminal title","type":"string"},"type":{"$ref":"#/definitions/TerminalType","description":"Terminal type"}},"type":"object"},"FuelPumpTerminalEventStatus":{"properties":{"id":{"description":"Event Id (readonly)","format":"uuid","type":"string","x-nullable":true},"processed":{"description":"Event UTC processed date-time","format":"date-time","type":"string","x-nullable":true},"remote_addr":{"description":"Remote address (remote IP)","type":"string","x-nullable":true},"status":{"$ref":"#/definitions/TerminalEventStatusCode","description":"Event Status","x-nullable":true}},"type":"object"},"FuelPumpTerminalList":{"items":{"$ref":"#/definitions/FuelPumpTerminal"},"type":"array"},"FuelRec":{"properties":{"configuration":{"$ref":"#/definitions/FuelControllerConfiguration","description":"Controller configuration","x-nullable":true},"configuration_reading_status":{"$ref":"#/definitions/FuelControllerConfigurationReadingStatus","description":"Configuration reading status (read only)","x-nullable":true},"configuration_updated":{"description":"Controller configuration last updated time","format":"date-time","type":"string","x-nullable":true},"id":{"description":"Controller ID","format":"uuid","type":"string","x-nullable":true},"pump_authorize_confirmation":{"$ref":"#/definitions/FuelControllerPumpAuthorizeConfirmation","description":"Pump authorize confirmation type","x-nullable":true},"pump_authorize_type":{"$ref":"#/definitions/FuelFillingType","description":"Pump authorize type","x-nullable":true},"pumps":{"description":"Pumps info","items":{"$ref":"#/definitions/FuelPumpRec"},"type":"array","x-nullable":true},"skip_pumps_in_selection":{"description":"Skip pumps when selecting fuel for filling","enum":[0,1],"type":"integer","x-nullable":true}},"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":{"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_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":{"active":{"description":"Goods active (1) or not (0)","enum":[0,1],"type":"integer","x-nullable":true},"additional_images":{"$ref":"#/definitions/ImageObjectsList","description":"Additional images array","x-nullable":true},"barcode":{"description":"Barcode","type":"string","x-nullable":true},"code":{"description":"Goods code","type":"string","x-nullable":true},"color":{"description":"Color","type":"integer","x-nullable":true},"description":{"description":"Description","type":"string","x-nullable":true},"fuel":{"description":"Fuel information (optional)","items":{"$ref":"#/definitions/FuelRec"},"type":"array","x-nullable":true},"id":{"description":"Goods ID","format":"uuid","type":"string","x-nullable":true},"image":{"$ref":"#/definitions/ImageObject","description":"Main image object","x-nullable":true},"image_id":{"description":"Main image ID","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"parent_code":{"description":"Parent category code (optional)","type":"string","x-nullable":true},"parent_id":{"description":"Parent category ID (optional)","format":"uuid","type":"string","x-nullable":true},"parent_public_title":{"description":"Parent category public title (optional)","type":"string","x-nullable":true},"parent_title":{"description":"Parent category title (optional)","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":"Price values","items":{"$ref":"#/definitions/GoodsPrice"},"type":"array","x-nullable":true},"service_types":{"$ref":"#/definitions/StringValuesList","description":"Service types of goods","x-nullable":true},"sort_order":{"description":"Sort order","type":"integer","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true},"unit":{"description":"Measuring units","type":"string","x-nullable":true},"variable_price":{"description":"Price change allowed","enum":[0,1],"type":"integer","x-nullable":true},"variable_total":{"description":"Total change allowed","enum":[0,1],"type":"integer","x-nullable":true},"weighing":{"description":"Weight goods flag","enum":[0,1],"type":"integer","x-nullable":true},"whole_number":{"description":"Quantity is integer number only","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"GoodsCategories":{"items":{"properties":{"id":{"description":"Goods category ID","format":"uuid","type":"string"}},"type":"object"},"type":"array"},"GoodsCategory":{"properties":{"active":{"default":1,"description":"Category is active flag","enum":[0,1],"type":"integer","x-nullable":true},"color":{"description":"Color","type":"integer","x-nullable":true},"id":{"description":"Goods category ID","format":"uuid","type":"string"},"image":{"$ref":"#/definitions/ImageObject","description":"Category image","x-nullable":true},"link":{"description":"Category link","type":"string","x-nullable":true},"parent_id":{"description":"Parent category ID","format":"uuid","type":"string","x-nullable":true},"public_description":{"description":"Category public description","type":"string","x-nullable":true},"public_title":{"description":"Category public title","type":"string","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true}},"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"},"GpsDataMetadata":{"properties":{"good":{"description":"GPS data goodness flag","type":"boolean","x-nullable":true},"stop_data":{"$ref":"#/definitions/GpsParkingDataMetadata","description":"Stop/parking point additional data","x-nullable":true},"stop_point":{"description":"Is GPS data is stop/parking point","type":"boolean","x-nullable":true}},"type":"object"},"GpsParkingDataMetadata":{"properties":{"begin":{"description":"Stop/parking begin time (UTC)","format":"date-time","type":"string","x-nullable":true},"end":{"description":"Stop/parking end time (UTC)","format":"date-time","type":"string","x-nullable":true},"latitude":{"description":"Stop/parking latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"longitude":{"description":"Stop/parking longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"number":{"description":"Stop/parking number in route","type":"integer","x-nullable":true},"points_count":{"description":"Stop/parking suppressed points count","type":"integer","x-nullable":true}},"type":"object"},"GradeFuelDeliveriesList":{"items":{"$ref":"#/definitions/GradeFuelDelivery"},"type":"array"},"GradeFuelDelivery":{"properties":{"average_cost":{"description":"Value of product average cost per volume measure unit based on delivery (optional, readonly)","format":"double","type":"number","x-nullable":true},"controller_id":{"description":"Controller ID (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"delivery_cost":{"description":"Value of product delivery cost per volume measure unit (optional)","format":"double","type":"number","x-nullable":true},"delivery_datetime":{"description":"Delivery date and time (optional)","format":"date-time","type":"string","x-nullable":true},"delivery_id":{"description":"Delivery ID (optional)","format":"uuid","type":"string","x-nullable":true},"delivery_vehicle_id":{"description":"Delivery vehicle / rail car number/id (optional)","type":"string","x-nullable":true},"delivery_volume":{"description":"Value of product delivery volume in volume measure units (optional)","format":"double","type":"number","x-nullable":true},"exists":{"description":"Delivery data existence (readonly)","type":"boolean","x-nullable":true},"grade_id":{"description":"Grade ID (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"product_volume_before_delivery":{"description":"Value of product volume before delivery in volume measure units (optional)","format":"double","type":"number","x-nullable":true},"volume_measure_unit":{"$ref":"#/definitions/FuelControllerVolumeMeasurementUnit","description":"Unit of volume measure (optional, readonly)","x-nullable":true}},"type":"object"},"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"},"Loyalty":{"properties":{"categories":{"description":"Categories","items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array","x-nullable":true},"id":{"description":"Loyalty Id (readonly)","format":"uuid","type":"string","x-nullable":true},"legal_info":{"description":"Loyalty legal info","type":"string","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links","x-nullable":true},"photos":{"$ref":"#/definitions/StringValuesList","x-nullable":true},"privacy_policy_url":{"description":"Loyalty privacy policy link","type":"string","x-nullable":true},"title":{"type":"string"}},"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"},"LoyaltyGoods":{"properties":{"active":{"description":"Active (1) or not (0)","enum":[0,1],"type":"integer"},"barcode":{"description":"Barcode","type":"string","x-nullable":true},"code":{"description":"Code","type":"string","x-nullable":true},"color":{"description":"Color","type":"integer","x-nullable":true},"id":{"description":"Goods ID","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"online_store_available":{"description":"Online store available (1) or not (0)","enum":[0,1],"type":"integer","x-nullable":true},"passthru_data":{"$ref":"#/definitions/GoodsPassThru","description":"PassThru data for Fleet, etc","x-nullable":true},"preconfigured_values":{"description":"Pre-configured values with amount or totals","items":{"$ref":"#/definitions/PreConfiguredValues"},"type":"array","x-nullable":true},"price":{"description":"Price values","items":{"$ref":"#/definitions/GoodsPrice"},"type":"array","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Title (multilanguage)","x-nullable":true},"service_types":{"description":"Service types of goods","items":{"description":"type identifier","type":"string"},"type":"array","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true},"unit":{"description":"Measuring units","type":"string","x-nullable":true},"whole_number":{"description":"Whole number","type":"integer","x-nullable":true}},"type":"object"},"LoyaltyGoodsCategory":{"properties":{"active":{"default":1,"description":"Category is active flag","enum":[0,1],"type":"integer","x-nullable":true},"color":{"description":"Color","type":"integer","x-nullable":true},"id":{"description":"Goods category ID","format":"uuid","type":"string"},"image":{"$ref":"#/definitions/ImageObject","description":"Category image","x-nullable":true},"link":{"description":"Category link","type":"string","x-nullable":true},"online_store_available":{"default":0,"description":"Category available in online store flag","enum":[0,1],"type":"integer","x-nullable":true},"parent_id":{"description":"Parent category ID","format":"uuid","type":"string","x-nullable":true},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Category public description (multilanguage)","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Category public title (multilanguage)","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true}},"type":"object"},"LoyaltyGoodsPreconfiguredValues":{"properties":{"preconfigured_values":{"description":"Pre-configured values with amount or totals","items":{"$ref":"#/definitions/PreConfiguredValues"},"type":"array","x-nullable":true}},"type":"object"},"LoyaltyGoodsPrice":{"properties":{"price":{"description":"Price values","items":{"$ref":"#/definitions/GoodsPrice"},"type":"array","x-nullable":true}},"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"},"LoyaltyOnlineStore":{"properties":{"active":{"description":"Object active flag","type":"boolean"},"additional_customer_info":{"description":"Additional customer info","type":"string"},"title":{"description":"Online store public title","type":"string"}},"type":"object"},"LoyaltyRule":{"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","default":"all","description":"Rule applicable for API type (for automatic and coupon automatic only)"},"applicable_for_customer":{"$ref":"#/definitions/LoyaltyRuleApplicableForCustomer","default":"identified","description":"Rule applicable for customer type","x-nullable":true},"applicable_for_sale":{"$ref":"#/definitions/LoyaltyRuleApplicableForSale","description":"Rule applicable for sale type","x-nullable":true},"apply_when_bonuses_redeemed":{"default":1,"description":"Apply rule when bonus points redeemed","enum":[0,1],"type":"integer","x-nullable":true},"apply_when_customers_account_payment":{"default":0,"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":{"default":1,"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":{"default":0,"description":"Do not add emitted coupons to the customer's wallet (optional)","enum":[0,1],"type":"integer"},"depends_calc_period":{"$ref":"#/definitions/LoyaltyRuleDependsCalcPeriod","description":"Rule values dependencies period (not applicable for depency 'bonuses-on-account')","x-nullable":true},"depends_calc_period_related_to_current_category":{"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)","type":"array","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},"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 (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":{"default":0,"description":"maximum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"items_limit_min":{"default":0,"description":"minimum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","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":{"default":0,"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":{"default":0,"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"},"LoyaltyRuleActionType":{"enum":["discount-percent-by-item","discount-amount-by-item","special-price-by-item","discount-percent-by-check","discount-amount-by-check","charge-percent-by-item","charge-amount-by-item","charge-percent-by-check","charge-amount-by-check","emission-coupon-by-item","emission-coupon-by-check"],"type":"string"},"LoyaltyRuleApplicableApiScope":{"enum":["all","client","terminal"],"type":"string"},"LoyaltyRuleApplicableForCustomer":{"enum":["identified","anonymous","all"],"type":"string"},"LoyaltyRuleApplicableForSale":{"enum":["all","first-only","all-but-first"],"type":"string"},"LoyaltyRuleDependsCalcPeriod":{"enum":["all","check","day","week","month","three-month","year","current-week","past-week","current-month","past-month","current-quarter","past-quarter","current-year","past-year"],"type":"string"},"LoyaltyRuleDependsTimeZone":{"enum":["system","pos"],"type":"string"},"LoyaltyRuleDependsType":{"enum":["none","amount","quantity","bonuses-earned","bonuses-on-account"],"type":"string"},"LoyaltyRuleImplementedBy":{"enum":["automatic-rule","manual-rule","display-rule","coupon"],"type":"string"},"LoyaltyRuleImplementedCalculationType":{"enum":["summarizing","maximum","sequential"],"type":"string"},"LoyaltyRuleList":{"items":{"$ref":"#/definitions/LoyaltyRule"},"type":"array"},"LoyaltyRuleScope":{"enum":["retail","corporate"],"type":"string"},"LoyaltySettings":{"description":"Loyalty 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"},"show_customers_questionnaire":{"description":"Automatic show customers questionaries in terminal","enum":["do-not-show","show-only-for-new","show-for-all"],"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"},"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"},"MobileAppPaymentSettings":{"properties":{"settings":{"$ref":"#/definitions/MobileAppPaymentSystemSettings","description":"Settings of payment system"},"type":{"$ref":"#/definitions/MobileAppPaymentSystemType","description":"Type of payment system"}},"type":"object"},"MobileAppPaymentSettingsFee":{"properties":{"fixed":{"description":"Fixed amount of fee","format":"float","type":"number"},"percentage":{"description":"Percentage from payment amount part of fee","format":"float","type":"number"}},"type":"object"},"MobileAppPaymentSettingsList":{"items":{"$ref":"#/definitions/MobileAppPaymentSettings"},"type":"array"},"MobileAppPaymentSystemSettings":{"properties":{"api_key":{"description":"Submerchant API key (optional, for eway only)","type":"string"},"application_fee":{"$ref":"#/definitions/MobileAppPaymentSettingsFee","description":"Payment transaction Business fee object (optional, for stripe only)"},"customer_application_fee":{"$ref":"#/definitions/MobileAppPaymentSettingsFee","description":"Payment transaction Customer fee object"},"password":{"description":"Submerchant API key (optional, for eway only)","type":"string"},"scope":{"description":"Settings scope","enum":["platform","business","loyalty","pos"],"type":"string"},"service_id_payment_by_token":{"description":"Submerchant payment by card token service Id (optional, for 4bill only)","type":"integer"},"service_id_tokenize_by_payment":{"description":"Submerchant card tokenization (by success payment) service Id (optional, for 4bill only)","type":"integer"},"smch_id":{"description":"Submerchant Id","type":"string"},"verification_limit":{"description":"Amount from which 3DS verification needed (optional, for ipay only)","format":"float","type":"number"},"wallet_id":{"description":"Submerchant wallet Id (optional, for 4bill only)","type":"integer"}},"type":"object"},"MobileAppPaymentSystemType":{"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"},"ObjectIds":{"items":{"description":"Object ID","format":"uuid","type":"string"},"type":"array"},"OdometerUnitType":{"enum":["K","M","H"],"type":"string"},"Order":{"properties":{"check":{"$ref":"#/definitions/Check","description":"Check object","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"created":{"description":"Created order time","format":"date-time","type":"string","x-nullable":true},"delivered":{"description":"Delivered time","format":"date-time","type":"string","x-nullable":true},"delivery_id":{"description":"Delivery method ID","format":"uuid","type":"string","x-nullable":true},"fuel_delivery":{"$ref":"#/definitions/OrderFuelDelivery","description":"Fuel delivery object"},"id":{"description":"Order ID","format":"uuid","type":"string","x-nullable":true},"loyalty":{"$ref":"#/definitions/Loyalty","description":"Loyalty object (optional)","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"number":{"description":"Order number","type":"string","x-nullable":true},"online_store":{"$ref":"#/definitions/LoyaltyOnlineStore","description":"Online store object (optional)","x-nullable":true},"paid":{"description":"Order paid flag","type":"boolean","x-nullable":true},"payment_method":{"description":"Order payment method","enum":["payment-at-checkout","payment-upon-receipt"],"type":"string","x-nullable":true},"pos_id":{"description":"Pos ID","format":"uuid","type":"string","x-nullable":true},"route":{"$ref":"#/definitions/RouteTerminal","description":"Route object (optional)","x-nullable":true},"shipping":{"$ref":"#/definitions/Shipping","description":"Shipping object","x-nullable":true},"status":{"description":"Order status","enum":["created","inprocess","delivered","canceled"],"type":"string","x-nullable":true},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"time_zone":{"description":"Time zone","type":"string","x-nullable":true},"transaction":{"description":"Order transactions","items":{"$ref":"#/definitions/Transaction"},"type":"array","x-nullable":true},"transaction_actual":{"$ref":"#/definitions/Transaction","description":"Order actual transaction (if exists)","x-nullable":true},"type":{"description":"Order type","enum":["online-store","fuel-taxi"],"type":"string","x-nullable":true},"user_id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"OrderFuelDelivery":{"properties":{"address":{"description":"Delivery address","type":"string","x-nullable":true},"comment":{"description":"Delivery instruction","type":"string","x-nullable":true},"latitude":{"description":"Delivery Latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"longitude":{"description":"Delivery Longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"user_vehicle":{"$ref":"#/definitions/UserVehicle","description":"User vehicle object","x-nullable":true}},"type":"object"},"OrderListResult":{"properties":{"newest_order_created":{"description":"Newest Order created time","format":"date-time","type":"string","x-nullable":true},"newest_order_id":{"description":"Newest Order ID","format":"uuid","type":"string","x-nullable":true},"orders":{"description":"Orders list","items":{"$ref":"#/definitions/Order"},"type":"array"}},"type":"object"},"Payment":{"properties":{"amount":{"description":"To pay amount","format":"float","type":"number","x-nullable":true},"bank_card_external":{"$ref":"#/definitions/BankCardExternalInfo","description":"bank-card-external payment type info (optional)","x-nullable":true},"business_fee_amount":{"description":"Business fee amount (optional, only for 'mobile-app' type)","format":"float","type":"number","x-nullable":true},"change":{"description":"Payment change (optional, only for 'cash' type)","format":"float","type":"number"},"currency":{"description":"Currensy ISO code (depends on transaction type)","type":"string","x-nullable":true},"customer_fee_amount":{"description":"Customer fee amount (optional, only for 'mobile-app' type)","format":"float","type":"number","x-nullable":true},"external_info":{"$ref":"#/definitions/PaymentExternalInfo","description":"payment external system info (optional)","x-nullable":true},"id":{"description":"Payment Id","format":"uuid","type":"string","x-nullable":true},"mobileapp":{"$ref":"#/definitions/MobileAppInfo","description":"mobile-app payment type info (optional)","x-nullable":true},"receipt":{"description":"Payment receipt (optional, only for 'cash' type)","format":"float","type":"number"},"status":{"$ref":"#/definitions/BankCardExternalPaymentStatus","description":"Operation status","x-nullable":true},"type":{"$ref":"#/definitions/PaymentType","description":"Payment type","x-nullable":true}},"type":"object"},"PaymentExternalInfo":{"properties":{"app_version":{"description":"Software version","type":"string","x-nullable":true},"auth_code":{"description":"Authorization code","type":"string","x-nullable":true},"bank_response_code":{"description":"Bank response code","type":"string","x-nullable":true},"batch_number":{"description":"Batch number","type":"string","x-nullable":true},"card_holder_name":{"description":"Card holder name","type":"string","x-nullable":true},"card_issuer_name":{"description":"Card issuer name","type":"string","x-nullable":true},"card_label":{"description":"Card label","type":"string","x-nullable":true},"card_wallet":{"description":"Card wallet like 'Apple Pay', 'Google Pay', 'Masterpass', 'Visa Checkout', etc (optional)","type":"string","x-nullable":true},"cvm":{"description":"Card verification method","type":"string","x-nullable":true},"emv_ac":{"description":"EMV Application Cryptogram","type":"string","x-nullable":true},"emv_aid":{"description":"EMV Application Identifier","type":"string","x-nullable":true},"emv_aid_name":{"description":"EMV Application Name","type":"string","x-nullable":true},"emv_atc":{"description":"EMV Application Transaction Counter","type":"string","x-nullable":true},"emv_iad":{"description":"EMV Issuer Application Data","type":"string","x-nullable":true},"emv_tsi":{"description":"EMV Transaction Status Indicator","type":"string","x-nullable":true},"emv_tvr":{"description":"EMV Transaction Verification Results","type":"string","x-nullable":true},"entry_mode":{"description":"Card entry mode","type":"string","x-nullable":true},"gateway_transaction_id":{"description":"Receipt gateway transaction Id","type":"string","x-nullable":true},"host_timestamp":{"description":"Host timestamp","type":"string","x-nullable":true},"invoice_number":{"description":"Invoice/receipt number","type":"string","x-nullable":true},"merchant_id":{"description":"Merchant Id","type":"string","x-nullable":true},"pan":{"description":"Masked primary account number","type":"string","x-nullable":true},"response_code":{"description":"Response code from host","type":"string","x-nullable":true},"response_code_iso":{"description":"ISO response code","type":"string","x-nullable":true},"response_text":{"description":"Response text from host","type":"string","x-nullable":true},"sequence_number":{"description":"Sequence number","type":"string","x-nullable":true},"system_type":{"$ref":"#/definitions/CustomerPaymentSystemType","description":"Payment system type (depends on payment type)","x-nullable":true},"terminal_id":{"description":"Termsnal Id","type":"string","x-nullable":true},"transaction_name":{"description":"Receipt transaction name","type":"string","x-nullable":true},"transaction_reference_number":{"description":"Receipt transaction reference number","type":"string","x-nullable":true}},"type":"object"},"PaymentForProcess":{"properties":{"amount":{"description":"Payment amount","format":"float","type":"number"},"bank_card_external":{"$ref":"#/definitions/BankCardExternalInfo","description":"bank-card-external payment type info (optional)","x-nullable":true},"currency":{"description":"Currensy ISO code (depends on transaction type)","type":"string"},"id":{"description":"Payment Id","format":"uuid","type":"string"},"operation_type":{"$ref":"#/definitions/BankCardExternalPaymentOperationType","description":"Payment operation type (depends on payment_system_type)"},"payment_system_type":{"$ref":"#/definitions/BankCardExternalPaymentSystemType","description":"Payment system type (depends on payment type)"},"preliminary_transaction_id":{"description":"Preliminary Transaction Id (optional, only if exists)","format":"uuid","type":"string","x-nullable":true},"processing_result":{"description":"Payment processing result (depends on payment_system_type)","type":"object","x-nullable":true},"status":{"$ref":"#/definitions/BankCardExternalPaymentStatus","description":"Operation status"},"transaction_id":{"description":"Transaction Id","format":"uuid","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/PaymentType","description":"Payment type"}},"type":"object"},"PaymentProcess":{"properties":{"bank_card_external":{"$ref":"#/definitions/BankCardExternalInfo","description":"bank-card-external payment type info (optional)","x-nullable":true},"edc_card_type":{"$ref":"#/definitions/ExternalBankCardsEDCTypes","default":"auto","description":"Bank card EDC Type type (depends on payment system type)","x-nullable":true},"failed":{"description":"Payment processing failed flag","type":"boolean"},"id":{"description":"Payment Id","format":"uuid","type":"string"},"operation_type":{"$ref":"#/definitions/BankCardExternalPaymentOperationType","description":"Payment operation type (depends on payment_system_type)"},"payment_system_type":{"$ref":"#/definitions/BankCardExternalPaymentSystemType","description":"Payment system type (depends on payment type)"},"processing_prerequest":{"$ref":"#/definitions/PaymentProcessPreRequest","description":"Payment processing pre-request (depends on payment_system_type)","x-nullable":true},"processing_request":{"description":"Payment processing request (depends on payment_system_type)","type":"object","x-nullable":true},"processing_result":{"description":"Payment processing result (depends on payment_system_type)","type":"object","x-nullable":true}},"required":["id","payment_system_type","operation_type"],"type":"object"},"PaymentProcessPreRequest":{"properties":{"command_http_request_data":{"description":"HTTP Request payload data (depends on payment_system_type)","type":"object","x-nullable":true},"command_http_request_method":{"description":"HTTP Request Method","enum":["GET","POST"],"type":"string","x-nullable":true},"command_http_request_path":{"description":"HTTP Request Path","type":"string","x-nullable":true},"command_http_request_query":{"description":"HTTP Request Query string","type":"string","x-nullable":true},"operation_type":{"description":"Card/Unit operation type","type":"string","x-nullable":true}},"type":"object"},"PaymentStatus":{"description":"Payment status details","properties":{"amount":{"description":"To pay amount (optional)","format":"float","type":"number","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","x-nullable":true},"invoice":{"description":"Payment amount (optional)","format":"float","type":"number"},"secure":{"description":"Secure type (optional)","enum":["none","otp","3ds"],"type":"string","x-nullable":true},"status":{"description":"Operation status","enum":["inprocess","success","fail","verification","registered","canceled","error","authorized","unknown"],"type":"string","x-nullable":true},"type":{"$ref":"#/definitions/CustomerPaymentSystemType","description":"Wallet type","x-nullable":true}},"type":"object"},"PaymentType":{"enum":["cash","bank-card","bank-card-external","mobile-app","special-account"],"type":"string"},"PaymentUnitOperationProcess":{"properties":{"default_idle_screen":{"description":"Default idle screen (depends on payment_system_type and operation_type) (optional)","type":"boolean","x-nullable":true},"display_data":{"description":"Display data base64 encoded (depends on payment_system_type and operation_type) (optional)","type":"string","x-nullable":true},"failed":{"description":"Operation processing failed flag (optional)","type":"boolean"},"operation_type":{"$ref":"#/definitions/BankCardExternalPaymentUnitOperationType","description":"Payment terminal unit operation type (depends on payment_system_type)"},"payment_system_type":{"$ref":"#/definitions/BankCardExternalPaymentSystemType","description":"Payment system type (depends on payment type)"},"processing_prerequest":{"$ref":"#/definitions/PaymentProcessPreRequest","description":"Operation processing pre-request (depends on payment_system_type)","x-nullable":true},"processing_request":{"description":"Operation processing request (depends on payment_system_type)","type":"object","x-nullable":true},"processing_result":{"description":"Operation processing result (depends on payment_system_type)","type":"object","x-nullable":true},"processing_result_specific_params":{"description":"Operation processing result params (depends on payment_system_type) (readonly)","type":"object","x-nullable":true},"status":{"$ref":"#/definitions/BankCardExternalPaymentUnitOperationStatus","description":"Operation status (readonly)","x-nullable":true},"user_defined_echo_data":{"description":"User defined echo data (depends on payment_system_type and operation_type) (optional)","type":"string","x-nullable":true}},"required":["payment_system_type","operation_type"],"type":"object"},"PhoneNumber":{"properties":{"number":{"description":"Phone number","type":"string"}},"type":"object"},"PhoneNumbersList":{"items":{"$ref":"#/definitions/PhoneNumber"},"type":"array"},"PinConfirmationResponse":{"properties":{"code":{"description":"Response code","format":"int32","type":"integer"},"info":{"properties":{"channel":{"description":"Confirmation channel","enum":["sms","email","external-system","external-verification-service"],"type":"string"},"code":{"description":"PIN-code (masked)","type":"string"},"length":{"description":"PIN-code length","type":"integer"},"recipient":{"description":"Recipien address","type":"string"}},"type":"object"},"message":{"description":"Response message","type":"string"}},"type":"object"},"Pos":{"description":"Point of sale","properties":{"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":"Point of sales address","type":"string"},"categories":{"description":"Categories","items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array"},"check_item_enter_mode":{"$ref":"#/definitions/CheckItemEnterMode","description":"Pos check items entering mode possibilities","x-nullable":true},"country":{"description":"Point of sales country code","type":"string"},"id":{"description":"Point of sales ID","format":"uuid","type":"string"},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links"},"maximum_service_distance":{"description":"Maximum service distance in km (0 - unlimited)","type":"integer"},"phone_prefix":{"description":"Phone prefix in international format. Sample '+380'","type":"string"},"phone_prefix_local":{"description":"Local interpretation of phone prefix in international format. Sample '+380'","type":"string"},"phones":{"$ref":"#/definitions/PhoneNumbersList","description":"Phones of sale point"},"photos":{"$ref":"#/definitions/ImageObjectsList"},"title":{"description":"Point of sales title","type":"string"},"type":{"$ref":"#/definitions/PosType","description":"Pos type"}},"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},"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"},"PriceGroupItem":{"properties":{"item_active":{"description":"Goods item active flag","enum":[0,1],"type":"integer","x-nullable":true},"item_category_id":{"description":"Goods item category ID","format":"uuid","type":"string","x-nullable":true},"item_category_title":{"description":"Goods item category title","type":"string","x-nullable":true},"item_code":{"description":"Goods item code","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string","x-nullable":true},"item_title":{"description":"Goods item title","type":"string","x-nullable":true},"master_price":{"$ref":"#/definitions/PriceGroupMasterPrice","description":"Current master price (optional)","x-nullable":true},"price_group_default_time_zone":{"description":"Price Group default time zone db name (optional) (readonly)","type":"string"},"price_group_id":{"description":"Price group ID (optional) (readonly)","format":"uuid","type":"string","x-nullable":true},"price_group_terminal_items_master_price_change_allowed":{"description":"Allowed change items master prices by Terminal API","enum":[0,1],"type":"integer"},"price_group_terminal_items_taxes_change_allowed":{"description":"Allowed change items taxes by Terminal API","enum":[0,1],"type":"integer"},"tax_rates":{"description":"Tax rates (optional)","items":{"$ref":"#/definitions/PriceGroupTaxRate"},"type":"array","x-nullable":true}},"type":"object"},"PriceGroupItemsList":{"items":{"$ref":"#/definitions/PriceGroupItem"},"type":"array"},"PriceGroupItemsListPaginated":{"properties":{"data":{"description":"Price group items list","items":{"$ref":"#/definitions/PriceGroupItem"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"},"PriceGroupMasterPrice":{"properties":{"currency":{"description":"Currency ISO code (readonly)","type":"string","x-nullable":true},"id":{"description":"Master price unique ID","format":"uuid","type":"string","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string","x-nullable":true},"price_decimal_digits":{"description":"Items price decimal digits (readonly)","type":"integer"},"price_group_id":{"description":"Price group ID","format":"uuid","type":"string","x-nullable":true},"starting":{"description":"Date and time from which master price is valid","format":"date-time","type":"string","x-nullable":true},"time_zone":{"description":"Starting value time zone db name","type":"string","x-nullable":true},"value":{"description":"Master price value","format":"float","type":"number","x-nullable":true}},"type":"object"},"PriceGroupSettings":{"properties":{"id":{"description":"Price group ID (optional)","format":"uuid","type":"string"},"items_master_price_change_allowed":{"description":"Price group items Master Price change allowed (optional)","type":"boolean"},"items_taxes_change_allowed":{"description":"Price group items Taxes change allowed (optional)","type":"boolean"},"used":{"description":"Price group used","type":"boolean"}},"type":"object"},"PriceGroupTaxRate":{"properties":{"currency":{"description":"Currency ISO code (readonly)","type":"string","x-nullable":true},"default_value":{"description":"Tax rate default value in the Price Group (readonly)","format":"float","type":"number","x-nullable":true},"item_id":{"description":"Goods item ID","format":"uuid","type":"string","x-nullable":true},"price_group_id":{"description":"Price group ID","format":"uuid","type":"string","x-nullable":true},"tax_classification":{"description":"Tax classification","enum":["base-tax","sales-tax"],"type":"string","x-nullable":true},"tax_code":{"description":"Tax code","type":"string","x-nullable":true},"tax_decimal_digits":{"description":"Tax rate decimal digits (readonly)","type":"integer"},"tax_id":{"description":"Tax ID","format":"uuid","type":"string","x-nullable":true},"tax_title":{"description":"Tax title (readonly)","type":"string","x-nullable":true},"tax_type":{"description":"Tax rate value type (readonly)","enum":["amount","percentage"],"type":"string","x-nullable":true},"value":{"description":"Tax rate actual value in the Price Group","format":"float","type":"number","x-nullable":true}},"type":"object"},"PriceMargins":{"properties":{"terminal_additional_costs":{"description":"Terminal additional costs detailing","items":{"$ref":"#/definitions/PriceExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"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"},"ProtectionOptions":{"properties":{"operation":{"description":"Protected action marker","enum":["terminal_remind_password"],"type":"string"},"params":{"description":"Protection parameters (depends on protection type)","type":"object"},"protection":{"description":"Protection type ('none' - without protection)","enum":["none","recaptcha"],"type":"string"}},"type":"object"},"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"},"RelatedTerminal":{"properties":{"external_id":{"description":"Terminal External ID (up to 128 symbols)","type":"string","x-nullable":true},"id":{"description":"Terminal Id","format":"uuid","type":"string","x-nullable":true},"login":{"description":"Terminal login","type":"string","x-nullable":true},"terminal_transaction_cancel_allowed":{"description":"Access granted to the transaction cancel operation","type":"boolean"},"terminal_transaction_finalize_allowed":{"description":"Access granted to the transaction finalize operation","type":"boolean"},"terminal_transaction_info_allowed":{"description":"Access granted to the transaction info","type":"boolean"},"terminal_transaction_list_allowed":{"description":"Access granted to the transactions list","type":"boolean"},"terminal_transaction_receipt_allowed":{"description":"Access granted to the transaction receipt info","type":"boolean"},"title":{"description":"Terminal Title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/TerminalType","description":"Terminal type"}},"type":"object"},"RelatedTerminalList":{"items":{"$ref":"#/definitions/RelatedTerminal"},"type":"array"},"RewardGrantPeriodType":{"enum":["day","month"],"type":"string"},"RewardValueType":{"enum":["check-percentage","fixed-amount"],"type":"string"},"RouteOperation":{"properties":{"assistance_available":{"description":"Operation 'assistance' available (readonly)","type":"boolean"},"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},"canceled_available":{"description":"Operation 'canceled' available (readonly)","type":"boolean"},"comment":{"description":"Comment","type":"string","x-nullable":true},"corporate_customer":{"$ref":"#/definitions/CorporateCustomerCardInfo","description":"Corporate Customer CardInfo object (optional)","x-nullable":true},"corporate_customer_id":{"description":"Corporate Customer Id","format":"uuid","type":"string","x-nullable":true},"customer":{"$ref":"#/definitions/CardInfo","description":"Customer CardInfo object (optional)","x-nullable":true},"customer_id":{"description":"Retail Customer Id","format":"uuid","type":"string","x-nullable":true},"customer_type":{"description":"Customer type","enum":["customer","corporate-customer","business"],"type":"string","x-nullable":true},"date":{"description":"Route date","format":"date","type":"string","x-nullable":true},"details":{"$ref":"#/definitions/RouteOperationDetails","description":"Operation details (depends on type) (optional)","x-nullable":true},"failed_available":{"description":"Operation 'failed' available (readonly)","type":"boolean"},"goods":{"description":"List of goods (optional)","items":{"$ref":"#/definitions/Goods"},"type":"array","x-nullable":true},"id":{"description":"Operation Id","format":"uuid","type":"string","x-nullable":true},"preliminary_transaction_id":{"description":"Preliminary Transaction Id (optional, only for pending type)","format":"uuid","type":"string","x-nullable":true},"processed_available":{"description":"Operation 'processed' available (readonly)","type":"boolean"},"refueling_available":{"description":"Operation 'refueling' available (readonly)","type":"boolean"},"scheduled":{"description":"Scheduled time in HH:mm / HH:mm:ss format","type":"string","x-nullable":true},"shipping_available":{"description":"Operation 'shipping' available (readonly)","type":"boolean"},"status":{"description":"Operation status","enum":["pending","processed","failed","canceled","shipping","customer-assistance-needed","refueling"],"type":"string","x-nullable":true},"transaction_id":{"description":"Transaction Id (Finalized transaction Id)","format":"uuid","type":"string","x-nullable":true},"type":{"description":"Operation type","enum":["sale-fuel-to-tank","fuel-taxi-order-delivery","online-store-order-delivery"],"type":"string","x-nullable":true}},"type":"object"},"RouteOperationDetails":{"properties":{"order":{"$ref":"#/definitions/Order","description":"Order object (for 'fuel-taxi-order-delivery', 'online-store-order-delivery' types)","x-nullable":true},"quantity":{"description":"Quantity which will be fill (for 'sale-fuel-to-tank' type)","format":"float","type":"number","x-nullable":true},"tank":{"$ref":"#/definitions/Tank","description":"Tank object (for 'sale-fuel-to-tank' type)","x-nullable":true}},"type":"object"},"RouteOperationListResult":{"properties":{"data":{"description":"Route operation list","items":{"$ref":"#/definitions/RouteOperation"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total route operations count","type":"integer"}},"type":"object"}},"type":"object"},"RouteOperationModify":{"properties":{"date":{"description":"Route date","format":"date","type":"string","x-nullable":true},"id":{"description":"Operation Id","format":"uuid","type":"string"},"scheduled":{"description":"Scheduled time in HH:mm / HH:mm:ss format","type":"string","x-nullable":true}},"required":["id"],"type":"object"},"RouteOperationOrder":{"properties":{"date":{"description":"Route date","format":"date","type":"string"},"order_id":{"description":"Order Id","format":"uuid","type":"string"},"scheduled":{"description":"Scheduled time in HH:mm / HH:mm:ss format","type":"string"}},"required":["order_id","date","scheduled"],"type":"object"},"RouteOperationProcessData":{"properties":{"assistance_type":{"description":"Assistance trouble type (only for assistance operation required)","enum":["fuel-cap-locked","vehicle-not-found"],"type":"string","x-nullable":true},"comment":{"description":"Operation/Failure comment","type":"string","x-nullable":true}},"type":"object"},"RouteOperationsCount":{"properties":{"assistance":{"type":"integer","x-nullable":true},"canceled":{"type":"integer","x-nullable":true},"failed":{"type":"integer","x-nullable":true},"pending":{"type":"integer","x-nullable":true},"processed":{"type":"integer","x-nullable":true},"refueling":{"type":"integer","x-nullable":true},"shipping":{"type":"integer","x-nullable":true}},"type":"object"},"RouteTerminal":{"properties":{"active":{"default":1,"description":"Route is active flag","enum":[0,1],"type":"integer"},"comment":{"description":"Comment","type":"string","x-nullable":true},"date":{"description":"Route date in format YYYY-MM-DD (if null or not exists - create route on current date)","format":"date","type":"string","x-nullable":true},"id":{"description":"Route id","format":"uuid","type":"string"},"operations":{"description":"Route operation list","items":{"$ref":"#/definitions/RouteOperation"},"type":"array"},"operations_count":{"$ref":"#/definitions/RouteOperationsCount","description":"Operations count by status (optional)","x-nullable":true}},"type":"object"},"RuleCalculationBaseData":{"properties":{"amount":{"description":"Check amount","format":"float","type":"number","x-nullable":true},"bonuses_redeemed_amount":{"description":"Check bonus points redeem amount","format":"float","type":"number","x-nullable":true}},"type":"object"},"RuleCalculationBaseItemData":{"properties":{"amount":{"description":"Item amount","format":"float","type":"number","x-nullable":true},"bonuses_redeemed_amount":{"description":"Item total bonus points redeemed calculated by check","format":"float","type":"number","x-nullable":true},"index":{"description":"Check item index","format":"int32","type":"integer","x-nullable":true},"price":{"description":"Item price","format":"float","type":"number","x-nullable":true},"quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"unit_bonuses_redeemed_amount":{"description":"Item unit bonus points redeemed calculated by check","format":"float","type":"number","x-nullable":true}},"type":"object"},"RuleImplementationData":{"properties":{"calculated_result":{"$ref":"#/definitions/RuleImplementationResultData","description":"Rule calculated result (optional)","x-nullable":true},"coupon":{"$ref":"#/definitions/CheckCoupon","description":"Redeemed coupon that fires the rule (optional, only for implemented by 'coupon')","x-nullable":true},"dependencies_time_zone":{"$ref":"#/definitions/LoyaltyRuleDependsTimeZone","x-nullable":true},"dependencies_time_zone_value":{"type":"string","x-nullable":true},"depends_amount":{"description":"Amount/value, according to the rule dependency type, on which the rule was triggered (optional)","format":"float","type":"number","x-nullable":true},"depends_calc_period":{"$ref":"#/definitions/LoyaltyRuleDependsCalcPeriod","x-nullable":true},"depends_type":{"$ref":"#/definitions/LoyaltyRuleDependsType","description":"Rule dependency type value (optional)","x-nullable":true},"depends_user_category_id":{"description":"Customer category ID, according to the rule dependency type, on which the rule was triggered (optional)","format":"uuid","type":"string","x-nullable":true},"depends_user_category_valid_from":{"description":"Customer category valid from date and time, according to the rule dependency type, on which the rule was triggered (optional)","format":"datetime","type":"string","x-nullable":true},"implemented_by":{"$ref":"#/definitions/LoyaltyRuleImplementedBy","description":"Implemented by","x-nullable":true},"implemented_calculation_type":{"$ref":"#/definitions/LoyaltyRuleImplementedCalculationType","description":"Rules calculation and implementation type","x-nullable":true},"result":{"$ref":"#/definitions/RuleImplementationResultData","description":"Rule implemented result","x-nullable":true}},"type":"object"},"RuleImplementationResultData":{"properties":{"bonuses_added":{"description":"Bonuses added (optional)","items":{"$ref":"#/definitions/BonusAdded"},"type":"array","x-nullable":true},"calculation_base":{"$ref":"#/definitions/RuleCalculationBaseData","description":"Calculation base data","x-nullable":true},"discount":{"description":"Discount amount (optional)","format":"float","type":"number","x-nullable":true},"emitted_coupons":{"description":"Emitted coupons (optional)","items":{"$ref":"#/definitions/CheckCoupon"},"type":"array","x-nullable":true},"error":{"description":"Implementation error (optional)","type":"string","x-nullable":true},"error_code":{"description":"Implementation error code (optional)","format":"int32","type":"integer","x-nullable":true},"items":{"description":"Result by items (optional)","items":{"$ref":"#/definitions/RuleImplementationResultItemData"},"type":"array","x-nullable":true},"special_accounts_charges":{"description":"Special account charges (optional)","items":{"$ref":"#/definitions/SpecialAccountCharge"},"type":"array","x-nullable":true}},"type":"object"},"RuleImplementationResultItemData":{"properties":{"amount":{"description":"Rule amount for item row","format":"float","type":"number","x-nullable":true},"calculation_base":{"$ref":"#/definitions/RuleCalculationBaseItemData","description":"Calculation base data","x-nullable":true},"unit_amount":{"description":"Rule amount for item unit row (optional)","format":"float","type":"number","x-nullable":true}},"type":"object"},"Settings":{"properties":{"application_settings":{"$ref":"#/definitions/TerminalApplicationSettings","description":"Settings for application (optional)","x-nullable":true},"begin_work_with_customer_select":{"description":"Start work in the Register by customer identification","enum":[0,1],"type":"integer","x-nullable":true},"business_code":{"description":"Business code","type":"string","x-nullable":true},"currency":{"description":"Currensy ISO code","type":"string","x-nullable":true},"customer_additional_card_scope":{"description":"Default scope of customers cards","enum":["business","loyalty"],"type":"string","x-nullable":true},"customer_feedback_settings":{"$ref":"#/definitions/CustomerFeedbackSettings","x-nullable":true},"display_active":{"description":"Terminal has active display","enum":[0,1],"type":"integer","x-nullable":true},"display_type":{"description":"Display type","enum":["customer-identity","gift-redeem","login-pad","steward"],"type":"string","x-nullable":true},"equipment":{"description":"Terminal support equipment processing","type":"boolean","x-nullable":true},"events_status_send_period":{"description":"send last event status period in seconds (if zero - only on application events)","format":"int16","type":"integer","x-nullable":true},"external_devices_settings":{"$ref":"#/definitions/TerminalExternalDevicesSettings","description":"External devices settings connected to the terminal","x-nullable":true},"external_id":{"description":"Terminal External ID (up to 128 symbols)","type":"string","x-nullable":true},"fuel":{"description":"Terminal support fuel processing","type":"boolean","x-nullable":true},"goods_preset_recommnded_values_only":{"description":"Only preset recommended values allowed","enum":[0,1],"type":"integer","x-nullable":true},"id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"login":{"description":"Terminal login","type":"string","x-nullable":true},"loyalty":{"$ref":"#/definitions/Loyalty","x-nullable":true},"loyalty_settings":{"$ref":"#/definitions/LoyaltySettings","x-nullable":true},"mobileapp_payment_allowed":{"description":"MobileApp payment allowed for Terminal","type":"boolean","x-nullable":true},"mobileapp_payment_for_anonym_transactions_allowed":{"description":"MobileApp payment allowed for anonym transaction/check","type":"boolean","x-nullable":true},"mobileapp_payment_settings":{"$ref":"#/definitions/MobileAppPaymentSettingsList","description":"MobileApp payment settings","x-nullable":true},"phone":{"description":"Terminal phone","type":"string","x-nullable":true},"pos":{"$ref":"#/definitions/Pos","x-nullable":true},"poster_settings":{"$ref":"#/definitions/TerminalPosterSettings","description":"Settings for Poster (optional)","x-nullable":true},"price_group_settings":{"$ref":"#/definitions/PriceGroupSettings","x-nullable":true},"screensaver_settings":{"$ref":"#/definitions/TerminalScreensaverSettings","description":"Settings for screensaver (optional)","x-nullable":true},"staff_sign_in_required":{"description":"Terminal required staff sign in for work","enum":[0,1],"type":"integer","x-nullable":true},"system_params":{"$ref":"#/definitions/SystemParams","x-nullable":true},"title":{"description":"Terminal title","type":"string","x-nullable":true},"token":{"description":"Token for next authorization requests (optional, only for /token request)","type":"string"},"type":{"$ref":"#/definitions/TerminalType","description":"Terminal type","x-nullable":true},"user_consent_required":{"description":"Customer consent required for working","type":"boolean","x-nullable":true},"user_qrcode_settings":{"$ref":"#/definitions/UserQrCodeSettings","description":"User QR-code settings (readonly)","x-nullable":true},"vehicle_fuel_settings":{"$ref":"#/definitions/TerminalVehicleFuelSettings","description":"Settings for vehicles and refuels (readonly)","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"},"SpecialAccountsList":{"items":{"$ref":"#/definitions/SpecialAccount"},"type":"array"},"StringValuesList":{"items":{"description":"Value","type":"string"},"type":"array"},"StripeIntegrationTypes":{"items":{"enum":["checkout","elements"],"type":"string"},"type":"array"},"SystemParams":{"properties":{"allow_customers_list_sort":{"description":"Platform allow customers list sort","type":"boolean"},"allow_messages_to_external_system":{"description":"Platform allow send messages to external system by External ID","type":"boolean"},"default_check_amount_decimal_digits":{"description":"Platform default check amount decimal digits","type":"integer"},"default_check_bonuses_decimal_digits":{"description":"Platform default check bonuses decimal digits","type":"integer"},"default_check_special_accounts_decimal_digits":{"description":"Platform default check special accounts decimal digits","type":"integer"},"default_item_amount_decimal_digits":{"description":"Platform default item amount decimal digits","type":"integer"},"default_item_bonuses_decimal_digits":{"description":"Platform default item bonuses decimal digits","type":"integer"},"default_item_price_decimal_digits":{"description":"Platform default item price decimal digits","type":"integer"},"default_item_special_accounts_decimal_digits":{"description":"Platform default item special accounts decimal digits","type":"integer"},"maximum_check_amount_decimal_digits":{"description":"Platform maximum check amount decimal digits","type":"integer"},"maximum_check_bonuses_decimal_digits":{"description":"Platform maximum check bonuses decimal digits","type":"integer"},"maximum_check_special_accounts_decimal_digits":{"description":"Platform maximum check special accounts decimal digits","type":"integer"},"maximum_item_amount_decimal_digits":{"description":"Platform maximum item amount decimal digits","type":"integer"},"maximum_item_bonuses_decimal_digits":{"description":"Platform maximum item bonuses decimal digits","type":"integer"},"maximum_item_price_decimal_digits":{"description":"Platform maximum item price decimal digits","type":"integer"},"maximum_item_special_accounts_decimal_digits":{"description":"Platform maximum item special accounts decimal digits","type":"integer"},"privacy_policy_url":{"description":"Privacy Policy URL","type":"string"},"support_external_id_primary_identifier":{"description":"External ID support","type":"boolean"},"terms_of_service_url":{"description":"Terms of Service URL","type":"string"}},"type":"object"},"Tank":{"properties":{"active":{"default":1,"description":"Tank is active flag","enum":[0,1],"type":"integer"},"address":{"description":"Title","type":"string","x-nullable":true},"code":{"description":"Tank unique code","type":"string","x-nullable":true},"corporate_customer":{"$ref":"#/definitions/CorporateCustomerCardInfo","description":"Corporate Customer CardInfo object (optional)","x-nullable":true},"customer":{"$ref":"#/definitions/CardInfo","description":"Customer CardInfo object (optional)","x-nullable":true},"goods":{"$ref":"#/definitions/Goods","description":"Linked Goods Item Info (optional)"},"goods_code":{"description":"Linked product code (optional, only for linked tank data)","type":"string","x-nullable":true},"id":{"description":"Tank id","format":"uuid","type":"string","x-nullable":true},"latitude":{"description":"Latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"linked":{"description":"Tank linked with Business flag","type":"boolean"},"longitude":{"description":"Longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"owner_email":{"description":"Tank owner email (User, Corporate User depends on owner_type)","type":"string"},"owner_external_id":{"description":"Tank owner external Id (User, Corporate User depends on owner_type)","type":"string"},"owner_id":{"description":"Tank owner Id (User, Corporate User depends on owner_type)","format":"uuid","type":"string"},"owner_name":{"description":"Tank owner name (User, Corporate User depends on owner_type)","type":"string"},"owner_phone":{"description":"Tank owner phone (User, Corporate User depends on owner_type)","type":"string"},"owner_type":{"description":"Tank owner type","enum":["customer","corporate-customer"],"type":"string"},"product_title":{"description":"Product title (for information only)","type":"string","x-nullable":true},"product_volume":{"description":"Current product volume","format":"float","type":"number","x-nullable":true},"title":{"description":"Title","type":"string","x-nullable":true},"ullage_volume":{"description":"Current product volume","format":"float","type":"number","x-nullable":true},"unit":{"description":"Measuring units","type":"string","x-nullable":true},"volume":{"description":"Tank volume","format":"float","type":"number","x-nullable":true}},"type":"object"},"TankConfiguration":{"properties":{"critical_high_product_alarm_height":{"description":"Critical high product height alarm, mm","type":"integer","x-nullable":true},"critical_low_product_alarm_height":{"description":"Critical low product height alarm, mm","type":"integer","x-nullable":true},"height":{"description":"Height, mm","type":"integer","x-nullable":true},"high_product_alarm_height":{"description":"High product height alarm, mm","type":"integer","x-nullable":true},"high_water_alarm_height":{"description":"High water alarm height, mm","type":"integer","x-nullable":true},"low_product_alarm_height":{"description":"Low product height alarm, mm","type":"integer","x-nullable":true}},"type":"object"},"TemporaryCode":{"properties":{"code":{"description":"Temporary code","type":"string"},"redeem_allowed":{"description":"Allowed redeem bonuses or special account flag","type":"boolean"}},"type":"object"},"TerminalApplicationSettings":{"type":"object"},"TerminalEventStatusCode":{"enum":["terminal-sign-in-awaiting","staff-sign-in-awaiting","customer-awaiting","customer-processing","refueling-started","refueling-finished","terminal-settings-processing","customer-tap-splashscreen","payment-process"],"type":"string"},"TerminalExternalAmpDevice":{"properties":{"connection_type":{"description":"Device connection type","enum":["local"],"type":"string"},"settings":{"description":"Device settings (depends on device type)","type":"object"},"type":{"description":"Device type","enum":["payment-terminal"],"type":"string"},"vendor_type":{"description":"Device vendor specific type","enum":["amp-6500"],"type":"string"}},"type":"object"},"TerminalExternalAmpSettings":{"properties":{"devices":{"items":{"$ref":"#/definitions/TerminalExternalAmpDevice"},"type":"array"}},"type":"object"},"TerminalExternalDevicesSettings":{"properties":{"amp":{"$ref":"#/definitions/TerminalExternalAmpSettings","description":"AMP devices connected to the terminal","x-nullable":true},"pax":{"$ref":"#/definitions/TerminalExternalPaxSettings","description":"AMP devices connected to the terminal","x-nullable":true},"stripe":{"$ref":"#/definitions/TerminalExternalStripeSettings","description":"Stripe readers connected to the terminal","x-nullable":true}},"type":"object"},"TerminalExternalPaxDevice":{"properties":{"connection_type":{"description":"Device connection type","enum":["local"],"type":"string"},"settings":{"description":"Device settings (depends on device type)","type":"object"}},"type":"object"},"TerminalExternalPaxSettings":{"properties":{"devices":{"items":{"$ref":"#/definitions/TerminalExternalPaxDevice"},"type":"array"},"ignore_duplicate_transactions":{"description":"Allow PAX terminal not check for duplicate, also it will override the local duplicate check (default true)","type":"boolean"},"send_entry_mode":{"description":"Send entry mode in AUTH requests (default true)","type":"boolean"},"send_fuel_amount":{"description":"Send the fuel amount (fleet goods) regardless of the payment amount (default false)","type":"boolean"},"zero_amount_auth":{"description":"Use AUTH with zero amount (default false)","type":"boolean"}},"type":"object"},"TerminalExternalStripeLocation":{"properties":{"address":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["line1","city","state","country","postal_code"],"type":"object","x-nullable":true},"id":{"description":"Location Id (readonly)","type":"string","x-nullable":true}},"required":["address"],"type":"object"},"TerminalExternalStripeReader":{"type":"object"},"TerminalExternalStripeSettings":{"properties":{"devices":{"items":{"$ref":"#/definitions/TerminalExternalStripeReader"},"type":"array"},"location":{"$ref":"#/definitions/TerminalExternalStripeLocation","x-nullable":true}},"type":"object"},"TerminalPosterSettings":{"type":"object"},"TerminalScreensaverSettings":{"properties":{"sources":{"description":"Screensavers list","items":{"$ref":"#/definitions/TerminalScreensaverSource"},"type":"array"}},"type":"object"},"TerminalScreensaverSource":{"properties":{"order":{"description":"Source order (non-negative)","type":"integer"},"show_time":{"description":"Show time (null or greater than zero)","type":"integer","x-nullable":true},"type":{"description":"Source type","enum":["youtube","image"],"type":"string"},"url":{"description":"Source url","type":"string","x-nullable":true}},"type":"object"},"TerminalStatus":{"properties":{"authorized":{"description":"Authenticate status","type":"boolean"},"external_id":{"description":"Terminal External ID if Terminal authenticated (up to 128 symbols)","type":"string","x-nullable":true},"id":{"description":"Terminal ID if Terminal authenticated","format":"uuid","type":"string","x-nullable":true},"staff":{"$ref":"#/definitions/BusinessStaff","description":"Business Staff if Staff authenticated","x-nullable":true}},"type":"object"},"TerminalTokenByPosterRequest":{"properties":{"account":{"description":"Poster Company Account","type":"string"},"application_id":{"description":"Poster Application ID","type":"string"},"client_number":{"description":"Poster Customer Number","type":"string"},"spot_id":{"description":"Poster Location Id","type":"integer"},"spot_tablet_id":{"description":"Poster Register Id","type":"integer"}},"required":["application_id","account","client_number","spot_id","spot_tablet_id"],"type":"object"},"TerminalTokenRequest":{"properties":{"login":{"description":"Terminal login","type":"string"},"password":{"description":"Terminal password","type":"string"}},"required":["login","password"],"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 (optional)","type":"integer"}},"type":"object"},"TourCardServiceUse":{"properties":{"card_id":{"description":"Tourist card ID","format":"uuid","type":"string"},"service_id":{"description":"Tourist card service ID","format":"uuid","type":"string"}},"required":["card_id","service_id"],"type":"object"},"Transaction":{"properties":{"amount":{"format":"double","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer"},"amount_to_pay":{"format":"double","type":"number"},"bonuses_added":{"format":"double","type":"number","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer"},"bonuses_on_account":{"format":"double","type":"number","x-nullable":true},"bonuses_redeemed":{"format":"double","type":"number","x-nullable":true},"business_staff_id":{"description":"Business Staff ID (optional)","format":"uuid","type":"string","x-nullable":true},"business_staff_name":{"description":"Business Staff name (optional)","type":"string","x-nullable":true},"cancel_allowed":{"description":"Is transaction cancelation allowed (optional, for authorize-payment transaction type only)","type":"boolean"},"cancellation_comment":{"description":"Comment","type":"string","x-nullable":true},"cancelled":{"enum":[0,1],"type":"integer"},"comment":{"description":"Comment","type":"string","x-nullable":true},"confirmation_comment":{"description":"Comment","type":"string","x-nullable":true},"corporate_customer_email":{"description":"Corporate customer email (optional)","type":"string","x-nullable":true},"corporate_customer_id":{"description":"Corporate customer ID (optional)","format":"uuid","type":"string","x-nullable":true},"corporate_customer_name":{"description":"Corporate customer name (optional)","type":"string","x-nullable":true},"corporate_customer_special_account_id":{"description":"Instance of corporate customer special account ID","format":"uuid","type":"string","x-nullable":true},"currency":{"description":"Currency ISO code (if transaction payment 'currency')","type":"string","x-nullable":true},"customer_special_account_id":{"description":"Instance of customer special account ID","format":"uuid","type":"string","x-nullable":true},"discount_amount":{"format":"double","type":"number","x-nullable":true},"errors":{"description":"Errors list (optional)","items":{"$ref":"#/definitions/TransactionErrors"},"type":"array","x-nullable":true},"finalize_allowed":{"description":"Is transaction finalization allowed (optional, for authorize-payment transaction type only)","type":"boolean"},"finalized":{"description":"Transaction UTC finalized date-time","format":"date-time","type":"string","x-nullable":true},"finalized_local":{"description":"Transaction local (by POS time zone) finalized date-time","format":"date-time","type":"string","x-nullable":true},"id":{"description":"Transaction ID","format":"uuid","type":"string"},"item_amount":{"description":"Goods item amount (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_amount_decimal_digits":{"description":"Number of decimal digits in amount value (for list with stock only)","type":"integer","x-nullable":true},"item_amount_inc_discount":{"description":"Goods item amount inclusive calculated discount (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (for list with stock only)","type":"integer","x-nullable":true},"item_calculated_bonuses_redeemed_amount":{"description":"Goods item total bonus points redeemed calculated by check (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_calculated_discount_amount":{"description":"Goods item total discount calculated by rules (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_calculated_price":{"description":"Goods item price calculated by rules (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_calculated_unit_discount_amount":{"description":"Goods item unit discount calculated by rules (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_category":{"description":"Goods item category (for list with stock only)","type":"string","x-nullable":true},"item_code":{"description":"Goods item code (for list with stock only)","type":"string","x-nullable":true},"item_discount_amount":{"description":"Goods item discount amount (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_id":{"description":"Transaction item unique identifier (for list with stock only)","type":"string","x-nullable":true},"item_price":{"description":"Goods item price (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_price_decimal_digits":{"description":"Number of decimal digits in price value (for list with stock only)","type":"integer","x-nullable":true},"item_quantity":{"description":"Goods item quantity (for list with stock only)","format":"double","type":"number","x-nullable":true},"item_special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value (for list with stock only)","type":"integer","x-nullable":true},"item_title":{"description":"Goods item title (for list with stock only)","type":"string","x-nullable":true},"item_unit":{"description":"Goods item measuring units (for list with stock only)","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title (optional)","type":"string","x-nullable":true},"online_store_order_id":{"description":"Online store order ID (optional)","format":"uuid","type":"string","x-nullable":true},"payment_type":{"$ref":"#/definitions/TransactionPaymentType","description":"Payment type"},"pos_title":{"description":"POS title (optional)","type":"string","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},"sc_bonuses_redeem":{"description":"Temporary code bonus points redeem allowed flag (optional)","enum":[0,1],"type":"integer","x-nullable":true},"sc_code":{"description":"Temporary code (optional)","type":"string","x-nullable":true},"sc_created":{"format":"Temporary code created UTC date-time (optional)","type":"string","x-nullable":true},"sc_terminal_external_id":{"description":"Temporary code terminal external Id (optional)","type":"string","x-nullable":true},"sc_terminal_id":{"description":"Temporary code terminal ID (optional)","format":"uuid","type":"string","x-nullable":true},"sc_terminal_login":{"description":"Temporary code terminal login (optional)","type":"string","x-nullable":true},"sc_terminal_phone":{"description":"Temporary code terminal phone (optional)","type":"string","x-nullable":true},"sc_terminal_title":{"description":"Temporary code terminal title (optional)","type":"string","x-nullable":true},"services_amount":{"format":"float","type":"number"},"shipping_amount":{"format":"double","type":"number"},"special_account_amount":{"format":"double","type":"number","x-nullable":true},"special_account_currency":{"description":"Special account currency ISO code","type":"string","x-nullable":true},"special_account_id":{"description":"Special account ID (if transaction payment in 'special-account', 'corporate-special-account-access', 'retail-special-account-access')","format":"uuid","type":"string","x-nullable":true},"special_account_title":{"description":"Special account title","type":"string","x-nullable":true},"special_account_type":{"$ref":"#/definitions/SpecialAccountType","description":"Special account type","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer"},"subtype":{"$ref":"#/definitions/TransactionSubType","description":"Transaction subtype (optional, readonly)","x-nullable":true},"summary_amount":{"description":"Sum of amount and shipping_amount and services_amount","format":"double","type":"number"},"terminal_external_id":{"description":"Terminal External Id (optional)","type":"string","x-nullable":true},"terminal_login":{"description":"Terminal login (optional)","type":"string","x-nullable":true},"terminal_phone":{"description":"Terminal phone (optional)","type":"string","x-nullable":true},"terminal_title":{"description":"Terminal title (optional)","type":"string","x-nullable":true},"terminal_transaction_cancel_allowed":{"description":"Access granted to the transaction cancel operation (optional, applicable for related terminals)","type":"boolean"},"terminal_transaction_finalize_allowed":{"description":"Access granted to the transaction finalize operation (optional, applicable for related terminals)","type":"boolean"},"terminal_transaction_info_allowed":{"description":"Access granted to the transaction info (optional, applicable for related terminals)","type":"boolean"},"terminal_transaction_receipt_allowed":{"description":"Access granted to the transaction receipt info (optional, applicable for related terminals)","type":"boolean"},"transaction_id":{"description":"Referenced transaction ID","format":"uuid","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/TransactionType","description":"Transaction type"},"user_email":{"description":"User email (optional)","type":"string","x-nullable":true},"user_external_id":{"description":"User external id (optional)","type":"string","x-nullable":true},"user_id":{"description":"User ID (optional)","format":"uuid","type":"string","x-nullable":true},"user_name":{"description":"User name (optional)","type":"string","x-nullable":true},"user_phone":{"description":"User phone number (optional)","type":"string","x-nullable":true}},"type":"object"},"TransactionErrors":{"properties":{"code":{"description":"Error code","type":"string"},"level":{"description":"Error level","enum":["warning","error"],"type":"string"},"message":{"description":"Error message","type":"string"},"type":{"description":"Error type","enum":["authorized-payment-capture","transaction-post-processing"],"type":"string"}},"type":"object"},"TransactionPaymentType":{"enum":["currency","special-account","corporate-special-account-access","retail-special-account-access"],"type":"string"},"TransactionReceipt":{"properties":{"check":{"$ref":"#/definitions/Check","description":"Transaction check (optional)"},"id":{"description":"Transaction ID","format":"uuid","type":"string","x-nullable":true},"lang":{"description":"language ISO code","type":"string","x-nullable":true},"legal_info":{"$ref":"#/definitions/ReceiptLegalInfo","description":"Business legal info (optional)"},"print_date":{"description":"Check print local (by POS time zone) date-time","format":"date-time","type":"string","x-nullable":true},"template":{"$ref":"#/definitions/TransactionReceiptTemplateType","description":"Receipt template","x-nullable":true},"transaction":{"$ref":"#/definitions/Transaction","description":"Transaction check (optional)"}},"type":"object"},"TransactionReceiptActions":{"properties":{"print_on_terminal":{"description":"Customer's receipt print on terminal (optional)","type":"boolean","x-nullable":true},"send_to_customer":{"$ref":"#/definitions/TransactionReceiptSendTo","description":"Customer's receipt send to (optional)","x-nullable":true}},"type":"object"},"TransactionReceiptList":{"items":{"$ref":"#/definitions/TransactionReceipt"},"type":"array"},"TransactionReceiptSendTo":{"items":{"description":"email","type":"string"},"type":"array"},"TransactionReceiptTemplateType":{"enum":["business","customer","commercial"],"type":"string"},"TransactionSubType":{"enum":["sale","special-account-refill","special-account-refill-direct","special-account-refill-by-customer","special-account-write-offs-direct","special-account-write-offs-loan","special-account-write-offs-scheduled"],"type":"string"},"TransactionType":{"enum":["reserve","presale","sale","cancel","redeem-giftcard","bonus-add","special-account-refill","coupon-sale","authorize-payment","bonus-write-offs","special-account-write-offs"],"type":"string"},"TransactionsList":{"items":{"$ref":"#/definitions/Transaction"},"type":"array"},"TransactionsPaginatedList":{"properties":{"data":{"$ref":"#/definitions/TransactionsList"},"summary":{"$ref":"#/definitions/TransactionsSummary"}},"type":"object"},"TransactionsSummary":{"properties":{"total_rows_count":{"type":"integer"}},"type":"object"},"UserAddIdentifier":{"properties":{"added":{"description":"Result status (optional, readonly)","type":"boolean","x-nullable":true},"code":{"description":"Identity code","type":"string"},"error":{"description":"Error message (optional, readonly)","type":"string","x-nullable":true},"id":{"description":"Identifier Id (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"scope":{"description":"Identifier scope (optional, for 'card' type only)","enum":["all","business","loyalty"],"type":"string"},"type":{"$ref":"#/definitions/IdType"}},"required":["code","type"],"type":"object"},"UserAddIdentifiers":{"description":"User identification for add list","items":{"$ref":"#/definitions/UserAddIdentifier"},"type":"array"},"UserDeleteIdentifier":{"properties":{"code":{"description":"Identity code (optional)","type":"string"},"deleted":{"description":"Result status (optional, readonly)","type":"boolean","x-nullable":true},"error":{"description":"Error message (optional, readonly)","type":"string","x-nullable":true},"id":{"description":"Identifier Id","format":"uuid","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/IdType"}},"required":["id","type"],"type":"object"},"UserDeleteIdentifiers":{"description":"User identification for delete list","items":{"$ref":"#/definitions/UserDeleteIdentifier"},"type":"array"},"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"},"UserIdentifier":{"properties":{"code":{"description":"Identity code","type":"string"},"id":{"description":"Identifier Id (optional)","format":"uuid","type":"string","x-nullable":true},"scope":{"description":"Identifier scope (optional, for 'card' type only)","enum":["all","business","loyalty"],"type":"string"},"type":{"$ref":"#/definitions/IdType"}},"type":"object"},"UserIdentifiers":{"description":"User identification data list","items":{"$ref":"#/definitions/UserIdentifier"},"type":"array"},"UserQrCodeLegacies":{"items":{"$ref":"#/definitions/UserQrCodeLegacy"},"type":"array"},"UserQrCodeLegacy":{"properties":{"code_regex":{"description":"User QR code regex (readonly)","type":"string"},"version":{"description":"Current version of user QR code (readonly)","type":"integer","x-nullable":true}},"type":"object"},"UserQrCodeSettings":{"properties":{"code_regex":{"description":"User QR code regex (readonly)","type":"string"},"legacy":{"$ref":"#/definitions/UserQrCodeLegacies","description":"QR code legacy info (readonly)","x-nullable":true},"version":{"description":"Current version of user QR code (readonly)","type":"integer","x-nullable":true},"version_regex":{"description":"Version of user QR code regex (readonly)","type":"string"}},"type":"object"},"UserShipToAddress":{"properties":{"address":{"description":"Address string","type":"string"},"first_name":{"description":"First name","type":"string"},"id":{"description":"Address ID","format":"uuid","type":"string"},"last_name":{"description":"Last name","type":"string"},"phone":{"description":"Phone number","type":"string"}},"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 terminal application  \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`external`: \texternal application and systems which itegrated with inCust API\n\n### X-Application-Latitude HTTP Header\nAll requests may contain a header **X-Application-Latitude**.  \nThis header contain Latitude (part of GEO Location) in decimal degrees (DD) received by Application.  \n\n### X-Application-Longitude HTTP Header\nAll requests may contain a header **X-Application-Longitude**.  \nThis header contain Longitude (part of GEO Location) in decimal degrees (DD) received by Application.  \n","title":"inCust terminal API","version":"1.0"},"paths":{"/adjust_benefits":{"post":{"description":"Adjust (refill or write-off) benefits points on the customers account - DEPRECATED","operationId":"incust.controllers.term.api.adjust_benefits","parameters":[{"description":"Charged data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBenefitsAdjustOperationData"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/authorize_payment_check":{"post":{"description":"Make authorize payment type transaction","operationId":"incust.controllers.term.api.authorize_payment_check","parameters":[{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount","amount_to_pay"]}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/authorize_payment_check/{transaction_id}/capture":{"post":{"description":"Capture previously made authorize payment type transaction","operationId":"incust.controllers.term.api.authorize_payment_check_capture","parameters":[{"description":"Transaction Id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount","amount_to_pay"]}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/authorize_payment_check/{transaction_id}/prepare_check/{calculation_type}":{"get":{"description":"Prepare previously made authorize payment check data, modify check - recalculate by selected type","operationId":"incust.controllers.term.api.terminal_authorize_payment_prepare_check","parameters":[{"description":"Transaction Id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Prepare check recalculate type","enum":["by-job-processed-amount","adjust-by-authorized-amount","by-authorized-check"],"in":"path","name":"calculation_type","required":true,"type":"string"}],"responses":{"200":{"description":"Check object","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/authorize_payment_check/{transaction_id}/process_check/{rules_type}":{"post":{"description":"Process previously made authorize payment check data, modify check - implement loyalty rules by selected type","operationId":"incust.controllers.term.api.terminal_authorize_payment_process_check","parameters":[{"description":"Transaction Id","format":"uuid","in":"path","name":"transaction_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 & Transactions"]}},"/business/goods":{"get":{"description":"Return list of goods in Business","operationId":"incust.controllers.term.api.term_business_goods","parameters":[{"description":"Expression","in":"query","name":"search_text","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"]}},"/cancel_check":{"get":{"description":"Cancel check object","operationId":"incust.controllers.term.api.cancel_check","responses":{"200":{"description":"OK","schema":{"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Display"]}},"/card_categories":{"get":{"description":"Return available customer card categories list","operationId":"incust.controllers.term.api.card_categories","responses":{"200":{"description":"Array of card categories","schema":{"$ref":"#/definitions/CardCategoriesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"]}},"/cardinfo":{"get":{"description":"Return info by user card (phone)","operationId":"incust.controllers.term.api.cardinfo","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"User card info","schema":{"$ref":"#/definitions/CardInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/cardinfo/{user_id_value}":{"get":{"description":"Return info by user card (phone) - DEPRECATED","operationId":"incust.controllers.term.api.cardinfo_simple","parameters":[{"description":"User phone number. Minimum 3 chars","in":"path","name":"user_id_value","required":true,"type":"string"}],"responses":{"200":{"description":"User card info","schema":{"$ref":"#/definitions/CardInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/cardinfo/{user_id_value}/{user_id_type}":{"get":{"description":"Return info by user card (phone) - DEPRECATED","operationId":"incust.controllers.term.api.cardinfo_ex","parameters":[{"description":"User phone number. Minimum 3 chars","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"}],"responses":{"200":{"description":"User card info","schema":{"$ref":"#/definitions/CardInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/categories":{"get":{"description":"Return goods categories as tree for POS processing","operationId":"incust.controllers.term.api.categories","responses":{"200":{"description":"Card categories data","schema":{"items":{"$ref":"#/definitions/GoodsCategory"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"]}},"/charge_benefits":{"post":{"description":"Add benefits points to the customers account - DEPRECATED","operationId":"incust.controllers.term.api.charge_benefits","parameters":[{"description":"Top Up data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBenefitsTopUpOperationData"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/close_check":{"get":{"description":"Close check object","operationId":"incust.controllers.term.api.close_check","responses":{"200":{"description":"OK","schema":{"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Display"]}},"/confirm_check":{"post":{"description":"Make transaction by check data","operationId":"incust.controllers.term.api.confirm_check","parameters":[{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount"]}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/coupons/batch/{code}/emission":{"get":{"description":"Coupon emission and return emitted coupons list","operationId":"incust.controllers.term.api.terminal_coupon_emission","parameters":[{"description":"Coupon batch CODE.","in":"path","name":"code","required":true,"type":"string"},{"default":1,"description":"Count of coupons for emission","in":"query","name":"count","required":false,"type":"integer"}],"responses":{"200":{"description":"Coupons array","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/coupon/get":{"post":{"description":"Return coupon object found by id, code or external code","operationId":"incust.controllers.term.api.terminal_coupon_get","parameters":[{"description":"Coupon codes object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CouponRequest","description":"Coupon code"}}],"responses":{"200":{"description":"Array of found coupons object","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/redeem":{"post":{"description":"Return list coupon object","operationId":"incust.controllers.term.api.coupon_redeem_wo_user","parameters":[{"description":"Array of coupon object","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}}],"responses":{"200":{"description":"Array of redeemed coupons object","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/user":{"get":{"description":"Return list of customers coupons","operationId":"incust.controllers.term.api.customer_coupons","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Array of coupon object","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/user/add":{"post":{"description":"Return list of added coupon object","operationId":"incust.controllers.term.api.customer_coupon_add","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Array of coupon codes object","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/CouponCode"},"type":"array"}}],"responses":{"200":{"description":"Array of added coupons object","schema":{"$ref":"#/definitions/CouponAddedResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/user/redeem":{"post":{"description":"Return list coupon object","operationId":"incust.controllers.term.api.customer_coupon_redeem","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Array of coupon object","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}}],"responses":{"200":{"description":"Array of redeemed coupons object","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/{user_id_value}":{"get":{"description":"Return list of customers coupons - DEPRECATED","operationId":"incust.controllers.term.api.customer_coupons_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"}],"responses":{"200":{"description":"Array of coupon object","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/{user_id_value}/add":{"post":{"description":"Return list of added coupon object - DEPRECATED","operationId":"incust.controllers.term.api.customer_coupon_add_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Array of coupon codes object","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/CouponCode"},"type":"array"}}],"responses":{"200":{"description":"Array of added coupons object","schema":{"$ref":"#/definitions/CouponAddedResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/{user_id_value}/redeem":{"post":{"description":"Return list coupon object - DEPRECATED","operationId":"incust.controllers.term.api.customer_coupon_redeem_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Array of coupon object","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}}],"responses":{"200":{"description":"Array of redeemed coupons object","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/{user_id_value}/{user_id_type}":{"get":{"description":"Return list of customers coupons - DEPRECATED","operationId":"incust.controllers.term.api.customer_coupons_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"}],"responses":{"200":{"description":"Array of coupon object","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/{user_id_value}/{user_id_type}/add":{"post":{"description":"Return list of added coupon object - DEPRECATED","operationId":"incust.controllers.term.api.customer_coupon_add_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Array of coupon codes object","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/CouponCode"},"type":"array"}}],"responses":{"200":{"description":"Array of added coupons object","schema":{"$ref":"#/definitions/CouponAddedResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/coupons/{user_id_value}/{user_id_type}/redeem":{"post":{"description":"Return list coupon object - DEPRECATED","operationId":"incust.controllers.term.api.customer_coupon_redeem_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Array of coupon object","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}}],"responses":{"200":{"description":"Array of redeemed coupons object","schema":{"items":{"$ref":"#/definitions/Coupon"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Coupons"]}},"/customer_fields":{"get":{"description":"Return available customer fields list","operationId":"incust.controllers.term.api.customer_fields","responses":{"200":{"description":"Array of fields","schema":{"$ref":"#/definitions/CustomerFieldsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"]}},"/customers":{"post":{"description":"Return list of customer info","operationId":"incust.controllers.term.api.customers_list","parameters":[{"description":"Array of identity parameters","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Customer"}}],"responses":{"200":{"description":"List of customer info","schema":{"items":{"$ref":"#/definitions/Customer"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/access_type":{"get":{"description":"Return access type for customer","operationId":"incust.controllers.term.api.customer_access_type_get","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Customer access type","schema":{"$ref":"#/definitions/CustomerAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Change access type for customer","operationId":"incust.controllers.term.api.customer_access_type_change","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Customer access type","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerAccess"}}],"responses":{"200":{"description":"Customer access type","schema":{"$ref":"#/definitions/CustomerAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/add":{"post":{"description":"Add user and customer","operationId":"incust.controllers.term.api.customer_add","parameters":[{"description":"Customer parameters","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Customer"}}],"responses":{"200":{"description":"List of customer info","schema":{"$ref":"#/definitions/Customer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/all/search":{"get":{"description":"Return list of customers (retail and corporate)","operationId":"incust.controllers.term.api.search_customers","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Customer's type filtering","enum":["all","customer","corporate-customer"],"in":"query","name":"customer_type","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (email, phone, name, external_id)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"title","description":"Sort field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Customer data object array","schema":{"properties":{"data":{"description":"Customer list","items":{"$ref":"#/definitions/AllTypeCustomer"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/benefits/accounts":{"get":{"description":"Return customer's accounts info","operationId":"incust.controllers.term.api.customer_benefits_special_accounts_general","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"User accounts info","schema":{"$ref":"#/definitions/CustomerSpecialAccounts"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/customers/benefits/accounts/{account_id}":{"get":{"description":"Return customer's account info","operationId":"incust.controllers.term.api.customer_benefits_special_account_info","parameters":[{"description":"Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"User account info","schema":{"$ref":"#/definitions/CustomerSpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/customers/benefits/adjust":{"post":{"description":"Adjust (refill or write-off) benefits points on the customers account","operationId":"incust.controllers.term.api.adjust_benefits_ex","parameters":[{"description":"Charged data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBenefitsAdjustOperationData"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/customers/benefits/bonuses":{"get":{"description":"Return customer's bonus points info","operationId":"incust.controllers.term.api.customer_benefits_bonuses_general","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"default":false,"description":"Return detailing available permanent bonuses","in":"query","name":"permanent_bonuses_detailing","required":false,"type":"boolean"},{"default":false,"description":"Return detailing available promotional bonuses","in":"query","name":"promotion_bonuses_detailing","required":false,"type":"boolean"},{"default":true,"description":"Return only activated (ready for use) bonuses in detailing","in":"query","name":"activated_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"User bonus points info","schema":{"$ref":"#/definitions/CustomerBonusesAccounts"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/customers/benefits/bonuses/{currency}":{"get":{"description":"Return customer's bonus points info for specified currency","operationId":"incust.controllers.term.api.customer_benefits_bonuses_by_currency","parameters":[{"description":"Currency ISO code","in":"path","name":"currency","required":true,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"default":false,"description":"Return detailing available permanent bonuses","in":"query","name":"permanent_bonuses_detailing","required":false,"type":"boolean"},{"default":false,"description":"Return detailing available promotional bonuses","in":"query","name":"promotion_bonuses_detailing","required":false,"type":"boolean"},{"default":true,"description":"Return only activated (ready for use) bonuses in detailing","in":"query","name":"activated_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"User bonus points info for currency","schema":{"$ref":"#/definitions/CustomerBonusesAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/customers/benefits/coupons":{"get":{"description":"Return customer's coupons info","operationId":"incust.controllers.term.api.customer_benefits_coupons_general","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"User coupons info","schema":{"$ref":"#/definitions/CustomerCoupons"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/customers/benefits/topup":{"post":{"description":"Add benefits points to the customers account","operationId":"incust.controllers.term.api.charge_benefits_ex","parameters":[{"description":"Top Up data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBenefitsTopUpOperationData"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/customers/benefits/write_off":{"post":{"description":"Write-off of benefits points from the customers account","operationId":"incust.controllers.term.api.write_off_benefits_ex","parameters":[{"description":"Write-offs data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBenefitsWriteOffOperationData"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}},"/customers/card_category":{"get":{"description":"Return card category for customer","operationId":"incust.controllers.term.api.customer_card_category_get","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Customer card category","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Change card category for customer","operationId":"incust.controllers.term.api.customer_card_category_change","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Customer card category","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CardCategory"}}],"responses":{"200":{"description":"Customer card category","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/consent":{"post":{"description":"Set customer consent data (if no confirmation code in data for pin or email types automaically sent confirmation code to user)","operationId":"incust.controllers.term.api.customer_consent","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Consent information","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ConsentConfirmation"}}],"responses":{"200":{"description":"User consent data","schema":{"$ref":"#/definitions/ConsentInfo"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/identification":{"delete":{"description":"Delete identifiers for customer","operationId":"incust.controllers.term.api.customer_identification_delete","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Customer identifiers IDs","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserDeleteIdentifiers"}}],"responses":{"200":{"description":"List of deleted customers identifiers","schema":{"$ref":"#/definitions/UserDeleteIdentifiers"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"get":{"description":"Return customer identification info","operationId":"incust.controllers.term.api.customer_identification_get","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Customer info","schema":{"$ref":"#/definitions/Customer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"post":{"description":"Add identifiers for customer","operationId":"incust.controllers.term.api.customer_identification_add","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Customer identifiers","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserAddIdentifiers"}}],"responses":{"200":{"description":"List of customer info","schema":{"$ref":"#/definitions/UserAddIdentifiers"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/access_type":{"get":{"description":"Return access type for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_access_type_get_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"}],"responses":{"200":{"description":"Customer access type","schema":{"$ref":"#/definitions/CustomerAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Change access type for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_access_type_change_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Customer access type","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerAccess"}}],"responses":{"200":{"description":"Customer access type","schema":{"$ref":"#/definitions/CustomerAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/card_category":{"get":{"description":"Return card category for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_card_category_get_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"}],"responses":{"200":{"description":"Customer card category","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Change card category for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_card_category_change_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Customer card category","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CardCategory"}}],"responses":{"200":{"description":"Customer card category","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/consent":{"post":{"description":"Set customer consent data (if no confirmation code in data for pin or email types automaically sent confirmation code to user) - DEPRECATED","operationId":"incust.controllers.term.api.customer_consent_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Consent information","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ConsentConfirmation"}}],"responses":{"200":{"description":"User consent data","schema":{"$ref":"#/definitions/ConsentInfo"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/identification":{"get":{"description":"Return customer identification info - DEPRECATED","operationId":"incust.controllers.term.api.customer_identification_get_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"}],"responses":{"200":{"description":"Customer info","schema":{"$ref":"#/definitions/Customer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"post":{"description":"Add identifiers for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_identification_add_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Customer identifiers","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserAddIdentifiers"}}],"responses":{"200":{"description":"List of customer info","schema":{"$ref":"#/definitions/UserAddIdentifiers"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/identification/delete":{"post":{"description":"Delete identifiers for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_identification_delete_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Customer identifiers IDs","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserDeleteIdentifiers"}}],"responses":{"200":{"description":"List of customer info","schema":{"$ref":"#/definitions/UserDeleteIdentifiers"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/{user_id_type}/access_type":{"get":{"description":"Return access type for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_access_type_get_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"}],"responses":{"200":{"description":"Customer access type","schema":{"$ref":"#/definitions/CustomerAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Change access type for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_access_type_change_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Customer access type","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerAccess"}}],"responses":{"200":{"description":"Customer access type","schema":{"$ref":"#/definitions/CustomerAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/{user_id_type}/card_category":{"get":{"description":"Return card category for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_card_category_get_ex","parameters":[{"description":"User identifier","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"}],"responses":{"200":{"description":"Customer card category","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Change card category for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_card_category_change_ex","parameters":[{"description":"User identifier","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Customer card category","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CardCategory"}}],"responses":{"200":{"description":"Customer card category","schema":{"$ref":"#/definitions/CardCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/{user_id_type}/consent":{"post":{"description":"Set customer consent data (if no confirmation code in data for pin or email types automaically sent confirmation code to user) - DEPRECATED","operationId":"incust.controllers.term.api.customer_consent_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Consent information","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ConsentConfirmation"}}],"responses":{"200":{"description":"User consent data","schema":{"$ref":"#/definitions/ConsentInfo"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/{user_id_type}/identification":{"get":{"description":"Return customer identification info - DEPRECATED","operationId":"incust.controllers.term.api.customer_identification_get_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"}],"responses":{"200":{"description":"Customer info","schema":{"$ref":"#/definitions/Customer"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"post":{"description":"Add identifiers for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_identification_add_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Customer identifiers","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserAddIdentifiers"}}],"responses":{"200":{"description":"List of customer info","schema":{"$ref":"#/definitions/UserAddIdentifiers"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/customers/{user_id_value}/{user_id_type}/identification/delete":{"post":{"description":"Delete identifiers for customer - DEPRECATED","operationId":"incust.controllers.term.api.customer_identification_delete_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Customer identifiers IDs","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserDeleteIdentifiers"}}],"responses":{"200":{"description":"List of customer info","schema":{"$ref":"#/definitions/UserDeleteIdentifiers"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/display_customer":{"get":{"description":"Return current display customer info","operationId":"incust.controllers.term.api.display_customer","responses":{"200":{"description":"Customer identification info","schema":{"items":{"$ref":"#/definitions/DisplayCustomer"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Display"]}},"/equipment":{"get":{"description":"Return equipments info","operationId":"incust.controllers.term.api.equipment_general_info","parameters":[{"default":false,"description":"Return equipments info without info about jobs","in":"query","name":"exclude_equipment_jobs","required":false,"type":"boolean"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate Customer Id","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Equipment objects array","schema":{"$ref":"#/definitions/EquipmentRecList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/equipment/jobs/current":{"get":{"description":"Return equipment controller current jobs list","operationId":"incust.controllers.term.api.equipment_jobs_current_get","parameters":[{"description":"Equipment ID","format":"uuid","in":"query","name":"equipment_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/equipment/jobs/pending":{"get":{"description":"Return equipment controller pending jobs list","operationId":"incust.controllers.term.api.equipment_jobs_pending_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Equipment ID","format":"uuid","in":"query","name":"equipment_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/equipment/jobs/recent/finalize_failed":{"get":{"description":"Return equipment controller recent finalize failed jobs list","operationId":"incust.controllers.term.api.equipment_jobs_recent_finalize_failed_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Equipment ID","format":"uuid","in":"query","name":"equipment_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/equipment/jobs/recent/finalized":{"get":{"description":"Return equipment controller recent finalized jobs list","operationId":"incust.controllers.term.api.equipment_jobs_recent_finalized_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Equipment ID","format":"uuid","in":"query","name":"equipment_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/equipment/jobs/recent/not_processed":{"get":{"description":"Return equipment controller recent not processed jobs list","operationId":"incust.controllers.term.api.equipment_jobs_recent_not_processed_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Equipment ID","format":"uuid","in":"query","name":"equipment_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/equipment/jobs/recent/processed":{"get":{"description":"Return equipment controller recent processed but not finalized jobs list","operationId":"incust.controllers.term.api.equipment_jobs_recent_processed_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Equipment ID","format":"uuid","in":"query","name":"equipment_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/equipment/transactions/recent":{"get":{"description":"Return equipment controller recent finalized jobs transactions list","operationId":"incust.controllers.term.api.equipment_transactions_recent_finalized_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Equipment ID","format":"uuid","in":"query","name":"equipment_id","required":false,"type":"string"}],"responses":{"200":{"description":"Transactions data","schema":{"$ref":"#/definitions/TransactionsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/equipment/{equipment_id}/transactions/last":{"get":{"description":"Return equipment last transaction info","operationId":"incust.controllers.term.api.equipment_transaction_last_get","parameters":[{"description":"Equipment ID","format":"uuid","in":"path","name":"equipment_id","required":true,"type":"string"}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Equipment"]}},"/events/status":{"post":{"description":"Set new event status","operationId":"incust.controllers.term.api.events_status_set","parameters":[{"description":"Event status data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/EventStatus"}}],"responses":{"200":{"description":"Event status data","schema":{"$ref":"#/definitions/EventStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Events Status"]}},"/external_forms/{external_form_id}/user":{"get":{"description":"Return external form template (prefilled or no) for user","operationId":"incust.controllers.term.api.external_form_for_user_get","parameters":[{"description":"External form Id","format":"uuid","in":"path","name":"external_form_id","required":true,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"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.term.api.external_form_for_user_add","parameters":[{"description":"External form Id","format":"uuid","in":"path","name":"external_form_id","required":true,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"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"]}},"/finalize_check":{"post":{"description":"Finalize transaction made in write_check or reserve_check methods","operationId":"incust.controllers.term.api.finalize_check","parameters":[{"description":"Transaction object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/FinalizeCheck"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/fuel":{"get":{"description":"Return fuel controller and pumps info","operationId":"incust.controllers.term.api.fuel_general_info","parameters":[{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"},{"description":"Fuel pump nozzle ID","format":"uuid","in":"query","name":"nozzle_id","required":false,"type":"string"},{"default":true,"description":"Return controller and pumps info without info about nozzles that are not linked to the goods items","in":"query","name":"exclude_nozzles_without_goods_item","required":false,"type":"boolean"},{"default":false,"description":"Return lite portion of controller and pumps info (without info about goods)","in":"query","name":"lite","required":false,"type":"boolean"},{"default":false,"description":"Return controller and pumps info without info about pump jobs","in":"query","name":"exclude_pump_jobs","required":false,"type":"boolean"},{"default":false,"description":"Return controller and pumps info without info about pump finalized jobs","in":"query","name":"exclude_pump_finalized_jobs","required":false,"type":"boolean"},{"default":false,"description":"Return controller and pumps info without info about pump finalize failed jobs","in":"query","name":"exclude_pump_finalize_failed_jobs","required":false,"type":"boolean"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate Customer Id","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true},{"default":true,"description":"Return available prices by scope (not only base) in fuel info","in":"query","name":"prices_values","required":false,"type":"boolean"},{"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":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":"Fuel object","schema":{"$ref":"#/definitions/FuelRec"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/controller":{"get":{"description":"Return fuel controller info","operationId":"incust.controllers.term.api.fuel_controller_info","parameters":[{"default":false,"description":"Return actual GPS data","in":"query","name":"gps_data","required":false,"type":"boolean"},{"default":false,"description":"Return tanks data","in":"query","name":"tanks","required":false,"type":"boolean"},{"default":false,"description":"Return grades data","in":"query","name":"grades","required":false,"type":"boolean"},{"default":false,"description":"Return pumps data","in":"query","name":"pumps","required":false,"type":"boolean"},{"default":false,"description":"Return nozzles data","in":"query","name":"nozzles","required":false,"type":"boolean"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/controller/nozzles/{nozzle_id}/grade":{"delete":{"description":"Remove grade for pump nozzle","operationId":"incust.controllers.term.api.fuel_controller_nozzle_grade_delete","parameters":[{"description":"Fuel pump nozzle ID","format":"uuid","in":"path","name":"nozzle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]},"post":{"description":"Set grade for pump nozzle","operationId":"incust.controllers.term.api.fuel_controller_nozzle_grade_set","parameters":[{"description":"Fuel pump nozzle ID","format":"uuid","in":"path","name":"nozzle_id","required":true,"type":"string"},{"description":"Grade data","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Grade ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/controller/nozzles/{nozzle_id}/tank":{"delete":{"description":"Remove tank for pump nozzle","operationId":"incust.controllers.term.api.fuel_controller_nozzle_tank_delete","parameters":[{"description":"Fuel pump nozzle ID","format":"uuid","in":"path","name":"nozzle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]},"post":{"description":"Set tank for pump nozzle","operationId":"incust.controllers.term.api.fuel_controller_nozzle_tank_set","parameters":[{"description":"Fuel pump nozzle ID","format":"uuid","in":"path","name":"nozzle_id","required":true,"type":"string"},{"description":"Grade data","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Tank ID","format":"uuid","type":"string"},"set_grade_by_tank":{"default":false,"description":"Set pump nozzle Grade by Tank Grade","type":"boolean"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/controller/tanks/{tank_id}/grade":{"delete":{"description":"Remove grade for fuel tank","operationId":"incust.controllers.term.api.fuel_controller_tank_grade_delete","parameters":[{"description":"Fuel tank ID","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]},"post":{"description":"Set grade for fuel tank","operationId":"incust.controllers.term.api.fuel_controller_tank_grade_set","parameters":[{"description":"Fuel tank ID","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"},{"description":"Grade data","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Grade ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"Fuel controller data","schema":{"$ref":"#/definitions/FuelController"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/jobs/current":{"get":{"description":"Return fuel controller current jobs list","operationId":"incust.controllers.term.api.fuel_jobs_current_get","parameters":[{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/jobs/pending":{"get":{"description":"Return fuel controller pending jobs list","operationId":"incust.controllers.term.api.fuel_jobs_pending_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/jobs/recent/finalize_failed":{"get":{"description":"Return fuel controller recent finalize failed jobs list","operationId":"incust.controllers.term.api.fuel_jobs_recent_finalize_failed_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/jobs/recent/finalized":{"get":{"description":"Return fuel controller recent finalized jobs list","operationId":"incust.controllers.term.api.fuel_jobs_recent_finalized_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/jobs/recent/not_processed":{"get":{"description":"Return fuel controller recent not processed jobs list","operationId":"incust.controllers.term.api.fuel_jobs_recent_not_processed_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/jobs/recent/processed":{"get":{"description":"Return fuel controller recent processed but not finalized jobs list","operationId":"incust.controllers.term.api.fuel_jobs_recent_processed_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Jobs count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"}],"responses":{"200":{"description":"Jobs data","schema":{"$ref":"#/definitions/JobsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/transactions/last":{"get":{"description":"Return fuel controller last transaction info","operationId":"incust.controllers.term.api.fuel_transaction_last_get","parameters":[{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"},{"description":"Fuel pump nozzle ID","format":"uuid","in":"query","name":"nozzle_id","required":false,"type":"string"}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/fuel/transactions/recent":{"get":{"description":"Return fuel controller recent finalized jobs transactions list","operationId":"incust.controllers.term.api.fuel_transactions_recent_finalized_get","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count per page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Fuel pump ID","format":"uuid","in":"query","name":"pump_id","required":false,"type":"string"}],"responses":{"200":{"description":"Transactions data","schema":{"$ref":"#/definitions/TransactionsPaginatedList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Fuel"]}},"/generate_temporary_code":{"get":{"description":"Generate temporary code like loginpad/stuward program","operationId":"incust.controllers.term.api.generate_temporary_code","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"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":["Temporary code"]}},"/generate_temporary_code/{user_id_value}":{"get":{"description":"Generate temporary code like loginpad/stuward program - DEPRECATED","operationId":"incust.controllers.term.api.generate_temporary_code_simple","parameters":[{"description":"User phone number. Minimum 3 chars","in":"path","name":"user_id_value","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":["Temporary code"]}},"/generate_temporary_code/{user_id_value}/{user_id_type}":{"get":{"description":"Generate temporary code like loginpad/stuard programm - DEPRECATED","operationId":"incust.controllers.term.api.generate_temporary_code_ex","parameters":[{"description":"User phone number. Minimum 3 chars","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","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":["Temporary code"]}},"/gift_cards/card/{code}":{"get":{"description":"Find Gift Card by code and return Gift Card info","operationId":"incust.controllers.term.api.terminal_gift_card_by_code","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":{"get":{"description":"Return list of goods for POS processing","operationId":"incust.controllers.term.api.goods","parameters":[{"default":10,"description":"Count limit","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Page number","in":"query","name":"page","required":false,"type":"integer"},{"description":"Page data rows number","in":"query","name":"count","required":false,"type":"integer"},{"default":true,"description":"Return only active goods items","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Category ID","in":"query","name":"category","required":false,"type":"string"},{"description":"Search string","in":"query","name":"search","required":false,"type":"string"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"},{"description":"Goods item (loyalty item) Id","format":"uuid","in":"query","name":"item_id","required":false,"type":"string","x-nullable":true},{"description":"Goods item (loyalty item) Code","in":"query","name":"item_code","required":false,"type":"string","x-nullable":true},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string","x-nullable":true},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Corporate Customer Id","format":"uuid","in":"query","name":"corporate_customer_id","required":false,"type":"string","x-nullable":true},{"default":1,"description":"Return fuel info (0/1)","enum":[0,1],"in":"query","name":"fuel_info","required":false,"type":"integer"},{"default":1,"description":"Return preconfigured values (0/1)","enum":[0,1],"in":"query","name":"preconfigured_values","required":false,"type":"integer"},{"default":1,"description":"Return additional images info (0/1)","enum":[0,1],"in":"query","name":"additional_images","required":false,"type":"integer"},{"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 objects data","schema":{"$ref":"#/definitions/Goods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"]}},"/goods/service_types":{"get":{"description":"Return list of available goods service types","operationId":"incust.controllers.term.api.goods_service_types","responses":{"200":{"description":"Service types data","schema":{"items":{"description":"Service type","properties":{"description":{"description":"type description","type":"string"},"type":{"description":"type identifier","type":"string"}},"type":"object"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Goods"]}},"/jobs":{"post":{"description":"Add job with or without transaction","operationId":"incust.controllers.term.api.job_add","parameters":[{"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/check/{transaction_id}":{"get":{"description":"Get transaction jobs list","operationId":"incust.controllers.term.api.transaction_jobs","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.term.api.transaction_job_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.term.api.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}/remove_from_recent":{"post":{"description":"Remove job from recent","operationId":"incust.controllers.term.api.job_remove_from_recent_set","parameters":[{"description":"Job ID","format":"uuid","in":"path","name":"job_id","required":true,"type":"string"},{"description":"Command details","in":"body","name":"data","required":false,"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}/start":{"post":{"description":"Job start","operationId":"incust.controllers.term.api.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.term.api.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"]}},"/jobs/{job_id}/transaction":{"post":{"description":"Set transaction for job","operationId":"incust.controllers.term.api.job_transaction_set","parameters":[{"description":"Job ID","format":"uuid","in":"path","name":"job_id","required":true,"type":"string"},{"description":"Transaction details","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Transaction Id","format":"uuid","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Job object","schema":{"$ref":"#/definitions/Job"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Jobs"]}},"/last_temporary_code":{"get":{"description":"Return last temporary code which generated by loginpad/stuard programm for this terminal","operationId":"incust.controllers.term.api.get_last_temporary_code","parameters":[{"default":5,"description":"Time periond for search generated temporary code","in":"query","name":"time_delta","required":false,"type":"integer"}],"responses":{"200":{"description":"Last generated temporary code","schema":{"properties":{"code":{"description":"Temporary code","type":"string"},"redeem_allowed":{"description":"Allowed redeem bonuses or special account flag","type":"boolean"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Temporary code"]}},"/loyalty/goods":{"get":{"description":"Return list of all goods in loyalty","operationId":"incust.controllers.term.api.term_loyalty_goods","parameters":[{"default":"all","description":"Category ID ('all' - goods in all categories, 'root' - goods wihout category/root category)","in":"query","name":"category","required":false,"type":"string"},{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Users count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Expression","in":"query","name":"search_text","required":false,"type":"string"},{"default":"none","description":"Return goods with requested service types. By default return goods without service type.","enum":["none","all","fuel"],"in":"query","name":"service_type","required":false,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]},"post":{"description":"Add new goods to loyalty","operationId":"incust.controllers.term.api.term_loyalty_goods_add","parameters":[{"description":"Data of new goods","in":"body","name":"data","schema":{"$ref":"#/definitions/LoyaltyGoods"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"201":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/categories":{"get":{"description":"Return goods categories as tree","operationId":"incust.controllers.term.api.term_loyalty_goods_categories","parameters":[{"default":false,"description":"Return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Card categories data","schema":{"items":{"$ref":"#/definitions/LoyaltyGoodsCategory"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]},"post":{"description":"Add goods category","operationId":"incust.controllers.term.api.term_loyalty_goods_category_add","parameters":[{"description":"Category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyGoodsCategory"}}],"responses":{"200":{"description":"Goods categories data","schema":{"$ref":"#/definitions/LoyaltyGoodsCategory"}},"201":{"description":"Goods categories data","schema":{"$ref":"#/definitions/LoyaltyGoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/category/{category_id}":{"get":{"description":"Return goods category","operationId":"incust.controllers.term.api.term_loyalty_goods_category","parameters":[{"description":"Category ID","in":"path","name":"category_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods category data","schema":{"$ref":"#/definitions/LoyaltyGoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]},"patch":{"description":"Edit goods category","operationId":"incust.controllers.term.api.term_loyalty_goods_category_edit","parameters":[{"description":"Calegory ID","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Category data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyGoodsCategory"}}],"responses":{"200":{"description":"Goods categories data","schema":{"$ref":"#/definitions/LoyaltyGoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/category/{category_id}/photo":{"delete":{"description":"Delete/Clear category photo. Allowed ContentType","operationId":"incust.controllers.term.api.term_loyalty_goods_category_photo_delete","parameters":[{"description":"Category ID","in":"path","name":"category_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods categories data","schema":{"$ref":"#/definitions/LoyaltyGoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set category photo. Allowed ContentType (image/jpeg, image/png)","operationId":"incust.controllers.term.api.term_loyalty_goods_category_photo_store","parameters":[{"description":"Category ID","in":"path","name":"category_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Goods categories data","schema":{"$ref":"#/definitions/LoyaltyGoodsCategory"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/code":{"post":{"description":"Get goods info by code","operationId":"incust.controllers.term.api.term_loyalty_goods_get_by_code","parameters":[{"description":"Goods code","in":"body","name":"data","required":true,"schema":{"properties":{"code":{"description":"Goods code","type":"string"}},"required":["code"],"type":"object"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/{goods_id}":{"get":{"description":"Get goods info","operationId":"incust.controllers.term.api.term_loyalty_goods_get","parameters":[{"description":"Goods ID","in":"path","name":"goods_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]},"patch":{"description":"Edit goods","operationId":"incust.controllers.term.api.term_loyalty_goods_edit","parameters":[{"description":"Goods ID","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Goods data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyGoods"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/{goods_id}/active":{"patch":{"description":"Edit goods active flag","operationId":"incust.controllers.term.api.term_loyalty_goods_edit_active","parameters":[{"description":"Goods ID","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Goods data","in":"body","name":"data","required":true,"schema":{"properties":{"active":{"description":"Active (1) or not (0)","enum":[0,1],"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/{goods_id}/additional_image":{"post":{"consumes":["image/jpeg","image/png"],"description":"Set goods additional image. Allowed ContentType (image/jpeg, image/png)","operationId":"incust.controllers.term.api.term_loyalty_goods_additional_photo_store","parameters":[{"description":"Goods ID.","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/{goods_id}/additional_image/{image_id}":{"delete":{"description":"Delete goods additional image.","operationId":"incust.controllers.term.api.term_loyalty_goods_additional_photo_delete","parameters":[{"description":"Goods ID.","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Additional image ID.","in":"path","name":"image_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/{goods_id}/photo":{"delete":{"description":"Delete/Clear goods photo","operationId":"incust.controllers.term.api.term_loyalty_goods_photo_delete","parameters":[{"description":"Goods ID.","in":"path","name":"goods_id","required":true,"type":"string"}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]},"post":{"consumes":["image/jpeg","image/png"],"description":"Set goods photo. Allowed ContentType (image/jpeg, image/png)","operationId":"incust.controllers.term.api.term_loyalty_goods_photo_store","parameters":[{"description":"Goods ID.","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Octet stream","in":"body","name":"data","required":true,"schema":{"description":"stream"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/{goods_id}/preconfigured_values":{"patch":{"description":"Modify goods recommended values","operationId":"incust.controllers.term.api.term_loyalty_goods_edit_preconfigured_values","parameters":[{"description":"Goods ID","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Goods data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyGoodsPreconfiguredValues"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/loyalty/goods/{goods_id}/price":{"patch":{"description":"Modify goods price","operationId":"incust.controllers.term.api.term_loyalty_goods_edit_price","parameters":[{"description":"Goods ID","in":"path","name":"goods_id","required":true,"type":"string"},{"description":"Goods data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyGoodsPrice"}}],"responses":{"200":{"description":"Goods data","schema":{"$ref":"#/definitions/LoyaltyGoods"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Loyalty Goods"]}},"/make_check":{"post":{"description":"Process check data, modify check - implement loyalty rules and make transaction by check data","operationId":"incust.controllers.term.api.make_check","parameters":[{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/make_check/{rules_type}":{"post":{"description":"Process check data, modify check - implement loyalty rules and make transaction by check data and by selected type","operationId":"incust.controllers.term.api.make_check_by_rules","parameters":[{"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 info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/online_store/orders":{"get":{"description":"Return orders list","operationId":"incust.controllers.term.api.online_store_orders","parameters":[{"description":"Order type filtering if needed","enum":["all","online-store","fuel-taxi"],"in":"query","name":"order_type","required":false,"type":"string"},{"default":false,"description":"Return only summary information","in":"query","name":"summary_only","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Order number if need","in":"query","name":"number","required":false,"type":"string"},{"default":true,"description":"Return only not paid orders","in":"query","name":"not_paid_only","required":false,"type":"boolean"},{"default":false,"description":"Return only orders that not in route","in":"query","name":"not_in_route_only","required":false,"type":"boolean"},{"default":false,"description":"Return only orders that not completed (doesn't have the status 'delivered' or 'canceled')","in":"query","name":"not_completed_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"Orders array","schema":{"$ref":"#/definitions/OrderListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/online_store/orders/{order_id}":{"get":{"description":"Return order object","operationId":"incust.controllers.term.api.online_store_order","parameters":[{"description":"Order Id","in":"path","name":"order_id","required":true,"type":"string"}],"responses":{"200":{"description":"Order object","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]},"patch":{"description":"Change order status and return order object","operationId":"incust.controllers.term.api.online_store_change_order_status","parameters":[{"description":"Order Id","in":"path","name":"order_id","required":true,"type":"string"},{"description":"Action info","in":"body","name":"data","required":true,"schema":{"properties":{"status":{"description":"Status","enum":["canceled","delivered","inprocess"],"type":"string"}},"required":["status"],"type":"object"}}],"responses":{"200":{"description":"Order object","schema":{"$ref":"#/definitions/Order"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/online_store/user/orders":{"get":{"description":"Return user orders list","operationId":"incust.controllers.term.api.online_store_customer_orders","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Order type filtering if needed","enum":["all","online-store","fuel-taxi"],"in":"query","name":"order_type","required":false,"type":"string"},{"default":false,"description":"Return only summary information","in":"query","name":"summary_only","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Order number if need","in":"query","name":"number","required":false,"type":"string"},{"default":true,"description":"Return only not paid orders","in":"query","name":"not_paid_only","required":false,"type":"boolean"},{"default":false,"description":"Return only orders that not in route","in":"query","name":"not_in_route_only","required":false,"type":"boolean"},{"default":false,"description":"Return only orders that not completed (doesn't have the status 'delivered' or 'canceled')","in":"query","name":"not_completed_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"Orders array","schema":{"$ref":"#/definitions/OrderListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/online_store/{user_id_value}/orders":{"get":{"description":"Return user orders list - DEPRECATED","operationId":"incust.controllers.term.api.online_store_customer_orders_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","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"},{"default":false,"description":"Return only summary information","in":"query","name":"summary_only","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Order number if need","in":"query","name":"number","required":false,"type":"string"},{"default":true,"description":"Return only not paid orders","in":"query","name":"not_paid_only","required":false,"type":"boolean"},{"default":false,"description":"Return only orders that not in route","in":"query","name":"not_in_route_only","required":false,"type":"boolean"},{"default":false,"description":"Return only orders that not completed (doesn't have the status 'delivered' or 'canceled')","in":"query","name":"not_completed_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"Orders array","schema":{"$ref":"#/definitions/OrderListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/online_store/{user_id_value}/{user_id_type}/orders":{"get":{"description":"Return user orders list - DEPRECATED","operationId":"incust.controllers.term.api.online_store_customer_orders_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","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"},{"default":false,"description":"Return only summary information","in":"query","name":"summary_only","required":false,"type":"boolean"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Order number if need","in":"query","name":"number","required":false,"type":"string"},{"default":true,"description":"Return only not paid orders","in":"query","name":"not_paid_only","required":false,"type":"boolean"},{"default":false,"description":"Return only orders that not in route","in":"query","name":"not_in_route_only","required":false,"type":"boolean"},{"default":false,"description":"Return only orders that not completed (doesn't have the status 'delivered' or 'canceled')","in":"query","name":"not_completed_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"Orders array","schema":{"$ref":"#/definitions/OrderListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Online Store"]}},"/payment/check/{transaction_id}":{"get":{"description":"Return transaction payments","operationId":"incust.controllers.term.api.transaction_payments","parameters":[{"description":"Transaction Id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"List of transaction payments","schema":{"items":{"$ref":"#/definitions/Payment"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/check/{transaction_id}/add":{"post":{"description":"Add payments for transaction","operationId":"incust.controllers.term.api.transaction_payments_add","parameters":[{"description":"Transaction Id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Payments data","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/Payment"},"type":"array"}}],"responses":{"200":{"description":"List of transaction payments","schema":{"items":{"$ref":"#/definitions/Payment"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/check/{transaction_id}/cancel":{"post":{"description":"Cancel payments for transaction","operationId":"incust.controllers.term.api.transaction_payments_cancel","parameters":[{"description":"Transaction Id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Payments to be canceled","in":"body","name":"data","required":true,"schema":{"items":{"description":"Payment Id","format":"uuid","type":"string"},"type":"array"}}],"responses":{"200":{"description":"List of transaction payments","schema":{"items":{"$ref":"#/definitions/Payment"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/check/{transaction_id}/preprocess":{"post":{"description":"Pre-process payments for transaction (generate request for processing by external system)","operationId":"incust.controllers.term.api.transaction_payments_process_pre","parameters":[{"description":"Transaction Id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Payments process data","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/PaymentProcess"},"type":"array"}}],"responses":{"200":{"description":"Payments data for processing","schema":{"items":{"$ref":"#/definitions/PaymentProcess"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/check/{transaction_id}/process":{"post":{"description":"Process payments for transaction (result processing by external system)","operationId":"incust.controllers.term.api.transaction_payments_process","parameters":[{"description":"Transaction Id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Payments process data","in":"body","name":"data","required":true,"schema":{"items":{"$ref":"#/definitions/PaymentProcess"},"type":"array"}}],"responses":{"200":{"description":"List of transaction payments","schema":{"items":{"$ref":"#/definitions/Payment"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/completion_required":{"get":{"description":"Payments for transaction requiring processing (capture or cancel)","operationId":"incust.controllers.term.api.terminal_payments_completion_required","parameters":[{"description":"Payment system type filter","enum":["amp","pax"],"in":"query","name":"payment_system_type","required":false,"type":"string"},{"description":"Transaction ID","format":"uuid","in":"query","name":"transaction_id","required":false,"type":"string"}],"responses":{"200":{"description":"List of transaction payments requiring processing","schema":{"items":{"$ref":"#/definitions/PaymentForProcess"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/device/operation/preprocess":{"post":{"description":"Pre-process payment terminal unit operation (generate request for processing by external system)","operationId":"incust.controllers.term.api.payments_device_operation_process_pre","parameters":[{"description":"Operation process data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PaymentUnitOperationProcess"}}],"responses":{"200":{"description":"Operation data for processing","schema":{"$ref":"#/definitions/PaymentUnitOperationProcess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/device/operation/process":{"post":{"description":"Process payment terminal unit operation (return result by processing data)","operationId":"incust.controllers.term.api.payments_device_operation_process","parameters":[{"description":"Operation process data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PaymentUnitOperationProcess"}}],"responses":{"200":{"description":"Operation processing result","schema":{"$ref":"#/definitions/PaymentUnitOperationProcess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/mobileapp/message":{"post":{"description":"Send message with payment to customer","operationId":"incust.controllers.term.api.payment_mobileapp_message","parameters":[{"description":"Customer parameters","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Transaction Id","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"List of customer info","schema":{"items":{"$ref":"#/definitions/PaymentStatus"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/payment/mobileapp/status":{"post":{"description":"Get payment info and status","operationId":"incust.controllers.term.api.payment_mobileapp_status","parameters":[{"description":"Customer parameters","in":"body","name":"data","required":true,"schema":{"properties":{"id":{"description":"Transaction Id","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}],"responses":{"200":{"description":"List of customer info","schema":{"$ref":"#/definitions/PaymentStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/phone/verification":{"post":{"description":"Send to phone verification code or verify posted code","operationId":"incust.controllers.term.api.phone_verification","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"properties":{"phone":{"description":"Phone number. Minimum 3 chars.","minLength":3,"type":"string"},"pincode":{"description":"Secure pin code","type":"string"}},"required":["phone"],"type":"object"}}],"responses":{"200":{"description":"Ok message","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}}}},"/price_group/items":{"get":{"description":"Return list of goods items in the price group","operationId":"incust.controllers.term.api.price_group_items","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":"Item category Id filter (if needed). For root category used 'root' value.","format":"uuid","in":"query","name":"item_category_id","required":false,"type":"string","x-nullable":true},{"default":false,"description":"Exclude items without price (null priced items)","in":"query","name":"exclude_without_price","required":false,"type":"boolean"}],"responses":{"200":{"description":"Price group item data object array","schema":{"$ref":"#/definitions/PriceGroupItemsListPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"]},"patch":{"description":"Modify goods item in the price group","operationId":"incust.controllers.term.api.price_group_items_edit","parameters":[{"description":"Price group items data object array","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PriceGroupItemsList"}}],"responses":{"200":{"description":"Added price group item data objects array","schema":{"$ref":"#/definitions/PriceGroupItemsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Prices"]}},"/process_check":{"post":{"description":"Process check data, modify check - implement loyalty rules","operationId":"incust.controllers.term.api.terminal_process_check","parameters":[{"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 & Transactions"]}},"/process_check/{rules_type}":{"post":{"description":"Process check data, modify check - implement loyalty rules by selected type","operationId":"incust.controllers.term.api.terminal_process_check_by_rules","parameters":[{"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 & Transactions"]}},"/questionnaire":{"get":{"description":"Return additional customer fields with values","operationId":"incust.controllers.term.api.questionary","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Array of fields and customer user info","schema":{"$ref":"#/definitions/CustomerQuestionnaireResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Edit customer fields with values","operationId":"incust.controllers.term.api.questionary_edit","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Сustomer user info and fields value","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerQuestionnaireRequest"}}],"responses":{"200":{"description":"Array of fields and customer user info","schema":{"$ref":"#/definitions/CustomerQuestionnaireResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/questionnaire/{user_id_value}":{"get":{"description":"Return additional customer fields with values - DEPRECATED","operationId":"incust.controllers.term.api.questionary_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"}],"responses":{"200":{"description":"Array of fields and customer user info","schema":{"$ref":"#/definitions/CustomerQuestionnaireResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Edit customer fields with values - DEPRECATED","operationId":"incust.controllers.term.api.questionary_edit_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Сustomer user info and fields value","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerQuestionnaireRequest"}}],"responses":{"200":{"description":"Array of fields and customer user info","schema":{"$ref":"#/definitions/CustomerQuestionnaireResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/questionnaire/{user_id_value}/{user_id_type}":{"get":{"description":"Return additional customer fields with values - DEPRECATED","operationId":"incust.controllers.term.api.questionary_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"}],"responses":{"200":{"description":"Array of fields and customer user info","schema":{"$ref":"#/definitions/CustomerQuestionnaireResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]},"patch":{"description":"Edit customer fields with values - DEPRECATED","operationId":"incust.controllers.term.api.questionary_edit_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Сustomer user info and fields value","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerQuestionnaireRequest"}}],"responses":{"200":{"description":"Array of fields and customer user info","schema":{"$ref":"#/definitions/CustomerQuestionnaireResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer"]}},"/referral_program/chain":{"get":{"description":"Return loyalty referral program referral chain","operationId":"incust.controllers.term.api.referral_program_chain","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"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":["Referral Program"]}},"/referral_program/code":{"get":{"description":"Emit and return referral program code","operationId":"incust.controllers.term.api.referral_program_code_get","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Loyalty referral program code object","schema":{"$ref":"#/definitions/ReferralProgramCode"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Referral Program"]}},"/referral_program/referrer":{"get":{"description":"Return loyalty referral program referrer user info (if exists)","operationId":"incust.controllers.term.api.referral_program_referrer_user","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Loyalty referral program referrer user info","schema":{"$ref":"#/definitions/RefferalProgramReferrerUser"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Referral Program"]}},"/referral_program/summary":{"get":{"description":"Return loyalty referral program summary information","operationId":"incust.controllers.term.api.referral_program_summary","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Loyalty referral program summary info","schema":{"$ref":"#/definitions/ReferralProgramSummary"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Referral Program"]}},"/related_terminals":{"get":{"description":"Return list of related terminals","operationId":"incust.controllers.term.api.related_terminals","responses":{"200":{"description":"Relaned terminals list","schema":{"$ref":"#/definitions/RelatedTerminalList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Related Terminals"]}},"/related_terminals/{related_terminal_id}/transactions":{"get":{"description":"Return transactions list maked in related terminal","operationId":"incust.controllers.term.api.related_terminals_transactions","parameters":[{"description":"Related Terminal ID","format":"uuid","in":"path","name":"related_terminal_id","required":true,"type":"string"},{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count in page","in":"query","name":"count","required":false,"type":"integer"},{"default":false,"description":"Do not calculate totals values","in":"query","name":"skip_totals","required":false,"type":"boolean"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"User ID","format":"uuid","in":"query","name":"user_id","required":false,"type":"string"},{"description":"Transactions type if need","enum":["all","reserve","sale","bonus-add","special-account-refill","coupon-sale","presale","authorize-payment","bonus-write-offs","special-account-write-offs"],"in":"query","name":"transaction_type","required":false,"type":"string"},{"description":"Transactions by canceled flag","in":"query","name":"canceled","required":false,"type":"boolean"},{"default":"all","description":"Customers type if need","enum":["all","retail","corporate"],"in":"query","name":"customer_type","required":false,"type":"string"},{"default":false,"description":"Detalized (split rows) by stock (return transactions with stock only)","in":"query","name":"by_stock","required":false,"type":"boolean"},{"description":"Sorting field name and direction","in":"query","name":"sort","required":false,"type":"string"}],"responses":{"200":{"description":"Data with transactions","schema":{"items":{"$ref":"#/definitions/Transaction"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Related Terminals"]}},"/remind_password":{"post":{"description":"Send sms with password for access to terminal","operationId":"incust.controllers.term.api.remind_password","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"properties":{"login":{"description":"Terminal login","type":"string"}},"required":["login"],"type":"object"}}],"responses":{"200":{"description":"Ok message","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Authorization"]}},"/remind_password/pre":{"post":{"description":"Remind password  pre-processing","operationId":"incust.controllers.term.api.remind_password_pre_processing","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"properties":{"login":{"description":"Terminal login","type":"string"}},"required":["login"],"type":"object"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"properties":{"protection_options":{"$ref":"#/definitions/ProtectionOptions"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Authorization"]}},"/reserve_check":{"post":{"description":"Make reserve type transaction","operationId":"incust.controllers.term.api.reserve_check","parameters":[{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount"]}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/routes/month":{"get":{"description":"Return Routes by month","operationId":"incust.controllers.term.api.route_by_month","parameters":[{"description":"Year","in":"query","name":"year","required":true,"type":"integer"},{"description":"Operation status filtering","in":"query","name":"month","required":true,"type":"integer"}],"responses":{"200":{"description":"Routes array","schema":{"items":{"$ref":"#/definitions/RouteTerminal"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/date":{"get":{"description":"Return Route operations list for date","operationId":"incust.controllers.term.api.route_operations_by_date","parameters":[{"description":"Route date","format":"date","in":"query","name":"date","required":false,"type":"string"},{"description":"Operation status filtering","enum":["pending","processed","failed","canceled","shipping","customer-assistance-needed","refueling"],"in":"query","name":"status","required":false,"type":"string"}],"responses":{"200":{"description":"Route operations data array","schema":{"items":{"$ref":"#/definitions/RouteOperation"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/list":{"get":{"description":"Return Route operations list (paginated)","operationId":"incust.controllers.term.api.route_operations_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Transactions count in page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Date filter from in RFC3339","format":"date","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date filter to from in RFC3339","format":"date","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Operation status filtering","enum":["pending","processed","failed","canceled","shipping","customer-assistance-needed","refueling"],"in":"query","name":"status","required":false,"type":"string"}],"responses":{"200":{"description":"Route operations data array","schema":{"$ref":"#/definitions/RouteOperationListResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/order":{"post":{"description":"Add Order type route operation","operationId":"incust.controllers.term.api.route_operation_order_add","parameters":[{"description":"Order type route operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/RouteOperationOrder"}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/{operation_id}":{"get":{"description":"Return Route operation data","operationId":"incust.controllers.term.api.route_operation_get","parameters":[{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]},"patch":{"description":"Route operation date/time modify","operationId":"incust.controllers.term.api.route_operation_modify","parameters":[{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"},{"description":"Route operation data for modification","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/RouteOperationModify"}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/{operation_id}/assistance":{"post":{"description":"Set Route operation status to assistance needed","operationId":"incust.controllers.term.api.route_operation_assistance_needed","parameters":[{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"},{"description":"Assistance details","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/RouteOperationProcessData","x-nullable":true}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/{operation_id}/canceled":{"post":{"description":"Set Route operation status to Canceled","operationId":"incust.controllers.term.api.route_operation_canceled","parameters":[{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"},{"description":"Failure details","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/RouteOperationProcessData","x-nullable":true}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/{operation_id}/failed":{"post":{"description":"Set Route operation status to Failed","operationId":"incust.controllers.term.api.route_operation_failed","parameters":[{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"},{"description":"Failure details","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/RouteOperationProcessData","x-nullable":true}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/{operation_id}/processed":{"post":{"description":"Set Route operation status to Processed","operationId":"incust.controllers.term.api.route_operation_processed","parameters":[{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"},{"description":"Failure details","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/RouteOperationProcessData","x-nullable":true}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/{operation_id}/refueling":{"post":{"description":"Set Route operation status to refueling","operationId":"incust.controllers.term.api.route_operation_refueling","parameters":[{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"},{"description":"Refueling details","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/RouteOperationProcessData","x-nullable":true}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/routes/operations/{operation_id}/shipping":{"post":{"description":"Set Route operation status to Shipping","operationId":"incust.controllers.term.api.route_operation_shipping","parameters":[{"description":"Operation Id","format":"uuid","in":"path","name":"operation_id","required":true,"type":"string"},{"description":"Failure details","in":"body","name":"data","required":false,"schema":{"$ref":"#/definitions/RouteOperationProcessData","x-nullable":true}}],"responses":{"200":{"description":"Route operation data","schema":{"$ref":"#/definitions/RouteOperation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Route"]}},"/rules":{"get":{"description":"Return rules list for terminal","operationId":"incust.controllers.term.api.rules","parameters":[{"default":"all","description":"Scope of rules","enum":["all","retail","corporate"],"in":"query","name":"scope","required":false,"type":"string"},{"default":"manual","description":"Type of rules","enum":["all","manual","automatic","coupon","display"],"in":"query","name":"rule_type","required":false,"type":"string"}],"responses":{"200":{"description":"Loyalty rules","schema":{"$ref":"#/definitions/LoyaltyRuleList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"]}},"/settings":{"get":{"description":"Return terminal settings","operationId":"incust.controllers.term.api.settings","responses":{"200":{"description":"Terminal settings","schema":{"$ref":"#/definitions/Settings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/settings/application":{"get":{"description":"Return settings for application","operationId":"incust.controllers.term.api.settings_application_get","responses":{"200":{"description":"Application settings","schema":{"$ref":"#/definitions/TerminalApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]},"patch":{"description":"Set and return settings for application","operationId":"incust.controllers.term.api.settings_application_set","parameters":[{"description":"Application settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalApplicationSettings"}}],"responses":{"200":{"description":"Application settings","schema":{"$ref":"#/definitions/TerminalApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/settings/external_devices/amp":{"get":{"description":"Return AMP settings","operationId":"incust.controllers.term.api.settings_external_devices_amp_get","responses":{"200":{"description":"Terminal AMP settings","schema":{"$ref":"#/definitions/TerminalExternalAmpSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]},"patch":{"description":"Set AMP settings","operationId":"incust.controllers.term.api.settings_external_devices_amp_set","parameters":[{"description":"Terminal AMP settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalExternalAmpSettings"}}],"responses":{"200":{"description":"Terminal AMP settings","schema":{"$ref":"#/definitions/TerminalExternalAmpSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/settings/external_devices/pax":{"get":{"description":"Return PAX settings","operationId":"incust.controllers.term.api.settings_external_devices_pax_get","responses":{"200":{"description":"Terminal PAX settings","schema":{"$ref":"#/definitions/TerminalExternalPaxSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]},"patch":{"description":"Set PAX settings","operationId":"incust.controllers.term.api.settings_external_devices_pax_set","parameters":[{"description":"Terminal PAX settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalExternalPaxSettings"}}],"responses":{"200":{"description":"Terminal PAX settings","schema":{"$ref":"#/definitions/TerminalExternalPaxSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/settings/external_devices/stripe":{"get":{"description":"Return Stripe settings","operationId":"incust.controllers.term.api.settings_external_devices_stripe_get","responses":{"200":{"description":"Terminal Stripe settings","schema":{"$ref":"#/definitions/TerminalExternalStripeSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]},"patch":{"description":"Set Stripe settings","operationId":"incust.controllers.term.api.settings_external_devices_stripe_set","parameters":[{"description":"Terminal Stripe settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalExternalStripeSettings"}}],"responses":{"200":{"description":"Terminal Stripe settings","schema":{"$ref":"#/definitions/TerminalExternalStripeSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/settings/external_devices/stripe/location":{"delete":{"description":"Clear Stripe Location","operationId":"incust.controllers.term.api.settings_external_devices_stripe_location_clear","responses":{"200":{"description":"Terminal Stripe Location settings","schema":{"$ref":"#/definitions/TerminalExternalStripeLocation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]},"get":{"description":"Return Stripe Location settings","operationId":"incust.controllers.term.api.settings_external_devices_stripe_location_get","responses":{"200":{"description":"Terminal Stripe Location settings","schema":{"$ref":"#/definitions/TerminalExternalStripeLocation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]},"patch":{"description":"Set Stripe Location settings","operationId":"incust.controllers.term.api.settings_external_devices_stripe_location_set","parameters":[{"description":"Terminal Stripe Location settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalExternalStripeLocation"}}],"responses":{"200":{"description":"Terminal Stripe Location settings","schema":{"$ref":"#/definitions/TerminalExternalStripeLocation"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/settings/poster":{"get":{"description":"Return settings for Poster","operationId":"incust.controllers.term.api.settings_poster_get","responses":{"200":{"description":"Poster settings","schema":{"$ref":"#/definitions/TerminalPosterSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Poster"]}},"/settings/screensaver":{"get":{"description":"Return settings for screensaver","operationId":"incust.controllers.term.api.settings_screensaver_get","responses":{"200":{"description":"Screensaver settings","schema":{"$ref":"#/definitions/TerminalScreensaverSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/special_account":{"get":{"description":"Return special accounts list","operationId":"incust.controllers.term.api.special_accounts","parameters":[{"default":"retail","description":"Scope of accounts","enum":["retail","corporate","all"],"in":"query","name":"scope","required":false,"type":"string"}],"responses":{"200":{"description":"Array of special accounts","schema":{"$ref":"#/definitions/SpecialAccountsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Business"]}},"/staff/signin":{"post":{"description":"Staff sign in, return staff token","operationId":"incust.controllers.term.api.staff_sign_in","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"properties":{"auth_code":{"description":"Staff auth code","type":"string"}},"required":["auth_code"],"type":"object"}}],"responses":{"200":{"description":"Response TOKEN and Staff info","schema":{"$ref":"#/definitions/BusinessStaff"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/signout":{"post":{"description":"Staff sign out, return terminal token","operationId":"incust.controllers.term.api.staff_sign_out","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"type":"object"}}],"responses":{"200":{"description":"Response TOKEN and Settings","schema":{"$ref":"#/definitions/Settings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/status":{"get":{"description":"Return terminal status","operationId":"incust.controllers.term.api.terminal_status","responses":{"200":{"description":"Terminal status","schema":{"$ref":"#/definitions/TerminalStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["General Info"]}},"/tanks/linked":{"get":{"description":"Return list of Tanks linked to the Business","operationId":"incust.controllers.term.api.tanks_linked_list","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Owner Id filtering","format":"uuid","in":"query","name":"owner_id","required":false,"type":"string"},{"description":"Owner type filtering","enum":["customer","corporate-customer"],"in":"query","name":"owner_type","required":false,"type":"string"},{"description":"Code filtering (matching criteria)","in":"query","name":"code","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (code, title, address, product_title)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"all","description":"Filter by active flag","enum":["all","yes","no"],"in":"query","name":"active","required":false,"type":"string"},{"description":"Goods code filtering (matching criteria)","in":"query","name":"goods_code","required":false,"type":"string"},{"default":"title","description":"Sort field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Linked Tanks array","schema":{"properties":{"data":{"description":"Tanks list","items":{"$ref":"#/definitions/Tank"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]},"post":{"description":"Add new link to tank","operationId":"incust.controllers.term.api.tanks_linked_add","parameters":[{"description":"Linked tank data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tank"}}],"responses":{"200":{"description":"Linked tank data","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]}},"/tanks/linked/{tank_id}":{"delete":{"description":"Return linked Tank info","operationId":"incust.controllers.term.api.tanks_linked_delete","parameters":[{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]},"get":{"description":"Return linked Tank info","operationId":"incust.controllers.term.api.tanks_linked_get","parameters":[{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"}],"responses":{"200":{"description":"Linked tank data","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]},"patch":{"description":"Modify link to Tank","operationId":"incust.controllers.term.api.tanks_linked_modify","parameters":[{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"},{"description":"Linked tank data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tank"}}],"responses":{"200":{"description":"Linked tank data","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]}},"/tanks/owner/{owner_id}":{"get":{"description":"Return list of Tanks for owner","operationId":"incust.controllers.term.api.tanks_by_owner_list","parameters":[{"description":"Owner Id","format":"uuid","in":"path","name":"owner_id","required":true,"type":"string"},{"description":"Code filtering (matching criteria)","in":"query","name":"code","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (code, title, address, product_title)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"all","description":"Filter by active flag","enum":["all","yes","no"],"in":"query","name":"active","required":false,"type":"string"},{"default":"title","description":"Sort field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Tanks data object array","schema":{"items":{"$ref":"#/definitions/Tank"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]},"post":{"description":"Add Tank for owner","operationId":"incust.controllers.term.api.tank_by_owner_add","parameters":[{"description":"Owner Id","format":"uuid","in":"path","name":"owner_id","required":true,"type":"string"},{"description":"Tanks data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tank"}}],"responses":{"200":{"description":"Tanks data object","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]}},"/tanks/owner/{owner_id}/{tank_id}":{"get":{"description":"Get Tank for owner","operationId":"incust.controllers.term.api.tank_by_owner_get","parameters":[{"description":"Owner Id","format":"uuid","in":"path","name":"owner_id","required":true,"type":"string"},{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"}],"responses":{"200":{"description":"Tanks data object","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]},"patch":{"description":"Modify Tank for owner","operationId":"incust.controllers.term.api.tank_by_owner_edit","parameters":[{"description":"Owner Id","format":"uuid","in":"path","name":"owner_id","required":true,"type":"string"},{"description":"Tank Id","format":"uuid","in":"path","name":"tank_id","required":true,"type":"string"},{"description":"Tanks data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Tank"}}],"responses":{"200":{"description":"Tanks data object","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]}},"/tanks/{code}":{"get":{"description":"Find Tank by code and return Tank Info","operationId":"incust.controllers.term.api.tank_by_code_get","parameters":[{"description":"Tank Code","in":"path","name":"code","required":true,"type":"string"}],"responses":{"200":{"description":"Tank object data","schema":{"$ref":"#/definitions/Tank"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tanks"]}},"/token":{"post":{"description":"Check existing terminal and if valid return token","operationId":"incust.controllers.term.api.token","parameters":[{"description":"Token request data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalTokenRequest"}}],"responses":{"200":{"description":"Response TOKEN and Settings","schema":{"$ref":"#/definitions/Settings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Authorization"]}},"/token/poster":{"post":{"description":"Check existing terminal for Poster and if valid return token","operationId":"incust.controllers.term.api.token_for_poster","parameters":[{"description":"Token request data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TerminalTokenByPosterRequest"}}],"responses":{"200":{"description":"Response TOKEN and Settings","schema":{"$ref":"#/definitions/Settings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Poster"]}},"/token/renew":{"get":{"description":"Renew and return new token and settings.","operationId":"incust.controllers.term.api.token_renew","responses":{"200":{"description":"Response TOKEN and Settings","schema":{"$ref":"#/definitions/Settings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Authorization"]}},"/tour_card/cards/code":{"post":{"description":"Search tourist card by code and return tourist card info","operationId":"incust.controllers.term.api.tour_card_info_wo_user","parameters":[{"description":"Tourist card code","in":"body","name":"data","required":true,"schema":{"properties":{"code":{"description":"Tourist card code","type":"string"}},"required":["code"],"type":"object"}}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/cards/service/use":{"post":{"description":"Use tourist card service","operationId":"incust.controllers.term.api.tour_card_service_use_wo_user","parameters":[{"description":"Tourist card and service Ids","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardServiceUse"}}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/user/cards":{"get":{"description":"Return tourist cards list","operationId":"incust.controllers.term.api.tour_cards_list","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true}],"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/user/cards/add":{"post":{"description":"Add tourist card for user and return tourist card list","operationId":"incust.controllers.term.api.tour_card_add","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Tourist card and service Ids","in":"body","name":"data","required":true,"schema":{"properties":{"card_id":{"description":"Tourist card ID","format":"uuid","type":"string"}},"required":["card_id"],"type":"object"}}],"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/user/cards/code":{"post":{"description":"Search tourist card by code and return tourist card info","operationId":"incust.controllers.term.api.tour_card_info_w_user","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Tourist card code","in":"body","name":"data","required":true,"schema":{"properties":{"code":{"description":"Tourist card code","type":"string"}},"required":["code"],"type":"object"}}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/user/cards/service/use":{"post":{"description":"Use tourist card service","operationId":"incust.controllers.term.api.tour_card_service_use_w_user","parameters":[{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string","x-nullable":true},{"description":"Tourist card and service Ids","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardServiceUse"}}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/{user_id_value}/cards":{"get":{"description":"Return tourist cards list - DEPRECATED","operationId":"incust.controllers.term.api.tour_cards_list_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"}],"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/{user_id_value}/cards/add":{"post":{"description":"Add tourist card for user and return tourist card list - DEPRECATED","operationId":"incust.controllers.term.api.tour_card_add_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Tourist card and service Ids","in":"body","name":"data","required":true,"schema":{"properties":{"card_id":{"description":"Tourist card ID","format":"uuid","type":"string"}},"required":["card_id"],"type":"object"}}],"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/{user_id_value}/cards/code":{"post":{"description":"Search tourist card by code and return tourist card info - DEPRECATED","operationId":"incust.controllers.term.api.tour_card_info_w_user_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Tourist card code","in":"body","name":"data","required":true,"schema":{"properties":{"code":{"description":"Tourist card code","type":"string"}},"required":["code"],"type":"object"}}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/{user_id_value}/cards/service/use":{"post":{"description":"Use tourist card service - DEPRECATED","operationId":"incust.controllers.term.api.tour_card_service_use_w_user_simple","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Tourist card and service Ids","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardServiceUse"}}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/{user_id_value}/{user_id_type}/cards":{"get":{"description":"Return tourist cards list - DEPRECATED","operationId":"incust.controllers.term.api.tour_cards_list_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"}],"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/{user_id_value}/{user_id_type}/cards/add":{"post":{"description":"Add tourist card for user and return tourist card list - DEPRECATED","operationId":"incust.controllers.term.api.tour_card_add_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Tourist card and service Ids","in":"body","name":"data","required":true,"schema":{"properties":{"card_id":{"description":"Tourist card ID","format":"uuid","type":"string"}},"required":["card_id"],"type":"object"}}],"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/{user_id_value}/{user_id_type}/cards/code":{"post":{"description":"Search tourist card by code and return tourist card info - DEPRECATED","operationId":"incust.controllers.term.api.tour_card_info_w_user_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Tourist card code","in":"body","name":"data","required":true,"schema":{"properties":{"code":{"description":"Tourist card code","type":"string"}},"required":["code"],"type":"object"}}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/tour_card/{user_id_value}/{user_id_type}/cards/service/use":{"post":{"description":"Use tourist card service - DEPRECATED","operationId":"incust.controllers.term.api.tour_card_service_use_w_user_ex","parameters":[{"description":"User phone number","in":"path","name":"user_id_value","required":true,"type":"string"},{"description":"Type of user identity","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"path","name":"user_id_type","required":true,"type":"string"},{"description":"Tourist card and service Ids","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/TourCardServiceUse"}}],"responses":{"200":{"description":"Tourist card object","schema":{"$ref":"#/definitions/TourCard"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Tourist Cards"]}},"/transaction/{transaction_id}":{"get":{"description":"Return transaction info","operationId":"incust.controllers.term.api.transaction","parameters":[{"description":"Transaction ID","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/transaction/{transaction_id}/check":{"get":{"description":"Return transaction info","operationId":"incust.controllers.term.api.transaction_check","parameters":[{"description":"Transaction ID","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Transaction check info","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/transaction/{transaction_id}/receipt":{"get":{"description":"Return transaction receipt","operationId":"incust.controllers.term.api.transaction_receipt","parameters":[{"description":"Transaction_id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Transaction receipt","schema":{"$ref":"#/definitions/TransactionReceipt"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/transaction_cancel":{"post":{"description":"Cancel transaction","operationId":"incust.controllers.term.api.transaction_cancel","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"properties":{"comment":{"description":"Comment","type":"string"},"temporary_code":{"description":"Temporary code used in canceled transaction","type":"string"},"transaction_id":{"description":"Canceled transaction ID","format":"uuid","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/transactions":{"get":{"description":"Return transactions list maked in terminal","operationId":"incust.controllers.term.api.transactions","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"Transactions count in page","in":"query","name":"count","required":false,"type":"integer"},{"default":false,"description":"Do not calculate totals values","in":"query","name":"skip_totals","required":false,"type":"boolean"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"User ID","format":"uuid","in":"query","name":"user_id","required":false,"type":"string"},{"description":"Transactions type if need","enum":["all","reserve","sale","bonus-add","special-account-refill","coupon-sale","presale","authorize-payment","bonus-write-offs","special-account-write-offs"],"in":"query","name":"transaction_type","required":false,"type":"string"},{"description":"Transactions by canceled flag","in":"query","name":"canceled","required":false,"type":"boolean"},{"default":"all","description":"Customers type if need","enum":["all","retail","corporate"],"in":"query","name":"customer_type","required":false,"type":"string"},{"default":false,"description":"Detalized (split rows) by stock (return transactions with stock only)","in":"query","name":"by_stock","required":false,"type":"boolean"},{"description":"Sorting field name and direction","in":"query","name":"sort","required":false,"type":"string"}],"responses":{"200":{"description":"Data with transactions","schema":{"items":{"$ref":"#/definitions/Transaction"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/transactions/authorize_payment/not_captured":{"get":{"description":"Return transactions list of not captured authorize payment transactions made in terminal","operationId":"incust.controllers.term.api.transactions_authorize_payment_not_captured","parameters":[{"description":"User ID","format":"uuid","in":"query","name":"user_id","required":false,"type":"string"},{"description":"Skip transactions with jobs wich have auto_capture_parent_transaction value in true","in":"query","name":"skip_transactions_with_auto_capture_job","required":false,"type":"boolean"}],"responses":{"200":{"description":"Transactions list","schema":{"items":{"$ref":"#/definitions/Transaction"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/transactions/receipt/customer/print/required":{"get":{"description":"Return transactions list for which a customer receipt must be printed","operationId":"incust.controllers.term.api.transactions_customer_receipt_for_print","parameters":[{"description":"Filter by User ID (if needed)","format":"uuid","in":"query","name":"user_id","required":false,"type":"string"}],"responses":{"200":{"description":"Transaction Receipt list","schema":{"$ref":"#/definitions/TransactionReceiptList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/transactions/receipt/customer/print/{transaction_id}/processed":{"get":{"description":"Mark transaction customer receipt wich must be printed as processed (printed)","operationId":"incust.controllers.term.api.transaction_customer_receipt_mark_as_printed","parameters":[{"description":"Transaction_id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/write_check":{"post":{"description":"Make transaction by check data without finalization","operationId":"incust.controllers.term.api.write_check","parameters":[{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount"]}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"201":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"202":{"description":"Confirmation by security PIN","schema":{"$ref":"#/definitions/PinConfirmationResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Check & Transactions"]}},"/write_offs_benefits":{"post":{"description":"Write-off of benefits points from the customers account - DEPRECATED","operationId":"incust.controllers.term.api.write_off_benefits","parameters":[{"description":"Write-offs data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomerBenefitsWriteOffOperationData"}}],"responses":{"200":{"description":"Transaction info","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Customer Benefits"]}}},"produces":["application/json"],"schemes":["https","http"],"securityDefinitions":{"bearer":{"in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"incust.auth.apikey_auth"}},"swagger":"2.0"}