{"basePath":"/v1/corporate_client","consumes":["application/json"],"definitions":{"AccessObject":{"properties":{"granted":{"description":"Access granted","type":"boolean","x-nullable":true},"scopes":{"$ref":"#/definitions/AccessScopes","description":"Access scopes","x-nullable":true}},"type":"object"},"AccessScope":{"enum":["administration","payments","security"],"type":"string"},"AccessScopes":{"items":{"$ref":"#/definitions/AccessScope"},"type":"array"},"AdditionalService":{"properties":{"code":{"description":"Service code","type":"string","x-nullable":true},"cost":{"$ref":"#/definitions/AdditionalServiceCostList","description":"Service cost","x-nullable":true},"default":{"description":"Service is default","enum":[0,1],"type":"integer","x-nullable":true},"id":{"description":"Additional service ID","format":"uuid","type":"string","x-nullable":true},"public_description":{"description":"Service description","type":"string","x-nullable":true},"public_title":{"description":"Service title","type":"string","x-nullable":true},"sort_order":{"description":"Sort order weight","type":"integer"},"type":{"$ref":"#/definitions/AdditionalServiceType","description":"Service type","x-nullable":true}},"type":"object"},"AdditionalServiceCost":{"properties":{"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"min_value":{"description":"Minimal value","format":"float","type":"number","x-nullable":true},"values":{"$ref":"#/definitions/AdditionalServiceCostValueList","description":"Threshold values","x-nullable":true}},"type":"object"},"AdditionalServiceCostList":{"items":{"$ref":"#/definitions/AdditionalServiceCost"},"type":"array"},"AdditionalServiceCostType":{"enum":["amount","percentage","multiplier"],"type":"string"},"AdditionalServiceCostValue":{"properties":{"threshold":{"description":"Threshold","format":"float","type":"number","x-nullable":true},"type":{"$ref":"#/definitions/AdditionalServiceCostType","description":"Value type","x-nullable":true},"value":{"description":"Value","format":"float","type":"number","x-nullable":true}},"type":"object"},"AdditionalServiceCostValueList":{"items":{"$ref":"#/definitions/AdditionalServiceCostValue"},"type":"array"},"AdditionalServiceType":{"enum":["delivery","commission","tip"],"type":"string"},"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"},"Business":{"description":"Busoness info","properties":{"access":{"$ref":"#/definitions/AccessObject","description":"Business access (optional)"},"active":{"description":"Business active flag","enum":[0,1],"type":"integer"},"code":{"description":"Business code","type":"string"},"country":{"description":"Country ISO code","type":"string"},"id":{"description":"Business Id","format":"uuid","type":"string"},"loyalties":{"description":"Business loyalties (optional)","items":{"$ref":"#/definitions/RelativeLoyalty"},"type":"array"},"title":{"description":"Business title","type":"string"}},"type":"object"},"BusinessesList":{"items":{"$ref":"#/definitions/Business"},"type":"array"},"Check":{"properties":{"amount":{"description":"Amount of check","format":"float","type":"number","x-nullable":true},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"amount_to_pay":{"description":"Amount to pay","format":"float","type":"number","x-nullable":true},"avi_id":{"description":"AVI (automatic vehicle identification) Id value (optional)","type":"string","x-nullable":true},"billing_info":{"$ref":"#/definitions/BillingInfo","description":"Billing Info","x-nullable":true},"bonuses_added":{"items":{"$ref":"#/definitions/BonusAdded"},"type":"array","x-nullable":true},"bonuses_added_amount":{"description":"Added bonuses amount","format":"float","type":"number","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer","x-nullable":true},"bonuses_redeemed_amount":{"description":"Redeemed bonuses amount","format":"float","type":"number","x-nullable":true},"business":{"$ref":"#/definitions/CheckBusiness","description":"Business info if exists (optional)","x-nullable":true},"business_staff":{"$ref":"#/definitions/CheckBusinessStaff","description":"Business Staff info if exists (readonly, optional)","x-nullable":true},"calculated_margins":{"$ref":"#/definitions/CheckMargins","description":"Total margins calculated by items total margins (optional, readonly)","x-nullable":true},"calculated_taxes":{"$ref":"#/definitions/CheckTaxes","description":"Total taxes calculated by items total taxes (optional, readonly)","x-nullable":true},"cardotppassword":{"description":"User phone number. Minimum 3 chars (optional)","type":"string","x-nullable":true},"check_items":{"items":{"$ref":"#/definitions/CheckItem"},"type":"array","x-nullable":true},"check_services":{"$ref":"#/definitions/CheckServices","description":"Services added on check (optional)","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"corporate_customer_id":{"description":"Corporate Customer ID (optional)","format":"uuid","type":"string","x-nullable":true},"corporate_customer_special_account_id":{"description":"Corporate Customer Account ID","format":"uuid","type":"string","x-nullable":true},"corporate_vehicle":{"$ref":"#/definitions/CheckCorporateVehicle","description":"Corporate vehicle Info (optional)","x-nullable":true},"customer_feedback_settings":{"$ref":"#/definitions/CheckCustomerFeedbackSettings","description":"Customer feedback settings (optional)","x-nullable":true},"customer_id":{"description":"Customer user ID (optional)","format":"uuid","type":"string","x-nullable":true},"discount_amount":{"description":"Amount of discount","format":"float","type":"number","x-nullable":true},"emitted_coupons":{"items":{"$ref":"#/definitions/CheckCoupon"},"type":"array","x-nullable":true},"external_additional_info":{"description":"Any custom external data (optional)","type":"object","x-nullable":true},"external_check_id":{"description":"External check identifier","type":"string","x-nullable":true},"external_check_id_by_user":{"default":0,"description":"Checking the uniqueness of the identifier within a user (different users may use the same identifier or campaign)","enum":[0,1],"type":"integer","x-nullable":true},"external_check_id_scope":{"$ref":"#/definitions/ExternalCheckIdScope","description":"External check identifier scope","x-nullable":true},"id":{"description":"User identifier (phone number, card code, QR code). Minimum 3 chars (optional)","type":"string","x-nullable":true},"id_type":{"$ref":"#/definitions/IdType","description":"Type of user identity (optional)","x-nullable":true},"implemented_rules":{"$ref":"#/definitions/CheckImplementedRulesList","description":"Loyalty rules implemented to check","x-nullable":true},"loyalty":{"$ref":"#/definitions/CheckLoyalty","description":"Loyalty info if exists (optional)","x-nullable":true},"manual_rules":{"description":"Specified the rules manually selected at the terminal","type":"boolean","x-nullable":true},"odometer":{"description":"Odometer/engine hours value, up to two decimal digits (optional)","format":"float","type":"number","x-nullable":true},"odometer_unit":{"$ref":"#/definitions/OdometerUnitType","description":"Odometer unit of measure (optional)","x-nullable":true},"online_store_order_id":{"description":"Online store order id","format":"uuid","type":"string","x-nullable":true},"payment_id":{"description":"Currency ISO code, special account Id or corporate special account access","type":"string","x-nullable":true},"payment_type":{"$ref":"#/definitions/TransactionPaymentType","description":"Payment type","x-nullable":true},"payments":{"items":{"$ref":"#/definitions/Payment"},"type":"array","x-nullable":true},"pos":{"$ref":"#/definitions/CheckPos","description":"Pos info if exists (optional)","x-nullable":true},"preliminary_transaction_id":{"description":"Preliminary Transaction Id (optional, only if exists)","format":"uuid","type":"string","x-nullable":true},"preliminary_transaction_type":{"$ref":"#/definitions/TransactionType","description":"Preliminary Transaction type (optional, only if exists)","x-nullable":true},"redeemed_coupons":{"items":{"$ref":"#/definitions/CheckCoupon"},"type":"array","x-nullable":true},"route_operation_id":{"description":"Route operation Id","type":"string","x-nullable":true},"services_amount":{"description":"Added on check services total amount (optional)","format":"float","type":"number","x-nullable":true},"shipping_amount":{"description":"Shipping amount (optional)","format":"float","type":"number","x-nullable":true},"skip_message":{"default":false,"description":"Skip notifications","type":"boolean","x-nullable":true},"special_account":{"$ref":"#/definitions/CheckSpecialAccount","description":"Special account info","x-nullable":true},"special_account_odometer_required":{"$ref":"#/definitions/DataRequiredType","description":"Odometer value required flag for operating with special account (response only) (optional, readonly)","x-nullable":true},"special_account_pin":{"description":"PIN code for operating with special account (request only) (optional)","type":"string","x-nullable":true},"special_account_pin_required":{"description":"PIN required flag for operating with special account (response only) (optional)","type":"boolean","x-nullable":true},"special_account_required_values_verify":{"description":"Verify special account required values flag (only for process_check, ignored in othe methods) (optional)","type":"boolean","x-nullable":true},"special_account_vehicle_id_required":{"$ref":"#/definitions/DataRequiredType","description":"VIN (other vehicle identifier) value required flag for operating with special account (response only) (optional, readonly)","x-nullable":true},"special_accounts_charges":{"items":{"$ref":"#/definitions/SpecialAccountCharge"},"type":"array","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer","x-nullable":true},"summary_amount":{"description":"Sum of amount and shipping_amount and services_amount (optional, readonly)","format":"double","type":"number","x-nullable":true},"tanks":{"description":"Tanks Data (optional)","items":{"$ref":"#/definitions/CheckTank"},"type":"array","x-nullable":true},"terminal_odometer_measurement_units":{"$ref":"#/definitions/OdometerUnitType","description":"Odometer measuremen units selection type by Terminal settings (optional)","x-nullable":true},"transaction_cancelled":{"description":"Transaction canceled flag","enum":[0,1],"type":"integer","x-nullable":true},"transaction_id":{"description":"Transaction ID","format":"uuid","type":"string","x-nullable":true},"transaction_receipt_actions":{"$ref":"#/definitions/TransactionReceiptActions","description":"Transaction receipt actions (optional)","x-nullable":true},"transaction_subtype":{"$ref":"#/definitions/TransactionSubType","description":"Transaction subtype (optional, readonly)","x-nullable":true},"transaction_type":{"$ref":"#/definitions/TransactionType","description":"Transaction type","x-nullable":true},"user_external_forms":{"$ref":"#/definitions/CheckUserExternalFormRelations","description":"External forms filled by customer (optional, readonly)","x-nullable":true},"vehicle_id":{"description":"Qr Code / Tag of vehicle or equipment value (optional)","type":"string","x-nullable":true}},"type":"object"},"CheckBusiness":{"properties":{"description":{"description":"Business title","type":"string","x-nullable":true},"id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Business logos","x-nullable":true},"title":{"description":"Business title","type":"string","x-nullable":true}},"type":"object"},"CheckBusinessStaff":{"properties":{"id":{"description":"Staff id","format":"uuid","type":"string","x-nullable":true},"name":{"description":"Name","type":"string","x-nullable":true}},"type":"object"},"CheckCorporateStaffPosition":{"properties":{"id":{"description":"Position ID","format":"uuid","type":"string"},"public_description":{"description":"Position public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Position public title (optional)","type":"string","x-nullable":true},"title":{"description":"Position title","type":"string"}},"type":"object"},"CheckCorporateVehicle":{"properties":{"avi_id":{"description":"Vehicle/Inventory AVI (automatic vehicle identification) Id (optional)","type":"string","x-nullable":true},"description":{"description":"Description (optional)","type":"string","x-nullable":true},"id":{"description":"Vehicle/Inventory unique Id","format":"uuid","type":"string","x-nullable":true},"position":{"$ref":"#/definitions/CheckCorporateStaffPosition","description":"Position info (readonly) (optional)","x-nullable":true},"position_id":{"description":"Position ID (optional)","format":"uuid","type":"string","x-nullable":true},"qr_code":{"description":"Qr Code / Tag (optional)","type":"string","x-nullable":true},"vehicle_id":{"description":"Vehicle/Inventory Id (optional)","type":"string","x-nullable":true}},"type":"object"},"CheckCoupon":{"properties":{"activity_id":{"description":"Activity ID (optional, check only)","format":"uuid","type":"string","x-nullable":true},"applicable":{"description":"Coupon check applicable for check (optional, redeem in check only)","type":"boolean","x-nullable":true},"batch":{"$ref":"#/definitions/CheckCouponBatch","description":"Batch info (optional)","x-nullable":true},"batch_id":{"description":"Batch Id (optional)","format":"uuid","type":"string","x-nullable":true},"business_code":{"description":"Business code","type":"string","x-nullable":true},"code":{"description":"Coupon code","type":"string","x-nullable":true},"description":{"description":"Coupon Description","type":"string","x-nullable":true},"do_not_add_to_wallet":{"description":"Do not add emitted coupons to the customer's wallet (optional, check only)","type":"boolean","x-nullable":true},"error":{"description":"Coupon check implementation error (optional, redeem in check only)","type":"string","x-nullable":true},"expire_date":{"description":"Date expiry of coupon","format":"date","type":"string","x-nullable":true},"external_code":{"description":"Coupon external_code (optional)","type":"string","x-nullable":true},"external_code_visibility_type":{"$ref":"#/definitions/CouponExternalCodeVisibilityType","description":"External code visibility type (optional)","x-nullable":true},"id":{"description":"Unique id of coupon","format":"uuid","type":"string","x-nullable":true},"image":{"description":"Coupon batch image (optional)","format":"url","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty emission id","format":"uuid","type":"string","x-nullable":true},"object_id":{"description":"Reference object ID, up to 36 chars (optional, check only)","type":"string","x-nullable":true},"object_type":{"$ref":"#/definitions/BenefitsTopUpReferenceObjectType","description":"Reference object type (optional, check only)","x-nullable":true},"processing_status":{"$ref":"#/definitions/CouponProcessingStatus","description":"Coupon processing status (optional, check by transaction only)","x-nullable":true},"redeem_at_terminal":{"description":"Redeem only at terminal restriction","enum":[0,1],"type":"integer","x-nullable":true},"share_allowed":{"description":"Coupons share allowed for customer","enum":[0,1],"type":"integer","x-nullable":true},"status":{"$ref":"#/definitions/CouponStatus","description":"Status of coupon","x-nullable":true},"title":{"description":"Coupon Title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/CouponType","description":"Type of coupon","x-nullable":true},"valid":{"description":"Coupon valid flag (optional)","type":"boolean","x-nullable":true}},"type":"object"},"CheckCouponBatch":{"properties":{"alias":{"$ref":"#/definitions/CouponBatchAlias","description":"Batch alias (optional, readonly)","x-nullable":true},"auto_redeem_on_add_to_wallet":{"description":"Automatically redeem on wallet add event (optional)","enum":[0,1],"type":"integer","x-nullable":true},"business_id":{"description":"Business Id","format":"uuid","type":"string","x-nullable":true},"customers_price_amount":{"description":"Coupon emission price (optional)","format":"double","type":"number","x-nullable":true},"customers_price_currency":{"description":"Coupon emission price currency (optional)","type":"string","x-nullable":true},"customers_price_special_account_id":{"description":"Coupon emission price special account Id (optional)","format":"uuid","type":"string","x-nullable":true},"customers_price_special_account_title":{"description":"Coupon emission price special account title (optional)","type":"string","x-nullable":true},"customers_price_type":{"$ref":"#/definitions/BenefitsPriceType","description":"Coupon emission price type (optional)","x-nullable":true},"id":{"description":"Unique id of coupon batch","format":"uuid","type":"string","x-nullable":true},"image":{"description":"Coupon batch image (optional)","format":"url","type":"string","x-nullable":true},"links":{"$ref":"#/definitions/CouponBatchLinks","description":"Batch links list (optional, readonly)","x-nullable":true},"loyalty_id":{"description":"Loyalty emission id","format":"uuid","type":"string","x-nullable":true},"public_description":{"description":"Coupons batch public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Coupons batch public title (optional)","type":"string","x-nullable":true},"redeem_at_terminal":{"description":"Redeem only at terminal restriction (optional)","enum":[0,1],"type":"integer","x-nullable":true},"share_allowed":{"description":"Coupons share allowed for customer (optional)","enum":[0,1],"type":"integer","x-nullable":true},"type":{"$ref":"#/definitions/CouponType","description":"Type of coupon","x-nullable":true}},"type":"object"},"CheckCustomerFeedbackSettings":{"properties":{"active":{"description":"Feedback system active flag","enum":[0,1],"type":"integer"},"feedback_source":{"$ref":"#/definitions/CheckFeedbackSource"},"print_feedback_on_check":{"$ref":"#/definitions/CustomerFeedbackPrintOnCheck","description":"Print feedback source on check"},"print_feedback_on_check_message_text":{"description":"Invitation message text for printinting on check","type":"string"}},"type":"object"},"CheckFeedbackSource":{"properties":{"id":{"description":"Feedback source ID","format":"uuid","type":"string"},"invitation_text":{"description":"Text displayed for customers as invitation","type":"string"},"title":{"description":"Title","type":"string"},"urls":{"description":"URLs for object","properties":{"base_url":{"description":"Full URL","type":"string"},"short_url":{"description":"Short URL","type":"string"}},"type":"object"}},"type":"object"},"CheckImplementedRule":{"properties":{"action_type":{"$ref":"#/definitions/LoyaltyRuleActionType","description":"Rule action dependency type (by some kinds of amount or by items)","x-nullable":true},"active":{"description":"Rule is active","enum":[0,1],"type":"integer","x-nullable":true},"applicable_api_scope":{"$ref":"#/definitions/LoyaltyRuleApplicableApiScope","description":"Rule applicable for API type (for automatic and coupon automatic only)","x-nullable":true},"applicable_for_customer":{"$ref":"#/definitions/LoyaltyRuleApplicableForCustomer","description":"Rule applicable for customer type","x-nullable":true},"applicable_for_sale":{"$ref":"#/definitions/LoyaltyRuleApplicableForSale","description":"Rule applicable for sale type","x-nullable":true},"apply_when_bonuses_redeemed":{"description":"Apply rule when bonus points redeemed","enum":[0,1],"type":"integer","x-nullable":true},"apply_when_customers_account_payment":{"description":"Apply rule when payments from customer accounts","enum":[0,1],"type":"integer","x-nullable":true},"automatic":{"description":"Rule applied type (0 - manual, 1 - automatic, 2 - coupon, 3 - display, 4 - corporate manual, 5 - corporate automatic)","enum":[0,1,2,3,4,5],"type":"integer","x-nullable":true},"card_category_id":{"description":"Card category ID (optional, for rules with retail scope only)","format":"uuid","type":"string","x-nullable":true},"charge_type":{"$ref":"#/definitions/BenefitsChargeTypeBase","description":"Refill object type","x-nullable":true},"combine":{"description":"Combine with other rules flag","enum":[0,1],"type":"integer","x-nullable":true},"comment":{"description":"Rule comment","type":"string","x-nullable":true},"corporate_customer_category_id":{"description":"Corporate customers category ID (optional, for rules with corporate scope only)","format":"uuid","type":"string","x-nullable":true},"count_bonuses_redeemed_amount":{"description":"Consider redeemed bonuses when calculating the rule value (null if used loyalty settings)","enum":[0,1],"type":"integer","x-nullable":true},"coupon_batch_code":{"description":"Batch code of emitted coupons (optional)","type":"string","x-nullable":true},"coupon_do_not_add_to_wallet":{"description":"Do not add emitted coupons to the customer's wallet (optional)","enum":[0,1],"type":"integer"},"depends_calc_period":{"$ref":"#/definitions/LoyaltyRuleDependsCalcPeriod","description":"Rule values dependencies period (not applicable for depency 'bonuses-on-account')","x-nullable":true},"depends_calc_period_related_to_current_category":{"description":"Dependencies period limited by current category period","enum":[0,1],"type":"integer"},"depends_excluded_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc do not applied for item categories (if empty - no exceptions)","x-nullable":true},"depends_excluded_items":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc do not applied for items codes (if empty - no exceptions)","x-nullable":true},"depends_included_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc applied for item categories (if empty - applied for any categories)","x-nullable":true},"depends_included_items":{"$ref":"#/definitions/StringValuesList","description":"Depencies calc applied for items codes (if empty - applied for any items)","x-nullable":true},"depends_type":{"$ref":"#/definitions/LoyaltyRuleDependsType","description":"Rule values dependencies type","x-nullable":true},"excluded_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Rule do not applied for item categories (if empty - no exceptions)","x-nullable":true},"excluded_items":{"$ref":"#/definitions/StringValuesList","description":"Rule do not applied for items codes (if empty - no exceptions)","x-nullable":true},"id":{"description":"Rule ID","format":"uuid","type":"string","x-nullable":true},"implementation_data":{"$ref":"#/definitions/RuleImplementationData","description":"Rule check implementation data (optional, only in check implemented rules)","x-nullable":true},"included_item_categories":{"$ref":"#/definitions/StringValuesList","description":"Rule applied for item categories (if empty - applied for any categories)","x-nullable":true},"included_items":{"$ref":"#/definitions/StringValuesList","description":"Rule applied for items codes (if empty - applied for any items)","x-nullable":true},"item_zero_quantity_as_one_quantity":{"description":"Interpret zero quantity of an item as one (for item action types only)","enum":[0,1],"type":"integer"},"items_limit_max":{"description":"maximum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"items_limit_min":{"description":"minimum limit items in check (0 - no limits)","type":"integer","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"only_once_per_check":{"description":"Apply rule only once per check (for coupon automatic only)","enum":[0,1],"type":"integer"},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"List of POS where rule is applicable","x-nullable":true},"priority":{"description":"Rule priority(0 - the greatest one)","type":"integer","x-nullable":true},"promotional_bonuses_expire_date":{"description":"Value of promotional bonuses expire date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"promotional_bonuses_expire_type":{"$ref":"#/definitions/PromotionalBonusesExpireType","description":"Promotional bonuses expiration value type","x-nullable":true},"promotional_bonuses_expire_value":{"description":"Value of promotional bonuses expire","type":"integer","x-nullable":true},"promotional_bonuses_starting_date":{"description":"Value of promotional bonuses start date (depends on the Business settings; by default, it is based on the UTC time zone)","format":"date","type":"string","x-nullable":true},"promotional_bonuses_starting_type":{"$ref":"#/definitions/PromotionalBonusesStartingType","description":"Promotional bonuses starting value type","x-nullable":true},"promotional_bonuses_starting_value":{"description":"Value of promotional bonuses start","type":"integer","x-nullable":true},"scheduled":{"description":"Rule is scheduled","enum":[0,1],"type":"integer","x-nullable":true},"scope":{"$ref":"#/definitions/LoyaltyRuleScope","description":"Rule scope (readonly)","x-nullable":true},"special_account_id":{"description":"Special account ID","type":"string","x-nullable":true},"time_from":{"description":"Rule valid from time (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"time_to":{"description":"Rule valid to time (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"title":{"description":"Rule title","type":"string","x-nullable":true},"use_alternative_dependencies_by_items":{"description":"Alternative calc by items dependencies usage","enum":[0,1],"type":"integer"},"valid_after":{"description":"Rule valid from date (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"valid_before":{"description":"Rule valid to date (used if rule is scheduled, in RFC3339)","format":"date","type":"string","x-nullable":true},"value":{"$ref":"#/definitions/ThresholdsValues","description":"Values set based on thresholds","x-nullable":true},"week_days":{"$ref":"#/definitions/WeekDaysList","description":"Rule valid at the days (used if rule is scheduled)","x-nullable":true}},"type":"object"},"CheckImplementedRulesList":{"items":{"$ref":"#/definitions/CheckImplementedRule"},"type":"array"},"CheckItem":{"properties":{"additions":{"$ref":"#/definitions/CheckItemAdditionalInfo","description":"Additional information for further processing","x-nullable":true},"amount":{"description":"Item row total","format":"float","type":"number","x-nullable":true},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"authorized_amount":{"description":"Item row total by authorized payment transaction","format":"float","type":"number","x-nullable":true},"authorized_quantity":{"description":"Item quantity by authorized payment transaction","format":"float","type":"number","x-nullable":true},"bonuses_added":{"description":"Amount of added bonuses","format":"float","type":"number","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value","type":"integer","x-nullable":true},"calculated_bonuses_redeemed_amount":{"description":"Goods item total bonus points redeemed calculated by check (for list with stock)","format":"double","type":"number","x-nullable":true},"calculated_discount_amount":{"description":"Goods item total discount calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"calculated_margins":{"$ref":"#/definitions/CheckMargins","description":"Goods item total margins calculated by margins applicable to the price (optional, readonly)","x-nullable":true},"calculated_price":{"description":"Goods item price calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"calculated_taxes":{"$ref":"#/definitions/CheckTaxes","description":"Goods item total taxes calculated by taxes applicable to the price (optional, readonly)","x-nullable":true},"calculated_unit_bonuses_redeemed_amount":{"description":"Goods item unit bonus points redeemed calculated by check (for list with stock)","format":"double","type":"number","x-nullable":true},"calculated_unit_discount_amount":{"description":"Goods item unit discount calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"category":{"description":"item category","type":"string","x-nullable":true},"code":{"description":"item code","type":"string","x-nullable":true},"discount_amount":{"description":"Amount of discount","format":"float","type":"number","x-nullable":true},"loyalty_item_id":{"description":"Loyalty item unique id related to check item (optional, readonly)","type":"string","x-nullable":true},"margins":{"$ref":"#/definitions/PriceMargins","description":"Margins applicable to the price (optional)","x-nullable":true},"passthru_data":{"$ref":"#/definitions/GoodsPassThru","description":"PassThru data for Fleet, etc (optional)","x-nullable":true},"price":{"description":"Item price","format":"float","type":"number","x-nullable":true},"price_decimal_digits":{"description":"Number of decimal digits in price value","type":"integer","x-nullable":true},"processed_amount":{"description":"Item row total by job","format":"float","type":"number","x-nullable":true},"processed_quantity":{"description":"Item quantity by job","format":"float","type":"number","x-nullable":true},"quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"quantity_decimal_digits":{"description":"Number of decimal digits in quantity value (only for quantity_recalculate_type is applicable)","type":"integer","x-nullable":true},"quantity_recalculate_type":{"$ref":"#/definitions/CheckItemQuantityRecalculateType","description":"Quantity recalculate type (if needed)","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer","x-nullable":true},"taxes":{"$ref":"#/definitions/PriceTaxes","description":"Taxes applicable to the price (optional)","x-nullable":true},"title":{"description":"item title","type":"string","x-nullable":true},"unit":{"description":"Measuring units","type":"string","x-nullable":true},"weighing":{"description":"Weight goods flag","enum":[0,1],"type":"integer","x-nullable":true},"whole_number":{"description":"Item quantity only by whole number flag","enum":[0,1],"type":"integer","x-nullable":true}},"type":"object"},"CheckItemAdditionalInfo":{"properties":{"job":{"$ref":"#/definitions/Job","description":"Information for further job processing","type":"string"},"loyalty_item_id":{"description":"Loyalty item unique id related to check item (optional, readonly)","type":"string","x-nullable":true},"processing_id":{"description":"Check item processing id (optional, readonly)","type":"string","x-nullable":true},"quantity_decimal_digits":{"description":"Number of decimal digits in quantity value (optional, readonly)","type":"integer","x-nullable":true},"quantity_recalculate_skipped":{"description":"Quantity recalculate skipped flag (optional, readonly)","type":"boolean","x-nullable":true},"quantity_recalculate_type":{"$ref":"#/definitions/CheckItemQuantityRecalculateType","description":"Quantity recalculate type (optional, readonly)","x-nullable":true}},"type":"object"},"CheckItemEnterMode":{"enum":["without-limits","presets-only","manually-only"],"type":"string"},"CheckItemQuantityRecalculateType":{"enum":["adjust-by-amount","recalculate-by-amount"],"type":"string"},"CheckLoyalty":{"properties":{"active":{"description":"Active flag (optional)","enum":[0,1],"type":"integer","x-nullable":true},"categories":{"$ref":"#/definitions/LoyaltyCategoriesList","description":"Categories (optional)"},"id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"legal_info":{"description":"Loyalty legal info (optional)","type":"string","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links (optional)"},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos (optional)"},"privacy_policy_url":{"description":"Loyalty privacy policy link (optional)","type":"string","x-nullable":true},"public_description":{"description":"Loyalty public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Loyalty public title (optional)","type":"string","x-nullable":true},"title":{"description":"Loyalty title","type":"string","x-nullable":true}},"type":"object"},"CheckMarginExplainDetailingItem":{"properties":{"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"include_in_receipt":{"description":"Include in receipt (optional)","type":"boolean","x-nullable":true},"source":{"$ref":"#/definitions/PriceExplainValueSource","description":"Source of value","x-nullable":true},"type":{"$ref":"#/definitions/PriceExplainValueType","description":"Type of value","x-nullable":true},"value":{"description":"Result value of current price level","format":"float","type":"number","x-nullable":true},"value_code":{"description":"Value Code if exists (optional)","type":"string","x-nullable":true},"value_id":{"description":"Value Id if exists (optional)","format":"uuid","type":"string","x-nullable":true},"value_title":{"description":"Value title if exists (optional)","type":"string","x-nullable":true}},"type":"object"},"CheckMargins":{"properties":{"terminal_additional_costs":{"description":"Terminal additional costs detailing","items":{"$ref":"#/definitions/CheckMarginExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"CheckPos":{"properties":{"active":{"description":"Terminal is active flag (optional)","enum":[0,1],"type":"integer"},"additional_services_required":{"description":"Is additional services required (optional)","enum":[0,1],"type":"integer","x-nullable":true},"addresses":{"description":"Address of sale point (optional)","type":"string","x-nullable":true},"catalog_publication_comment":{"description":"Pos catalog publication comment","type":"string","x-nullable":true},"catalog_publication_state":{"$ref":"#/definitions/PosCatalogPublicationState","description":"Pos catalog publication state (optional)","x-nullable":true},"categories":{"$ref":"#/definitions/LoyaltyCategoriesList","description":"Categories (optional)","x-nullable":true},"check_item_enter_mode":{"$ref":"#/definitions/CheckItemEnterMode","description":"Pos check items entering mode possibilities (optional)","x-nullable":true},"country":{"description":"Country code (optional)","type":"string","x-nullable":true},"id":{"description":"Point of sales ID","format":"uuid","type":"string"},"latitude":{"description":"GEO Latitude (optional)","format":"double","type":"number","x-nullable":true},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links (optional)","x-nullable":true},"longitude":{"description":"GEO Longitude (optional)","format":"double","type":"number","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","type":"string"},"maximum_service_distance":{"description":"Maximum service distance in km (0 - unlimited) (optional)","type":"integer"},"phones":{"$ref":"#/definitions/PhoneNumbersList","description":"Phones of sale point"},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos (optional)","x-nullable":true},"priority":{"description":"Priority (optional)","type":"integer"},"public_description":{"description":"Point of sale public description (optional)","type":"string","x-nullable":true},"public_title":{"description":"Point of sale public title (optional)","type":"string","x-nullable":true},"time_zone":{"description":"Time zone (optional)","type":"string","x-nullable":true},"title":{"description":"POS title","type":"string"},"type":{"$ref":"#/definitions/PosType","description":"Pos type"}},"type":"object"},"CheckService":{"properties":{"additional_service_id":{"description":"Unique Id of additional service by code (optional, readonly)","format":"uuid","type":"string","x-nullable":true},"amount":{"description":"Service amount","format":"float","type":"number","x-nullable":true},"code":{"description":"Service code","type":"string"},"cost":{"description":"Service cost (for unit of value)","format":"float","type":"number","x-nullable":true},"decimal_digits":{"description":"Number of decimal digits in cost and amount values","type":"integer","x-nullable":true},"service_item_info":{"$ref":"#/definitions/AdditionalService","description":"Additional service info (optional, readonly)","x-nullable":true},"title":{"description":"Service title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/AdditionalServiceType","description":"Service type","x-nullable":true},"value":{"description":"Base value for calculate service cost and amount (distance, etc.)","format":"float","type":"number","x-nullable":true}},"required":["code"],"type":"object"},"CheckServices":{"items":{"$ref":"#/definitions/CheckService"},"type":"array"},"CheckSpecialAccount":{"properties":{"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"id":{"description":"Field id","type":"string","x-nullable":true},"title":{"description":"Account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type","x-nullable":true}},"type":"object"},"CheckTank":{"properties":{"address":{"description":"Title","type":"string","x-nullable":true},"code":{"description":"Tank unique code (read only)","type":"string","x-nullable":true},"goods_code":{"description":"Linked product code (optional, only for linked tank data) (read only)","type":"string","x-nullable":true},"latitude":{"description":"Latitude in decimal degrees","format":"float","type":"number","x-nullable":true},"longitude":{"description":"Longitude in decimal degrees","format":"float","type":"number","x-nullable":true},"physical_dip_amount":{"description":"Physical DIP Amount","format":"float","type":"number","x-nullable":true},"product_volume_after":{"description":"Tank product volume after operation (read only)","format":"float","type":"number","x-nullable":true},"product_volume_before":{"description":"Tank product volume before operation (read only)","format":"float","type":"number","x-nullable":true},"tank_id":{"description":"Tank id","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Title (read only)","type":"string","x-nullable":true},"volume":{"description":"Tank volume (read only)","format":"float","type":"number","x-nullable":true}},"type":"object"},"CheckTaxExplainDetailingItem":{"properties":{"decimal_digits":{"description":"Number of decimal digits in value","type":"integer","x-nullable":true},"exempt":{"description":"Tax/Margin exemption (optional)","type":"boolean","x-nullable":true},"include_in_receipt":{"description":"Include in receipt (optional)","type":"boolean","x-nullable":true},"source":{"$ref":"#/definitions/PriceExplainValueSource","description":"Source of value","x-nullable":true},"type":{"$ref":"#/definitions/PriceExplainValueType","description":"Type of value","x-nullable":true},"value":{"description":"Result value of current price level","format":"float","type":"number","x-nullable":true},"value_code":{"description":"Value Code if exists (optional)","type":"string","x-nullable":true},"value_id":{"description":"Value Id if exists (optional)","format":"uuid","type":"string","x-nullable":true},"value_title":{"description":"Value title if exists (optional)","type":"string","x-nullable":true}},"type":"object"},"CheckTaxes":{"properties":{"base":{"description":"Base taxes detailing","items":{"$ref":"#/definitions/CheckTaxExplainDetailingItem"},"type":"array","x-nullable":true},"sales":{"description":"Sales taxes detailing","items":{"$ref":"#/definitions/CheckTaxExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"CheckUserExternalFormRelations":{"properties":{"required":{"description":"Requred user external forms","items":{"$ref":"#/definitions/UserExternalForm"},"type":"array","x-nullable":true},"wanted":{"description":"Wanted user external forms","items":{"$ref":"#/definitions/UserExternalForm"},"type":"array","x-nullable":true}},"type":"object"},"CorporateSpecialAccountRefillObject":{"properties":{"amount":{"description":"Refill amount","format":"float","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value (optional)","type":"integer","x-nullable":true},"bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (optional)","type":"integer","x-nullable":true},"check_services":{"$ref":"#/definitions/CheckServices","description":"Services added on check (optional)","x-nullable":true},"comment":{"description":"Comment","type":"string","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value (optional)","type":"integer","x-nullable":true}},"required":["amount"],"type":"object"},"CorporateUserContact":{"description":"Contact info","properties":{"address":{"description":"contact address","type":"string","x-nullable":true},"comment":{"description":"contact comment","type":"string","x-nullable":true},"contact_person":{"description":"Contact person","type":"string","x-nullable":true},"email":{"description":"contact email","type":"string","x-nullable":true},"mobile":{"description":"Mobile phone number","type":"string","x-nullable":true},"phones":{"description":"Phone numbers","type":"string","x-nullable":true}},"type":"object","x-nullable":true},"CorporateUserNotificationSettings":{"properties":{"transaction_notification":{"description":"Send transaction notifications","enum":[0,1],"type":"integer","x-nullable":true},"transaction_notification_emails":{"description":"Transaction notifications recipients email list","items":{"description":"Recipient email","type":"string"},"type":"array","x-nullable":true}},"type":"object"},"CorporateUserProfile":{"properties":{"address":{"description":"Address","type":"string","x-nullable":true},"city":{"description":"City","type":"string","x-nullable":true},"company_name":{"description":"Company name","type":"string","x-nullable":true},"contacts":{"description":"Contacts list","items":{"$ref":"#/definitions/CorporateUserContact"},"type":"array"},"country":{"description":"Country ISO code","type":"string","x-nullable":true},"email":{"description":"Email for access to account","type":"string","x-nullable":true},"id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"language":{"description":"language ISO code","type":"string","x-nullable":true},"name":{"description":"User Name","type":"string","x-nullable":true},"notification_settings":{"$ref":"#/definitions/CorporateUserNotificationSettings","description":"Notification settings"},"password":{"description":"Static password exists","type":"boolean","x-nullable":true},"post_code":{"description":"Post Code","type":"string","x-nullable":true},"qr_secret_key":{"description":"Secret key for QR code generation","type":"string","x-nullable":true},"region":{"description":"Region","type":"string","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"},"CouponExternalCodeVisibilityType":{"enum":["always-open","on-redeem"],"type":"string"},"CouponProcessingStatus":{"enum":["pending","processed","error"],"type":"string"},"CouponStatus":{"enum":["open","redeemed","cancelled"],"type":"string"},"CouponType":{"enum":["check-modifier","certificate","external"],"type":"string"},"CouponTypeExtended":{"enum":["check-modifier","certificate","external","cross-business"],"type":"string"},"CustomPreferencesParameter":{"properties":{"name":{"description":"Preferences parameter name","type":"string"},"value":{"description":"Preferences parameter value","type":"object","x-nullable":true}},"type":"object"},"CustomerAccessType":{"enum":["full-bonuses-access","add-bonuses-only","waiting-for-confirmation","in-black-list"],"type":"string"},"CustomerCards":{"description":"Customer cards list","items":{"description":"Card code","type":"string"},"type":"array"},"CustomerCardsGroupedByLoyalty":{"properties":{"loyalties":{"description":"Loyalty list with customer cards info","items":{"$ref":"#/definitions/LoyaltyCustomerCards","description":"Loyalty info with customer cards"},"type":"array"}},"type":"object"},"CustomerFeedbackPrintOnCheck":{"enum":["none","qr-code","url","all"],"type":"string"},"CustomerPaymentSystemType":{"enum":["ipay","stripe","amp","4bill","eway","flutterwave","global-payments","wave","pax"],"type":"string"},"DashboardAccountState":{"properties":{"active":{"default":1,"description":"Account active flag","enum":[0,1],"type":"integer"},"available_amount":{"description":"Account available amount (readonly)","format":"float","type":"number","x-nullable":true},"available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"balance":{"description":"Account balance (readonly)","format":"float","type":"number","x-nullable":true},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"business_title":{"description":"Business title","type":"string"},"credit_limit":{"description":"Credit limit (only for 'credit' accounts)","format":"float","type":"number","x-nullable":true},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type","x-nullable":true},"currency":{"description":"Currency ISO code (if account type 'money')","type":"string"},"day_limit":{"default":0,"description":"Day limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"day_limit_available":{"description":"Day available amount, null if unlimited  (readonly)","format":"float","type":"number","x-nullable":true},"day_limit_used":{"description":"Day used amount (readonly)","format":"float","type":"number","x-nullable":true},"id":{"description":"Account ID","format":"uuid","type":"string"},"month_limit":{"default":0,"description":"Month limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"month_limit_available":{"description":"Month available amount, null if unlimited  (readonly)","format":"float","type":"number","x-nullable":true},"month_limit_used":{"description":"Month used amount (readonly)","format":"float","type":"number","x-nullable":true},"title":{"description":"Business special account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type"}},"type":"object"},"DashboardAccountTurnoverByCheckItemsItem":{"properties":{"active":{"default":1,"description":"Account active flag","enum":[0,1],"type":"integer"},"amount":{"description":"Turnover amount","format":"double","type":"number"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"business_title":{"description":"Business title","type":"string"},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type","x-nullable":true},"currency":{"description":"Currency ISO code (if account type 'money')","type":"string"},"id":{"description":"Account ID","format":"uuid","type":"string"},"item_category":{"description":"item category","type":"string"},"item_code":{"description":"item code","type":"string"},"item_title":{"description":"item title","type":"string"},"item_unit":{"description":"item measuring units","type":"string"},"title":{"description":"Business special account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type"}},"type":"object"},"DashboardAccountTurnoverByCorporateVehiclesItem":{"properties":{"active":{"default":1,"description":"Account active flag","enum":[0,1],"type":"integer"},"amount":{"description":"Turnover amount","format":"double","type":"number"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"business_title":{"description":"Business title","type":"string"},"corporate_vehicle_description":{"description":"Corporate vehicle description","type":"string"},"corporate_vehicle_id":{"description":"Corporate vehicle ID","format":"uuid","type":"string"},"corporate_vehicle_qr_code":{"description":"Corporate vehicle qr code","type":"string"},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type","x-nullable":true},"currency":{"description":"Currency ISO code (if account type 'money')","type":"string"},"id":{"description":"Account ID","format":"uuid","type":"string"},"title":{"description":"Business special account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type"}},"type":"object"},"DashboardAccountTurnoverByStaffItem":{"properties":{"active":{"default":1,"description":"Account active flag","enum":[0,1],"type":"integer"},"amount":{"description":"Turnover amount","format":"double","type":"number"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"business_title":{"description":"Business title","type":"string"},"corporate_staff_comment":{"description":"Staff Comment","type":"string"},"corporate_staff_id":{"description":"Staff ID","format":"uuid","type":"string"},"corporate_staff_position_id":{"description":"Staff Position ID","format":"uuid","type":"string"},"corporate_staff_position_title":{"description":"Staff Position title","type":"string"},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type","x-nullable":true},"currency":{"description":"Currency ISO code (if account type 'money')","type":"string"},"id":{"description":"Account ID","format":"uuid","type":"string"},"title":{"description":"Business special account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type"},"user_email":{"description":"User email","type":"string"},"user_external_id":{"description":"User external id","type":"string"},"user_name":{"description":"User name","type":"string"},"user_phone":{"description":"User phone number","type":"string"}},"type":"object"},"DashboardAccountTurnoverItem":{"properties":{"active":{"default":1,"description":"Account active flag","enum":[0,1],"type":"integer"},"business_id":{"description":"Business ID","format":"uuid","type":"string"},"business_title":{"description":"Business title","type":"string"},"close_amount":{"description":"Account amount at the ending of the period","format":"float","type":"number","x-nullable":true},"credit_type":{"$ref":"#/definitions/SpecialAccountCreditType","description":"Credit type","x-nullable":true},"currency":{"description":"Currency ISO code (if account type 'money')","type":"string"},"id":{"description":"Account ID","format":"uuid","type":"string"},"open_amount":{"description":"Account amount at the beginning of the period","format":"float","type":"number","x-nullable":true},"title":{"description":"Business special account title","type":"string","x-nullable":true},"turnover_credit_amount":{"description":"Credit turnover amount","format":"float","type":"number","x-nullable":true},"turnover_debit_amount":{"description":"Debit turnover amount","format":"float","type":"number","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type"}},"type":"object"},"DashboardRefuelItem":{"properties":{"business_id":{"description":"Business ID","format":"uuid","type":"string"},"business_title":{"description":"Business title","type":"string"},"consumption_odometer":{"description":"Consumption by odometer in volume per one distance/engine hours unit (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_dpv":{"description":"Consumption by odometer in distance/engine hours per one volume unit (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_gpd":{"description":"Consumption by odometer in galons per distance/engine hours units (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_gph":{"description":"Consumption by odometer in galons per engine hours units (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_l100k":{"description":"Consumption by odometer in liters per 100 kilometers (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_lpd":{"description":"Consumption by odometer in liters per distance/engine hoursunits (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_lph":{"description":"Consumption by odometer in liters per engine hours units (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_mpg":{"description":"Consumption by odometer in miles per galon (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_v100d":{"description":"Consumption by odometer in volume per 100 distance/engine hours units (optional, if exists previous refuel)","format":"double","type":"number"},"consumption_odometer_vpd":{"description":"Consumption by odometer in volume per distance/engine hours units (optional, if exists previous refuel)","format":"double","type":"number"},"corporate_offline_site_id":{"description":"Off-line site unique Id","type":"string"},"corporate_offline_site_title":{"description":"Off-line site title","type":"string"},"corporate_vehicle_avi_id":{"description":"Vehicle/Inventory avi identifier  (optional)","type":"string","x-nullable":true},"corporate_vehicle_description":{"description":"Vehicle/Inventory description  (optional)","type":"string","x-nullable":true},"corporate_vehicle_id":{"description":"Vehicle/Inventory unique Id  (optional)","type":"string","x-nullable":true},"corporate_vehicle_offline_one_time_fueling_limit":{"description":"Vehicle/Inventory off-line one time fueling limit  (optional)","format":"float","type":"number","x-nullable":true},"corporate_vehicle_qr_code":{"description":"Vehicle/Inventory qr-code / tag  (optional)","type":"string","x-nullable":true},"corporate_vehicle_rfid_tag":{"description":"Vehicle/Inventory rfid tag  (optional)","type":"string","x-nullable":true},"corporate_vehicle_vehicle_id":{"description":"Vehicle/Inventory Id  (optional)","type":"string","x-nullable":true},"distance_odometer":{"description":"Distance by odometer value (optional, if exists previous refuel)","format":"double","type":"number"},"distance_odometer_h":{"description":"Distance by odometer value in engine hours (optional, if exists previous refuel)","format":"double","type":"number"},"distance_odometer_k":{"description":"Distance by odometer value in kilometers (optional, if exists previous refuel)","format":"double","type":"number"},"distance_odometer_m":{"description":"Distance by odometer value in miles (optional, if exists previous refuel)","format":"double","type":"number"},"distance_odometer_unit":{"$ref":"#/definitions/OdometerUnitType","description":"Distance by odometer value unit of measure (optional)"},"id":{"description":"Refuel ID","format":"uuid","type":"string"},"item_captured_amount":{"description":"Captured amount","format":"double","type":"number"},"item_captured_price":{"description":"Captured price","format":"double","type":"number"},"item_captured_quantity":{"description":"Captured quantity","format":"double","type":"number"},"item_category":{"description":"Refuel item category","type":"string"},"item_code":{"description":"Refuel item code","type":"string"},"item_filled_amount":{"description":"Refuel amount","format":"double","type":"number"},"item_filled_price":{"description":"Refuel price","format":"double","type":"number"},"item_filled_quantity":{"description":"Refuel quantity","format":"double","type":"number"},"item_filled_quantity_g":{"description":"Refuel quantity in gallons","format":"double","type":"number"},"item_filled_quantity_l":{"description":"Refuel quantity in liters","format":"double","type":"number"},"item_filled_quantity_unit":{"$ref":"#/definitions/VolumeUnitType","description":"Refuel quantity measurement unit"},"item_price_unit":{"description":"Refuel item price unit - quantity or currency ISO code (Only if filling_price_type is 'special-account')","type":"string"},"item_title":{"description":"Refuel item title","type":"string"},"item_unit":{"description":"Refuel item measuring units","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_title":{"description":"Loyalty title","type":"string"},"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 value unit of measure"},"pos_id":{"description":"Pos ID","format":"uuid","type":"string"},"pos_title":{"description":"POS title","type":"string"},"position_id":{"description":"Position ID","format":"uuid","type":"string","x-nullable":true},"position_title":{"description":"Position title","type":"string","x-nullable":true},"previous_odometer":{"description":"Odometer value (optional, if exists previous refuel)","format":"double","type":"number"},"previous_odometer_unit":{"$ref":"#/definitions/OdometerUnitType","description":"Odometer value unit of measure (optional, if exists previous refuel)"},"processed":{"description":"Refuel UTC processed date-time","format":"date-time","type":"string"},"processed_local":{"description":"Transaction local (by POS time zone) processed date-time","format":"date-time","type":"string"},"staff_comment":{"description":"Staff comment","type":"string","x-nullable":true},"staff_id":{"description":"Staff ID","format":"uuid","type":"string","x-nullable":true},"staff_offline_one_time_fueling_limit":{"description":"Staff off-line one time fueling limit","format":"float","type":"number","x-nullable":true},"staff_qr_code":{"description":"Staff qr-code / tag","type":"string","x-nullable":true},"staff_rfid_tag":{"description":"Staff rfid tag","type":"string","x-nullable":true},"staff_suspended":{"description":"Staff suspended flag","enum":[0,1],"type":"integer","x-nullable":true},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"user_email":{"description":"User email","type":"string"},"user_external_id":{"description":"User external id","type":"string"},"user_id":{"description":"User ID","format":"uuid","type":"string"},"user_name":{"description":"User name","type":"string"},"user_phone":{"description":"User phone number","type":"string"},"vehicle_id":{"description":"Vehicle/inventory identifier/tag value  (optional)","type":"string","x-nullable":true}},"type":"object"},"DashboardRefuelsPeriodRequest":{"properties":{"corporate_staff_ids":{"description":"Filter by staff if needed","items":{"description":"Staff ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"corporate_vehicles_ids":{"description":"Filter by staff if needed","items":{"description":"Staff ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"count":{"description":"Report rows count per page","type":"integer"},"page":{"description":"Report list page number","type":"integer"},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"sort":{"$ref":"#/definitions/DashboardResultSortObject","description":"Sort options","x-nullable":true}},"type":"object"},"DashboardRefuelsPeriodSummary":{"properties":{"data":{"description":"Turnover data","items":{"$ref":"#/definitions/DashboardRefuelItem"},"type":"array"},"summary":{"properties":{"average_consumption":{"description":"Average refuels consumptionin in volume per one distance/engine hours unit (by odometer)","format":"float","type":"number"},"average_consumption_dpv":{"description":"Average refuels consumption in distance/engine hours per one volume unit (by odometer)","format":"float","type":"number"},"average_consumption_gpd":{"description":"Average refuels consumption in galons per distance/engine hours units (by odometer)","format":"float","type":"number"},"average_consumption_gph":{"description":"Average refuels consumption in galons per engine hours units (by odometer)","format":"float","type":"number"},"average_consumption_l100k":{"description":"Average refuels consumption in liters per 100 kilometers (by odometer)","format":"float","type":"number"},"average_consumption_lpd":{"description":"Average refuels consumption in liters per distance/engine hours units (by odometer)","format":"float","type":"number"},"average_consumption_lph":{"description":"Average refuels consumption in liters per engine hours units (by odometer)","format":"float","type":"number"},"average_consumption_mpg":{"description":"Average refuels consumption in miles per gallon (by odometer)","format":"float","type":"number"},"average_consumption_v100d":{"description":"Average refuels consumption in volume per 100 distance/engine hours units (by odometer)","format":"float","type":"number"},"average_consumption_vpd":{"description":"Average refuels consumption in volume per distance/engine hours units (by odometer)","format":"float","type":"number"},"total_amount":{"description":"Total refuels amount","format":"float","type":"number"},"total_distance":{"description":"Total refuels distance/engine hours (by odometer)","format":"float","type":"number"},"total_distance_h":{"description":"Total refuels distance in engine hours (by odometer)","format":"float","type":"number"},"total_distance_k":{"description":"Total refuels distance in kilometers (by odometer)","format":"float","type":"number"},"total_distance_m":{"description":"Total refuels distance in miles (by odometer)","format":"float","type":"number"},"total_quantity":{"description":"Total refuels volume","format":"float","type":"number"},"total_quantity_g":{"description":"Total refuels volume in gallons","format":"float","type":"number"},"total_quantity_l":{"description":"Total refuels volume in liters","format":"float","type":"number"},"total_rows_count":{"description":"Total rows count","type":"integer"}},"type":"object"}},"type":"object"},"DashboardRefuelsTotalRequest":{"properties":{"by_corporate_staff":{"default":true,"description":"Aggregate by staff","type":"boolean"},"by_corporate_vehicles":{"default":true,"description":"Aggregate by vehicles","type":"boolean"},"corporate_staff_ids":{"description":"Filter by staff if needed","items":{"description":"Staff ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"corporate_vehicles_ids":{"description":"Filter by staff if needed","items":{"description":"Staff ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"sort":{"$ref":"#/definitions/DashboardResultSortObject","description":"Sort options","x-nullable":true}},"type":"object"},"DashboardResultSortObject":{"properties":{"direction":{"$ref":"#/definitions/SortDirection","description":"Sort direction"},"field":{"description":"Field name","type":"string"}},"type":"object"},"DashboardScopeFilter":{"properties":{"ids":{"$ref":"#/definitions/StringValuesList","description":"List of filtered objects id"},"scope":{"description":"Scope type","enum":["business","loyalty","account"],"type":"string"}},"type":"object"},"DashboardTransactionsItemsUsage":{"properties":{"item_category":{"description":"Goods item category","type":"string"},"item_code":{"description":"Goods item code","type":"string"},"item_quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"item_title":{"description":"Goods item title","type":"string"},"item_unit":{"description":"Goods item measuring units","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_title":{"description":"Loyalty title","type":"string"}},"type":"object"},"DashboardTransactionsItemsUsagePosition":{"properties":{"corporate_position_id":{"description":"Corporate Position (Department) Id","format":"uuid","type":"string"},"corporate_position_title":{"description":"Corporate Position (Department) title","type":"string"},"item_category":{"description":"Goods item category","type":"string"},"item_code":{"description":"Goods item code","type":"string"},"item_quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"item_title":{"description":"Goods item title","type":"string"},"item_unit":{"description":"Goods item measuring units","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_title":{"description":"Loyalty title","type":"string"}},"type":"object"},"DashboardTransactionsItemsUsagePositionsSummary":{"description":"Items usage data","items":{"$ref":"#/definitions/DashboardTransactionsItemsUsagePosition"},"type":"array"},"DashboardTransactionsItemsUsageStaff":{"properties":{"corporate_position_id":{"description":"Corporate Position (Department) Id","format":"uuid","type":"string"},"corporate_position_title":{"description":"Corporate Position (Department) title","type":"string"},"corporate_staff_comment":{"description":"Corporate Staff comment","type":"string"},"corporate_staff_id":{"description":"Corporate Staff Id","format":"uuid","type":"string"},"corporate_staff_user_email":{"description":"Corporate Staff User email (login)","type":"string"},"corporate_staff_user_external_id":{"description":"Corporate Staff User external id","type":"string"},"corporate_staff_user_name":{"description":"Corporate Staff User name","type":"string"},"corporate_staff_user_phone":{"description":"Corporate Staff User phone","type":"string"},"item_category":{"description":"Goods item category","type":"string"},"item_code":{"description":"Goods item code","type":"string"},"item_quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"item_title":{"description":"Goods item title","type":"string"},"item_unit":{"description":"Goods item measuring units","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_title":{"description":"Loyalty title","type":"string"}},"type":"object"},"DashboardTransactionsItemsUsageStaffSummary":{"description":"Items usage data","items":{"$ref":"#/definitions/DashboardTransactionsItemsUsageStaff"},"type":"array"},"DashboardTransactionsItemsUsageSummary":{"description":"Items usage data","items":{"$ref":"#/definitions/DashboardTransactionsItemsUsage"},"type":"array"},"DashboardTransactionsItemsUsageSummaryRequest":{"properties":{"corporate_position_ids":{"description":"Filter by staff positions if needed","items":{"description":"Staff Position ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"corporate_staff_ids":{"description":"Filter by staff if needed","items":{"description":"Staff ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"corporate_vehicles_ids":{"description":"Filter by corporate vehicles if needed","items":{"description":"Corporate Vehicle ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"item_categories":{"description":"Filter by item categories if needed","items":{"description":"Item Categories","type":"string"},"type":"array","x-nullable":true},"item_codes":{"description":"Filter by item codes if needed","items":{"description":"Item Code","type":"string"},"type":"array","x-nullable":true},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"sort":{"$ref":"#/definitions/DashboardResultSortObject","description":"Sort options","x-nullable":true}},"type":"object"},"DashboardTransactionsItemsUsageVehicle":{"properties":{"corporate_position_id":{"description":"Corporate Position (Department) Id","format":"uuid","type":"string"},"corporate_position_title":{"description":"Corporate Position (Department) title","type":"string"},"corporate_vehicle_description":{"description":"Corporate Vehicle title","type":"string"},"corporate_vehicle_id":{"description":"Corporate Vehicle Id","format":"uuid","type":"string"},"corporate_vehicle_qr_code":{"description":"Corporate Vehicle qr-code","type":"string"},"corporate_vehicle_vehicle_id":{"description":"Corporate Vehicle vehicle id","type":"string"},"item_category":{"description":"Goods item category","type":"string"},"item_code":{"description":"Goods item code","type":"string"},"item_quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"item_title":{"description":"Goods item title","type":"string"},"item_unit":{"description":"Goods item measuring units","type":"string"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"loyalty_title":{"description":"Loyalty title","type":"string"}},"type":"object"},"DashboardTransactionsItemsUsageVehiclesSummary":{"description":"Items usage data","items":{"$ref":"#/definitions/DashboardTransactionsItemsUsageVehicle"},"type":"array"},"DataRequiredType":{"enum":["no","yes","possible"],"type":"string"},"EmailsList":{"items":{"description":"Email","type":"string"},"type":"array"},"EquipmentControllerStatus":{"enum":["created","connection-failed","available","unavailable"],"type":"string"},"EquipmentControllerType":{"enum":["plc-modicon-m241"],"type":"string"},"EquipmentType":{"enum":["car-wash"],"type":"string"},"ExternalBankCardsEDCTypes":{"enum":["auto","credit","debit","gift"],"type":"string"},"ExternalCheckIdScope":{"enum":["system","business","loyalty","pos","terminal"],"type":"string"},"FinalizeCheck":{"properties":{"comment":{"description":"Comment","type":"string"},"id":{"description":"Transaction Id (optional, not used if the identifier is passed in the path)","format":"uuid","type":"string"},"transaction_id":{"description":"Alias to id","format":"uuid","type":"string"}},"type":"object"},"FuelControllerConfiguration":{"properties":{"decimal_digits":{"$ref":"#/definitions/FuelControllerConfigurationDecimalDigits","description":"Controller decimal digits configuration","x-nullable":true},"measurement_units":{"$ref":"#/definitions/FuelControllerConfigurationMeasurementUnits","x-nullable":true}},"type":"object"},"FuelControllerConfigurationDecimalDigits":{"properties":{"amount":{"description":"Number of decimal digits in amount value","type":"integer"},"price":{"description":"Number of decimal digits in price value","type":"integer"},"volume":{"description":"Number of decimal digits in volume value","type":"integer"}},"type":"object"},"FuelControllerConfigurationMeasurementUnits":{"properties":{"volume":{"$ref":"#/definitions/FuelControllerVolumeMeasurementUnit","description":"Volume measurement unit","x-nullable":true}},"type":"object"},"FuelControllerConfigurationReadingStatus":{"enum":["connection-not-configured","ready-to-read","success","fail"],"type":"string"},"FuelControllerPriceControlScheme":{"enum":["none","price-from-system","price-from-controller"],"type":"string"},"FuelControllerPumpAuthorizeConfirmation":{"enum":["selected-nozzle-up","without-nozzle-confirmation"],"type":"string"},"FuelControllerType":{"enum":["pts-2"],"type":"string"},"FuelControllerVolumeMeasurementUnit":{"enum":["L","G"],"type":"string"},"FuelFillingType":{"enum":["amount","volume"],"type":"string"},"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"},"Goods":{"properties":{"code":{"description":"Goods Code","type":"string"},"id":{"description":"Goods ID","format":"uuid","type":"string"},"title":{"description":"Goods Title","type":"string"}},"type":"object"},"GoodsCodes":{"items":{"description":"goods code","type":"string"},"type":"array"},"GoodsPassThru":{"properties":{"fleet":{"$ref":"#/definitions/GoodsPassThruFleet","description":"PassThru data for Fleet","x-nullable":true}},"type":"object"},"GoodsPassThruFleet":{"properties":{"measure_unit":{"description":"Unit of measure","enum":["L","G"],"type":"string","x-nullable":true},"product_code":{"description":"NACS Product Code","type":"string","x-nullable":true}},"type":"object"},"IdType":{"enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"type":"string"},"IdentifierChangeObject":{"properties":{"pin":{"description":"Verification pin (optional)","type":"string"},"value":{"description":"Identifier value or verified token","type":"string"}},"required":["value"],"type":"object"},"IdentifierValidationRequestObject":{"properties":{"value":{"description":"Identifier (phone number, email) value","type":"string","x-nullable":true}},"required":["value"],"type":"object"},"ImageObject":{"properties":{"id":{"description":"Image asset ID","format":"uuid","type":"string","x-nullable":true},"url":{"description":"Image asset URL","type":"string","x-nullable":true}},"type":"object"},"ImageObjectsList":{"items":{"$ref":"#/definitions/ImageObject"},"type":"array"},"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"},"description":{"type":"string"},"id":{"description":"Loyalty ID","format":"uuid","type":"string"},"legal_info":{"description":"Loyalty legal info","type":"string"},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links"},"photos":{"$ref":"#/definitions/ImageObjectsList"},"privacy_policy_url":{"description":"Loyalty privacy policy link","type":"string"},"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"},"LoyaltyCustomerCards":{"properties":{"active":{"description":"Loyalty active flag","enum":[0,1],"type":"integer"},"business":{"description":"Business info","properties":{"active":{"description":"Business active flag","enum":[0,1],"type":"integer"},"code":{"description":"Business code","type":"string"},"country":{"description":"Country ISO code","type":"string"},"id":{"description":"Business Id","format":"uuid","type":"string"},"title":{"description":"Business title","type":"string"}},"type":"object","x-nullable":true},"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"cards":{"$ref":"#/definitions/CustomerCards","description":"Customer cards list"},"id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Loyalty Title","type":"string","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"},"LoyaltyRuleActionType":{"enum":["discount-percent-by-item","discount-amount-by-item","special-price-by-item","discount-percent-by-check","discount-amount-by-check","charge-percent-by-item","charge-amount-by-item","charge-percent-by-check","charge-amount-by-check","emission-coupon-by-item","emission-coupon-by-check"],"type":"string"},"LoyaltyRuleApplicableApiScope":{"enum":["all","client","terminal"],"type":"string"},"LoyaltyRuleApplicableForCustomer":{"enum":["identified","anonymous","all"],"type":"string"},"LoyaltyRuleApplicableForSale":{"enum":["all","first-only","all-but-first"],"type":"string"},"LoyaltyRuleDependsCalcPeriod":{"enum":["all","check","day","week","month","three-month","year","current-week","past-week","current-month","past-month","current-quarter","past-quarter","current-year","past-year"],"type":"string"},"LoyaltyRuleDependsTimeZone":{"enum":["system","pos"],"type":"string"},"LoyaltyRuleDependsType":{"enum":["none","amount","quantity","bonuses-earned","bonuses-on-account"],"type":"string"},"LoyaltyRuleImplementedBy":{"enum":["automatic-rule","manual-rule","display-rule","coupon"],"type":"string"},"LoyaltyRuleImplementedCalculationType":{"enum":["summarizing","maximum","sequential"],"type":"string"},"LoyaltyRuleScope":{"enum":["retail","corporate"],"type":"string"},"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"},"MobileAppWalletType":{"enum":["stripe","eway","flutterwave","global-payments","wave"],"type":"string"},"MobileWallets":{"items":{"$ref":"#/definitions/PaymentWallet"},"type":"array"},"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"},"OfflineSite":{"properties":{"active":{"description":"Site active flag","enum":[0,1],"type":"integer"},"created":{"description":"Site created date and time","format":"date-time","type":"string","x-nullable":true},"id":{"description":"Site unique Id","format":"uuid","type":"string","x-nullable":true},"last_clients_sync_time":{"description":"Last Clients synchronize time (readonly, optional)","format":"date-time","type":"string","x-nullable":true},"last_transactions_sync_time":{"description":"Last Transactions synchronize time (readonly, optional)","format":"date-time","type":"string","x-nullable":true},"login":{"description":"Site login","type":"string"},"password":{"description":"Site password","type":"string","x-nullable":true},"special_account":{"$ref":"#/definitions/SpecialAccount","description":"Special account info (optional)","x-nullable":true},"special_account_id":{"description":"Corporate Customer Account ID (optional)","format":"uuid","type":"string","x-nullable":true},"title":{"description":"Site title","type":"string"}},"type":"object"},"OfflineSiteApplicationSettings":{"type":"object"},"OfflineSitesList":{"items":{"$ref":"#/definitions/OfflineSite"},"type":"array"},"OfflineSitesListPaginated":{"properties":{"data":{"$ref":"#/definitions/OfflineSitesList","description":"Off-line sites list"},"summary":{"$ref":"#/definitions/OfflineSitesListPaginatedSummary"}},"type":"object"},"OfflineSitesListPaginatedSummary":{"properties":{"total_rows_count":{"description":"Total off-line sites count","type":"integer"}},"type":"object"},"Payment":{"properties":{"amount":{"description":"To pay amount","format":"float","type":"number","x-nullable":true},"bank_card_external":{"$ref":"#/definitions/BankCardExternalInfo","description":"bank-card-external payment type info (optional)","x-nullable":true},"business_fee_amount":{"description":"Business fee amount (optional, only for 'mobile-app' type)","format":"float","type":"number","x-nullable":true},"change":{"description":"Payment change (optional, only for 'cash' type)","format":"float","type":"number"},"currency":{"description":"Currensy ISO code (depends on transaction type)","type":"string","x-nullable":true},"customer_fee_amount":{"description":"Customer fee amount (optional, only for 'mobile-app' type)","format":"float","type":"number","x-nullable":true},"external_info":{"$ref":"#/definitions/PaymentExternalInfo","description":"payment external system info (optional)","x-nullable":true},"id":{"description":"Payment Id","format":"uuid","type":"string","x-nullable":true},"mobileapp":{"$ref":"#/definitions/MobileAppInfo","description":"mobile-app payment type info (optional)","x-nullable":true},"receipt":{"description":"Payment receipt (optional, only for 'cash' type)","format":"float","type":"number"},"status":{"$ref":"#/definitions/BankCardExternalPaymentStatus","description":"Operation status","x-nullable":true},"type":{"$ref":"#/definitions/PaymentType","description":"Payment type","x-nullable":true}},"type":"object"},"PaymentCardManage":{"properties":{"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"cards":{"$ref":"#/definitions/ObjectIds","description":"Cards id's array (for 'carddelete' action only)","x-nullable":true},"redirect_cancel_url":{"description":"Redirect URL if operation canceled (for 'cardadd' action only)","type":"string"},"redirect_fail_url":{"description":"Redirect URL if operation failed (for 'cardadd' action only)","type":"string"},"redirect_success_url":{"description":"Redirect URL if operation successful (for 'cardadd' action only)","type":"string"}},"type":"object"},"PaymentCardManageResult":{"properties":{"error":{"description":"Error text","type":"string"},"process_params":{"properties":{"client_secret":{"description":"One time client operation token (for stripe only)","type":"string"},"setup_external_id":{"description":"Setup intent ID (for stripe only)","type":"string"}},"type":"object"},"type":{"description":"Object type","enum":["status","url"],"type":"string"},"value":{"description":"Object value","type":"string"}},"type":"object"},"PaymentData":{"properties":{"amount":{"description":"Payment amount","format":"float","type":"number"},"auto_finalize_parent_transaction":{"default":false,"description":"Automaticaly finalize transactions when payment completed successfuly","type":"boolean"},"card_id":{"description":"Card Id","format":"uuid","type":"string"},"card_password":{"description":"Card password","type":"string"},"id":{"description":"Payment Id","format":"uuid","type":"string"},"integration_type":{"description":"Integration type used for payment (for Stripe only)","enum":["checkout","elements"],"type":"string"},"redirect_cancel_url":{"description":"Redirect URL if payment canceled","type":"string"},"redirect_fail_url":{"description":"Redirect URL if payment failed","type":"string"},"redirect_success_url":{"description":"Redirect URL if payment successful","type":"string"},"save_for_future_use":{"description":"Save card for future use (for Stripe & GP only)","type":"boolean"}},"required":["id","card_id","amount"],"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"},"PaymentInfoList":{"items":{"$ref":"#/definitions/Payment"},"type":"array"},"PaymentStatus":{"description":"Payment status details","properties":{"amount":{"description":"To pay amount (optional)","format":"float","type":"number","x-nullable":true},"card_details_required":{"description":"Card details required for payment (for stripe only)","type":"boolean"},"client_secret":{"description":"One time client operation token (for stripe only)","type":"string"},"currency":{"description":"Currency ISO code","type":"string","x-nullable":true},"customer_fee_amount":{"description":"Customer fee amount (optional, only for 'mobile-app' type)","format":"float","type":"number","x-nullable":true},"error":{"description":"Payment error (optional)","type":"string","x-nullable":true},"id":{"description":"Payment Id","format":"uuid","type":"string"},"invoice":{"description":"Payment amount (optional)","format":"float","type":"number"},"payment_external_id":{"description":"External system payment identifier (optional, for stripe, 4bill, eway only)","type":"string"},"payment_processing_url":{"description":"External system payment processing URL (optional, for 4bill, eway only)","type":"string"},"secure":{"description":"Secure type","enum":["none","otp","3ds"],"type":"string"},"status":{"description":"Operation status","enum":["inprocess","success","fail","confirmation","verification","registered","canceled","error","authorized","unknown"],"type":"string"},"type":{"$ref":"#/definitions/MobileAppWalletType","description":"Wallet type"}},"type":"object"},"PaymentType":{"enum":["cash","bank-card","bank-card-external","mobile-app","special-account"],"type":"string"},"PaymentWallet":{"description":"Wallet details","properties":{"add_card_by_payment":{"description":"Wallet support add card by payment (optional)","type":"boolean"},"add_card_stand_alone":{"description":"Wallet support add card stand-alone operation (optional)","type":"boolean"},"apple_pay_allowed":{"description":"Wallet payment by ApplePay allowed (optional)","type":"boolean"},"authorize_payment_allowed":{"description":"Wallet authorize payment (hold funds and later capture) allowed (optional)","type":"boolean"},"business":{"$ref":"#/definitions/Business","description":"Business info (optional, only for split_by_businesses is true case)"},"cards":{"description":"Wallet cards (optional)","items":{"$ref":"#/definitions/PaymentWalletCards"},"type":"array"},"country":{"description":"Country ISO code","type":"string"},"customer_country_required":{"description":"Operation required customer country (optional)","type":"boolean"},"customer_email_required":{"description":"Operation required customer email (optional)","type":"boolean"},"customer_fee":{"$ref":"#/definitions/PaymentWalletFee","description":"Payment system customers fee"},"customer_name_required":{"description":"Operation required customer name (optional)","type":"boolean"},"customer_phone_required":{"description":"Operation required customer phone (optional)","type":"boolean"},"google_pay_allowed":{"description":"Wallet payment by GooglePay allowed (optional)","type":"boolean"},"integration_types":{"$ref":"#/definitions/StripeIntegrationTypes","description":"Supported integration types (optional)"},"minimal_amount":{"$ref":"#/definitions/PaymentWalletMinimalAmount","description":"Payment system customers manamum amount (optional)"},"pkey":{"description":"Publick Key (optional)","type":"string"},"split_by_businesses":{"description":"Split wallet by businesses (optional, not for splitted wallets)","type":"boolean"},"status":{"description":"Wallet status (optional)","enum":["notexists","invite","exists","error"],"type":"string"},"type":{"$ref":"#/definitions/MobileAppWalletType","description":"Wallet type (optional, not for splitted wallets)"},"wallets":{"description":"Wallet by Businesses (optional, only for split_by_businesses is true case)","items":{"$ref":"#/definitions/PaymentWallet"},"type":"array"}},"type":"object"},"PaymentWalletCardBillingDetails":{"description":"Card billing details","properties":{"address":{"description":"Address (depends on the payment system) (optional)","type":"object"},"email":{"description":"User email (optional)","type":"string"},"name":{"description":"User name (optional)","type":"string"},"phone":{"description":"User phone number (optional)","type":"string"}},"type":"object"},"PaymentWalletCards":{"description":"Wallet Card Info","properties":{"alias":{"description":"Card alias (optional)","type":"string"},"billing_details":{"$ref":"#/definitions/PaymentWalletCardBillingDetails","description":"Card billing details (optional)"},"brand":{"description":"Card brand (optional)","type":"string"},"default":{"description":"Card is default","type":"boolean"},"external_id":{"description":"Card external id (optional)","type":"string"},"funding":{"description":"Card funding type (optional)","type":"string"},"id":{"description":"Card Id","format":"uuid","type":"string"},"integration_types":{"$ref":"#/definitions/StripeIntegrationTypes","description":"Integration type used for card (optional)"},"is_corporate":{"description":"Card corporate flag (optional)","enum":[0,1],"type":"integer"},"is_expired":{"description":"Card expired flag (optional)","enum":[0,1],"type":"integer"},"mask":{"description":"Card masked PAN","type":"string"},"password":{"description":"Password required for using","type":"boolean"},"payment_type":{"description":"Card payment type (optional)","enum":["card"],"type":"string"}},"type":"object"},"PaymentWalletFee":{"properties":{"exist":{"description":"Fee exists (greater than zero)","type":"boolean"},"fee":{"$ref":"#/definitions/PaymentWalletFeeDetail","description":"Fee details"}},"type":"object"},"PaymentWalletFeeDetail":{"properties":{"fixed":{"description":"Fixed amount of fee","format":"float","type":"number"},"percentage":{"description":"Percentage from payment amount part of fee","format":"float","type":"number"}},"required":["fixed","percentage"],"type":"object"},"PaymentWalletMinimalAmount":{"properties":{"amount":{"description":"Minimal amount value","format":"float","type":"number"},"currency":{"description":"Minimal amount currency","type":"string"},"exist":{"description":"Minimal amount exist (greater than zero)","type":"boolean"}},"type":"object"},"PhoneNumber":{"properties":{"number":{"description":"Phone number","type":"string"}},"type":"object"},"PhoneNumbersList":{"items":{"$ref":"#/definitions/PhoneNumber"},"type":"array"},"Pos":{"description":"Point of sale","properties":{"additional_services_required":{"default":0,"description":"Is additional services required","enum":[0,1],"type":"integer"},"addresses":{"description":"Address of sale point","type":"string"},"categories":{"description":"Categories","items":{"$ref":"#/definitions/LoyaltyCategory"},"type":"array"},"country":{"description":"Country code","type":"string"},"description":{"description":"Point of sale public description","type":"string"},"id":{"description":"Point of sales ID","format":"uuid","type":"string"},"latitude":{"description":"GEO Latitude","format":"double","type":"number"},"links":{"$ref":"#/definitions/LoyaltyLinks","description":"Links"},"longitude":{"description":"GEO Longitude","format":"double","type":"number"},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"maximum_service_distance":{"default":0,"description":"Maximum service distance in km (0 - unlimited)","type":"integer"},"phones":{"$ref":"#/definitions/PhoneNumbersList","description":"Phones of sale point"},"photos":{"$ref":"#/definitions/ImageObjectsList","description":"Photos of POS"},"time_zone":{"description":"Time zone","type":"string"},"title":{"description":"Point of sale public 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"},"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"},"PriceExplainOriginValueOption":{"enum":["discount","markup"],"type":"string"},"PriceExplainOriginValueType":{"enum":["percentage","amount"],"type":"string"},"PriceExplainValueBaseType":{"enum":["base-price","sale-price","posted-price","price-including-taxes"],"type":"string"},"PriceExplainValueSource":{"enum":["defined","received","calculated","reseted","price-by-item","price-by-special-account","master-price-by-date","price-group-tax-by-item","price-group-tax-default","price-group-tax-default-base","terminal-additional-cost-by-item","terminal-additional-cost-default","terminal-additional-cost-default-base","corporate-account-price-option-by-item","corporate-category-account-price-option-by-item","retail-category-account-price-option-by-item","retail-category-currency-price-option-by-item"],"type":"string"},"PriceExplainValueType":{"enum":["price","base-tax","base-taxes","sales-tax","sales-taxes","margin","margins","option","options"],"type":"string"},"PriceMargins":{"properties":{"terminal_additional_costs":{"description":"Terminal additional costs detailing","items":{"$ref":"#/definitions/PriceExplainDetailingItem"},"type":"array","x-nullable":true}},"type":"object"},"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"},"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":["corporate_user_signup_request","corporate_user_signup_process","corporate_user_signin_request","corporate_user_signin_process","corporate_user_identifier_change_request","corporate_user_identifier_change_process"],"type":"string"},"params":{"description":"Protection parameters (depends on protection type)","type":"object"},"protection":{"description":"Protection type ('none' - without protection)","enum":["none","recaptcha"],"type":"string"}},"type":"object"},"QuestionnaireField":{"properties":{"dictionary_values":{"items":{"description":"Dictionary values","type":"string"},"type":"array","x-nullable":true},"id":{"description":"Field id","type":"string"},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Some help for user","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Title to show (multilanguage)","x-nullable":true},"sort_order":{"description":"Sort order weight","type":"integer"},"title":{"description":"Field title","type":"string","x-nullable":true},"type":{"description":"Field type","enum":["string","integer","money","date","dictionary"],"type":"string"},"value_field_name":{"description":"Field value key name (readonly)","type":"string"}},"type":"object"},"QuestionnaireFieldEmbedded":{"properties":{"description":{"description":"Field description","type":"string","x-nullable":true},"id":{"description":"Field id","type":"string"},"sort_order":{"description":"Sort order weight","type":"integer","x-nullable":true},"title":{"description":"Field title","type":"string","x-nullable":true},"type":{"description":"Field type","enum":["string","integer","money","date","dictionary"],"type":"string"},"value":{"description":"Field value (readonly)","x-nullable":true},"value_field_name":{"description":"Field value key name (readonly)","type":"string","x-nullable":true}},"type":"object"},"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"},"RelativeLoyalty":{"description":"Loyalty info","properties":{"active":{"description":"Loyalty active flag","enum":[0,1],"type":"integer"},"id":{"description":"Loyalty Id","format":"uuid","type":"string"},"pos":{"$ref":"#/definitions/PosEmbeddedList","description":"List of POS where account is applicable","x-nullable":true},"title":{"description":"Loyalty public title","type":"string"}},"type":"object"},"RewardGrantPeriodType":{"enum":["day","month"],"type":"string"},"RewardValueType":{"enum":["check-percentage","fixed-amount"],"type":"string"},"RuleCalculationBaseData":{"properties":{"amount":{"description":"Check amount","format":"float","type":"number","x-nullable":true},"bonuses_redeemed_amount":{"description":"Check bonus points redeem amount","format":"float","type":"number","x-nullable":true}},"type":"object"},"RuleCalculationBaseItemData":{"properties":{"amount":{"description":"Item amount","format":"float","type":"number","x-nullable":true},"bonuses_redeemed_amount":{"description":"Item total bonus points redeemed calculated by check","format":"float","type":"number","x-nullable":true},"index":{"description":"Check item index","format":"int32","type":"integer","x-nullable":true},"price":{"description":"Item price","format":"float","type":"number","x-nullable":true},"quantity":{"description":"Item quantity","format":"float","type":"number","x-nullable":true},"unit_bonuses_redeemed_amount":{"description":"Item unit bonus points redeemed calculated by check","format":"float","type":"number","x-nullable":true}},"type":"object"},"RuleImplementationData":{"properties":{"calculated_result":{"$ref":"#/definitions/RuleImplementationResultData","description":"Rule calculated result (optional)","x-nullable":true},"coupon":{"$ref":"#/definitions/CheckCoupon","description":"Redeemed coupon that fires the rule (optional, only for implemented by 'coupon')","x-nullable":true},"dependencies_time_zone":{"$ref":"#/definitions/LoyaltyRuleDependsTimeZone","x-nullable":true},"dependencies_time_zone_value":{"type":"string","x-nullable":true},"depends_amount":{"description":"Amount/value, according to the rule dependency type, on which the rule was triggered (optional)","format":"float","type":"number","x-nullable":true},"depends_calc_period":{"$ref":"#/definitions/LoyaltyRuleDependsCalcPeriod","x-nullable":true},"depends_type":{"$ref":"#/definitions/LoyaltyRuleDependsType","description":"Rule dependency type value (optional)","x-nullable":true},"depends_user_category_id":{"description":"Customer category ID, according to the rule dependency type, on which the rule was triggered (optional)","format":"uuid","type":"string","x-nullable":true},"depends_user_category_valid_from":{"description":"Customer category valid from date and time, according to the rule dependency type, on which the rule was triggered (optional)","format":"datetime","type":"string","x-nullable":true},"implemented_by":{"$ref":"#/definitions/LoyaltyRuleImplementedBy","description":"Implemented by","x-nullable":true},"implemented_calculation_type":{"$ref":"#/definitions/LoyaltyRuleImplementedCalculationType","description":"Rules calculation and implementation type","x-nullable":true},"result":{"$ref":"#/definitions/RuleImplementationResultData","description":"Rule implemented result","x-nullable":true}},"type":"object"},"RuleImplementationResultData":{"properties":{"bonuses_added":{"description":"Bonuses added (optional)","items":{"$ref":"#/definitions/BonusAdded"},"type":"array","x-nullable":true},"calculation_base":{"$ref":"#/definitions/RuleCalculationBaseData","description":"Calculation base data","x-nullable":true},"discount":{"description":"Discount amount (optional)","format":"float","type":"number","x-nullable":true},"emitted_coupons":{"description":"Emitted coupons (optional)","items":{"$ref":"#/definitions/CheckCoupon"},"type":"array","x-nullable":true},"error":{"description":"Implementation error (optional)","type":"string","x-nullable":true},"error_code":{"description":"Implementation error code (optional)","format":"int32","type":"integer","x-nullable":true},"items":{"description":"Result by items (optional)","items":{"$ref":"#/definitions/RuleImplementationResultItemData"},"type":"array","x-nullable":true},"special_accounts_charges":{"description":"Special account charges (optional)","items":{"$ref":"#/definitions/SpecialAccountCharge"},"type":"array","x-nullable":true}},"type":"object"},"RuleImplementationResultItemData":{"properties":{"amount":{"description":"Rule amount for item row","format":"float","type":"number","x-nullable":true},"calculation_base":{"$ref":"#/definitions/RuleCalculationBaseItemData","description":"Calculation base data","x-nullable":true},"unit_amount":{"description":"Rule amount for item unit row (optional)","format":"float","type":"number","x-nullable":true}},"type":"object"},"SignInRequestData":{"properties":{"dynamic":{"description":"Use dynamic password","type":"boolean","x-nullable":true},"email":{"description":"Corporate user email","minLength":3,"type":"string"},"password":{"description":"Corporate user password","type":"string","x-nullable":true}},"required":["email"],"type":"object"},"SignUpRequestData":{"properties":{"email":{"description":"Corporate user email","minLength":3,"type":"string"},"name":{"description":"Corporate user name","type":"string","x-nullable":true},"password":{"description":"Corporate user password","type":"string","x-nullable":true},"password_new":{"description":"New corporate user password","type":"string","x-nullable":true}},"required":["email"],"type":"object"},"SortDirection":{"enum":["asc","desc"],"type":"string"},"SpecialAccount":{"properties":{"active":{"default":1,"description":"Account active flag","enum":[0,1],"type":"integer","x-nullable":true},"amount":{"description":"Amount of funds on the account (readonly)","format":"float","type":"number","x-nullable":true},"available_amount":{"description":"Amount of funds in the account available for using (null if unlimited)","format":"float","type":"number","x-nullable":true},"available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"balance":{"description":"Account balance (readonly)","format":"float","type":"number","x-nullable":true},"business":{"$ref":"#/definitions/Business","description":"Business info (readonly)","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},"currency_name":{"description":"Currency name","type":"string","x-nullable":true},"day_limit":{"default":0,"description":"Day limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"day_limit_available":{"description":"Day available amount, null if unlimited  (readonly)","format":"float","type":"number","x-nullable":true},"day_limit_used":{"description":"Day used amount (readonly)","format":"float","type":"number","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods filter","x-nullable":true},"id":{"description":"Account ID","format":"uuid","type":"string","x-nullable":true},"info":{"description":"Information (optional)","type":"string","x-nullable":true},"month_limit":{"default":0,"description":"Month limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"month_limit_available":{"description":"Month available amount, null if unlimited  (readonly)","format":"float","type":"number","x-nullable":true},"month_limit_used":{"description":"Month used amount (readonly)","format":"float","type":"number","x-nullable":true},"refill_allowed":{"description":"Refill operation (readonly)","type":"boolean","x-nullable":true},"title":{"description":"Business special account title","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/SpecialAccountType","description":"Account type","x-nullable":true}},"type":"object"},"SpecialAccountAccess":{"properties":{"available_amount":{"description":"Amount of funds in the account available for using (null if unlimited)","format":"float","type":"number","x-nullable":true},"available_from":{"description":"The time from which the funds in the account are available for use (null if no time limits)","format":"date-time","type":"string","x-nullable":true},"available_until":{"description":"The time until which the funds in the account remain available for use (null if no time limits) (readonly)","format":"date-time","type":"string","x-nullable":true},"corporate_staff":{"$ref":"#/definitions/StaffInfo","description":"Staff info (readonly)"},"corporate_staff_id":{"description":"Staff ID","format":"uuid","type":"string"},"day_limit":{"default":0,"description":"Day limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"day_limit_available":{"description":"Day available amount, null if unlimited (readonly)","format":"float","type":"number","x-nullable":true},"day_limit_used":{"description":"Day used amount (readonly)","format":"float","type":"number","x-nullable":true},"goods_items":{"$ref":"#/definitions/GoodsCodes","description":"Account applicable goods filter","x-nullable":true},"id":{"description":"Access ID","format":"uuid","type":"string","x-nullable":true},"month_limit":{"default":0,"description":"Month limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"month_limit_available":{"description":"Month available amount, null if unlimited  (readonly)","format":"float","type":"number","x-nullable":true},"month_limit_used":{"description":"Month used amount (readonly)","format":"float","type":"number","x-nullable":true},"odometer":{"$ref":"#/definitions/DataRequiredType","default":"no","description":"Odometer value needed flag"},"overall_limit":{"description":"Customer account overall limit (if 0 - unlimited)","format":"float","type":"number","x-nullable":true},"overall_limit_available":{"description":"Customer account overall available amount, not for unlimited account (null if unlimited)","format":"float","type":"number","x-nullable":true},"overall_limit_used":{"description":"Customer account overall used amount","format":"float","type":"number","x-nullable":true},"reset_overall_count":{"description":"Reset overall limit count (only for access modify request)","type":"boolean","x-nullable":true},"security_code":{"description":"Additional PIN-code for access to the account","type":"string","x-nullable":true},"special_account":{"$ref":"#/definitions/SpecialAccount","description":"Corporate special account info (readonly)"},"special_account_id":{"description":"Corporate special account ID","format":"uuid","type":"string"},"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"},"SpecialAccountAccessList":{"items":{"$ref":"#/definitions/SpecialAccountAccess"},"type":"array"},"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"},"StaffInfo":{"properties":{"comment":{"description":"Comment","type":"string","x-nullable":true},"customer_cards":{"$ref":"#/definitions/CustomerCardsGroupedByLoyalty","description":"Loyalty list with customer cards info"},"id":{"description":"Staff id","format":"uuid","type":"string"},"offline_one_time_fueling_limit":{"description":"One time refuel amount","format":"double","type":"number","x-nullable":true},"position":{"$ref":"#/definitions/StaffPosition","description":"Position info (readonly)","x-nullable":true},"position_id":{"description":"Position ID","format":"uuid","type":"string","x-nullable":true},"qr_code":{"description":"Qr Code / Tag","type":"string","x-nullable":true},"questionnaire":{"description":"Default questionnaire fields values","type":"object","x-nullable":true},"rfid_tag":{"description":"RFID / Fleet Tag","type":"string","x-nullable":true},"special_accounts_access":{"description":"Special account access list (readonly)","items":{"$ref":"#/definitions/SpecialAccountAccess","description":"Access object"},"type":"array"},"suspended":{"description":"Suspended flag","enum":[0,1],"type":"integer","x-nullable":true},"user":{"$ref":"#/definitions/UserProfile","description":"User info (readonly)"},"user_id":{"description":"User ID","format":"uuid","type":"string"}},"type":"object"},"StaffPosition":{"properties":{"delete_allowed":{"description":"No staff with this position - allowed deletion of position  (readonly)","type":"boolean"},"id":{"description":"Position ID","format":"uuid","type":"string"},"public_description":{"$ref":"#/definitions/MultiLanguageObject","description":"Position public description (multilanguage)","x-nullable":true},"public_title":{"$ref":"#/definitions/MultiLanguageObject","description":"Position public title (multilanguage)","x-nullable":true},"sort_order":{"description":"Sort order weight","type":"integer"},"title":{"description":"Position title","type":"string"}},"type":"object"},"StaffQuestionnaire":{"properties":{"detailing":{"description":"Detailing of questionnaire fields (readonly)","items":{"$ref":"#/definitions/QuestionnaireFieldEmbedded"},"type":"array","x-nullable":true}},"type":"object"},"StringValuesList":{"items":{"description":"Value","type":"string"},"type":"array"},"StripeIntegrationTypes":{"items":{"enum":["checkout","elements"],"type":"string"},"type":"array"},"TankConfiguration":{"properties":{"critical_high_product_alarm_height":{"description":"Critical high product height alarm, mm","type":"integer","x-nullable":true},"critical_low_product_alarm_height":{"description":"Critical low product height alarm, mm","type":"integer","x-nullable":true},"height":{"description":"Height, mm","type":"integer","x-nullable":true},"high_product_alarm_height":{"description":"High product height alarm, mm","type":"integer","x-nullable":true},"high_water_alarm_height":{"description":"High water alarm height, mm","type":"integer","x-nullable":true},"low_product_alarm_height":{"description":"Low product height alarm, mm","type":"integer","x-nullable":true}},"type":"object"},"TemporaryCode":{"properties":{"code":{"description":"Temporary code","type":"string"},"redeem_allowed":{"description":"Allowed redeem bonuses or special account flag","type":"boolean"}},"type":"object"},"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"},"TerminalType":{"enum":["register","steward","validator","prepaid-services","road-tanker-driver","kiosk","kiosk-and-register"],"type":"string"},"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"},"Token":{"properties":{"access":{"description":"Token access by type.","enum":["owner","admin","business"],"type":"string"},"access_scopes":{"$ref":"#/definitions/TokenAccessScopes","description":"Token access scopes."},"owner":{"description":"Signed in as owner.","type":"boolean"},"token":{"description":"Token for next authorization requests.","type":"string"},"user":{"$ref":"#/definitions/CorporateUserProfile"}},"type":"object"},"TokenAccessScopes":{"items":{"enum":["administration","payments","security"],"type":"string"},"type":"array"},"Transaction":{"properties":{"amount":{"format":"double","type":"number"},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"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","x-nullable":true},"bonuses_on_account":{"format":"double","type":"number","x-nullable":true},"bonuses_redeemed":{"format":"double","type":"number"},"business_id":{"description":"Business ID","format":"uuid","type":"string","x-nullable":true},"business_title":{"description":"Business title","type":"string","x-nullable":true},"cancelled":{"description":"Transaction canceled flag","enum":[0,1],"type":"integer","x-nullable":true},"corporate_offline_site_id":{"description":"Off-line site unique Id  (if include_corporate_offline_site parameter is True)","type":"string","x-nullable":true},"corporate_offline_site_title":{"description":"Off-line site title  (if include_corporate_offline_site parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_avi_id":{"description":"Vehicle/Inventory avi identifier  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_description":{"description":"Vehicle/Inventory description  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_id":{"description":"Vehicle/Inventory unique Id  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_offline_one_time_fueling_limit":{"description":"Vehicle/Inventory off-line one time fueling limit  (if include_corporate_vehicle parameter is True)","format":"float","type":"number","x-nullable":true},"corporate_vehicle_position_id":{"description":"Vehicle/Inventory Position id (if include_corporate_vehicle parameter is True)","format":"uuid","type":"string","x-nullable":true},"corporate_vehicle_position_title":{"description":"Vehicle/Inventory Position title  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_qr_code":{"description":"Vehicle/Inventory qr-code / tag  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_rfid_tag":{"description":"Vehicle/Inventory rfid tag  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"corporate_vehicle_vehicle_id":{"description":"Vehicle/Inventory Id  (if include_corporate_vehicle parameter is True)","type":"string","x-nullable":true},"currency":{"description":"Currency ISO code (if transaction payment 'currency')","type":"string","x-nullable":true},"discount_amount":{"format":"double","type":"number","x-nullable":true},"id":{"description":"Transaction ID","format":"uuid","type":"string"},"item_amount":{"description":"Goods item amount (for list with stock)","format":"double","type":"number","x-nullable":true},"item_amount_decimal_digits":{"description":"Number of decimal digits in amount value (for list with stock)","type":"integer","x-nullable":true},"item_amount_inc_discount":{"description":"Goods item amount inclusive calculated discount (for list with stock)","format":"double","type":"number","x-nullable":true},"item_bonuses_decimal_digits":{"description":"Number of decimal digits in bonuses value (for list with stock)","type":"integer","x-nullable":true},"item_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},"item_calculated_discount_amount":{"description":"Goods item total discount calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"item_calculated_price":{"description":"Goods item price calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"item_calculated_unit_discount_amount":{"description":"Goods item unit discount calculated by rules (for list with stock)","format":"double","type":"number","x-nullable":true},"item_category":{"description":"Goods item category (for list with stock)","type":"string","x-nullable":true},"item_code":{"description":"Goods item code (for list with stock)","type":"string","x-nullable":true},"item_discount_amount":{"description":"Goods item discount amount (for list with stock)","format":"double","type":"number","x-nullable":true},"item_price":{"description":"Goods item price (for list with stock)","format":"double","type":"number","x-nullable":true},"item_price_decimal_digits":{"description":"Number of decimal digits in price value (for list with stock)","type":"integer","x-nullable":true},"item_quantity":{"description":"Goods item quantity (for list with stock)","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)","type":"integer","x-nullable":true},"item_title":{"description":"Goods item title (for list with stock)","type":"string","x-nullable":true},"item_unit":{"description":"Goods item measuring units (for list with stock)","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string","x-nullable":true},"loyalty_title":{"description":"Loyalty title","type":"string","x-nullable":true},"odometer":{"description":"Odometer/engine hours value, up to two decimal digits (if include_odometer parameter is True)","format":"float","type":"number","x-nullable":true},"payment_type":{"$ref":"#/definitions/TransactionPaymentType","description":"Payment type"},"pos_id":{"description":"Pos ID","format":"uuid","type":"string","x-nullable":true},"pos_title":{"description":"POS title","type":"string","x-nullable":true},"position_id":{"description":"Position ID","format":"uuid","type":"string","x-nullable":true},"position_title":{"description":"Position title","type":"string","x-nullable":true},"processed":{"description":"Transaction UTC processed date-time","format":"date-time","type":"string"},"processed_local":{"description":"Transaction local (by POS time zone) processed date-time","format":"date-time","type":"string"},"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":"Corporate customer special account ID (if transaction payment in 'special-account', 'corporate-special-account-access', 'retail-special-account-access')","format":"uuid","type":"string","x-nullable":true},"special_account_title":{"description":"Special account title","type":"string","x-nullable":true},"special_account_type":{"$ref":"#/definitions/SpecialAccountType","description":"Special account type","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer","x-nullable":true},"staff_comment":{"description":"Staff comment","type":"string","x-nullable":true},"staff_id":{"description":"Staff ID","format":"uuid","type":"string","x-nullable":true},"staff_offline_one_time_fueling_limit":{"description":"Staff off-line one time fueling limit","format":"float","type":"number","x-nullable":true},"staff_qr_code":{"description":"Staff qr-code / tag","type":"string","x-nullable":true},"staff_questionnaire":{"$ref":"#/definitions/StaffQuestionnaire","description":"Questionnaire fields values for Staff","x-nullable":true},"staff_rfid_tag":{"description":"Staff rfid tag","type":"string","x-nullable":true},"staff_suspended":{"description":"Staff suspended flag","enum":[0,1],"type":"integer","x-nullable":true},"subtype":{"$ref":"#/definitions/TransactionSubType","description":"Transaction subtype (optional, readonly)","x-nullable":true},"summary_amount":{"description":"Sum of amount and shipping_amount and services_amount","format":"double","type":"number"},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string","x-nullable":true},"transaction_id":{"description":"Referenced transaction ID","format":"uuid","type":"string","x-nullable":true},"type":{"$ref":"#/definitions/TransactionType","description":"Transaction type"},"user_email":{"description":"User email","type":"string","x-nullable":true},"user_external_id":{"description":"User external id","type":"string","x-nullable":true},"user_id":{"description":"User ID","format":"uuid","type":"string","x-nullable":true},"user_name":{"description":"User name","type":"string","x-nullable":true},"user_phone":{"description":"User phone number","type":"string","x-nullable":true},"vehicle_id":{"description":"Vehicle/inventory identifier/tag value  (if include_vehicle_id parameter is True)","type":"string","x-nullable":true}},"type":"object"},"TransactionErrors":{"properties":{"code":{"description":"Error code","type":"string"},"level":{"description":"Error level","enum":["warning","error"],"type":"string"},"message":{"description":"Error message","type":"string"},"type":{"description":"Error type","enum":["authorized-payment-capture","transaction-post-processing"],"type":"string"}},"type":"object"},"TransactionPaymentType":{"enum":["currency","special-account","corporate-special-account-access","retail-special-account-access"],"type":"string"},"TransactionReceipt":{"properties":{"check":{"$ref":"#/definitions/Check","description":"Transaction check (optional)"},"id":{"description":"Transaction ID","format":"uuid","type":"string","x-nullable":true},"lang":{"description":"language ISO code","type":"string","x-nullable":true},"legal_info":{"$ref":"#/definitions/ReceiptLegalInfo","description":"Business legal info (optional)"},"print_date":{"description":"Check print local (by POS time zone) date-time","format":"date-time","type":"string","x-nullable":true},"template":{"$ref":"#/definitions/TransactionReceiptTemplateType","description":"Receipt template","x-nullable":true},"transaction":{"$ref":"#/definitions/Transaction","description":"Transaction check (optional)"}},"type":"object"},"TransactionReceiptActions":{"properties":{"print_on_terminal":{"description":"Customer's receipt print on terminal (optional)","type":"boolean","x-nullable":true},"send_to_customer":{"$ref":"#/definitions/TransactionReceiptSendTo","description":"Customer's receipt send to (optional)","x-nullable":true}},"type":"object"},"TransactionReceiptSendTo":{"items":{"description":"email","type":"string"},"type":"array"},"TransactionReceiptTemplateType":{"enum":["business","customer","commercial"],"type":"string"},"TransactionSubType":{"enum":["sale","special-account-refill","special-account-refill-direct","special-account-refill-by-customer","special-account-write-offs-direct","special-account-write-offs-loan","special-account-write-offs-scheduled"],"type":"string"},"TransactionType":{"enum":["reserve","presale","sale","cancel","redeem-giftcard","bonus-add","special-account-refill","coupon-sale","authorize-payment","bonus-write-offs","special-account-write-offs"],"type":"string"},"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"},"UserProfile":{"properties":{"available":{"description":"User availability (readonly)","type":"boolean"},"birth_date":{"description":"User birth date","format":"date","type":"string","x-nullable":true},"country":{"description":"Country ISO code","type":"string","x-nullable":true},"email":{"description":"User email","type":"string","x-nullable":true},"emails":{"$ref":"#/definitions/EmailsList","description":"List of emails registered by user (readonly)","x-nullable":true},"external_id":{"description":"User external id","type":"string","x-nullable":true},"gender":{"$ref":"#/definitions/UserGender","description":"User gender","x-nullable":true},"id":{"description":"User ID","format":"uuid","type":"string"},"language":{"description":"Language ISO code","type":"string","x-nullable":true},"name":{"description":"Public user Name","type":"string","x-nullable":true},"phone":{"description":"User phone","type":"string","x-nullable":true},"phones":{"$ref":"#/definitions/StringValuesList","description":"List of phone numbers registered by user (readonly)","x-nullable":true},"status_availability_restriction":{"description":"User availability restriction by status (readonly)","type":"string","x-nullable":true}},"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"},"VehicleInfo":{"properties":{"avi_id":{"description":"AVI (automatic vehicle identification) Id / Tag","type":"string","x-nullable":true},"description":{"description":"Description","type":"string","x-nullable":true},"id":{"description":"Vehicle/Inventory unique Id","format":"uuid","type":"string","x-nullable":true},"offline_one_time_fueling_limit":{"description":"One time refuel amount","format":"double","type":"number","x-nullable":true},"position":{"$ref":"#/definitions/StaffPosition","description":"Position info (readonly)","x-nullable":true},"position_id":{"description":"Position ID","format":"uuid","type":"string","x-nullable":true},"qr_code":{"description":"Qr Code / Tag","type":"string","x-nullable":true},"rfid_tag":{"description":"RFID / Fleet Tag","type":"string","x-nullable":true},"vehicle_id":{"description":"Vehicle/Inventory Id","type":"string","x-nullable":true}},"type":"object"},"VehiclesList":{"items":{"$ref":"#/definitions/VehicleInfo"},"type":"array"},"VehiclesListPaginated":{"properties":{"data":{"$ref":"#/definitions/VehiclesList","description":"Vehicles/inventory list"},"summary":{"$ref":"#/definitions/VehiclesListPaginatedSummary"}},"type":"object"},"VehiclesListPaginatedSummary":{"properties":{"total_rows_count":{"description":"Total vehicles/inventory count","type":"integer"}},"type":"object"},"VolumeUnitType":{"enum":["L","G"],"type":"string"},"WeekDaysList":{"items":{"description":"Day of week","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"type":"string"},"type":"array"}},"info":{"description":"API for inCust Corporate Client\n\n\n### Methods\n`GET`: \t\tRetrieve resources  \n`POST`:\t\tCrete resources  \n`PATCH`:\tUpdate resources\n\n**Why use PATCH rather than a PUT?**\n`JLab13`: I think PATCH method is the correct choice for updating an\nexisting resources. PUT should only be used if you're replacing a \nresource in its entirety.\n\nFurther information on partial resource modification is available in\n[RFC 5789](http://tools.ietf.org/html/rfc5789). Specifically, the\nPUT method is described as follows:\n\n> Several applications extending the Hypertext Transfer Protocol (HTTP)\n> require a feature to do partial resource modification. The existing\n> HTTP PUT method only allows a complete replacement of a document. \n> This proposal adds a new HTTP method, PATCH, to modify an\n> existing HTTP resource.  \n\n### X-Application-Type HTTP Header\nAll requests must contain a header **X-Application-Type**.  \nThis header defines the type of application that makes the request.  \n\n**Available values:**  \n`web`: \t\t    application that runs in browser as web application  \n`android`: \t\tapplication that runs on android as android application  \n`ios`: \t\t    application that runs on iPhone/iPad/etc as iOS application  \n`windows`: \t\tapplication that runs on windows as windows application  \n`chatbot`: \t    application that runs as chatbot\n`external`: \texternal application and systems which itegrated with inCust API\n","title":"inCust API","version":"1.0"},"paths":{"/businesses":{"get":{"description":"Get businesses list","operationId":"incust.controllers.corporate_user.api.businesses","parameters":[{"default":true,"description":"return only active objects","in":"query","name":"only_active","required":false,"type":"boolean"},{"default":false,"description":"Include loyalties info","in":"query","name":"include_loyalties","required":false,"type":"boolean"}],"responses":{"200":{"description":"Business objects list","schema":{"$ref":"#/definitions/BusinessesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Businesses"]}},"/custom/preferences":{"patch":{"description":"Set custom preferences parameter by name","operationId":"incust.controllers.corporate_user.api.corporate_user_preferences_set","parameters":[{"description":"Parameter data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CustomPreferencesParameter"}}],"responses":{"202":{"description":"Parameter data","schema":{"$ref":"#/definitions/CustomPreferencesParameter"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"]},"post":{"description":"Get custom preferences parameter by name","operationId":"incust.controllers.corporate_user.api.corporate_user_preferences_get","parameters":[{"description":"Parameter data","in":"body","name":"data","required":true,"schema":{"properties":{"name":{"description":"Preferences parameter name","type":"string"}},"required":["name"],"type":"object"}}],"responses":{"202":{"description":"Parameter data","schema":{"$ref":"#/definitions/CustomPreferencesParameter"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"]}},"/dashboard/accounts/items/turnover/period":{"post":{"description":"Get accounts turnover for period by check items","operationId":"incust.controllers.corporate_user.dashboard.accounts_turnover_period_by_check_items","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"count":{"description":"Report rows count per page","type":"integer"},"items_codes":{"description":"Filter by items if needed","items":{"description":"Item code","type":"string"},"type":"array","x-nullable":true},"only_active":{"description":"Filter by active accounts","type":"boolean","x-nullable":true},"page":{"description":"Report list page number","type":"integer"},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"scope_filter":{"$ref":"#/definitions/DashboardScopeFilter","description":"Scope filter","x-nullable":true},"sort":{"$ref":"#/definitions/DashboardResultSortObject","description":"Sort options","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Summary data on turnover","schema":{"properties":{"data":{"description":"Turnover data","items":{"$ref":"#/definitions/DashboardAccountTurnoverByCheckItemsItem"},"type":"array"},"summary":{"properties":{"total_amount":{"description":"Total turnover amount","format":"float","type":"number"},"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Accounts"]}},"/dashboard/accounts/items/turnover/top":{"post":{"description":"Get top check items by turnover","operationId":"incust.controllers.corporate_user.dashboard.check_items_turnover_top","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"count":{"description":"Report rows count per page","type":"integer"},"only_active":{"description":"Filter by active accounts","type":"boolean","x-nullable":true},"page":{"description":"Report list page number","type":"integer"},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"scope_filter":{"$ref":"#/definitions/DashboardScopeFilter","description":"Scope filter","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Summary data on turnover","schema":{"properties":{"data":{"description":"Turnover data","items":{"$ref":"#/definitions/DashboardAccountTurnoverByCheckItemsItem"},"type":"array"},"summary":{"properties":{"total_amount":{"description":"Total turnover amount","format":"float","type":"number"},"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Accounts"]}},"/dashboard/accounts/staff/turnover/period":{"post":{"description":"Get accounts turnover for period by staff","operationId":"incust.controllers.corporate_user.dashboard.accounts_turnover_period_by_staff","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"corporate_staff_ids":{"description":"Filter by staff if needed","items":{"description":"Staff ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"count":{"description":"Report rows count per page","type":"integer"},"only_active":{"description":"Filter by active accounts","type":"boolean","x-nullable":true},"page":{"description":"Report list page number","type":"integer"},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"scope_filter":{"$ref":"#/definitions/DashboardScopeFilter","description":"Scope filter","x-nullable":true},"sort":{"$ref":"#/definitions/DashboardResultSortObject","description":"Sort options","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Summary data on turnover","schema":{"properties":{"data":{"description":"Turnover data","items":{"$ref":"#/definitions/DashboardAccountTurnoverByStaffItem"},"type":"array"},"summary":{"properties":{"total_amount":{"description":"Total turnover amount","format":"float","type":"number"},"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Accounts"]}},"/dashboard/accounts/staff/turnover/top":{"post":{"description":"Get top staff by turnover","operationId":"incust.controllers.corporate_user.dashboard.staff_turnover_top","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"count":{"description":"Report rows count per page","type":"integer"},"only_active":{"description":"Filter by active accounts","type":"boolean","x-nullable":true},"page":{"description":"Report list page number","type":"integer"},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"scope_filter":{"$ref":"#/definitions/DashboardScopeFilter","description":"Scope filter","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Summary data on turnover","schema":{"properties":{"data":{"description":"Turnover data","items":{"$ref":"#/definitions/DashboardAccountTurnoverByStaffItem"},"type":"array"},"summary":{"properties":{"total_amount":{"description":"Total turnover amount","format":"float","type":"number"},"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Accounts"]}},"/dashboard/accounts/state/current":{"post":{"description":"Get current accounts state","operationId":"incust.controllers.corporate_user.dashboard.accounts_state_current","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"only_active":{"default":false,"description":"Filter by active accounts","type":"boolean","x-nullable":true},"scope_filter":{"$ref":"#/definitions/DashboardScopeFilter","description":"Scope filter","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Accounts state list","schema":{"items":{"$ref":"#/definitions/DashboardAccountState"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Accounts"]}},"/dashboard/accounts/turnover/period":{"post":{"description":"Get accounts turnover for period","operationId":"incust.controllers.corporate_user.dashboard.accounts_turnover_period","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"count":{"description":"Report rows count per page","type":"integer"},"only_active":{"description":"Filter by active accounts","type":"boolean","x-nullable":true},"page":{"description":"Report list page number","type":"integer"},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"scope_filter":{"$ref":"#/definitions/DashboardScopeFilter","description":"Scope filter","x-nullable":true},"sort":{"$ref":"#/definitions/DashboardResultSortObject","description":"Sort options","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Summary data on turnover","schema":{"properties":{"data":{"description":"Turnover data","items":{"$ref":"#/definitions/DashboardAccountTurnoverItem"},"type":"array"},"summary":{"properties":{"total_close_amount":{"description":"Total account amount at the ending of the period","format":"float","type":"number"},"total_open_amount":{"description":"Total account amount at the beginning of the period","format":"float","type":"number"},"total_rows_count":{"description":"Total items count","type":"integer"},"total_turnover_credit_amount":{"description":"Total credit turnover amount","format":"float","type":"number"},"total_turnover_debit_amount":{"description":"Total debit turnover amount","format":"float","type":"number"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Accounts"]}},"/dashboard/accounts/vehicles/turnover/period":{"post":{"description":"Get accounts turnover for period corporate vehicles","operationId":"incust.controllers.corporate_user.dashboard.accounts_turnover_period_by_corporate_vehicles","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"corporate_vehicles_ids":{"description":"Filter by corporate vehicles if needed","items":{"description":"Corporate vehicle ID","format":"uuid","type":"string"},"type":"array","x-nullable":true},"count":{"description":"Report rows count per page","type":"integer"},"only_active":{"description":"Filter by active accounts","type":"boolean","x-nullable":true},"page":{"description":"Report list page number","type":"integer"},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"scope_filter":{"$ref":"#/definitions/DashboardScopeFilter","description":"Scope filter","x-nullable":true},"sort":{"$ref":"#/definitions/DashboardResultSortObject","description":"Sort options","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Summary data on turnover","schema":{"properties":{"data":{"description":"Turnover data","items":{"$ref":"#/definitions/DashboardAccountTurnoverByCorporateVehiclesItem"},"type":"array"},"summary":{"properties":{"total_amount":{"description":"Total turnover amount","format":"float","type":"number"},"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Accounts"]}},"/dashboard/accounts/vehicles/turnover/top":{"post":{"description":"Get top corporate vehicles by turnover","operationId":"incust.controllers.corporate_user.dashboard.corporate_vehicles_turnover_top","parameters":[{"in":"body","name":"data","required":true,"schema":{"properties":{"count":{"description":"Report rows count per page","type":"integer"},"only_active":{"description":"Filter by active accounts","type":"boolean","x-nullable":true},"page":{"description":"Report list page number","type":"integer"},"period_begin":{"description":"Report period begin date","format":"date","type":"string"},"period_end":{"description":"Report period end date","format":"date","type":"string"},"scope_filter":{"$ref":"#/definitions/DashboardScopeFilter","description":"Scope filter","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Summary data on turnover","schema":{"properties":{"data":{"description":"Turnover data","items":{"$ref":"#/definitions/DashboardAccountTurnoverByCorporateVehiclesItem"},"type":"array"},"summary":{"properties":{"total_amount":{"description":"Total turnover amount","format":"float","type":"number"},"total_rows_count":{"description":"Total items count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Accounts"]}},"/dashboard/refuels/period":{"post":{"description":"Get refuels list","operationId":"incust.controllers.corporate_user.dashboard.refuels_period","parameters":[{"in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/DashboardRefuelsPeriodRequest"}}],"responses":{"200":{"description":"Summary data for refuels","schema":{"$ref":"#/definitions/DashboardRefuelsPeriodSummary"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Refuels"]}},"/dashboard/transactions/items/usage/positions/summary":{"post":{"description":"Get items usage by period detailed by staff positions (department)","operationId":"incust.controllers.corporate_user.dashboard.items_usage_period_by_positions","parameters":[{"in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/DashboardTransactionsItemsUsageSummaryRequest"}}],"responses":{"200":{"description":"Summary data for items usage","schema":{"$ref":"#/definitions/DashboardTransactionsItemsUsagePositionsSummary"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Transactions Items Usage"]}},"/dashboard/transactions/items/usage/staff/summary":{"post":{"description":"Get items usage by period detailed by staff and positions (department)","operationId":"incust.controllers.corporate_user.dashboard.items_usage_period_by_staff","parameters":[{"in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/DashboardTransactionsItemsUsageSummaryRequest"}}],"responses":{"200":{"description":"Summary data for items usage","schema":{"$ref":"#/definitions/DashboardTransactionsItemsUsageStaffSummary"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Transactions Items Usage"]}},"/dashboard/transactions/items/usage/summary":{"post":{"description":"Get items usage by period","operationId":"incust.controllers.corporate_user.dashboard.items_usage_period","parameters":[{"in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/DashboardTransactionsItemsUsageSummaryRequest"}}],"responses":{"200":{"description":"Summary data for items usage","schema":{"$ref":"#/definitions/DashboardTransactionsItemsUsageSummary"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Transactions Items Usage"]}},"/dashboard/transactions/items/usage/vehicles/summary":{"post":{"description":"Get items usage by period detailed by vehicles and positions (department)","operationId":"incust.controllers.corporate_user.dashboard.items_usage_period_by_vehicles","parameters":[{"in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/DashboardTransactionsItemsUsageSummaryRequest"}}],"responses":{"200":{"description":"Summary data for items usage","schema":{"$ref":"#/definitions/DashboardTransactionsItemsUsageVehiclesSummary"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["DashBoard / Transactions Items Usage"]}},"/email/change":{"post":{"description":"Change user email (login)","operationId":"incust.controllers.corporate_user.api.change_email","parameters":[{"description":"New Email","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierChangeObject"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/CorporateUserProfile"}},"202":{"description":"Send email with pin code for verification","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/email/change/pre":{"post":{"description":"Change user email (login) pre-processing","operationId":"incust.controllers.corporate_user.api.change_email_pre_processing","parameters":[{"description":"New Email","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierChangeObject"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"$ref":"#/definitions/ProtectionOptions"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/email/validate":{"post":{"description":"Check email for correctness and uniqueness","operationId":"incust.controllers.corporate_user.api.validate_email","parameters":[{"description":"Email for validation","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/IdentifierValidationRequestObject"}}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/offline_sites":{"get":{"description":"Return off-line sites list","operationId":"incust.controllers.corporate_user.api.offline_sites","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"default":false,"description":"Return only active sites","in":"query","name":"only_active","required":false,"type":"boolean"},{"description":"Filter by search string (contains criteria) in main text fields (title, login)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"title","description":"Sort field name","enum":["title","login","special_account_id"],"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":"Array of off-line site object","schema":{"$ref":"#/definitions/OfflineSitesListPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Off-line Sites"]},"post":{"description":"Add new off-line site","operationId":"incust.controllers.corporate_user.api.offline_site_add","parameters":[{"description":"Off-line site object data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/OfflineSite"}}],"responses":{"200":{"description":"Off-line site object data","schema":{"$ref":"#/definitions/OfflineSite"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Off-line Sites"]}},"/offline_sites/{site_id}":{"delete":{"description":"Delete off-line site","operationId":"incust.controllers.corporate_user.api.offline_site_delete","parameters":[{"description":"Off-line site ID","format":"uuid","in":"path","name":"site_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Off-line Sites"]},"get":{"description":"Return off-line site data","operationId":"incust.controllers.corporate_user.api.offline_site_get","parameters":[{"description":"Off-line site ID","format":"uuid","in":"path","name":"site_id","required":true,"type":"string"}],"responses":{"200":{"description":"Vehicle/inventory object data","schema":{"$ref":"#/definitions/OfflineSite"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Off-line Sites"]},"patch":{"description":"Modify off-line site data","operationId":"incust.controllers.corporate_user.api.offline_site_edit","parameters":[{"description":"Off-line site ID","format":"uuid","in":"path","name":"site_id","required":true,"type":"string"},{"description":"Off-line object data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/VehicleInfo"}}],"responses":{"200":{"description":"Off-line object data","schema":{"$ref":"#/definitions/OfflineSite"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/OfflineSite"}}},"tags":["Off-line Sites"]}},"/offline_sites/{site_id}/settings/application":{"get":{"description":"Return off-line site settings for application","operationId":"incust.controllers.corporate_user.api.offline_site_settings_application_get","parameters":[{"description":"Off-line site ID","format":"uuid","in":"path","name":"site_id","required":true,"type":"string"}],"responses":{"200":{"description":"Application settings","schema":{"$ref":"#/definitions/OfflineSiteApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Off-line Sites"]},"patch":{"description":"Set and return off-line site settings for application","operationId":"incust.controllers.corporate_user.api.offline_site_settings_application_set","parameters":[{"description":"Off-line site ID","format":"uuid","in":"path","name":"site_id","required":true,"type":"string"},{"description":"Application settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/OfflineSiteApplicationSettings"}}],"responses":{"200":{"description":"Application settings","schema":{"$ref":"#/definitions/OfflineSiteApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Off-line Sites"]}},"/password":{"patch":{"description":"Change corporate user password","operationId":"incust.controllers.corporate_user.api.change_password","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"properties":{"password":{"description":"Password","type":"string"}},"required":["password"],"type":"object"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/pmt/info/{payment_id}":{"get":{"description":"Returns payment info","operationId":"incust.controllers.corporate_user.api.payment_info","parameters":[{"description":"Payment ID","format":"uuid","in":"path","name":"payment_id","required":true,"type":"string"}],"responses":{"200":{"description":"Payment info object","schema":{"$ref":"#/definitions/Payment"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet":{"get":{"description":"Returns mobile payment wallet","operationId":"incust.controllers.corporate_user.api.payment_wallet","parameters":[{"description":"Unique identifier of business","format":"uuid","in":"query","name":"business_id","required":false,"type":"string","x-nullable":true},{"description":"Currency","in":"query","name":"currency","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Corporate mobile payment wallets","schema":{"$ref":"#/definitions/MobileWallets"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"]}},"/pmt/wallet/payment":{"post":{"description":"Payment from wallet","operationId":"incust.controllers.corporate_user.api.payment_wallet_payment","parameters":[{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PaymentData"}}],"responses":{"200":{"description":"Response status","schema":{"$ref":"#/definitions/PaymentStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet/payment/{payment_id}/status":{"get":{"description":"Request of status for payment from wallet","operationId":"incust.controllers.corporate_user.api.payment_wallet_payment_status","parameters":[{"description":"Operation data","format":"uuid","in":"path","name":"payment_id","required":true,"type":"string"}],"responses":{"200":{"description":"Response status","schema":{"$ref":"#/definitions/PaymentStatus"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/pmt/wallet/{wallet_type}/{action}":{"post":{"description":"Manage payment corporate wallet","operationId":"incust.controllers.corporate_user.api.payment_wallet_manage_w_data","parameters":[{"description":"Type of payment wallet","enum":["stripe","eway","flutterwave","global-payments","wave"],"in":"path","name":"wallet_type","required":true,"type":"string"},{"description":"Action type","enum":["cardadd","carddelete"],"in":"path","name":"action","required":true,"type":"string"},{"description":"Operation data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/PaymentCardManage"}}],"responses":{"200":{"description":"Response object (URL or status)","schema":{"$ref":"#/definitions/PaymentCardManageResult"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Payment"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/profile":{"get":{"description":"Return corporate user profile","operationId":"incust.controllers.corporate_user.api.profile_get","responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/CorporateUserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"]},"patch":{"description":"Change and return modified corporate user profile","operationId":"incust.controllers.corporate_user.api.profile_patch","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateUserProfile"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/CorporateUserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"],"x-application-access-scope-restriction":{"allowed":["security"]}}},"/register":{"post":{"description":"Create new corporate, and return token and profile","operationId":"incust.controllers.corporate_user.api.register","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignUpRequestData"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"202":{"description":"Send email with pin code for access","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"]}},"/register/pre":{"post":{"description":"Register corporate user pre-processing","operationId":"incust.controllers.corporate_user.api.register_pre_processing","parameters":[{"description":"First account data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignUpRequestData"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"properties":{"protection_options":{"$ref":"#/definitions/ProtectionOptions"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"]}},"/security/access/businesses":{"get":{"description":"Get businesses list with access options","operationId":"incust.controllers.corporate_user.api.security_access_by_businesses","parameters":[{"default":true,"description":"Return only active Businesses","in":"query","name":"only_active","required":false,"type":"boolean"}],"responses":{"200":{"description":"Business access objects list","schema":{"$ref":"#/definitions/BusinessesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Security & Access"]},"patch":{"description":"Set businesses access options and","operationId":"incust.controllers.corporate_user.api.security_access_by_businesses_set","parameters":[{"description":"Business access objects list","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/BusinessesList"}}],"responses":{"200":{"description":"Business access objects list","schema":{"$ref":"#/definitions/BusinessesList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Security & Access"]}},"/special_accounts":{"get":{"description":"Return special accounts list","operationId":"incust.controllers.corporate_user.api.special_accounts","parameters":[{"default":"all","description":"Filter by active flag","enum":["all","yes","no"],"in":"query","name":"active","required":false,"type":"string"},{"description":"Filter by Business ID if needed","format":"uuid","in":"query","name":"business_id","required":false,"type":"string"},{"default":false,"description":"Return only general info (id, title, active, business)","in":"query","name":"lite","required":false,"type":"boolean"}],"responses":{"200":{"description":"Array of special accounts data","schema":{"$ref":"#/definitions/SpecialAccountsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]}},"/special_accounts/{account_id}":{"get":{"description":"Return special account info","operationId":"incust.controllers.corporate_user.api.special_account_get","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Special Account data","schema":{"$ref":"#/definitions/SpecialAccount"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]}},"/special_accounts/{account_id}/access":{"get":{"description":"Return special account access list","operationId":"incust.controllers.corporate_user.api.special_account_access_list","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"default":true,"description":"Include Staff info","in":"query","name":"include_staff_info","required":false,"type":"boolean"},{"default":false,"description":"Include Customers Cards info for Staff (only if include_staff_info is true)","in":"query","name":"include_customer_cards","required":false,"type":"boolean"}],"responses":{"200":{"description":"Array of special account access list","schema":{"$ref":"#/definitions/SpecialAccountAccessList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]},"post":{"description":"Add special account access","operationId":"incust.controllers.corporate_user.api.special_account_access_add","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Special account access data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SpecialAccountAccess"}}],"responses":{"200":{"description":"Special account access object","schema":{"$ref":"#/definitions/SpecialAccountAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]}},"/special_accounts/{account_id}/access/staff/{staff_id}":{"get":{"description":"Return special account access object for staff","operationId":"incust.controllers.corporate_user.api.special_account_access_by_staff","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Staff ID","format":"uuid","in":"path","name":"staff_id","required":true,"type":"string"}],"responses":{"200":{"description":"Special account access object","schema":{"$ref":"#/definitions/SpecialAccountAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]}},"/special_accounts/{account_id}/access/{access_id}":{"delete":{"description":"Delete special account access object","operationId":"incust.controllers.corporate_user.api.special_account_access_delete","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Special Account Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of special account access list","schema":{"items":{"$ref":"#/definitions/SpecialAccountAccess","description":"Special account access object"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]},"get":{"description":"Return special account access object","operationId":"incust.controllers.corporate_user.api.special_account_access_get","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Special Account Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"}],"responses":{"200":{"description":"Special account access object","schema":{"$ref":"#/definitions/SpecialAccountAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]},"patch":{"description":"Modify special account access object","operationId":"incust.controllers.corporate_user.api.special_account_access_edit","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Special Account Access ID","format":"uuid","in":"path","name":"access_id","required":true,"type":"string"},{"description":"Special account access data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SpecialAccountAccess"}}],"responses":{"200":{"description":"Special account access object","schema":{"$ref":"#/definitions/SpecialAccountAccess"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]}},"/special_accounts/{account_id}/goods":{"get":{"description":"Return special account available goods list","operationId":"incust.controllers.corporate_user.api.special_account_goods_list","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of goods","schema":{"items":{"$ref":"#/definitions/Goods","description":"Goods object"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"]}},"/special_accounts/{account_id}/refill":{"post":{"description":"Special Account refill without finalization","operationId":"incust.controllers.corporate_user.api.special_account_refill","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Refill data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateSpecialAccountRefillObject"}}],"responses":{"200":{"description":"Refill transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/special_accounts/{account_id}/refill/preview":{"post":{"description":"Special Account refill preview","operationId":"incust.controllers.corporate_user.api.special_account_refill_preview","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Refill data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/CorporateSpecialAccountRefillObject"}}],"responses":{"200":{"description":"Refill data","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/special_accounts/{account_id}/refill/process":{"post":{"description":"Special Account refill process check - DEPRECATED","operationId":"incust.controllers.corporate_user.api.special_account_refill_process_deprecated","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check"}}],"responses":{"200":{"description":"Check object","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/special_accounts/{account_id}/refill/write":{"post":{"description":"Special Account refill without finalization - DEPRECATED","operationId":"incust.controllers.corporate_user.api.special_account_refill_write_deprecated","parameters":[{"description":"Special Account ID","format":"uuid","in":"path","name":"account_id","required":true,"type":"string"},{"description":"Check object","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Check","required":["amount"]}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Special Accounts"],"x-application-access-scope-restriction":{"allowed":["payments"]}}},"/staff":{"get":{"description":"Return staff list","operationId":"incust.controllers.corporate_user.api.staff","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Filter by position","format":"uuid","in":"query","name":"position_id","required":false,"type":"string"},{"default":"all","description":"Filter by suspended flag","enum":["all","yes","no"],"in":"query","name":"suspended","required":false,"type":"string"},{"description":"Filter by primary phone ID (matching criteria)","in":"query","name":"phone","required":false,"type":"string"},{"description":"Filter by primary email ID (matching criteria)","in":"query","name":"email","required":false,"type":"string"},{"description":"Filter by primary external ID (matching criteria)","in":"query","name":"external_id","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (name, comment, questionnaire fields)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"suspended","description":"Sort field name","enum":["phone","email","external_id","name","comment","suspended"],"in":"query","name":"sort","required":false,"type":"string"},{"default":"asc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"}],"responses":{"200":{"description":"Array of staff object","schema":{"properties":{"data":{"description":"Staff list","items":{"$ref":"#/definitions/StaffInfo"},"type":"array"},"summary":{"properties":{"total_rows_count":{"description":"Total staff count","type":"integer"}},"type":"object"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"post":{"description":"Add new staff item","operationId":"incust.controllers.corporate_user.api.staff_add","parameters":[{"description":"Staff object data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/StaffInfo"}}],"responses":{"200":{"description":"Staff object data","schema":{"$ref":"#/definitions/StaffInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/positions":{"get":{"description":"Return staff positions list","operationId":"incust.controllers.corporate_user.api.staff_positions","parameters":[{"description":"Search expression","in":"query","name":"search_text","required":false,"type":"string"}],"responses":{"200":{"description":"Array of staff positions data","schema":{"items":{"$ref":"#/definitions/StaffPosition"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"patch":{"description":"Save default staff positions orders","operationId":"incust.controllers.corporate_user.api.staff_positions_save_orders","parameters":[{"description":"Positions ID array","in":"body","name":"data","required":true,"schema":{"items":{"description":"Position ID","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Array of staff positions data","schema":{"items":{"$ref":"#/definitions/StaffPosition"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"post":{"description":"Add new staff position","operationId":"incust.controllers.corporate_user.api.staff_position_add","parameters":[{"description":"Staff positions data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/StaffPosition"}}],"responses":{"200":{"description":"Staff positions data","schema":{"$ref":"#/definitions/StaffPosition"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/positions/{position_id}":{"delete":{"description":"Delete staff position","operationId":"incust.controllers.corporate_user.api.staff_position_delete","parameters":[{"description":"Position ID","format":"uuid","in":"path","name":"position_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of staff positions data","schema":{"items":{"$ref":"#/definitions/StaffPosition"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"get":{"description":"Return staff position data","operationId":"incust.controllers.corporate_user.api.staff_position_get","parameters":[{"description":"Position ID","format":"uuid","in":"path","name":"position_id","required":true,"type":"string"}],"responses":{"200":{"description":"Staff positions data","schema":{"$ref":"#/definitions/StaffPosition"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"patch":{"description":"Modify staff position","operationId":"incust.controllers.corporate_user.api.staff_position_edit","parameters":[{"description":"Position ID","format":"uuid","in":"path","name":"position_id","required":true,"type":"string"},{"description":"Staff positions data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/StaffPosition"}}],"responses":{"200":{"description":"Staff positions data","schema":{"$ref":"#/definitions/StaffPosition"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/positions/{position_id}/force_delete":{"post":{"description":"Delete staff position with staff","operationId":"incust.controllers.corporate_user.api.staff_position_delete_force","parameters":[{"description":"Position ID","format":"uuid","in":"path","name":"position_id","required":true,"type":"string"},{"description":"Staff positions data","in":"body","name":"data","required":true,"schema":{"properties":{"action":{"description":"Position's staff action","enum":["staff-position-remove","staff-position-remove-suspend"],"type":"string"}},"required":["action"],"type":"object"}}],"responses":{"200":{"description":"Staff positions data","schema":{"$ref":"#/definitions/StaffPosition"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/questionnaires/fields":{"get":{"description":"Return default staff questionnaire fields","operationId":"incust.controllers.corporate_user.api.default_staff_questionnaire_fields","responses":{"200":{"description":"Array of fields","schema":{"items":{"$ref":"#/definitions/QuestionnaireField"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"patch":{"description":"Save default staff questionnaire fields orders","operationId":"incust.controllers.corporate_user.api.default_staff_questionnaire_field_save_orders","parameters":[{"description":"Fields Id array","in":"body","name":"data","required":true,"schema":{"items":{"description":"Field ID","type":"string"},"type":"array"}}],"responses":{"200":{"description":"Array of fields","schema":{"items":{"$ref":"#/definitions/QuestionnaireField"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"post":{"description":"Add new default staff questionnaire field","operationId":"incust.controllers.corporate_user.api.default_staff_questionnaire_field_add","parameters":[{"description":"Field data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/QuestionnaireField"}}],"responses":{"201":{"description":"Field data","schema":{"$ref":"#/definitions/QuestionnaireField"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/questionnaires/fields/{field_id}":{"delete":{"description":"Delete default staff questionnaire field","operationId":"incust.controllers.corporate_user.api.default_staff_questionnaire_field_del","parameters":[{"description":"Field ID","in":"path","name":"field_id","required":true,"type":"string"}],"responses":{"200":{"description":"Array of fields","schema":{"items":{"$ref":"#/definitions/QuestionnaireField"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"get":{"description":"Return default staff questionnaire field info","operationId":"incust.controllers.corporate_user.api.default_staff_questionnaire_field_get","parameters":[{"description":"Field ID","format":"uuid","in":"path","name":"field_id","required":true,"type":"string"}],"responses":{"200":{"description":"Field data","schema":{"$ref":"#/definitions/QuestionnaireField"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"patch":{"description":"Modify default staff questionnaire field info","operationId":"incust.controllers.corporate_user.api.default_staff_questionnaire_field_edit","parameters":[{"description":"Field ID","in":"path","name":"field_id","required":true,"type":"string"},{"description":"Field data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/QuestionnaireField"}}],"responses":{"200":{"description":"Field data","schema":{"$ref":"#/definitions/QuestionnaireField"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/search":{"get":{"description":"Return staff list found by search text","operationId":"incust.controllers.corporate_user.api.staff_search","parameters":[{"description":"Filter by position","format":"uuid","in":"query","name":"position_id","required":false,"type":"string"},{"default":"all","description":"Filter by suspended flag","enum":["all","yes","no"],"in":"query","name":"suspended","required":false,"type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (name, comment, questionnaire fields)","in":"query","name":"search_text","required":false,"type":"string"}],"responses":{"200":{"description":"Array of staff object","schema":{"description":"Staff list","items":{"$ref":"#/definitions/StaffInfo"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/{staff_id}":{"get":{"description":"Return staff item data","operationId":"incust.controllers.corporate_user.api.staff_get","parameters":[{"description":"Staff ID","format":"uuid","in":"path","name":"staff_id","required":true,"type":"string"}],"responses":{"200":{"description":"Staff object data","schema":{"$ref":"#/definitions/StaffInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"patch":{"description":"Modify staff item","operationId":"incust.controllers.corporate_user.api.staff_edit","parameters":[{"description":"Staff ID","format":"uuid","in":"path","name":"staff_id","required":true,"type":"string"},{"description":"Staff object data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/StaffInfo"}}],"responses":{"200":{"description":"Staff object data","schema":{"$ref":"#/definitions/StaffInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/{staff_id}/customer_cards":{"get":{"description":"Return staff item customer cards list grouped by loyalty","operationId":"incust.controllers.corporate_user.api.staff_customer_cards","parameters":[{"description":"Staff ID","format":"uuid","in":"path","name":"staff_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customer cards data","schema":{"$ref":"#/definitions/CustomerCardsGroupedByLoyalty"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/staff/{staff_id}/customer_cards/loyalty/{loyalty_id}":{"get":{"description":"Return staff item customer cards for loyalty","operationId":"incust.controllers.corporate_user.api.staff_customer_cards_by_loyalty_get","parameters":[{"description":"Staff ID","format":"uuid","in":"path","name":"staff_id","required":true,"type":"string"},{"description":"Staff ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"}],"responses":{"200":{"description":"Customer cards data","schema":{"$ref":"#/definitions/LoyaltyCustomerCards"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]},"patch":{"description":"Modify staff item customer cards for loyalty","operationId":"incust.controllers.corporate_user.api.staff_customer_cards_by_loyalty_modify","parameters":[{"description":"Staff ID","format":"uuid","in":"path","name":"staff_id","required":true,"type":"string"},{"description":"Staff ID","format":"uuid","in":"path","name":"loyalty_id","required":true,"type":"string"},{"description":"Customer cards data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/LoyaltyCustomerCards"}}],"responses":{"200":{"description":"Customer cards data","schema":{"$ref":"#/definitions/LoyaltyCustomerCards"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Staff"]}},"/token":{"post":{"description":"Check existing corporate user and if valid return token and profile","operationId":"incust.controllers.corporate_user.api.token","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignInRequestData"}}],"responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"202":{"description":"Send email with pin code for access if dynamic password used","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"]}},"/token/pre":{"post":{"description":"Authorize corporate user pre-processing","operationId":"incust.controllers.corporate_user.api.token_pre_processing","parameters":[{"description":"Post data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/SignInRequestData"}}],"responses":{"200":{"description":"Pre-processing result","schema":{"properties":{"protection_options":{"$ref":"#/definitions/ProtectionOptions"}},"type":"object"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"]}},"/token/renew":{"get":{"description":"Renew and return new corporate user token and profile.","operationId":"incust.controllers.corporate_user.api.token_renew","responses":{"200":{"description":"Response TOKEN","schema":{"$ref":"#/definitions/Token"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Corporate User"]}},"/transactions":{"get":{"description":"Return transactions list","operationId":"incust.controllers.corporate_user.api.transactions","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"},{"default":"processed_local","description":"Sort field name","in":"query","name":"sort","required":false,"type":"string"},{"default":"desc","description":"Sort direction","enum":["asc","desc"],"in":"query","name":"order","required":false,"type":"string"},{"default":false,"description":"Do not calculate totals values","in":"query","name":"skip_totals","required":false,"type":"boolean"},{"description":"Date and time filter from in RFC3339","format":"date-time","in":"query","name":"date_from","required":false,"type":"string"},{"description":"Date and time to from in RFC3339","format":"date-time","in":"query","name":"date_to","required":false,"type":"string"},{"description":"Transactions type if need","enum":["all","reserve","sale","special-account-refill"],"in":"query","name":"transaction_type","required":false,"type":"string"},{"description":"Transactions by canceled flag","in":"query","name":"canceled","required":false,"type":"boolean"},{"description":"Business ID","format":"uuid","in":"query","name":"business_id","required":false,"type":"string"},{"description":"Loyalty ID","format":"uuid","in":"query","name":"loyalty_id","required":false,"type":"string"},{"description":"Point of sales ID","format":"uuid","in":"query","name":"pos_id","required":false,"type":"string"},{"description":"Instance of corporate customer special account ID if need","format":"uuid","in":"query","name":"special_account_id","required":false,"type":"string"},{"description":"Staff ID if need","format":"uuid","in":"query","name":"staff_id","required":false,"type":"string"},{"description":"Staff comment if need (search by contains)","in":"query","name":"staff_comment","required":false,"type":"string"},{"description":"Position ID if need","format":"uuid","in":"query","name":"position_id","required":false,"type":"string"},{"description":"Position title if need (search by contains)","in":"query","name":"position_title","required":false,"type":"string"},{"description":"User phone if need (search by contains)","in":"query","name":"user_phone","required":false,"type":"string"},{"description":"User email if need (search by contains)","in":"query","name":"user_email","required":false,"type":"string"},{"description":"User external id if need (search by contains)","in":"query","name":"user_external_id","required":false,"type":"string"},{"description":"User identifier, exclude search by user_phone, user_email and user_external_id fields (search by equals)","in":"query","name":"user_id_value","required":false,"type":"string"},{"description":"Type of user identifier","enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"in":"query","name":"user_id_type","required":false,"type":"string"},{"description":"Vehicle ID if need","in":"query","name":"vehicle_id","required":false,"type":"string"},{"description":"Corporate Vehicle/inventory unique Id if need","in":"query","name":"corporate_vehicle_id","required":false,"type":"string"},{"description":"Corporate off-line site unique Id if need","in":"query","name":"corporate_offline_site_id","required":false,"type":"string"},{"collectionFormat":"csv","description":"Transaction items array if need","in":"query","items":{"type":"string"},"name":"items","required":false,"type":"array"},{"default":false,"description":"Detalized by stock (return transactions with stock only)","in":"query","name":"by_stock","required":false,"type":"boolean"},{"default":false,"description":"Include check vehicle id info","in":"query","name":"include_vehicle_id","required":false,"type":"boolean"},{"default":false,"description":"Include check odometer info","in":"query","name":"include_odometer","required":false,"type":"boolean"},{"default":false,"description":"Include corporate vehicle/inventory info","in":"query","name":"include_corporate_vehicle","required":false,"type":"boolean"},{"default":false,"description":"Include corporate off-line sites info","in":"query","name":"include_corporate_offline_site","required":false,"type":"boolean"},{"default":false,"description":"Include staff cuestionnaire","in":"query","name":"include_questionnaire","required":false,"type":"boolean"}],"responses":{"200":{"description":"Transactions data","schema":{"items":{"$ref":"#/definitions/Transaction"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"]}},"/transactions/{transaction_id}/cancel":{"post":{"description":"Cancel not completed transaction","operationId":"incust.controllers.corporate_user.api.transaction_cancel","parameters":[{"description":"Transaction id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Operation data object","in":"body","name":"data","required":true,"schema":{"properties":{"comment":{"description":"Comment","type":"string"}},"type":"object"}}],"responses":{"200":{"description":"Transaction object","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"],"x-application-access-scope-restriction":{"forbidden":["administration"]}}},"/transactions/{transaction_id}/check":{"get":{"description":"Return transaction check","operationId":"incust.controllers.corporate_user.api.transaction_check","parameters":[{"description":"Transaction id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Check data","schema":{"$ref":"#/definitions/Check"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"]}},"/transactions/{transaction_id}/payments":{"get":{"description":"Return transaction payments info","operationId":"incust.controllers.corporate_user.api.transaction_payments","parameters":[{"description":"Transaction id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"},{"description":"Payment type filter if needed","enum":["cash","bank-card","bank-card-external","mobile-app","special-account"],"in":"query","name":"payment_type","required":false,"type":"string","x-nullable":true}],"responses":{"200":{"description":"Array of payments info object","schema":{"$ref":"#/definitions/PaymentInfoList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"]}},"/transactions/{transaction_id}/receipt":{"get":{"description":"Return transaction receipt","operationId":"incust.controllers.corporate_user.api.transaction_receipt","parameters":[{"description":"Transaction id","format":"uuid","in":"path","name":"transaction_id","required":true,"type":"string"}],"responses":{"200":{"description":"Receipt data","schema":{"$ref":"#/definitions/TransactionReceipt"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transaction"]}},"/users":{"post":{"description":"Add new user","operationId":"incust.controllers.corporate_user.api.user_add","parameters":[{"description":"User profile data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserProfile"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/users/search":{"post":{"description":"Search user and return user profile","operationId":"incust.controllers.corporate_user.api.user_search","parameters":[{"description":"Search data","in":"body","name":"data","required":true,"schema":{"properties":{"email":{"description":"User email","type":"string","x-nullable":true},"external_id":{"description":"User external id","type":"string","x-nullable":true},"phone":{"description":"User phone","type":"string","x-nullable":true}},"type":"object"}}],"responses":{"200":{"description":"Found users profile data","schema":{"items":{"$ref":"#/definitions/UserProfile"},"type":"array"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/users/{user_id}":{"get":{"description":"Get user profile","operationId":"incust.controllers.corporate_user.api.user_get","parameters":[{"description":"User ID","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]},"patch":{"description":"Modify user profile","operationId":"incust.controllers.corporate_user.api.user_edit","parameters":[{"description":"User ID","format":"uuid","in":"path","name":"user_id","required":true,"type":"string"},{"description":"User Profile data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/UserProfile"}}],"responses":{"200":{"description":"Profile data","schema":{"$ref":"#/definitions/UserProfile"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["User"]}},"/vehicles":{"get":{"description":"Return vehicles/inventory list","operationId":"incust.controllers.corporate_user.api.vehicles","parameters":[{"default":1,"description":"List page number","in":"query","name":"page","required":false,"type":"integer"},{"default":10,"description":"Objects on page","in":"query","name":"count","required":false,"type":"integer"},{"description":"Filter by position","format":"uuid","in":"query","name":"position_id","type":"string"},{"description":"Filter by QR Code (matching criteria)","in":"query","name":"qr_code","type":"string"},{"description":"Filter by search string (contains criteria) in main text fields (vehicle_id, description, qr_code, department)","in":"query","name":"search_text","required":false,"type":"string"},{"default":"vehicle_id","description":"Sort field name","enum":["vehicle_id","description","qr_code"],"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":"Array of vehicles/inventory object","schema":{"$ref":"#/definitions/VehiclesListPaginated"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Vehicles/Inventory"]},"post":{"description":"Add new vehicle/inventory item","operationId":"incust.controllers.corporate_user.api.vehicle_add","parameters":[{"description":"Vehicle/inventory object data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/VehicleInfo"}}],"responses":{"200":{"description":"Vehicle/inventory object data","schema":{"$ref":"#/definitions/VehicleInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Vehicles/Inventory"]}},"/vehicles/{vehicle_id}":{"delete":{"description":"Delete vehicle/inventory item","operationId":"incust.controllers.corporate_user.api.vehicle_delete","parameters":[{"description":"Vehicle/inventory ID","format":"uuid","in":"path","name":"vehicle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Vehicles/Inventory"]},"get":{"description":"Return vehicle/inventory item data","operationId":"incust.controllers.corporate_user.api.vehicle_get","parameters":[{"description":"Vehicle/inventory ID","format":"uuid","in":"path","name":"vehicle_id","required":true,"type":"string"}],"responses":{"200":{"description":"Vehicle/inventory object data","schema":{"$ref":"#/definitions/VehicleInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Vehicles/Inventory"]},"patch":{"description":"Modify vehicle/inventory item","operationId":"incust.controllers.corporate_user.api.vehicle_edit","parameters":[{"description":"Vehicle/inventory ID","format":"uuid","in":"path","name":"vehicle_id","required":true,"type":"string"},{"description":"Vehicle/inventory object data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/VehicleInfo"}}],"responses":{"200":{"description":"Vehicle/inventory object data","schema":{"$ref":"#/definitions/VehicleInfo"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Vehicles/Inventory"]}}},"produces":["application/json"],"schemes":["https","http"],"securityDefinitions":{"bearer":{"in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"incust.auth.apikey_auth"}},"swagger":"2.0"}