{"basePath":"/v1/corporate_offline_site","consumes":["application/json"],"definitions":{"AdditionalServiceCostType":{"enum":["amount","percentage","multiplier"],"type":"string"},"AdditionalServiceType":{"enum":["delivery","commission","tip"],"type":"string"},"ApplicationSettings":{"type":"object"},"BenefitsChargeTypeBase":{"enum":["regular-bonuses","promotional-bonuses","special-account"],"type":"string"},"BenefitsChargeTypeBaseNone":{"enum":["none","regular-bonuses","promotional-bonuses","special-account"],"type":"string"},"BenefitsChargeTypeExtended":{"enum":["none","regular-bonuses","promotional-bonuses","special-account","coupon"],"type":"string"},"BenefitsPriceType":{"enum":["bonuses","special-account"],"type":"string"},"BenefitsTopUpReferenceObjectType":{"enum":["loyalty-rule","external-system"],"type":"string"},"BonusAccountOperationType":{"enum":["bonus-add","bonus-write-offs","bonus-adjustment"],"type":"string"},"CheckItemEnterMode":{"enum":["without-limits","presets-only","manually-only"],"type":"string"},"Client":{"properties":{"created":{"description":"Client created date and time (UTC)","format":"date-time","type":"string","x-nullable":true},"name":{"description":"Client Name","format":"uuid","type":"string","x-nullable":true},"offline_one_time_fueling_limit":{"description":"Client one time refuel amount","format":"double","type":"number","x-nullable":true},"qr_code":{"description":"Client Qr Code / Tag","type":"string","x-nullable":true},"rfid_tag":{"description":"Client RFID / Fleet Tag","type":"string","x-nullable":true},"type":{"description":"Client type","enum":["driver","vehicle"],"type":"string","x-nullable":true},"updated":{"description":"Client last updated date and time (UTC)","format":"date-time","type":"string","x-nullable":true},"uuid":{"description":"Client unique ID","format":"uuid","type":"string","x-nullable":true}},"type":"object"},"ClientsList":{"description":"List of Clients","items":{"$ref":"#/definitions/Client"},"type":"array"},"ClientsOperation":{"properties":{"client":{"$ref":"#/definitions/Client","description":"Client Data","x-nullable":true},"process_error":{"description":"Update data error (readonly)","type":"string","x-nullable":true},"process_status":{"description":"Update data status (readonly)","enum":["success","fail"],"type":"string","x-nullable":true},"processed":{"description":"Operation processed date and time (UTC)","format":"date-time","type":"string","x-nullable":true},"type":{"description":"Client type","enum":["create","update","delete"],"type":"string","x-nullable":true}},"type":"object"},"ClientsOperationList":{"description":"List of Clients Operations","items":{"$ref":"#/definitions/ClientsOperation"},"type":"array"},"CustomerAccessType":{"enum":["full-bonuses-access","add-bonuses-only","waiting-for-confirmation","in-black-list"],"type":"string"},"CustomerFeedbackPrintOnCheck":{"enum":["none","qr-code","url","all"],"type":"string"},"DataRequiredType":{"enum":["no","yes","possible"],"type":"string"},"ExternalCheckIdScope":{"enum":["system","business","loyalty","pos","terminal"],"type":"string"},"IdType":{"enum":["phone","qr","email","card","temporary-card","id","external-id","social-network","ssn","itin","itn"],"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"},"OdometerUnitType":{"enum":["K","M","H"],"type":"string"},"PosCatalogPublicationState":{"enum":["none","requested","rejected","allowed"],"type":"string"},"PosType":{"enum":["pos","road-tanker","online-store"],"type":"string"},"PromotionalBonusesExpireType":{"enum":["none","date","day","month"],"type":"string"},"PromotionalBonusesExpireTypeBase":{"enum":["date","day","month"],"type":"string"},"PromotionalBonusesStartingType":{"enum":["immediately","date","day","month"],"type":"string"},"Refuel":{"properties":{"created":{"description":"Client created date and time (UTC)","format":"date-time","type":"string","x-nullable":true},"driver":{"$ref":"#/definitions/Client","description":"Client Data","x-nullable":true},"filled_volume":{"description":"Fuel filled volume","format":"float","type":"number","x-nullable":true},"filled_volume_decimal_digits":{"description":"Fuel filled volume decimal digits","format":"int32","type":"integer","x-nullable":true},"filled_volume_unit":{"$ref":"#/definitions/VolumeUnitType","description":"Fuel filled volume unit","x-nullable":true},"grade":{"description":"Internal grade ID / Grade number","format":"int32","type":"integer","x-nullable":true},"grade_code":{"description":"Internal Grade Code","type":"string","x-nullable":true},"id":{"description":"Refuel ID","format":"int64","type":"integer","x-nullable":true},"nozzle":{"description":"Internal nozzle ID / Nozzle number","format":"int32","type":"integer","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","format":"int32","type":"integer","x-nullable":true},"request_pump_authorize":{"$ref":"#/definitions/RequestPumpAuthorize","description":"Fuel controller Pump Authorize Request Data (optional)","x-nullable":true},"response_pump_authorize":{"$ref":"#/definitions/ResponsePumpAuthorize","description":"Fuel controller Pump Authorize Response Data (optional)","x-nullable":true},"title":{"description":"Off-line siye Title","type":"string","x-nullable":true},"transaction_error_message":{"description":"Fuel controller Transaction Error Message (optional)","type":"string","x-nullable":true},"transaction_id":{"description":"Fuel controller Transaction ID","format":"int32","type":"integer","x-nullable":true},"transaction_information":{"$ref":"#/definitions/TransactionInformation","description":"Fuel controller Transaction Info Data (optional)","x-nullable":true},"transaction_state":{"description":"Fuel controller Transaction State","type":"string","x-nullable":true},"updated":{"description":"Client last updated date and time (UTC)","format":"date-time","type":"string","x-nullable":true},"uuid":{"description":"Refuel unique ID","format":"uuid","type":"string","x-nullable":true},"vehicle":{"$ref":"#/definitions/Client","description":"Client Data","x-nullable":true}},"type":"object"},"RequestPumpAuthorize":{"type":"object"},"ResponsePumpAuthorize":{"type":"object"},"RewardGrantPeriodType":{"enum":["day","month"],"type":"string"},"RewardValueType":{"enum":["check-percentage","fixed-amount"],"type":"string"},"Settings":{"properties":{"application_settings":{"$ref":"#/definitions/ApplicationSettings","description":"Settings for application (optional)","x-nullable":true},"id":{"description":"Site ID","format":"uuid","type":"string"},"title":{"description":"Site title","type":"string"}},"type":"object"},"SortDirection":{"enum":["asc","desc"],"type":"string"},"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"},"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"},"Transaction":{"properties":{"amount":{"description":"Transaction amount","format":"double","type":"number","x-nullable":true},"amount_decimal_digits":{"description":"Number of decimal digits in amount value","type":"integer","x-nullable":true},"amount_to_pay":{"description":"Transaction amount to pay","format":"double","type":"number","x-nullable":true},"bonuses_added":{"description":"Bonus points added during transaction","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":{"description":"Bonus points account balance as result of transaction","format":"double","type":"number","x-nullable":true},"bonuses_redeemed":{"description":"Bonus points redeemed during transaction","format":"double","type":"number","x-nullable":true},"business_staff_id":{"description":"Business Staff ID (optional)","format":"uuid","type":"string","x-nullable":true},"canceled":{"description":"Transaction canceled","type":"boolean","x-nullable":true},"comment":{"description":"Comment","type":"string"},"corporate_customer_email":{"description":"Corporate customer email","type":"string","x-nullable":true},"corporate_customer_id":{"description":"Corporate customer ID","format":"uuid","type":"string"},"corporate_customer_name":{"description":"Corporate customer name","type":"string","x-nullable":true},"currency":{"description":"Currency ISO code (if transaction payment 'currency')","type":"string","x-nullable":true},"discount_amount":{"description":"Transaction discount amount","format":"double","type":"number","x-nullable":true},"errors":{"description":"Errors list (optional)","items":{"$ref":"#/definitions/TransactionErrors"},"type":"array"},"finalized":{"description":"Transaction finalized","type":"boolean","x-nullable":true},"id":{"description":"Transaction ID","format":"uuid","type":"string","x-nullable":true},"loyalty_id":{"description":"Loyalty ID","format":"uuid","type":"string"},"online_store_order_id":{"description":"Online store order ID","format":"uuid","type":"string","x-nullable":true},"payment_type":{"$ref":"#/definitions/TransactionPaymentType","description":"Payment type","x-nullable":true},"pos_id":{"description":"Pos ID","format":"uuid","type":"string"},"processed":{"description":"Transaction UTC processed date-time","format":"date-time","type":"string","x-nullable":true},"processed_local":{"description":"Transaction local (by POS time zone) processed date-time","format":"date-time","type":"string","x-nullable":true},"services_amount":{"description":"Services amount","format":"float","type":"number","x-nullable":true},"shipping_amount":{"description":"Shipping amount","format":"double","type":"number","x-nullable":true},"special_account_amount":{"description":"Special account balance as result of transactions (if transaction payment in 'special-account', 'corporate-special-account-access', 'retail-special-account-access')","format":"double","type":"number","x-nullable":true},"special_account_id":{"description":"Special account ID (if transaction payment in 'special-account', 'corporate-special-account-access', 'retail-special-account-access')","format":"uuid","type":"string","x-nullable":true},"special_accounts_decimal_digits":{"description":"Number of decimal digits in special account value","type":"integer","x-nullable":true},"subtype":{"$ref":"#/definitions/TransactionSubType","description":"Transaction subtype (optional, readonly)","x-nullable":true},"summary_amount":{"description":"Sum of amount and shipping_amount and services_amount (transaction total amount)","format":"double","type":"number","x-nullable":true},"terminal_id":{"description":"Terminal ID","format":"uuid","type":"string"},"transaction_id":{"description":"Referenced transaction ID","format":"uuid","type":"string"},"type":{"$ref":"#/definitions/TransactionType","description":"Transaction type","x-nullable":true},"user_email":{"description":"User email","type":"string"},"user_external_id":{"description":"User external id","type":"string"},"user_id":{"description":"User ID","format":"uuid","type":"string"},"user_name":{"description":"User name","type":"string"},"user_phone":{"description":"User phone number","type":"string"}},"type":"object"},"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"},"TransactionInformation":{"type":"object"},"TransactionPaymentType":{"enum":["currency","special-account","corporate-special-account-access","retail-special-account-access"],"type":"string"},"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"},"UserGender":{"enum":["male","female","other"],"type":"string"},"UserStatus":{"enum":["deleted","blocked","banned","suspended","registered","active"],"type":"string"},"UserStatusForAdmin":{"enum":["deleted","blocked","banned","suspended","registered","activated"],"type":"string"},"VolumeUnitType":{"enum":["L","G"],"type":"string"}},"info":{"description":"API for Corporate Off-line Site application  \n\n\n### Methods\n`GET`: \t\tRetrieve resources  \n`POST`:\t\tCrete resources  \n`PATCH`:\tUpdate resources\n\n**Why use PATCH rather than a PUT?**\n`JLab13`: I think PATCH method is the correct choice for updating an\nexisting resources. PUT should only be used if you're replacing a\nresource in its entirety.\n\nFurther information on partial resource modification is available in\n[RFC 5789](http://tools.ietf.org/html/rfc5789). Specifically, the\nPUT method is described as follows:\n\n> Several applications extending the Hypertext Transfer Protocol (HTTP)\n> require a feature to do partial resource modification. The existing\n> HTTP PUT method only allows a complete replacement of a document. \n> This proposal adds a new HTTP method, PATCH, to modify an\n> existing HTTP resource.  \n\n### X-Application-Type HTTP Header\nAll requests must contain a header **X-Application-Type**.  \nThis header defines the type of application that makes the request.  \n\n**Available values:**  \n`web`: \t\t    application that runs in browser as web application  \n`android`: \t\tapplication that runs on android as android application  \n`ios`: \t\t    application that runs on iPhone/iPad/etc as iOS application  \n`windows`: \t\tapplication that runs on windows as windows application  \n`external`: \texternal application and systems which itegrated with inCust API\n","title":"inCust Corporate Off-line Site API","version":"1.0"},"paths":{"/clients":{"get":{"description":"Return Clients List","operationId":"incust.controllers.corporate_offline_site.api.clients_get","responses":{"200":{"description":"List of Clients","schema":{"$ref":"#/definitions/ClientsList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Clients"]}},"/clients/operations":{"post":{"description":"Modify Clients by site data","operationId":"incust.controllers.corporate_offline_site.api.clients_operations","parameters":[{"description":"List of Clients Operations","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ClientsOperationList"}}],"responses":{"200":{"description":"List of Clients Operations","schema":{"$ref":"#/definitions/ClientsOperationList"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Clients"]}},"/ping":{"get":{"description":"Check if api is available","operationId":"incust.controllers.corporate_offline_site.api.ping","responses":{"200":{"description":"OK message","schema":{"$ref":"#/definitions/MessageResponse"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Heartbeat"]}},"/settings":{"get":{"description":"Return terminal settings","operationId":"incust.controllers.corporate_offline_site.api.settings","responses":{"200":{"description":"Terminal settings","schema":{"$ref":"#/definitions/Settings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/settings/application":{"get":{"description":"Return settings for application","operationId":"incust.controllers.corporate_offline_site.api.settings_application_get","responses":{"200":{"description":"Application settings","schema":{"$ref":"#/definitions/ApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]},"patch":{"description":"Set and return settings for application","operationId":"incust.controllers.corporate_offline_site.api.settings_application_set","parameters":[{"description":"Application settings","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/ApplicationSettings"}}],"responses":{"200":{"description":"Application settings","schema":{"$ref":"#/definitions/ApplicationSettings"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Settings"]}},"/transactions":{"post":{"description":"Make transaction by site data","operationId":"incust.controllers.corporate_offline_site.api.transaction_make","parameters":[{"description":"Site refuel data","in":"body","name":"data","required":true,"schema":{"$ref":"#/definitions/Refuel"}}],"responses":{"200":{"description":"Transaction data","schema":{"$ref":"#/definitions/Transaction"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/MessageResponse"}}},"tags":["Transactions"]}}},"produces":["application/json"],"schemes":["https","http"],"securityDefinitions":{"basicAuth":{"type":"basic","x-basicInfoFunc":"incust.auth.baseauth_auth"}},"swagger":"2.0"}